/*
 * IndexScanBounds.java
 *
 * This source file is part of the FoundationDB open source project
 *
 * Copyright 2022 Apple Inc. and the FoundationDB project authors
 *
 * Licensed 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 com.apple.foundationdb.record.provider.foundationdb;

import com.apple.foundationdb.annotation.API;
import com.apple.foundationdb.record.IndexScanType;

import javax.annotation.Nonnull;

/**
 * The bounds for an index scan.
 * This does not assume any data shape or implementation. That is all implied by the {@link IndexScanType} and understood by index maintainers that support the relevant type(s).
 * @see IndexMaintainer#scan
 */
@API(API.Status.UNSTABLE)
public interface IndexScanBounds {
    /**
     * Get the type of index scan to be performed.
     * @return the scan type
     */
    @Nonnull
    IndexScanType getScanType();
}
