fixed javadoc issues in java agent
authorVictor Kirhenshtein <victor@netxms.org>
Wed, 8 Jun 2016 15:38:50 +0000 (18:38 +0300)
committerVictor Kirhenshtein <victor@netxms.org>
Wed, 8 Jun 2016 15:38:50 +0000 (18:38 +0300)
12 files changed:
src/agent/subagents/java/java/src/main/java/org/netxms/agent/Action.java
src/agent/subagents/java/java/src/main/java/org/netxms/agent/AgentContributionItem.java
src/agent/subagents/java/java/src/main/java/org/netxms/agent/ListParameter.java
src/agent/subagents/java/java/src/main/java/org/netxms/agent/Parameter.java
src/agent/subagents/java/java/src/main/java/org/netxms/agent/Plugin.java
src/agent/subagents/java/java/src/main/java/org/netxms/agent/PushParameter.java
src/agent/subagents/java/java/src/main/java/org/netxms/agent/SubAgent.java
src/agent/subagents/java/java/src/main/java/org/netxms/agent/TableParameter.java
src/agent/subagents/java/java/src/main/java/org/netxms/agent/adapters/ActionAdapter.java
src/agent/subagents/java/java/src/main/java/org/netxms/agent/adapters/ParameterAdapter.java
src/agent/subagents/java/java/src/main/java/org/netxms/agent/adapters/PushParameterAdapter.java
src/agent/subagents/java/java/src/main/java/org/netxms/agent/adapters/TableAdapter.java

index 852e6f5..e601931 100644 (file)
@@ -26,10 +26,10 @@ public interface Action extends AgentContributionItem
    /**
     * Execute action
     * 
-    * @param action
-    * @param args
+    * @param action action name
+    * @param args action arguments
     * @return true on success
-    * @throws Exception
+    * @throws Exception can throw exception to indicate action execution error
     */
    public boolean execute(final String action, final String[] args) throws Exception;
 }
index f8b0406..e83ff79 100644 (file)
@@ -8,14 +8,14 @@ public interface AgentContributionItem
    /**
     * Get contribution item's name
     * 
-    * @return
+    * @return contribution item's name
     */
    public String getName();
 
    /**
     * Get contribution item's description
     * 
-    * @return
+    * @return contribution item's description
     */
    public String getDescription();
 
index 64aba6e..3ccf54c 100644 (file)
@@ -26,8 +26,9 @@ public interface ListParameter extends AgentContributionItem
    /**
     * Get value
     * 
-    * @param param
-    * @return
+    * @param param parameter name
+    * @return values for requested list
+    * @throws Exception can throw exception to indicate data collection error
     */
    public String[] getValue(final String param) throws Exception;
 }
index 660cce2..a72d2e6 100644 (file)
@@ -28,15 +28,16 @@ public interface Parameter extends AgentContributionItem
    /**
     * Get parameter's type
     * 
-    * @return
+    * @return parameter's type
     */
    public ParameterType getType();
 
    /**
     * Get value
     * 
-    * @param param
-    * @return
+    * @param param parameter name
+    * @return value for requested parameter
+    * @throws Exception can throw exception to indicate data collection error
     */
    public String getValue(final String param) throws Exception;
 }
index 7679051..a9cce91 100644 (file)
@@ -26,7 +26,7 @@ public abstract class Plugin
    /**
     * Constructor used by PluginManager
     * 
-    * @param config
+    * @param config agent configuration
     */
    public Plugin(Config config)
    {
@@ -35,21 +35,21 @@ public abstract class Plugin
    /**
     * Get plugin name
     * 
-    * @return
+    * @return plugin name
     */
    public abstract String getName();
 
    /**
     * Get plugin version
     * 
-    * @return
+    * @return plugin version
     */
    public abstract String getVersion();
 
    /**
     * Initialize plugin
     * 
-    * @param config
+    * @param config agent configuration
     */
    public void init(Config config)
    {
@@ -67,7 +67,7 @@ public abstract class Plugin
    /**
     * Get list of supported parameters
     * 
-    * @return
+    * @return list of supported parameters
     */
    public Parameter[] getParameters()
    {
@@ -77,7 +77,7 @@ public abstract class Plugin
    /**
     * Get list of supported push parameters
     * 
-    * @return
+    * @return list of supported push parameters
     */
    public PushParameter[] getPushParameters()
    {
@@ -87,7 +87,7 @@ public abstract class Plugin
    /**
     * Get list of supported lists
     * 
-    * @return
+    * @return list of supported lists
     */
    public ListParameter[] getListParameters()
    {
@@ -97,7 +97,7 @@ public abstract class Plugin
    /**
     * Get list of supported tables
     * 
-    * @return
+    * @return list of supported tables
     */
    public TableParameter[] getTableParameters()
    {
@@ -107,7 +107,7 @@ public abstract class Plugin
    /**
     * Get list of supported actions
     * 
-    * @return
+    * @return list of supported actions
     */
    public Action[] getActions()
    {
index c1939f7..ad57ee6 100644 (file)
@@ -26,7 +26,9 @@ import org.netxms.agent.ParameterType;
 public interface PushParameter extends AgentContributionItem
 {
    /**
-    * @return
+    * Get parameter's data type
+    * 
+    * @return parameter's data type
     */
    public ParameterType getType();
 }
index 8aef7ca..a08c582 100644 (file)
@@ -68,7 +68,8 @@ public class SubAgent
 
    /**
     * Private constructor. Will be invoked by native wrapper only.
-    * @param config
+    * 
+    * @param config agent configuration
     */
    private SubAgent(Config config)
    {
@@ -106,7 +107,9 @@ public class SubAgent
    }
 
    /**
-    * @return
+    * Get agent configuration object
+    * 
+    * @return agent configuration
     */
    protected Config getConfig()
    {
@@ -142,8 +145,8 @@ public class SubAgent
    /**
     * Wrapper for native writeLog call
     * 
-    * @param level
-    * @param message
+    * @param level log level
+    * @param message message text
     */
    public static void writeLog(LogLevel level, String message)
    {
@@ -153,9 +156,9 @@ public class SubAgent
    /**
     * Write exception's stack trace to debug log
     * 
-    * @param level
-    * @param prefix
-    * @param e
+    * @param level log level
+    * @param prefix message prefix
+    * @param e exception to log
     */
    public static void writeDebugLog(int level, String prefix, Throwable e)
    {
@@ -169,8 +172,8 @@ public class SubAgent
    /**
     * Initialize (to be called from native subagent)
     * 
-    * @param config
-    * @return
+    * @param config agent configuration
+    * @return true if initialization was successful
     */
    public boolean init(Config config)
    {
@@ -205,8 +208,8 @@ public class SubAgent
    /**
     * will be called from subagent native initialization
     * 
-    * @param path
-    * @return
+    * @param path path to plugin file
+    * @return true if plugin was loaded correctly
     */
    protected boolean loadPlugin(String path)
    {
@@ -256,10 +259,11 @@ public class SubAgent
    }
 
    /**
-    * @param classname
-    * @param config
-    * @return
-    * @throws Exception
+    * Create plugin with given class name.
+    * 
+    * @param classname plugin class name
+    * @param config agent configuration
+    * @return plugin object or null
     */
    protected Plugin[] createPluginWithClassname(String classname, Config config)
    {
@@ -279,10 +283,11 @@ public class SubAgent
    }
 
    /**
-    * @param jarFile
-    * @param config
-    * @return
-    * @throws Exception
+    * Create plugins from given jar file
+    * 
+    * @param jarFile jar file to load
+    * @param config agent configuration
+    * @return loaded plugins or null
     */
    protected Plugin[] createPluginWithJar(String jarFile, Config config)
    {
@@ -330,9 +335,9 @@ public class SubAgent
    /**
     * uses reflection to create an instance of Plugin
     * 
-    * @param pluginClass
-    * @param config
-    * @return
+    * @param pluginClass plugin class
+    * @param config agent configuration
+    * @return plugin object
     * @throws Exception
     */
    protected Plugin instantiatePlugin(Class<? extends Plugin> pluginClass, Config config) throws Exception
@@ -356,6 +361,7 @@ public class SubAgent
     * @param param
     * @param id
     * @return
+    * @throws Throwable
     */
    public String parameterHandler(final String param, final String id) throws Throwable
    {
@@ -382,6 +388,7 @@ public class SubAgent
     * @param param
     * @param id
     * @return
+    * @throws Throwable
     */
    public String[] listHandler(final String param, final String id) throws Throwable
    {
@@ -408,6 +415,7 @@ public class SubAgent
     * @param param
     * @param id
     * @return
+    * @throws Throwable
     */
    public String[][] tableHandler(final String param, final String id) throws Throwable
    {
@@ -432,18 +440,19 @@ public class SubAgent
    /**
     * to be called from native subagent
     * 
-    * @param param
-    * @param args
-    * @param id
+    * @param name action name
+    * @param args action arguments
+    * @param id action ID
+    * @return true if executed successfully
     */
-   public boolean actionHandler(final String param, final String[] args, final String id)
+   public boolean actionHandler(final String name, final String[] args, final String id)
    {
       try
       {
          Action action = actions.get(id);
          if (action != null)
          {
-            return action.execute(param, args);
+            return action.execute(name, args);
          }
       }
       catch(Throwable e)
@@ -546,9 +555,11 @@ public class SubAgent
    }
    
    /**
-    * @param plugin
-    * @param parameter
-    * @return
+    * Create contribution item ID.
+    * 
+    * @param plugin plugin object
+    * @param ci contribution item
+    * @return contribution item ID
     */
    private static String createContributionItemId(Plugin plugin, AgentContributionItem ci)
    {
index aaf6fea..f5054bc 100644 (file)
@@ -26,16 +26,16 @@ public interface TableParameter extends AgentContributionItem
    /**
     * Get table columns
     * 
-    * @return
+    * @return table columns
     */
    TableColumn[] getColumns();
 
    /**
     * Get value
     * 
-    * @param param
-    * @return
-    * @throws Exception
+    * @param param table name
+    * @return table values
+    * @throws Exception can throw exception to indicate data collection error
     */
    String[][] getValue(final String param) throws Exception;
 }
index 434f658..adaa635 100644 (file)
@@ -30,8 +30,8 @@ public abstract class ActionAdapter implements Action
    private String description;
 
    /**
-    * @param name
-    * @param description
+    * @param name action name
+    * @param description action description
     */
    public ActionAdapter(String name, String description)
    {
index 2f52f2c..faacdf7 100644 (file)
@@ -32,9 +32,9 @@ public abstract class ParameterAdapter implements Parameter
    private ParameterType type;
 
    /**
-    * @param name
-    * @param description
-    * @param type
+    * @param name parameter name
+    * @param description parameter description
+    * @param type parameter type
     */
    public ParameterAdapter(String name, String description, ParameterType type)
    {
index 73c1659..009cf41 100644 (file)
@@ -32,9 +32,9 @@ public class PushParameterAdapter implements PushParameter
    private ParameterType type;
 
    /**
-    * @param name
-    * @param description
-    * @param type
+    * @param name parameter name
+    * @param description parameter description
+    * @param type parameter type
     */
    public PushParameterAdapter(String name, String description, ParameterType type)
    {
index 7dc5510..43a206a 100644 (file)
@@ -32,9 +32,9 @@ public abstract class TableAdapter implements TableParameter
    private TableColumn[] columns;
 
    /**
-    * @param name
-    * @param description
-    * @param columns
+    * @param name table name
+    * @param description table description
+    * @param columns table columns
     */
    public TableAdapter(String name, String description, TableColumn[] columns)
    {