some code cleanup. removed unnecessary semikolons, unused vars, etc.

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

diff --git a/source/mir/producer/ProducerFactory.java b/source/mir/producer/ProducerFactory.java
index 7136d8c..dc8d771 100755 (executable)
--- a/source/mir/producer/ProducerFactory.java
+++ b/source/mir/producer/ProducerFactory.java
@@ -1,9 +1,61 @@
+/*
+ * Copyright (C) 2001, 2002 The Mir-coders group
+ *
+ * This file is part of Mir.
+ *
+ * Mir 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.
+ *
+ * Mir 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 Mir; if not, write to the Free Software
+ * 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.
+ * If you do not wish to do so, delete this exception statement from your version.
+ */
 package mir.producer;
 
-import java.util.*;
+import java.util.List;
+import java.util.Map;
 
 public interface ProducerFactory {
+  public interface ProducerVerb {
+    String getName();
+    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();
+
+  /**
+   * The set of pre-defined verbs. Returns a list of {@link ProducerVerb}s
+   */
+  public List verbs();
 }