X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=bindings%2Fjava%2Forg%2Fcollectd%2Fapi%2FCollectdMatchFactoryInterface.java;h=7b1c71a470d4f441a68a69c9fb5740ab9c1addb6;hb=8f40e8dacad2bfcb9d659e12740aa3ebc15ada65;hp=24cab5989d5b279f20194ca334d1e87018fde310;hpb=45aa6a65c24e38c0a3fa3880a300fbb02db50486;p=collectd.git
diff --git a/bindings/java/org/collectd/api/CollectdMatchFactoryInterface.java b/bindings/java/org/collectd/api/CollectdMatchFactoryInterface.java
index 24cab598..7b1c71a4 100644
--- a/bindings/java/org/collectd/api/CollectdMatchFactoryInterface.java
+++ b/bindings/java/org/collectd/api/CollectdMatchFactoryInterface.java
@@ -22,7 +22,7 @@
package org.collectd.api;
/**
- * Interface for objects implementing a match factory.
+ * Interface for objects implementing a "match factory".
*
* Objects implementing this interface are used to create objects implementing
* the CollectdMatchInterface interface.
@@ -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 create
member of the
+ * src/filter_chain.h:match_proc_t
struct.
+ *
+ * @return New {@link CollectdMatchInterface} object.
+ */
public CollectdMatchInterface createMatch (OConfigItem ci);
}