Migrated source code from Simantics SVN

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

diff --git a/bundles/org.simantics.utils.datastructures/src/org/simantics/utils/datastructures/cache/SoftCachedProvider.java b/bundles/org.simantics.utils.datastructures/src/org/simantics/utils/datastructures/cache/SoftCachedProvider.java
new file mode 100644 (file)
index 0000000..0c11f24
--- /dev/null
+++ b/bundles/org.simantics.utils.datastructures/src/org/simantics/utils/datastructures/cache/SoftCachedProvider.java
@@ -0,0 +1,64 @@
+/*******************************************************************************\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.lang.ref.SoftReference;\r
+\r
+/**\r
+ * Caches the value provided by provider until the value has been garbage collected.\r
+ * <p>\r
+ * Cached IProvider provides the same instance as long as it is in memory.\r
+ * <p>\r
+ * Cached version is equal to original in hashCode/equals wise.\r
+ * \r
+ * @author Toni Kalajainen\r
+ */\r
+public class SoftCachedProvider<V> implements IProvider<V> {\r
+\r
+    public static final <V> IProvider<V> cache(IProvider<V> provider)\r
+    {\r
+        if (provider instanceof SoftCachedProvider<?>)\r
+            return provider;\r
+        return new SoftCachedProvider<V>(provider);\r
+    }\r
+\r
+    IProvider<V> provider;\r
+    SoftReference<V> ref;\r
+\r
+    SoftCachedProvider(IProvider<V> orig)\r
+    {\r
+        this.provider = orig;\r
+    }\r
+\r
+    @Override\r
+    public synchronized V get() throws ProvisionException {\r
+        if (ref!=null) {\r
+            V x = ref.get();\r
+            if (x==null) ref=null;\r
+            else return x;\r
+        }\r
+        V x = provider.get();\r
+        ref = new SoftReference<V>(x);\r
+        return x;\r
+    }\r
+\r
+    @Override\r
+    public int hashCode() {\r
+        return provider.hashCode();\r
+    }\r
+\r
+    @Override\r
+    public boolean equals(Object obj) {\r
+        return provider.equals(obj);\r
+    }\r
+\r
+}\r