From 8fe1101910d3650cc59230ced5bb02a8eabe882e Mon Sep 17 00:00:00 2001 From: Florian Forster Date: Tue, 24 Feb 2009 10:13:11 +0100 Subject: [PATCH] bindings/java/: CollectdMatchFactoryInterface: Add more JavaDoc. --- .../java/org/collectd/api/CollectdMatchFactoryInterface.java | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/bindings/java/org/collectd/api/CollectdMatchFactoryInterface.java b/bindings/java/org/collectd/api/CollectdMatchFactoryInterface.java index d2801a1f..7b1c71a4 100644 --- a/bindings/java/org/collectd/api/CollectdMatchFactoryInterface.java +++ b/bindings/java/org/collectd/api/CollectdMatchFactoryInterface.java @@ -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); } -- 2.11.0