net.openhft.chronicle.map.DefaultValueProvider Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2014 Higher Frequency Trading
 *
 * http://www.higherfrequencytrading.com
 *
 * Licensed 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 net.openhft.chronicle.map;

import net.openhft.chronicle.hash.KeyContext;

import java.io.Serializable;

/**
 * Default value computation strategy, used
 * in {@link ChronicleMapBuilder#defaultValueProvider(DefaultValueProvider)} configuration.
 *
 * @param  map key class
 * @param  map value class
 * @deprecated specialize {@link MapEntryOperations#defaultValue(MapAbsentEntry)} instead
 */
@Deprecated
public interface DefaultValueProvider extends Serializable {
    /**
     * Returns a value to be put during {@link ChronicleMap#acquireUsing(Object, Object)} call
     * for the specified key, if it is absent in the map.
     *
     * @param keyContext key absent in the map
     * @return value to be put for the specified key in the map
     */
    V get(KeyContext keyContext);
}