org.apache.jackrabbit.oak.segment.SegmentIdFactory Maven / Gradle / Ivy
/*
* 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 org.jetbrains.annotations.NotNull;
/**
* A factory for {@link SegmentId} given their representation in MSB/LSB longs.
*
* An instance of this class is used by the {@link SegmentTracker} to delegate
* the creation of {@link SegmentId}s to its caller, that usually is a {@link
* SegmentStore}. This way, the {@link SegmentStore} may attach additional,
* implementation-dependent information to the returned {@link SegmentId} in a
* way that is transparent to the implementation of the {@link SegmentTracker}.
*/
public interface SegmentIdFactory {
/**
* Creates a {@link SegmentId} represented by the given MSB/LSB pair.
*
* @param msb The most significant bits of the {@link SegmentId}.
* @param lsb The least significant bits of the {@link SegmentId}.
* @return An instance of {@link SegmentId}. The returned instance is never
* {@code null}.
*/
@NotNull
SegmentId newSegmentId(long msb, long lsb);
}