org.apache.jackrabbit.oak.segment.BinaryReferenceConsumer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of oak-segment-tar Show documentation

There is a newer version: 1.74.0

/*
 * 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;

import java.util.UUID;

/**
 * A consumer for references to external binaries. An implementor of this
 * interface is called every time an external binary reference is written in the
 * store.
 */
public interface BinaryReferenceConsumer {

    /**
     * Consume the reference to an external binary.
     *
     * @param generation      The generation of the record referencing the
     *                        binary.
     * @param segmentId       The ID of the segment this reference belongs to.
     * @param binaryReference The opaque string representation of the binary
     *                        reference.
     */
    void consume(int generation, UUID segmentId, String binaryReference);

}