tmf: Update Javadoc throughout tmf.ui

[deliverable/tracecompass.git] / org.eclipse.linuxtools.tmf.ui / src / org / eclipse / linuxtools / tmf / ui / views / colors / ColorSettingsManager.java

diff --git a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/colors/ColorSettingsManager.java b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/colors/ColorSettingsManager.java
index 028a1aca68c8f22219f02e01f9bca70c7b7ff7a8..b1de6acaebff60334428cab7c7eae932d1d80130 100644 (file)
--- a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/colors/ColorSettingsManager.java
+++ b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/colors/ColorSettingsManager.java
@@ -1,11 +1,11 @@
 /*******************************************************************************\r
  * Copyright (c) 2010, 2012 Ericsson\r
- * \r
+ *\r
  * All rights reserved. This program and the accompanying materials are\r
  * made available under the terms of the Eclipse Public License v1.0 which\r
  * accompanies this distribution, and is available at\r
  * http://www.eclipse.org/legal/epl-v10.html\r
- * \r
+ *\r
  * Contributors:\r
  *   Patrick Tasse - Initial API and implementation\r
  *   Bernd Hufmann - Updated to use RGB for the tick color\r
@@ -24,16 +24,16 @@ import org.eclipse.swt.widgets.Display;
 \r
 /**\r
  * Static class for managing color settings.\r
- *  \r
+ *\r
  * @version 1.0\r
  * @author Patrick Tasse\r
  *\r
  */\r
 public class ColorSettingsManager {\r
-    \r
+\r
     // The color settings file name\r
        private static final String COLOR_SETTINGS_FILE_NAME = "color_settings.xml"; //$NON-NLS-1$\r
-       \r
+\r
        // The path for the color settings file\r
        private static final String COLOR_SETTINGS_PATH_NAME =\r
         Activator.getDefault().getStateLocation().addTrailingSeparator().append(COLOR_SETTINGS_FILE_NAME).toString();\r
@@ -46,7 +46,7 @@ public class ColorSettingsManager {
                        null);\r
 \r
        /**\r
-        * Special value for priority if unknown. \r
+        * Special value for priority if unknown.\r
         */\r
        public static final int PRIORITY_NONE = Integer.MAX_VALUE;\r
 \r
@@ -58,16 +58,16 @@ public class ColorSettingsManager {
 \r
        /**\r
         * Returns an array of color settings.\r
-        * \r
+        *\r
         * @return an array of color settings.\r
         */\r
        public static ColorSetting[] getColorSettings() {\r
                return (fColorSettings != null) ? Arrays.copyOf(fColorSettings, fColorSettings.length) : null;\r
        }\r
-       \r
+\r
        /**\r
         * Sets the array of color settings.\r
-        * \r
+        *\r
         * @param colorSettings A array of color settings to set\r
         */\r
        public static void setColorSettings(ColorSetting[] colorSettings) {\r
@@ -76,13 +76,15 @@ public class ColorSettingsManager {
                fireColorSettingsChanged();\r
        }\r
 \r
-       /**\r
-        * Gets the color settings that matches the filter for given event.\r
-        * \r
-        * @param A event the event to check\r
-        * \r
-        * @return color settings defined for filter if found else default color settings\r
-        */\r
+           /**\r
+     * Gets the color settings that matches the filter for given event.\r
+     *\r
+     * @param event\r
+     *            The event to check\r
+     *\r
+     * @return color settings defined for filter if found else default color\r
+     *         settings\r
+     */\r
        public static ColorSetting getColorSetting(ITmfEvent event) {\r
         for (int i = 0; i < fColorSettings.length; i++) {\r
                ColorSetting colorSetting = fColorSettings[i];\r
@@ -95,7 +97,7 @@ public class ColorSettingsManager {
 \r
        /**\r
         * Gets the color settings priority for the given event.\r
-        *   \r
+        *\r
         * @param event A event the event to check\r
         * @return the priority defined for the filter else PRIORITY_NONE\r
         */\r
@@ -110,8 +112,8 @@ public class ColorSettingsManager {
        }\r
 \r
        /**\r
-        * Returns the color settings based the priority. \r
-        * \r
+        * Returns the color settings based the priority.\r
+        *\r
         * @param priority A priority (index) of color settings\r
         * @return the color settings defined for the priority else default color settings\r
         */\r
@@ -119,12 +121,12 @@ public class ColorSettingsManager {
                if (priority < fColorSettings.length) {\r
                        return fColorSettings[priority];\r
                }\r
-               return DEFAULT_COLOR_SETTING; \r
+               return DEFAULT_COLOR_SETTING;\r
        }\r
 \r
        /**\r
         * Adds a color settings listener.\r
-        * \r
+        *\r
         * @param listener A listener to add.\r
         */\r
        public static void addColorSettingsListener(IColorSettingsListener listener) {\r
@@ -132,16 +134,16 @@ public class ColorSettingsManager {
                        fListeners.add(listener);\r
                }\r
        }\r
-       \r
+\r
        /**\r
         * Removes a color settings listener.\r
-        * \r
+        *\r
         * @param listener A listener to remove.\r
         */\r
        public static void removeColorSettingsListener(IColorSettingsListener listener) {\r
                fListeners.remove(listener);\r
        }\r
-       \r
+\r
        // Notify listeners\r
        private static void fireColorSettingsChanged() {\r
                for (IColorSettingsListener listener : fListeners) {\r