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 fc6d9bdcdbf29d3db0fd42c9d646d08cd8a35e5f..70905076193cfa3c5ca03a1de681c825295a287e 100644 (file)
--- 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 03fa532ab6b3c0192f30e5ade34babd501e38e24..abad04278e6e085e6926f6ef831a715d3fc2f68b 100644 (file)
--- 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 6997a2f8eedbfaa539ee8b1488e6aeef03b71c7f..c198036e65b87613c32bee213b020ec5aeedc4dc 100644 (file)
--- 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 ab874c5d552a3f2f86a2172ae715d2d7663c1761..1ab9ae104dc76aded63bec3688f4491b41a48d80 100644 (file)
--- 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 ac6060b8b94039e8ef5733cb7df16e80418f9887..2ff25b20926e8c6d9b8c80f421213acdf459841f 100644 (file)
--- 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 4181a10fce6736ea3b079feebe9589059ad69713..55e27404abe15f0de98f65cbda6bf1d1a74daa5e 100644 (file)
--- 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 13315a6d77b484160ab15cfe94686e3c93397f17..a1220f592e047ae5856ad43623657c6439a7ec45 100644 (file)
--- 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);