SRADA-896: Added comments for TracingFeatureArgument enum.

Change-Id: Iaae831247014e07d2a339bc9fd6785d8a2d750ee

diff --git a/org.tizen.dynamicanalyzer.cli/src/org/tizen/dynamicanalyzer/cli/tracing/TracingFeatureArgument.java b/org.tizen.dynamicanalyzer.cli/src/org/tizen/dynamicanalyzer/cli/tracing/TracingFeatureArgument.java
index adcd467..674a2ec 100644 (file)
--- a/org.tizen.dynamicanalyzer.cli/src/org/tizen/dynamicanalyzer/cli/tracing/TracingFeatureArgument.java
+++ b/org.tizen.dynamicanalyzer.cli/src/org/tizen/dynamicanalyzer/cli/tracing/TracingFeatureArgument.java
@@ -58,11 +58,9 @@ public enum TracingFeatureArgument {
 
        /**
         * Create CLI option for selecting group of tracing features
-        * 
-        * @param name
-        *            short name of CLI option
-        * @param longName
-        *            long name of CLI option
+        *
+        * @param name short name of CLI option
+        * @param longName long name of CLI option
         */
        private TracingFeatureArgument(String name, String longName) {
                this.option = Option.builder(name).longOpt(longName).hasArgs()
@@ -73,11 +71,9 @@ public enum TracingFeatureArgument {
 
        /**
         * Create CLI option for selecting single tracing features
-        * 
-        * @param name
-        *            short name of CLI option
-        * @param feature
-        *            primitive feature to be selected with the options
+        *
+        * @param name short name of CLI option
+        * @param feature primitive feature to be selected with the options
         */
        private TracingFeatureArgument(String name, PrimitiveFeature feature) {
                this.option = Option.builder(name)
@@ -87,15 +83,34 @@ public enum TracingFeatureArgument {
                defFeatures.add(feature);
        }
 
+       /**
+        * Add the feature to the default features which are selected with the option
+        *
+        * @param name value of option's argument for feature selection
+        * @param feature primitive feature to be added for tracing
+        */
        private void addDefaultFeatureValue(String name, PrimitiveFeature feature) {
                addFeatureValue(name, feature);
                defFeatures.add(feature);
        }
 
+       /**
+        * Add the feature to the map of features that may be selected with the option
+        *
+        * @param name value of option's argument for feature selection
+        * @param feature primitive feature to be added for tracing
+        */
        private void addFeatureValue(String name, PrimitiveFeature feature) {
                availFeatures.put(name, feature);
        }
 
+       /**
+        * Add to tracing arguments features selected with the option
+        *
+        * @param result tracing argument to add features to
+        * @param values array of arguments defining features for selection
+        * @throws ParseException if provided value is not from set of available features
+        */
        private void selectFeatures(TracingArguments result, String[] values)
                        throws ParseException {
                for (String val : values) {
@@ -108,11 +123,21 @@ public enum TracingFeatureArgument {
                }
        }
 
+       /**
+        * Add to tracing arguments all features available for the option
+        *
+        * @param result tracing argument to add features to
+        */
        private void selectAllFeatures(TracingArguments result) {
                for (PrimitiveFeature feature : availFeatures.values())
                        result.addFeature(feature);
        }
 
+       /**
+        * Add to tracing arguments default features for the option
+        *
+        * @param result tracing argument to add features to
+        */
        private void selectDefaultFeatures(TracingArguments result) {
                for (PrimitiveFeature feature : defFeatures)
                        result.addFeature(feature);
@@ -132,6 +157,13 @@ public enum TracingFeatureArgument {
                return option.getOpt();
        }
 
+       /**
+        * Parse CLI options for selection of tracing features defined by the enum value
+        *
+        * @param result tracing argument to add features to
+        * @param cmdline parsed command line
+        * @throws ParseException in any error occurred while parsing arguments
+        */
        public void parseFeatureOption(TracingArguments result, CommandLine cmdline)
                        throws ParseException {
                String optName = getOptionName();
@@ -148,6 +180,13 @@ public enum TracingFeatureArgument {
                }
        }
 
+       /**
+        * Parse CLI options for selection of any supported tracing features
+        *
+        * @param result tracing argument to add features to
+        * @param cmdline parsed command line
+        * @throws ParseException in any error occurred while parsing arguments
+        */
        public static void parseFeatureOptions(TracingArguments result,
                        CommandLine cmdline) throws ParseException {
                for (TracingFeatureArgument opt : values()) {
@@ -160,9 +199,8 @@ public enum TracingFeatureArgument {
 
        /**
         * Converts given {@link TracingArguments} object to ArrayList<String>.
-        * 
-        * @param args
-        *            {@link TracingArguments} object
+        *
+        * @param args {@link TracingArguments} object
         * @return ArrayList<String> representation of given arguments.
         */
        public static ArrayList<String> toStringArrayList(TracingArguments args) {