/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.apache.polaris.persistence.nosql.coretypes.catalog;

import java.util.Set;
import org.apache.polaris.immutables.PolarisImmutable;
import org.apache.polaris.persistence.nosql.api.index.IndexValueSerializer;
import org.immutables.value.Value;

/**
 * Container for a set of positive long values.
 *
 * <p>An empty {@code EntityIdSet} and {@code EntityIdSet==null} are treated the same, both are
 * deserialized as {@code null}.
 */
@PolarisImmutable
public interface EntityIdSet {
  IndexValueSerializer<EntityIdSet> ENTITY_ID_SET_SERIALIZER = new EntityIdSetSerializer();

  @Value.Parameter
  Set<Long> entityIds();

  @Value.Check
  default void check() {
    entityIds()
        .forEach(
            id -> {
              if (id < 0) {
                throw new IllegalStateException("Entity ID must not be negative: " + id);
              }
            });
  }

  static EntityIdSet entityIdSet(Set<Long> entityIds) {
    return ImmutableEntityIdSet.of(entityIds);
  }
}
