summaryrefslogtreecommitdiffstats
path: root/src-ambient/com/android/phone/common/ambient/SingletonHolder.java
diff options
context:
space:
mode:
authorStephen Bird <sbird@cyngn.com>2016-03-31 15:03:11 -0700
committerErica Chang <echang@cyngn.com>2016-04-26 22:38:42 -0700
commitecc708d3c1417b60f316a0387d17f2cf4c67c2b1 (patch)
treefefb202fcf37bb15e301a821b206e02cf0a0e16e /src-ambient/com/android/phone/common/ambient/SingletonHolder.java
parent33beb0a0b887dbfa9797f7fa97f3cd715bb71a74 (diff)
downloadpackages_apps_PhoneCommon-ecc708d3c1417b60f316a0387d17f2cf4c67c2b1.tar.gz
packages_apps_PhoneCommon-ecc708d3c1417b60f316a0387d17f2cf4c67c2b1.tar.bz2
packages_apps_PhoneCommon-ecc708d3c1417b60f316a0387d17f2cf4c67c2b1.zip
[1/4] Refactor CallMethodHelper
Change-Id: I3b24eedffddbf0960023dc2f1429038e5353de2f
Diffstat (limited to 'src-ambient/com/android/phone/common/ambient/SingletonHolder.java')
-rw-r--r--src-ambient/com/android/phone/common/ambient/SingletonHolder.java56
1 files changed, 56 insertions, 0 deletions
diff --git a/src-ambient/com/android/phone/common/ambient/SingletonHolder.java b/src-ambient/com/android/phone/common/ambient/SingletonHolder.java
new file mode 100644
index 0000000..bca6023
--- /dev/null
+++ b/src-ambient/com/android/phone/common/ambient/SingletonHolder.java
@@ -0,0 +1,56 @@
+package com.android.phone.common.ambient;
+
+/**
+ * Encapsulates a threadsafe singleton pattern.
+ *
+ * This class is designed to be used as a public constant, living within a class that has a private constructor.
+ * It defines a {@link #create(I)} method that will only ever be called once, upon the first call of {@link #get(I)}.
+ * That method is responsible for creating the actual singleton instance, and that instance will be returned for all
+ * future calls of {@link #get(I)}.
+ *
+ * Example:
+ * <code>
+ * public class FooSingleton {
+ * public static final SingletonHolder&lt;FooSingleton, ParamObject&gt; HOLDER =
+ * new SingletonHolder&lt;FooSingleton, ParamObject&gt;() {
+ * @Override
+ * protected FooSingleton create(ParamObject param) {
+ * return new FooSingleton(param);
+ * }
+ * };
+ *
+ * private FooSingleton(ParamObject param) {
+ *
+ * }
+ * }
+ *
+ * // somewhere else
+ * FooSingleton.HOLDER.get(params).doStuff();
+ * </code>
+ * @param <E> The type of the class to hold as a singleton.
+ * @param <I> A parameter object to use during creation of the singleton object.
+ */
+public abstract class SingletonHolder<E, I> {
+ private E mInstance;
+ private final Object LOCK = new Object();
+
+ public final E get(I initializer) {
+ if (null == mInstance) {
+ synchronized (LOCK) {
+ if (null == mInstance) {
+ mInstance = create(initializer);
+ }
+ }
+ }
+
+ return mInstance;
+ }
+
+ public final boolean isCreated() {
+ synchronized (LOCK) {
+ return mInstance != null;
+ }
+ }
+
+ protected abstract E create(I initializer);
+}