/*
 * 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.spi.state;

import java.util.Collection;

/**
 * Experimental {@link NodeStore} extension that allows prefetching of node
 * states given a collection of paths.
 */
public interface PrefetchNodeStore {

    PrefetchNodeStore NOOP = (paths, rootState) -> {
        // do nothing
    };

    /**
     * Make an attempt to prefetch node states for the given paths and hold them
     * in a cache.
     *
     * @param paths the paths of the node states to prefetch.
     * @param rootState the current root node state.
     */
    void prefetch(Collection<String> paths, NodeState rootState);
}
