perl plugin: Check "return value" of PERL_GET_CONTEXT.

[collectd.git] / bindings / java / org / collectd / api / CollectdMatchFactoryInterface.java

diff --git a/bindings/java/org/collectd/api/CollectdMatchFactoryInterface.java b/bindings/java/org/collectd/api/CollectdMatchFactoryInterface.java
index 24cab59..7b1c71a 100644 (file)
--- 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 <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);
 }