[jboss-cvs] JBossAS SVN: r96330 - projects/jboss-deployers/branches/Branch_2_0/deployers-spi/src/main/java/org/jboss/deployers/spi/deployer.

[jboss-cvs-commits at lists.jboss.org]

Author: alesj
Date: 2009-11-13 06:29:21 -0500 (Fri, 13 Nov 2009)
New Revision: 96330

Modified:
   projects/jboss-deployers/branches/Branch_2_0/deployers-spi/src/main/java/org/jboss/deployers/spi/deployer/Deployer.java
Log:
javadocs

Modified: projects/jboss-deployers/branches/Branch_2_0/deployers-spi/src/main/java/org/jboss/deployers/spi/deployer/Deployer.java
===================================================================
--- projects/jboss-deployers/branches/Branch_2_0/deployers-spi/src/main/java/org/jboss/deployers/spi/deployer/Deployer.java	2009-11-13 11:21:36 UTC (rev 96329)
+++ projects/jboss-deployers/branches/Branch_2_0/deployers-spi/src/main/java/org/jboss/deployers/spi/deployer/Deployer.java	2009-11-13 11:29:21 UTC (rev 96330)
@@ -64,14 +64,20 @@
    boolean isWantComponents();
    
    /**
-    * Whether we want all inputs
+    * Whether we want all inputs.
     *
     * @return true for all inputs
     */
    boolean isAllInputs();
    
    /**
-    * Get the input for this deployer
+    * Get the input for this deployer.
+    *
+    * Most deployers operate on a single attachment,
+    * if you need multiple inputs use required inputs.
+    *
+    * By default we require this input,
+    * if you wanna make this optional set all-inputs to true.
     * 
     * @return the input type
     */
@@ -85,16 +91,28 @@
    Class<?> getOutput();
    
    /**
-    * Get the input for this deployer
+    * Get the input for this deployer.
+    *
+    * This is set is mostly meant to help with
+    * natural order based on inputs/outputs.
+    *
+    * If you want to veto your deployer based on inputs,
+    * you should use required inputs.
+    *
+    * Every required input is of course also a plain input.
     * 
     * @return the inputs
     */
    Set<String> getInputs();
    
    /**
-    * Get the required input for this deployer
+    * Get the required input for this deployer.
     *
-    * @return the inputs
+    * This represents a set of required inputs,
+    * if one of them is missing, we veto deployer as not relevant
+    * for that deployment, hence it doesn't participate in deployment lifecycle.
+    *
+    * @return the required inputs
     */
    Set<String> getRequiredInputs();