X-Git-Url: http://drtracing.org/?a=blobdiff_plain;f=org.eclipse.linuxtools.lttng2.ui%2Fsrc%2Forg%2Feclipse%2Flinuxtools%2Finternal%2Flttng2%2Fui%2Fviews%2Fcontrol%2Fmodel%2FITraceControlComponent.java;h=b5e348eaf7d0f97940ebbb26d0853500dacd6053;hb=a6e6f7b4c37dc5adce8b2deeaf1d360b1284ad46;hp=0e9fd379aa267a8465095b2f439efd49b745c3f6;hpb=dbd4432dd9f427af47e9755cbf67b18e2e47b001;p=deliverable%2Ftracecompass.git diff --git a/org.eclipse.linuxtools.lttng2.ui/src/org/eclipse/linuxtools/internal/lttng2/ui/views/control/model/ITraceControlComponent.java b/org.eclipse.linuxtools.lttng2.ui/src/org/eclipse/linuxtools/internal/lttng2/ui/views/control/model/ITraceControlComponent.java index 0e9fd379aa..b5e348eaf7 100644 --- a/org.eclipse.linuxtools.lttng2.ui/src/org/eclipse/linuxtools/internal/lttng2/ui/views/control/model/ITraceControlComponent.java +++ b/org.eclipse.linuxtools.lttng2.ui/src/org/eclipse/linuxtools/internal/lttng2/ui/views/control/model/ITraceControlComponent.java @@ -1,12 +1,12 @@ /********************************************************************** - * Copyright (c) 2012 Ericsson - * + * Copyright (c) 2012, 2013 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; @@ -20,10 +20,10 @@ import org.eclipse.swt.graphics.Image; /** *

- * Interface for trace control components that can be displayed in the - * trace control tree viewer. + * Interface for trace control components that can be displayed in the + * trace control tree viewer. *

- * + * * @author Bernd Hufmann */ public interface ITraceControlComponent extends IAdaptable { @@ -35,90 +35,90 @@ public interface ITraceControlComponent extends IAdaptable { /** * @return the name of the component */ - public String getName(); + String getName(); /** * Sets the name of the component to the given value. * @param name - name to set */ - public void setName(String name); + void setName(String name); /** * @return the image representing the component. */ - public Image getImage(); + Image getImage(); /** * Sets the image path of the component. * @param path - path to the image location */ - public void setImage(String path); + void setImage(String path); /** * Sets the image the component. * @param image - image to the image location */ - public void setImage(Image image); + void setImage(Image image); /** * @return tool tip with information about the component. */ - public String getToolTip(); + String getToolTip(); /** * Sets the tool tip with information about the component. * @param toolTip - the tool tip to set. */ - public void setToolTip(String toolTip); - + void setToolTip(String toolTip); + /** * @return the node's connection state */ - public TargetNodeState getTargetNodeState(); + TargetNodeState getTargetNodeState(); /** - * Sets the node's connection state. + * Sets the node's connection state. * @param state - the state to set */ - public void setTargetNodeState(TargetNodeState state); - + void setTargetNodeState(TargetNodeState state); + /** * @return returns the parent component. */ - public ITraceControlComponent getParent(); + ITraceControlComponent getParent(); /** * Sets the parent component. * @param parent - the parent to set. */ - public void setParent(ITraceControlComponent parent); + void setParent(ITraceControlComponent parent); /** * @return the children components */ - public ITraceControlComponent[] getChildren(); + ITraceControlComponent[] getChildren(); /** * Sets the children components. * @param children - the children to set. */ - public void setChildren(List children); + void setChildren(List children); /** * Returns the child component with given name. * @param name - name of child to find. * @return child component or null. */ - public ITraceControlComponent getChild(String name); + ITraceControlComponent getChild(String name); /** * Gets children for given class type. * @param clazz - a class type to get - * @return list of trace control components matching given class type. + * @return list of trace control components matching given class type. */ - public List getChildren(Class clazz); + List getChildren(Class clazz); /** * @return the LTTng control service implementation. */ - public ILttngControlService getControlService(); + ILttngControlService getControlService(); /** * Sets the LTTng control service implementation. * @param service - the service to set. */ - public void setControlService(ILttngControlService service); + void setControlService(ILttngControlService service); // ------------------------------------------------------------------------ // Operations @@ -126,73 +126,67 @@ public interface ITraceControlComponent extends IAdaptable { /** * Dispose any resource. */ - public void dispose(); - + void dispose(); + /** * Adds a child component. * @param component - child to add. */ - public void addChild(ITraceControlComponent component); - - /** - * Adds several components. - * @param components - array of components to add. - */ -// public void addChildren(ITraceControlComponent[] components); - + void addChild(ITraceControlComponent component); + /** - * Removes the given child component. + * Removes the given child component. * @param component - the child to remove. */ - public void removeChild(ITraceControlComponent component); - + void removeChild(ITraceControlComponent component); + /** * Removes all children. */ - public void removeAllChildren(); - + void removeAllChildren(); + /** * Checks if child with given name exists. * @param name - child name to search for. * @return - true if exists else false. */ - public boolean containsChild(String name); - + boolean containsChild(String name); + /** - * Checks for children. + * Checks for children. * @return true if one or more children exist else false */ - public boolean hasChildren(); + boolean hasChildren(); /** * Adds a component listener for notification of component changes. * @param listener - listener interface implementation to add. */ - public void addComponentListener(ITraceControlComponentChangedListener listener); - + void addComponentListener(ITraceControlComponentChangedListener listener); + /** * Removes a component listener for notification of component changes. * @param listener - listener interface implementation to remove. */ - public void removeComponentListener(ITraceControlComponentChangedListener listener); - + void removeComponentListener(ITraceControlComponentChangedListener listener); + /** * Notifies listeners about the addition of a child. * @param parent - the parent where the child was added. * @param component - the child that was added. */ - public void fireComponentAdded(ITraceControlComponent parent, ITraceControlComponent component); - + void fireComponentAdded(ITraceControlComponent parent, ITraceControlComponent component); + /** * Notifies listeners about the removal of a child. * @param parent - the parent where the child was removed. * @param component - the child that was removed. */ - public void fireComponentRemoved(ITraceControlComponent parent, ITraceControlComponent component); - + void fireComponentRemoved(ITraceControlComponent parent, ITraceControlComponent component); + /** * Notifies listeners about the change of a component. * @param component - the component that was changed. */ - public void fireComponentChanged(ITraceControlComponent component); + void fireComponentChanged(ITraceControlComponent component); }