From: Florian Forster Date: Sun, 22 Feb 2009 23:05:35 +0000 (+0100) Subject: bindings/java/: Add some javadoc markup to the interfaces. X-Git-Tag: collectd-4.7.0~127^2~13 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=288b138151db981a943ef73b5d41ba4c86f569ce;p=thirdparty%2Fcollectd.git bindings/java/: Add some javadoc markup to the interfaces. --- diff --git a/bindings/java/org/collectd/api/CollectdConfigInterface.java b/bindings/java/org/collectd/api/CollectdConfigInterface.java index fc6d9bdcd..709050761 100644 --- a/bindings/java/org/collectd/api/CollectdConfigInterface.java +++ b/bindings/java/org/collectd/api/CollectdConfigInterface.java @@ -21,6 +21,12 @@ package org.collectd.api; +/** + * Interface for objects implementing a config function. + * + * @author Florian Forster <octo at verplant.org> + * @see Collectd#registerConfig(String, CollectdConfigInterface) + */ public interface CollectdConfigInterface { public int config (OConfigItem ci); diff --git a/bindings/java/org/collectd/api/CollectdFlushInterface.java b/bindings/java/org/collectd/api/CollectdFlushInterface.java index 03fa532ab..abad04278 100644 --- a/bindings/java/org/collectd/api/CollectdFlushInterface.java +++ b/bindings/java/org/collectd/api/CollectdFlushInterface.java @@ -21,6 +21,12 @@ package org.collectd.api; +/** + * Interface for objects implementing a flush function. + * + * @author Florian Forster <octo at verplant.org> + * @see Collectd#registerFlush + */ public interface CollectdFlushInterface { public int flush (int timeout, String identifier); diff --git a/bindings/java/org/collectd/api/CollectdInitInterface.java b/bindings/java/org/collectd/api/CollectdInitInterface.java index 6997a2f8e..c198036e6 100644 --- a/bindings/java/org/collectd/api/CollectdInitInterface.java +++ b/bindings/java/org/collectd/api/CollectdInitInterface.java @@ -21,6 +21,12 @@ package org.collectd.api; +/** + * Interface for objects implementing an init function. + * + * @author Florian Forster <octo at verplant.org> + * @see Collectd#registerInit + */ public interface CollectdInitInterface { public int init (); diff --git a/bindings/java/org/collectd/api/CollectdLogInterface.java b/bindings/java/org/collectd/api/CollectdLogInterface.java index ab874c5d5..1ab9ae104 100644 --- a/bindings/java/org/collectd/api/CollectdLogInterface.java +++ b/bindings/java/org/collectd/api/CollectdLogInterface.java @@ -21,6 +21,12 @@ package org.collectd.api; +/** + * Interface for objects implementing a log function. + * + * @author Florian Forster <octo at verplant.org> + * @see Collectd#registerLog + */ public interface CollectdLogInterface { public void log (int severity, String message); diff --git a/bindings/java/org/collectd/api/CollectdReadInterface.java b/bindings/java/org/collectd/api/CollectdReadInterface.java index ac6060b8b..2ff25b209 100644 --- a/bindings/java/org/collectd/api/CollectdReadInterface.java +++ b/bindings/java/org/collectd/api/CollectdReadInterface.java @@ -21,7 +21,27 @@ package org.collectd.api; +/** + * Interface for objects implementing a read function. + * + * Objects implementing this interface can be registered with the daemon. Their + * read method is then called periodically to acquire and submit values. + * + * @author Florian Forster <octo at verplant.org> + * @see Collectd#registerRead + */ public interface CollectdReadInterface { + /** + * Callback method for read plugins. + * + * This method is called once every few seconds (depends on the + * configuration of the daemon). It is supposed to gather values in + * some way and submit them to the daemon using + * {@link Collectd#dispatchValues}. + * + * @return zero when successful, non-zero when an error occurred. + * @see Collectd#dispatchValues + */ public int read (); } diff --git a/bindings/java/org/collectd/api/CollectdShutdownInterface.java b/bindings/java/org/collectd/api/CollectdShutdownInterface.java index 4181a10fc..55e27404a 100644 --- a/bindings/java/org/collectd/api/CollectdShutdownInterface.java +++ b/bindings/java/org/collectd/api/CollectdShutdownInterface.java @@ -21,6 +21,12 @@ package org.collectd.api; +/** + * Interface for objects implementing a shutdown function. + * + * @author Florian Forster <octo at verplant.org> + * @see Collectd#registerShutdown + */ public interface CollectdShutdownInterface { public int shutdown (); diff --git a/bindings/java/org/collectd/api/CollectdWriteInterface.java b/bindings/java/org/collectd/api/CollectdWriteInterface.java index 13315a6d7..a1220f592 100644 --- a/bindings/java/org/collectd/api/CollectdWriteInterface.java +++ b/bindings/java/org/collectd/api/CollectdWriteInterface.java @@ -21,6 +21,12 @@ package org.collectd.api; +/** + * Interface for objects implementing a write function. + * + * @author Florian Forster <octo at verplant.org> + * @see Collectd#registerWrite + */ public interface CollectdWriteInterface { public int write (ValueList vl);