Improved javadoc

forge · Aug 21, 2015 · a8a1cfd · a8a1cfd
1 parent e719e24
commit a8a1cfd
Showing 1 changed file with 22 additions and 0 deletions.
diff --git a/container-api/src/main/java/org/jboss/forge/furnace/spi/ExportedInstance.java b/container-api/src/main/java/org/jboss/forge/furnace/spi/ExportedInstance.java
@@ -9,15 +9,37 @@
 import org.jboss.forge.furnace.addons.Addon;
 
 /**
+ * An {@link ExportedInstance} object is a service returned from {@link ServiceRegistry}
+ * 
  * @author <a href="mailto:lincolnbaxter@gmail.com">Lincoln Baxter, III</a>
+ * @author <a href="mailto:ggastald@redhat.com">George Gastaldi</a>
  */
 public interface ExportedInstance<T>
 {
+   /**
+    * @return the instance associated with this {@link ExportedInstance}
+    */
    T get();
 
+   /**
+    * Releases this {@link ExportedInstance}. Subsequent calls to {@link ExportedInstance#get()} may present a different
+    * behavior
+    * 
+    * @param instance the instance returned in this{@link ExportedInstance#get()}
+    */
    void release(T instance);
 
+   /**
+    * The type associated with this {@link ExportedInstance}
+    * 
+    * @return {@link Class} associated with this object
+    */
    Class<? extends T> getActualType();
 
+   /**
+    * The addon that created this {@link ExportedInstance}
+    * 
+    * @return the {@link Addon} instance that created this object
+    */
    Addon getSourceAddon();
 }