bindings/java/: CollectdMatchFactoryInterface: Add more JavaDoc.
authorFlorian Forster <octo@leeloo.lan.home.verplant.org>
Tue, 24 Feb 2009 09:13:11 +0000 (10:13 +0100)
committerFlorian Forster <octo@leeloo.lan.home.verplant.org>
Tue, 24 Feb 2009 09:16:59 +0000 (10:16 +0100)
bindings/java/org/collectd/api/CollectdMatchFactoryInterface.java

index d2801a1..7b1c71a 100644 (file)
@@ -33,5 +33,17 @@ package org.collectd.api;
  */
 public interface CollectdMatchFactoryInterface
 {
+       /**
+        * Create a new "match" object.
+        *
+        * This method uses the configuration provided as argument to create a
+        * new object which must implement the {@link CollectdMatchInterface}
+        * interface.
+        *
+        * This function corresponds to the <code>create</code> member of the
+        * <code>src/filter_chain.h:match_proc_t</code> struct.
+        *
+        * @return New {@link CollectdMatchInterface} object.
+        */
        public CollectdMatchInterface createMatch (OConfigItem ci);
 }