Move source and test files to maven’s favourite locations.

[jFCPlib.git] / src / main / java / net / pterodactylus / util / thread / ObjectWrapper.java

diff --git a/src/main/java/net/pterodactylus/util/thread/ObjectWrapper.java b/src/main/java/net/pterodactylus/util/thread/ObjectWrapper.java
new file mode 100644 (file)
index 0000000..a95ec21
--- /dev/null
+++ b/src/main/java/net/pterodactylus/util/thread/ObjectWrapper.java
@@ -0,0 +1,64 @@
+/*
+ * jFCPlib - UserObject.java - Copyright © 2009 David Roden
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ */
+
+package net.pterodactylus.util.thread;
+
+/**
+ * Wrapper around an object that can be set and retrieved. Its primary use is as
+ * a container for return values from anonymous classes.
+ *
+ * <pre>
+ * final ObjectWrapper&lt;Object&gt; objectWrapper = new ObjectWrapper&lt;Object&gt;();
+ * new Runnable() {
+ *     public void run() {
+ *         ...
+ *         objectWrapper.set(someResult);
+ *     }
+ * }.run();
+ * Object result = objectWrapper.get();
+ * </pre>
+ *
+ * @param <T>
+ *            The type of the wrapped object
+ * @author David ‘Bombe’ Roden &lt;bombe@pterodactylus.net&gt;
+ */
+public class ObjectWrapper<T> {
+
+       /** The wrapped object. */
+       private volatile T wrappedObject;
+
+       /**
+        * Returns the wrapped object.
+        *
+        * @return The wrapped object
+        */
+       public T get() {
+               return wrappedObject;
+       }
+
+       /**
+        * Sets the wrapped object.
+        *
+        * @param wrappedObject
+        *            The wrapped object
+        */
+       public void set(T wrappedObject) {
+               this.wrappedObject = wrappedObject;
+       }
+
+}