Fixed JavaDoc in TMF UI plugin
[deliverable/tracecompass.git] / org.eclipse.linuxtools.tmf.ui / src / org / eclipse / linuxtools / tmf / ui / project / model / TmfTraceType.java
index 38f0d78f8a74f8261b4c668e67e6df824fd7729b..667496c23e7d86c4f58f4acc135bcd05a94a5017 100644 (file)
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2011 Ericsson
+ * Copyright (c) 2011, 2012 Ericsson
  * 
  * All rights reserved. This program and the accompanying materials are
  * made available under the terms of the Eclipse Public License v1.0 which
@@ -18,26 +18,71 @@ import java.util.List;
 import org.eclipse.core.runtime.IConfigurationElement;
 import org.eclipse.core.runtime.Platform;
 
+/**
+ * Utility class for accessing TMF trace type extensions from the platform's extensions registry.
+ * 
+ * @version 1.0
+ * @author Patrick Tasse
+ *
+ */
 public class TmfTraceType {
 
-    // Extension point ID
+    /**
+     *  Extension point ID
+     */
     public static final String TMF_TRACE_TYPE_ID = "org.eclipse.linuxtools.tmf.ui.tracetype"; //$NON-NLS-1$
 
-    // Extension point elements
+    /**
+     *  Extension point element 'Category'
+     */
     public static final String CATEGORY_ELEM = "category"; //$NON-NLS-1$
+    /**
+     *  Extension point element 'Type'
+     */
     public static final String TYPE_ELEM = "type"; //$NON-NLS-1$
+    /**
+     * Extension point element 'Default editor' 
+     */
     public static final String DEFAULT_EDITOR_ELEM = "defaultEditor"; //$NON-NLS-1$
+    /**
+     * Extension point element 'Events table type'
+     */
     public static final String EVENTS_TABLE_TYPE_ELEM = "eventsTableType"; //$NON-NLS-1$
 
-    // Extension point attributes
+    /**
+     *  Extension point attribute 'ID'
+     */
     public static final String ID_ATTR = "id"; //$NON-NLS-1$
+    /**
+     * Extension point attribute 'name'
+     */
     public static final String NAME_ATTR = "name"; //$NON-NLS-1$
+    /**
+     * Extension point attribute 'category'
+     */
     public static final String CATEGORY_ATTR = "category"; //$NON-NLS-1$
+    /**
+     * Extension point attribute 'trace_type'
+     */
     public static final String TRACE_TYPE_ATTR = "trace_type"; //$NON-NLS-1$
+    /**
+     * Extension point attribute 'event_type'
+     */
     public static final String EVENT_TYPE_ATTR = "event_type"; //$NON-NLS-1$
+    /**
+     * Extension point attribute 'icon'
+     */
     public static final String ICON_ATTR = "icon"; //$NON-NLS-1$
+    /**
+     * Extension point attribute 'class'
+     */
     public static final String CLASS_ATTR = "class"; //$NON-NLS-1$
 
+    /**
+     * Retrieves the category name from the platform extension registry based on the category ID
+     * @param categoryId The category ID
+     * @return the category name or empty string if not found
+     */
     public static String getCategoryName(String categoryId) {
         IConfigurationElement[] elements = Platform.getExtensionRegistry()
                 .getConfigurationElementsFor(TMF_TRACE_TYPE_ID);
@@ -49,6 +94,12 @@ public class TmfTraceType {
         return ""; //$NON-NLS-1$
     }
 
+    /**
+     * Retrieves all configuration elements from the platform extension registry 
+     * for the trace type extension.
+     * 
+     * @return an array of trace type configuration elements 
+     */
     public static IConfigurationElement[] getTypeElements() {
         IConfigurationElement[] elements = Platform.getExtensionRegistry()
                 .getConfigurationElementsFor(TMF_TRACE_TYPE_ID);
This page took 0.025137 seconds and 5 git commands to generate.