lttng: Fix Javadoc and formatting in lttng2.ui
[deliverable/tracecompass.git] / org.eclipse.linuxtools.lttng2.ui / src / org / eclipse / linuxtools / internal / lttng2 / ui / views / control / model / impl / TraceDomainComponent.java
index bed409ec7cf4ee96d36e7af2d1ac8e1a559fda07..fbb9231bb1050e5272af10402ff9ece3b85931ae 100644 (file)
@@ -1,12 +1,12 @@
 /**********************************************************************
  * Copyright (c) 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
  * accompanies this distribution, and is available at
  * http://www.eclipse.org/legal/epl-v10.html
- * 
- * Contributors: 
+ *
+ * Contributors:
  *   Bernd Hufmann - Initial API and implementation
  **********************************************************************/
 package org.eclipse.linuxtools.internal.lttng2.ui.views.control.model.impl;
@@ -30,7 +30,7 @@ import org.eclipse.ui.views.properties.IPropertySource;
  * <p>
  * Implementation of the trace domain component.
  * </p>
- * 
+ *
  * @author Bernd Hufmann
  */
 public class TraceDomainComponent extends TraceControlComponent {
@@ -54,7 +54,7 @@ public class TraceDomainComponent extends TraceControlComponent {
     // Constructors
     // ------------------------------------------------------------------------
     /**
-     * Constructor 
+     * Constructor
      * @param name - the name of the component.
      * @param parent - the parent of this component.
      */
@@ -94,19 +94,19 @@ public class TraceDomainComponent extends TraceControlComponent {
         }
         return null;
     }
-    
+
     /**
      * @return session name from parent
      */
     public String getSessionName() {
         return ((TraceSessionComponent)getParent()).getName();
     }
-    
+
     /**
      * @return session from parent
      */
     public TraceSessionComponent getSession() {
-       return (TraceSessionComponent)getParent(); 
+       return (TraceSessionComponent)getParent();
     }
 
     /**
@@ -115,23 +115,23 @@ public class TraceDomainComponent extends TraceControlComponent {
     public boolean isKernel() {
         return fDomainInfo.isKernel();
     }
-    
+
     /**
-     * Sets whether domain is  Kernel domain or UST 
+     * Sets whether domain is  Kernel domain or UST
      * @param isKernel true for kernel, false for UST
      */
     public void setIsKernel(boolean isKernel) {
         fDomainInfo.setIsKernel(isKernel);
     }
-    
+
     /**
      * @return returns all available channels for this domain.
      */
     public TraceChannelComponent[] getChannels() {
         List<ITraceControlComponent> channels = getChildren(TraceChannelComponent.class);
-        return (TraceChannelComponent[])channels.toArray(new TraceChannelComponent[channels.size()]);
+        return channels.toArray(new TraceChannelComponent[channels.size()]);
     }
-    
+
     /**
      * @return the parent target node
      */
@@ -142,141 +142,220 @@ public class TraceDomainComponent extends TraceControlComponent {
     // ------------------------------------------------------------------------
     // Operations
     // ------------------------------------------------------------------------
+
     /**
-     * Retrieves the session configuration from the node. 
+     * Retrieves the session configuration from the node.
+     *
      * @throws ExecutionException
+     *             If the command fails
      */
     public void getConfigurationFromNode() throws ExecutionException {
         getConfigurationFromNode(new NullProgressMonitor());
     }
+
     /**
-     * Retrieves the session configuration from the node. 
-     * @param monitor - a progress monitor
+     * Retrieves the session configuration from the node.
+     *
+     * @param monitor
+     *            - a progress monitor
      * @throws ExecutionException
+     *             If the command fails
      */
     public void getConfigurationFromNode(IProgressMonitor monitor) throws ExecutionException {
         TraceSessionComponent session = (TraceSessionComponent) getParent();
         session.getConfigurationFromNode(monitor);
     }
+
     /**
-     * Enables channels with given names which are part of this domain. If a given channel 
-     * doesn't exists it creates a new channel with the given parameters (or default values 
-     * if given parameter is null). 
-     * @param channelNames - a list of channel names to enable on this domain
-     * @param info - channel information to set for the channel (use null for default)
+     * Enables channels with given names which are part of this domain. If a
+     * given channel doesn't exists it creates a new channel with the given
+     * parameters (or default values if given parameter is null).
+     *
+     * @param channelNames
+     *            - a list of channel names to enable on this domain
+     * @param info
+     *            - channel information to set for the channel (use null for
+     *            default)
      * @throws ExecutionException
+     *             If the command fails
      */
     public void enableChannels(List<String> channelNames, IChannelInfo info) throws ExecutionException {
         enableChannels(channelNames, info, new NullProgressMonitor());
     }
+
     /**
-     * Enables channels with given names which are part of this domain. If a given channel 
-     * doesn't exists it creates a new channel with the given parameters (or default values 
-     * if given parameter is null). 
-     * @param channelNames - a list of channel names to enable on this domain
-     * @param info - channel information to set for the channel (use null for default)
-     * @param monitor - a progress monitor
+     * Enables channels with given names which are part of this domain. If a
+     * given channel doesn't exists it creates a new channel with the given
+     * parameters (or default values if given parameter is null).
+     *
+     * @param channelNames
+     *            - a list of channel names to enable on this domain
+     * @param info
+     *            - channel information to set for the channel (use null for
+     *            default)
+     * @param monitor
+     *            - a progress monitor
      * @throws ExecutionException
+     *             If the command fails
      */
-    public void enableChannels(List<String> channelNames, IChannelInfo info, IProgressMonitor monitor) throws ExecutionException {
-        getControlService().enableChannels(getParent().getName(), channelNames, isKernel(), info, monitor);
+    public void enableChannels(List<String> channelNames, IChannelInfo info,
+            IProgressMonitor monitor) throws ExecutionException {
+        getControlService().enableChannels(getParent().getName(), channelNames,
+                isKernel(), info, monitor);
     }
+
     /**
-     * Disables channels with given names which are part of this domain. 
-     * @param channelNames - a list of channel names to enable on this domain
+     * Disables channels with given names which are part of this domain.
+     *
+     * @param channelNames
+     *            - a list of channel names to enable on this domain
      * @throws ExecutionException
+     *             If the command fails
      */
-    public void disableChannels(List<String> channelNames) throws ExecutionException {
+    public void disableChannels(List<String> channelNames)
+            throws ExecutionException {
         disableChannels(channelNames, new NullProgressMonitor());
     }
+
     /**
-     * Disables channels with given names which are part of this domain. 
-     * @param channelNames - a list of channel names to enable on this domain
-     * @param monitor - a progress monitor
+     * Disables channels with given names which are part of this domain.
+     *
+     * @param channelNames
+     *            - a list of channel names to enable on this domain
+     * @param monitor
+     *            - a progress monitor
      * @throws ExecutionException
+     *             If the command fails
      */
-    public void disableChannels(List<String> channelNames, IProgressMonitor monitor) throws ExecutionException {
-        getControlService().disableChannels(getParent().getName(), channelNames, isKernel(), monitor);
+    public void disableChannels(List<String> channelNames,
+            IProgressMonitor monitor) throws ExecutionException {
+        getControlService().disableChannels(getParent().getName(),
+                channelNames, isKernel(), monitor);
     }
 
     /**
      * Enables a list of events with no additional parameters.
-     * @param eventNames - a list of event names to enabled.
-     * @param monitor - a progress monitor
+     *
+     * @param eventNames
+     *            - a list of event names to enabled.
+     * @param monitor
+     *            - a progress monitor
      * @throws ExecutionException
+     *             If the command fails
      */
-    public void enableEvents(List<String> eventNames, IProgressMonitor monitor) throws ExecutionException {
-        getControlService().enableEvents(getSessionName(), null, eventNames, isKernel(), monitor);
+    public void enableEvents(List<String> eventNames, IProgressMonitor monitor)
+            throws ExecutionException {
+        getControlService().enableEvents(getSessionName(), null, eventNames,
+                isKernel(), monitor);
     }
 
     /**
      * Enables all syscalls (for kernel domain)
+     *
      * @throws ExecutionException
+     *             If the command fails
      */
-   public void enableSyscalls() throws ExecutionException {
+    public void enableSyscalls() throws ExecutionException {
         enableSyscalls(new NullProgressMonitor());
     }
 
-   /**
-    * Enables all syscalls (for kernel domain)
-    * @param monitor - a progress monitor
-    * @throws ExecutionException
-    */
+    /**
+     * Enables all syscalls (for kernel domain)
+     *
+     * @param monitor
+     *            - a progress monitor
+     * @throws ExecutionException
+     *             If the command fails
+     */
 
-    public void enableSyscalls(IProgressMonitor monitor) throws ExecutionException {
+    public void enableSyscalls(IProgressMonitor monitor)
+            throws ExecutionException {
         getControlService().enableSyscalls(getSessionName(), null, monitor);
     }
 
     /**
      * Enables a dynamic probe (for kernel domain)
-     * @param eventName - event name for probe
-     * @param isFunction - true for dynamic function entry/return probe else false
-      * @param probe - the actual probe
+     *
+     * @param eventName
+     *            - event name for probe
+     * @param isFunction
+     *            - true for dynamic function entry/return probe else false
+     * @param probe
+     *            - the actual probe
      * @throws ExecutionException
+     *             If the command fails
      */
-    public void enableProbe(String eventName, boolean isFunction, String probe) throws ExecutionException {
+    public void enableProbe(String eventName, boolean isFunction, String probe)
+            throws ExecutionException {
         enableProbe(eventName, isFunction, probe, new NullProgressMonitor());
     }
-    
+
     /**
      * Enables a dynamic probe (for kernel domain)
-     * @param eventName - event name for probe
-     * @param isFunction - true for dynamic function entry/return probe else false
-     * @param probe - the actual probe
-     * @param monitor - a progress monitor
+     *
+     * @param eventName
+     *            - event name for probe
+     * @param isFunction
+     *            - true for dynamic function entry/return probe else false
+     * @param probe
+     *            - the actual probe
+     * @param monitor
+     *            - a progress monitor
      * @throws ExecutionException
+     *             If the command fails
      */
-    public void enableProbe(String eventName, boolean isFunction, String probe, IProgressMonitor monitor) throws ExecutionException {
-        getControlService().enableProbe(getSessionName(), null, eventName, isFunction, probe, monitor);
+    public void enableProbe(String eventName, boolean isFunction, String probe,
+            IProgressMonitor monitor) throws ExecutionException {
+        getControlService().enableProbe(getSessionName(), null, eventName,
+                isFunction, probe, monitor);
     }
 
     /**
      * Enables events using log level.
-     * @param eventName - a event name
-     * @param logLevelType - a log level type 
-     * @param level - a log level 
+     *
+     * @param eventName
+     *            - a event name
+     * @param logLevelType
+     *            - a log level type
+     * @param level
+     *            - a log level
      * @throws ExecutionException
+     *             If the command fails
      */
-    public void enableLogLevel(String eventName, LogLevelType logLevelType, TraceLogLevel level) throws ExecutionException {
-        enableLogLevel(eventName, logLevelType, level, new NullProgressMonitor());
+    public void enableLogLevel(String eventName, LogLevelType logLevelType,
+            TraceLogLevel level) throws ExecutionException {
+        enableLogLevel(eventName, logLevelType, level,
+                new NullProgressMonitor());
     }
 
     /**
      * Enables events using log level.
-     * @param eventName - a event name
-     * @param logLevelType - a log level type 
-     * @param level - a log level 
-     * @param monitor - a progress monitor  
+     *
+     * @param eventName
+     *            - a event name
+     * @param logLevelType
+     *            - a log level type
+     * @param level
+     *            - a log level
+     * @param monitor
+     *            - a progress monitor
      * @throws ExecutionException
+     *             If the command fails
      */
-    public void enableLogLevel(String eventName, LogLevelType logLevelType, TraceLogLevel level, IProgressMonitor monitor) throws ExecutionException {
-        getControlService().enableLogLevel(getSessionName(), null, eventName, logLevelType, level, monitor);
+    public void enableLogLevel(String eventName, LogLevelType logLevelType,
+            TraceLogLevel level, IProgressMonitor monitor)
+            throws ExecutionException {
+        getControlService().enableLogLevel(getSessionName(), null, eventName,
+                logLevelType, level, monitor);
     }
 
     /**
      * Add contexts to given channels and or events
-     * @param contexts - a list of contexts to add
+     *
+     * @param contexts
+     *            - a list of contexts to add
      * @throws ExecutionException
+     *             If the command fails
      */
     public void addContexts(List<String> contexts) throws ExecutionException {
         addContexts(contexts, new NullProgressMonitor());
@@ -284,17 +363,25 @@ public class TraceDomainComponent extends TraceControlComponent {
 
     /**
      * Add contexts to given channels and or events
-     * @param contexts - a list of contexts to add
-     * @param monitor - a progress monitor
+     *
+     * @param contexts
+     *            - a list of contexts to add
+     * @param monitor
+     *            - a progress monitor
      * @throws ExecutionException
+     *             If the command fails
      */
-    public void addContexts(List<String> contexts, IProgressMonitor monitor) throws ExecutionException {
-        getControlService().addContexts(getSessionName(), null, null, isKernel(), contexts, monitor);
+    public void addContexts(List<String> contexts, IProgressMonitor monitor)
+            throws ExecutionException {
+        getControlService().addContexts(getSessionName(), null, null,
+                isKernel(), contexts, monitor);
     }
 
     /**
      * Executes calibrate command to quantify LTTng overhead.
+     *
      * @throws ExecutionException
+     *             If the command fails
      */
     public void calibrate() throws ExecutionException {
         calibrate(new NullProgressMonitor());
@@ -302,8 +389,11 @@ public class TraceDomainComponent extends TraceControlComponent {
 
     /**
      * Executes calibrate command to quantify LTTng overhead.
-     * @param monitor - a progress monitor
+     *
+     * @param monitor
+     *            - a progress monitor
      * @throws ExecutionException
+     *             If the command fails
      */
     public void calibrate(IProgressMonitor monitor) throws ExecutionException {
         getControlService().calibrate(isKernel(), monitor);
This page took 0.030114 seconds and 5 git commands to generate.