X-Git-Url: https://gerrit.simantics.org/r/gitweb?a=blobdiff_plain;f=bundles%2Forg.simantics.utils.datastructures%2Fsrc%2Forg%2Fsimantics%2Futils%2Fdatastructures%2Fcache%2FITimedCache.java;fp=bundles%2Forg.simantics.utils.datastructures%2Fsrc%2Forg%2Fsimantics%2Futils%2Fdatastructures%2Fcache%2FITimedCache.java;h=86354ef9ac7fe856492943b0e64f81a94e712c31;hb=0ae2b770234dfc3cbb18bd38f324125cf0faca07;hp=cbe381f217627d970fe23ae6346fd0b832f9f0c1;hpb=24e2b34260f219f0d1644ca7a138894980e25b14;p=simantics%2Fplatform.git diff --git a/bundles/org.simantics.utils.datastructures/src/org/simantics/utils/datastructures/cache/ITimedCache.java b/bundles/org.simantics.utils.datastructures/src/org/simantics/utils/datastructures/cache/ITimedCache.java index cbe381f21..86354ef9a 100644 --- a/bundles/org.simantics.utils.datastructures/src/org/simantics/utils/datastructures/cache/ITimedCache.java +++ b/bundles/org.simantics.utils.datastructures/src/org/simantics/utils/datastructures/cache/ITimedCache.java @@ -1,55 +1,55 @@ -/******************************************************************************* - * Copyright (c) 2007, 2010 Association for Decentralized Information Management - * in Industry THTH ry. - * All rights reserved. This program and the accompanying materials - * are made available under the terms of the Eclipse Public License v1.0 - * which accompanies this distribution, and is available at - * http://www.eclipse.org/legal/epl-v10.html - * - * Contributors: - * VTT Technical Research Centre of Finland - initial API and implementation - *******************************************************************************/ -package org.simantics.utils.datastructures.cache; - -import java.util.concurrent.TimeUnit; - -/** - * A timed (Key, Value) cache which disposes the cached entry after the - * specified amount of time if it is not released from the cache during that - * time. The hold time is given to the {@link #put(Object, Object, long)} - * method, separately for each value. - * - * @author Tuukka Lehtonen - * - * @see SoftTimedCache - * @param key type - * @param value type - */ -public interface ITimedCache { - - /** - * Put the value v into this cache with key k to be kept for holdTimeMs - * milliseconds. After this times has elapsed, the (k,v) pair will be - * disposed of and it will no longer be retrievable with key k. - * - * @param k key with which the specified value is to be associated - * @param v value to be associated with the specified key - * @param holdTime the maximum amount of time units to hold on to the - * specified value - * @param unit the unit of holdTime - */ - void put(final K k, V v, long holdTime, TimeUnit unit); - - /** - * Releases the value associated to the specified key k from this cache. If - * the hold time for this particular (key, value) pair has ran out, the - * value will no longer exist in the cache and null will be - * returned. - * - * @param k key of the value to release from the cache. - * @return null if there is no value associated to the - * specified key - */ - V release(K k); - -} +/******************************************************************************* + * Copyright (c) 2007, 2010 Association for Decentralized Information Management + * in Industry THTH ry. + * All rights reserved. This program and the accompanying materials + * are made available under the terms of the Eclipse Public License v1.0 + * which accompanies this distribution, and is available at + * http://www.eclipse.org/legal/epl-v10.html + * + * Contributors: + * VTT Technical Research Centre of Finland - initial API and implementation + *******************************************************************************/ +package org.simantics.utils.datastructures.cache; + +import java.util.concurrent.TimeUnit; + +/** + * A timed (Key, Value) cache which disposes the cached entry after the + * specified amount of time if it is not released from the cache during that + * time. The hold time is given to the {@link #put(Object, Object, long)} + * method, separately for each value. + * + * @author Tuukka Lehtonen + * + * @see SoftTimedCache + * @param key type + * @param value type + */ +public interface ITimedCache { + + /** + * Put the value v into this cache with key k to be kept for holdTimeMs + * milliseconds. After this times has elapsed, the (k,v) pair will be + * disposed of and it will no longer be retrievable with key k. + * + * @param k key with which the specified value is to be associated + * @param v value to be associated with the specified key + * @param holdTime the maximum amount of time units to hold on to the + * specified value + * @param unit the unit of holdTime + */ + void put(final K k, V v, long holdTime, TimeUnit unit); + + /** + * Releases the value associated to the specified key k from this cache. If + * the hold time for this particular (key, value) pair has ran out, the + * value will no longer exist in the cache and null will be + * returned. + * + * @param k key of the value to release from the cache. + * @return null if there is no value associated to the + * specified key + */ + V release(K k); + +}