Migrated source code from Simantics SVN

[simantics/platform.git] / bundles / org.simantics.utils.datastructures / src / org / simantics / utils / datastructures / cache / ITimedCache.java

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
new file mode 100644 (file)
index 0000000..cbe381f
--- /dev/null
+++ b/bundles/org.simantics.utils.datastructures/src/org/simantics/utils/datastructures/cache/ITimedCache.java
@@ -0,0 +1,55 @@
+/*******************************************************************************\r
+ * Copyright (c) 2007, 2010 Association for Decentralized Information Management\r
+ * in Industry THTH ry.\r
+ * All rights reserved. This program and the accompanying materials\r
+ * are made available under the terms of the Eclipse Public License v1.0\r
+ * which accompanies this distribution, and is available at\r
+ * http://www.eclipse.org/legal/epl-v10.html\r
+ *\r
+ * Contributors:\r
+ *     VTT Technical Research Centre of Finland - initial API and implementation\r
+ *******************************************************************************/\r
+package org.simantics.utils.datastructures.cache;\r
+\r
+import java.util.concurrent.TimeUnit;\r
+\r
+/**\r
+ * A timed (Key, Value) cache which disposes the cached entry after the\r
+ * specified amount of time if it is not released from the cache during that\r
+ * time. The hold time is given to the {@link #put(Object, Object, long)}\r
+ * method, separately for each value.\r
+ * \r
+ * @author Tuukka Lehtonen\r
+ * \r
+ * @see SoftTimedCache\r
+ * @param <K> key type\r
+ * @param <V> value type\r
+ */\r
+public interface ITimedCache<K, V> {\r
+\r
+    /**\r
+     * Put the value v into this cache with key k to be kept for holdTimeMs\r
+     * milliseconds. After this times has elapsed, the (k,v) pair will be\r
+     * disposed of and it will no longer be retrievable with key k.\r
+     * \r
+     * @param k key with which the specified value is to be associated\r
+     * @param v value to be associated with the specified key\r
+     * @param holdTime the maximum amount of time units to hold on to the\r
+     *        specified value\r
+     * @param unit the unit of <code>holdTime</code>\r
+     */\r
+    void put(final K k, V v, long holdTime, TimeUnit unit);\r
+\r
+    /**\r
+     * Releases the value associated to the specified key k from this cache. If\r
+     * the hold time for this particular (key, value) pair has ran out, the\r
+     * value will no longer exist in the cache and <code>null</code> will be\r
+     * returned.\r
+     * \r
+     * @param k key of the value to release from the cache.\r
+     * @return <code>null</code> if there is no value associated to the\r
+     *         specified key\r
+     */\r
+    V release(K k);\r
+\r
+}\r