some javadoc additions some early work on the new producer node to report changes...

[mir.git] / source / mir / producer / reader / ProducerNodeBuilderLibrary.java

diff --git a/source/mir/producer/reader/ProducerNodeBuilderLibrary.java b/source/mir/producer/reader/ProducerNodeBuilderLibrary.java
index 74be2fc..1a88416 100755 (executable)
--- a/source/mir/producer/reader/ProducerNodeBuilderLibrary.java
+++ b/source/mir/producer/reader/ProducerNodeBuilderLibrary.java
@@ -37,6 +37,13 @@ public class ProducerNodeBuilderLibrary {
     nodeBuilders = new HashMap();
   }
 
+  /**
+   * Register a builder
+   * @param aName
+   * @param aProducerNodeBuilderClass
+   * @throws ProducerConfigExc
+   * @throws ProducerConfigFailure
+   */
   public void registerBuilder(String aName, Class aProducerNodeBuilderClass) throws ProducerConfigExc, ProducerConfigFailure {
     try {
       registerFactory(aName, new ProducerNodeBuilder.DefaultProducerNodeBuilderFactory( aProducerNodeBuilderClass ));
@@ -46,8 +53,15 @@ public class ProducerNodeBuilderLibrary {
     }
   }
 
-  public void registerFactory(String aName, ProducerNodeBuilder.ProducerNodeBuilderFactory aFactory) {
-    nodeBuilders.put(aName, aFactory);
+  /**
+   * Register a  {@link ProducerNodeBuilder.ProducerNodeBuilderFactory} for {@link mir.producer.ProducerNode}s
+   * @param aTag the tag to bind this factory to: every producers.xml tag with the name <code>aTag</code>
+   *     will be directed to this factory.
+   *
+   * @param aFactory the factory to bind the tag to.
+   */
+  public void registerFactory(String aTag, ProducerNodeBuilder.ProducerNodeBuilderFactory aFactory) {
+    nodeBuilders.put(aTag, aFactory);
   }
 
   public boolean hasBuilderForName(String aName) {