ResourceLimitedMapFunctor.java

/*
 * The MIT License
 *
 * Copyright (c) 2009 The Broad Institute
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package htsjdk.samtools.util;

/**
 * c.f. ResourceLimitedMap for details.
 * @param <Key> Used to find and create value.
 * @param <Value> Type stored in ResourceLimitedMap, which is created as necessary
 * and finalized when it is the least-recently used.
 */
public interface ResourceLimitedMapFunctor<Key, Value> {

    /**
     * Create a new value corresponding to the key
     * @param key
     * @return a new value corresponding to the key
     */
    Value makeValue(final Key key);

    /**
     * Clean up an existing value in conjunction with removing from ResourceLimitedMap.
     * @param key
     * @param value
     */
    void finalizeValue(final Key key, final Value value);
}