Added javadoc for ConverterGenerator and moved @exported to

ConverterGenerator interface
forge · Jun 6, 2013 · b15ec79 · b15ec79
1 parent 7a76682
commit b15ec79
Show file tree

Hide file tree

Showing 4 changed files with 30 additions and 6 deletions.
diff --git a/convert/api/src/main/java/org/jboss/forge/addon/convert/ConverterGenerator.java b/convert/api/src/main/java/org/jboss/forge/addon/convert/ConverterGenerator.java
@@ -7,11 +7,41 @@
 
 package org.jboss.forge.addon.convert;
 
+import org.jboss.forge.furnace.services.Exported;
+
+/**
+ * A {@link ConverterGenerator} is responsible for creating {@link Converter} objects
+ * 
+ * Custom converterts are required to implement this interface.
+ * 
+ * A {@link ConverterGenerator} should generate only one type of {@link Converter}
+ * 
+ * @author <a href="mailto:ggastald@redhat.com">George Gastaldi</a>
+ * 
+ */
+@Exported
 public interface ConverterGenerator
 {
+   /**
+    * If this {@link ConverterGenerator} can handle the conversion between the provided source and target parameters
+    * 
+    * @param source {@link Class} of the object to be converted from
+    * @param target {@link Class} of the object to be converted to
+    * @return true if this generator can handle this conversion request
+    */
    boolean handles(Class<?> source, Class<?> target);
 
+   /**
+    * Creates a new {@link Converter} instance
+    * 
+    * @param source {@link Class} of the object to be converted from
+    * @param target {@link Class} of the object to be converted to
+    * @return the Converter associated with this generator
+    */
    Converter<?, ?> generateConverter(Class<?> source, Class<?> target);
 
+   /**
+    * @return the type of the converter returned by {@link ConverterGenerator#generateConverter(Class, Class)}
+    */
    Class<? extends Converter<?, ?>> getConverterType();
 }
diff --git a/...in/java/org/jboss/forge/addon/resource/converter/DirectoryResourceConverterGenerator.java b/...in/java/org/jboss/forge/addon/resource/converter/DirectoryResourceConverterGenerator.java
@@ -12,15 +12,13 @@
 
 import org.jboss.forge.addon.convert.ConverterGenerator;
 import org.jboss.forge.addon.resource.DirectoryResource;
-import org.jboss.forge.furnace.services.Exported;
 
 /**
  * Generates {@link DirectoryResourceConverter}
  *
  * @author <a href="mailto:ggastald@redhat.com">George Gastaldi</a>
  *
  */
-@Exported
 public class DirectoryResourceConverterGenerator implements ConverterGenerator
 {
 

diff --git a/...rc/main/java/org/jboss/forge/addon/resource/converter/FileResourceConverterGenerator.java b/...rc/main/java/org/jboss/forge/addon/resource/converter/FileResourceConverterGenerator.java
@@ -13,15 +13,13 @@
 import org.jboss.forge.addon.convert.ConverterGenerator;
 import org.jboss.forge.addon.resource.DirectoryResource;
 import org.jboss.forge.addon.resource.FileResource;
-import org.jboss.forge.furnace.services.Exported;
 
 /**
  * Generates {@link DirectoryResourceConverter}
  *
  * @author <a href="mailto:ggastald@redhat.com">George Gastaldi</a>
  *
  */
-@Exported
 public class FileResourceConverterGenerator implements ConverterGenerator
 {
 

diff --git a/...pl/src/main/java/org/jboss/forge/addon/resource/converter/ResourceConverterGenerator.java b/...pl/src/main/java/org/jboss/forge/addon/resource/converter/ResourceConverterGenerator.java
@@ -14,9 +14,7 @@
 import org.jboss.forge.addon.resource.DirectoryResource;
 import org.jboss.forge.addon.resource.FileResource;
 import org.jboss.forge.addon.resource.Resource;
-import org.jboss.forge.furnace.services.Exported;
 
-@Exported
 public class ResourceConverterGenerator implements ConverterGenerator
 {