oak-store-document/src/main/java/org/apache/jackrabbit/oak/plugins/document/CommitValueResolver.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.plugins.document;

import org.jetbrains.annotations.NotNull;

/**
 * Resolves the commit value for a given change revision on a document.
 */
public interface CommitValueResolver {

    /**
     * Resolve a change revision on the given document and return the commit
     * value for the change revision.
     *
     * @param changeRevision the revision for a change.
     * @param doc the document with the change.
     * @return the commit value of the revision.
     */
    String resolve(@NotNull Revision changeRevision, @NotNull NodeDocument doc);
}