oak-segment-tar/src/main/java/org/apache/jackrabbit/oak/segment/SegmentReferences.java

/*
 * 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.jackrabbit.oak.segment;

/**
 * Represents a list of segment IDs referenced from a segment.
 */
interface SegmentReferences extends Iterable<SegmentId> {

    /**
     * Fetch the referenced segment ID associated to the provided reference.
     *
     * @param reference The reference to a segment ID.
     * @return The segment ID associated to the reference of {@code null} if
     * none is found.
     */
    SegmentId getSegmentId(int reference);

}