From 288b138151db981a943ef73b5d41ba4c86f569ce Mon Sep 17 00:00:00 2001 From: Florian Forster Date: Mon, 23 Feb 2009 00:05:35 +0100 Subject: [PATCH] bindings/java/: Add some javadoc markup to the interfaces. --- .../org/collectd/api/CollectdConfigInterface.java | 6 ++++++ .../org/collectd/api/CollectdFlushInterface.java | 6 ++++++ .../java/org/collectd/api/CollectdInitInterface.java | 6 ++++++ .../java/org/collectd/api/CollectdLogInterface.java | 6 ++++++ .../java/org/collectd/api/CollectdReadInterface.java | 20 ++++++++++++++++++++ .../org/collectd/api/CollectdShutdownInterface.java | 6 ++++++ .../org/collectd/api/CollectdWriteInterface.java | 6 ++++++ 7 files changed, 56 insertions(+) diff --git a/bindings/java/org/collectd/api/CollectdConfigInterface.java b/bindings/java/org/collectd/api/CollectdConfigInterface.java index fc6d9bdc..70905076 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 03fa532a..abad0427 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 6997a2f8..c198036e 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 ab874c5d..1ab9ae10 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 ac6060b8..2ff25b20 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 4181a10f..55e27404 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 13315a6d..a1220f59 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); -- 2.11.0