rebuilding head

[mir.git] / source / mir / producer / ProducerFactory.java

diff --git a/source/mir/producer/ProducerFactory.java b/source/mir/producer/ProducerFactory.java
index df164dc..d3ca018 100755 (executable)
--- a/source/mir/producer/ProducerFactory.java
+++ b/source/mir/producer/ProducerFactory.java
@@ -18,19 +18,19 @@
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  *
  * In addition, as a special exception, The Mir-coders gives permission to link
- * the code of this program with  any library licensed under the Apache Software License, 
- * The Sun (tm) Java Advanced Imaging library (JAI), The Sun JIMI library 
- * (or with modified versions of the above that use the same license as the above), 
- * and distribute linked combinations including the two.  You must obey the 
- * GNU General Public License in all respects for all of the code used other than 
- * the above mentioned libraries.  If you modify this file, you may extend this 
- * exception to your version of the file, but you are not obligated to do so.  
+ * the code of this program with  any library licensed under the Apache Software License,
+ * The Sun (tm) Java Advanced Imaging library (JAI), The Sun JIMI library
+ * (or with modified versions of the above that use the same license as the above),
+ * and distribute linked combinations including the two.  You must obey the
+ * GNU General Public License in all respects for all of the code used other than
+ * the above mentioned libraries.  If you modify this file, you may extend this
+ * exception to your version of the file, but you are not obligated to do so.
  * If you do not wish to do so, delete this exception statement from your version.
  */
 package mir.producer;
 
-import java.util.Iterator;
 import java.util.Map;
+import java.util.List;
 
 public interface ProducerFactory {
   public interface ProducerVerb {
@@ -38,8 +38,24 @@ public interface ProducerFactory {
     String getDescription();
   }
 
+  /**
+   * The identifying name of the factory
+   */
   public String getName();
+
+  /**
+   * Returns <code>true</code> if <code>aVerb</code> is a valid verb for this factory
+   */
+  public boolean allowVerb(String aVerb);
+
+  /**
+   * Instantiates a producer based on the supplied verb
+   */
   public Producer makeProducer(String aVerb, Map aStartingValues) throws ProducerFailure, ProducerExc;
-  public Iterator verbs(); /* returns ProducerVerbs */
+
+  /**
+   * The set of pre-defined verbs. Returns a list of {@link ProducerVerb}s
+   */
+  public List verbs();
 }