X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=bindings%2Fjava%2Forg%2Fcollectd%2Fapi%2FCollectd.java;h=84e659265850dceafd0650c4a9bb7297e728b11f;hb=8be9c73cc216609a54a1b997aad8a3d646a0a43f;hp=15e177c6f0ad1d302d363ac4effd68aa4ba8e676;hpb=636c770506ab2c0cd6c23f7bd357ac9113a01f44;p=collectd.git diff --git a/bindings/java/org/collectd/api/Collectd.java b/bindings/java/org/collectd/api/Collectd.java index 15e177c6..84e65926 100644 --- a/bindings/java/org/collectd/api/Collectd.java +++ b/bindings/java/org/collectd/api/Collectd.java @@ -24,89 +24,225 @@ package org.collectd.api; /** * Java API to internal functions of collectd. * + * All functions in this class are {@code static}. You don't need to create an + * object of this class (in fact, you can't). Just call these functions + * directly. + * * @author Florian Forster <octo at verplant.org> */ public class Collectd { + + /** + * Constant for severity (log level) "error". + * + * @see CollectdLogInterface + */ public static final int LOG_ERR = 3; + + /** + * Constant for severity (log level) "warning". + * + * @see CollectdLogInterface + */ public static final int LOG_WARNING = 4; + + /** + * Constant for severity (log level) "notice". + * + * @see CollectdLogInterface + */ public static final int LOG_NOTICE = 5; + + /** + * Constant for severity (log level) "info". + * + * @see CollectdLogInterface + */ public static final int LOG_INFO = 6; + + /** + * Constant for severity (log level) "debug". + * + * @see CollectdLogInterface + */ public static final int LOG_DEBUG = 7; + /** + * Return value of match methods: No match. + * + * This is one of two valid return values from match callbacks, indicating + * that the passed {@link DataSet} and {@link ValueList} did not match. + * + * Do not use the numeric value directly, it is subject to change without + * notice! + * + * @see CollectdMatchInterface + */ public static final int FC_MATCH_NO_MATCH = 0; + + /** + * Return value of match methods: Match. + * + * This is one of two valid return values from match callbacks, indicating + * that the passed {@link DataSet} and {@link ValueList} did match. + * + * Do not use the numeric value directly, it is subject to change without + * notice! + * + * @see CollectdMatchInterface + */ public static final int FC_MATCH_MATCHES = 1; + /** + * Return value of target methods: Continue. + * + * This is one of three valid return values from target callbacks, indicating + * that processing of the {@link ValueList} should continue. + * + * Do not use the numeric value directly, it is subject to change without + * notice! + * + * @see CollectdTargetInterface + */ public static final int FC_TARGET_CONTINUE = 0; + + /** + * Return value of target methods: Stop. + * + * This is one of three valid return values from target callbacks, indicating + * that processing of the {@link ValueList} should stop immediately. + * + * Do not use the numeric value directly, it is subject to change without + * notice! + * + * @see CollectdTargetInterface + */ public static final int FC_TARGET_STOP = 1; + + /** + * Return value of target methods: Return. + * + * This is one of three valid return values from target callbacks, indicating + * that processing of the current chain should be stopped and processing of + * the {@link ValueList} should continue in the calling chain. + * + * Do not use the numeric value directly, it is subject to change without + * notice! + * + * @see CollectdTargetInterface + */ public static final int FC_TARGET_RETURN = 2; /** * Java representation of collectd/src/plugin.h:plugin_register_config + * + * @return Zero when successful, non-zero otherwise. + * @see CollectdConfigInterface */ native public static int registerConfig (String name, CollectdConfigInterface object); /** * Java representation of collectd/src/plugin.h:plugin_register_init + * + * @return Zero when successful, non-zero otherwise. + * @see CollectdInitInterface */ native public static int registerInit (String name, CollectdInitInterface object); /** * Java representation of collectd/src/plugin.h:plugin_register_read + * + * @return Zero when successful, non-zero otherwise. + * @see CollectdReadInterface */ native public static int registerRead (String name, CollectdReadInterface object); /** * Java representation of collectd/src/plugin.h:plugin_register_write + * + * @return Zero when successful, non-zero otherwise. + * @see CollectdWriteInterface */ native public static int registerWrite (String name, CollectdWriteInterface object); /** * Java representation of collectd/src/plugin.h:plugin_register_flush + * + * @return Zero when successful, non-zero otherwise. + * @see CollectdFlushInterface */ native public static int registerFlush (String name, CollectdFlushInterface object); /** * Java representation of collectd/src/plugin.h:plugin_register_shutdown + * + * @return Zero when successful, non-zero otherwise. + * @see CollectdShutdownInterface */ native public static int registerShutdown (String name, CollectdShutdownInterface object); /** * Java representation of collectd/src/plugin.h:plugin_register_log + * + * @return Zero when successful, non-zero otherwise. + * @see CollectdLogInterface */ native public static int registerLog (String name, CollectdLogInterface object); /** * Java representation of collectd/src/plugin.h:plugin_register_notification + * + * @return Zero when successful, non-zero otherwise. + * @see CollectdNotificationInterface */ native public static int registerNotification (String name, CollectdNotificationInterface object); /** * Java representation of collectd/src/filter_chain.h:fc_register_match + * + * @return Zero when successful, non-zero otherwise. + * @see CollectdMatchFactoryInterface */ native public static int registerMatch (String name, CollectdMatchFactoryInterface object); + /** + * Java representation of collectd/src/filter_chain.h:fc_register_target + * + * @return Zero when successful, non-zero otherwise. + * @see CollectdTargetFactoryInterface + */ + native public static int registerTarget (String name, + CollectdTargetFactoryInterface object); + /** * Java representation of collectd/src/plugin.h:plugin_dispatch_values + * + * @return Zero when successful, non-zero otherwise. */ native public static int dispatchValues (ValueList vl); /** * Java representation of collectd/src/plugin.h:plugin_dispatch_notification + * + * @return Zero when successful, non-zero otherwise. */ native public static int dispatchNotification (Notification n); /** * Java representation of collectd/src/plugin.h:plugin_get_ds + * + * @return The appropriate {@link DataSet} object or {@code null} if no such + * type is registered. */ native public static DataSet getDS (String type); @@ -115,31 +251,45 @@ public class Collectd */ native private static void log (int severity, String message); + /** + * Prints an error message. + */ public static void logError (String message) { log (LOG_ERR, message); } /* void logError */ + /** + * Prints a warning message. + */ public static void logWarning (String message) { log (LOG_WARNING, message); } /* void logWarning */ + /** + * Prints a notice. + */ public static void logNotice (String message) { log (LOG_NOTICE, message); } /* void logNotice */ + /** + * Prints an info message. + */ public static void logInfo (String message) { log (LOG_INFO, message); } /* void logInfo */ + /** + * Prints a debug message. + */ public static void logDebug (String message) { log (LOG_DEBUG, message); } /* void logDebug */ - } /* class Collectd */ /* vim: set sw=2 sts=2 et fdm=marker : */