/**
* @return the trace event type
*/
- public TraceEventType getEventType();
+ TraceEventType getEventType();
/**
* Sets the trace event type to the given type
* @param type - type to set
*/
- public void setEventType(TraceEventType type);
+ void setEventType(TraceEventType type);
/**
* Sets the trace event type to the type specified by the given name.
* @param typeName - event type name
*/
- public void setEventType(String typeName);
+ void setEventType(String typeName);
/**
* @return the trace event log level
*/
- public TraceLogLevel getLogLevel();
+ TraceLogLevel getLogLevel();
/**
* Sets the trace event log level to the given level
* @param level - event log level to set
*/
- public void setLogLevel(TraceLogLevel level);
+ void setLogLevel(TraceLogLevel level);
/**
* Sets the trace event log level to the level specified by the given name.
* @param levelName - event log level name
*/
- public void setLogLevel(String levelName);
+ void setLogLevel(String levelName);
/**
* Returns the field information (if exists)
* @return the field information or null
*/
- public IFieldInfo[] getFields();
+ IFieldInfo[] getFields();
/**
* @param field The field to add
*/
- public void addField(IFieldInfo field);
+ void addField(IFieldInfo field);
/**
* Sets the fields
* @param fields The fields
*/
- public void setFields(List<IFieldInfo> fields);
+ void setFields(List<IFieldInfo> fields);
/**
* Returns filter expression.
* @return filter expression
*/
- public String getFilterExpression();
+ String getFilterExpression();
/**
* Sets the filter expression.
* @param filter The filter expression to set
*/
- public void setFilterExpression(String filter);
+ void setFilterExpression(String filter);
}
/**********************************************************************
- * 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.core.control.model;
* <p>
* Interface for retrieval of trace channel information.
* </p>
- *
+ *
* @author Bernd Hufmann
*/
public interface IChannelInfo extends ITraceInfo {
*/
public final static boolean DEFAULT_OVERWRITE_MODE = false;
/**
- * Default value for sub-buffer size for a UST channel.
+ * Default value for sub-buffer size for a UST channel.
*/
public final static long DEFAULT_SUB_BUFFER_SIZE_UST = 4096L;
/**
- * Default value for sub-buffer size for a Kernel channel.
+ * Default value for sub-buffer size for a Kernel channel.
*/
public final static long DEFAULT_SUB_BUFFER_SIZE_KERNEL = 262144L;
/**
- * Default value for number of sub-buffer a UST channel.
+ * Default value for number of sub-buffer a UST channel.
*/
public final static int DEFAULT_NUMBER_OF_SUB_BUFFERS_UST = 8;
/**
- * Default value for number of sub-buffer a Kernel channel.
+ * Default value for number of sub-buffer a Kernel channel.
*/
public final static int DEFAULT_NUMBER_OF_SUB_BUFFERS_KERNEL = 4;
/**
- * Default value for number of the switch timer interval.
+ * Default value for number of the switch timer interval.
*/
public final static long DEFAULT_SWITCH_TIMER = 0;
/**
- * Default value for number of the read timer interval.
+ * Default value for number of the read timer interval.
*/
public final static long DEFAULT_READ_TIMER = 200;
-
+
/**
* @return the overwrite mode value.
*/
- public boolean isOverwriteMode();
+ boolean isOverwriteMode();
/**
* Sets the overwrite mode value to the given mode.
* @param mode - mode to set.
*/
- public void setOverwriteMode(boolean mode);
+ void setOverwriteMode(boolean mode);
/**
* @return the sub-buffer size.
*/
- public long getSubBufferSize();
+ long getSubBufferSize();
/**
* Sets the sub-buffer size to the given value.
* @param bufferSize - size to set to set.
*/
- public void setSubBufferSize(long bufferSize);
+ void setSubBufferSize(long bufferSize);
/**
* @return the number of sub-buffers.
*/
- public int getNumberOfSubBuffers();
+ int getNumberOfSubBuffers();
/**
* Sets the number of sub-buffers to the given value.
* @param numberOfSubBuffers - value to set.
*/
- public void setNumberOfSubBuffers(int numberOfSubBuffers);
+ void setNumberOfSubBuffers(int numberOfSubBuffers);
/**
* @return the switch timer interval.
*/
- public long getSwitchTimer();
+ long getSwitchTimer();
/**
* Sets the switch timer interval to the given value.
* @param timer - timer value to set.
*/
- public void setSwitchTimer(long timer);
-
+ void setSwitchTimer(long timer);
+
/**
* @return the read timer interval.
*/
- public long getReadTimer();
+ long getReadTimer();
/**
* Sets the read timer interval to the given value.
* @param timer - timer value to set..
*/
- public void setReadTimer(long timer);
+ void setReadTimer(long timer);
/**
* @return the output type.
*/
- public String getOutputType();
+ String getOutputType();
/**
* Sets the output type to the given value.
* @param type - type to set.
*/
- public void setOutputType(String type);
-
+ void setOutputType(String type);
+
/**
* @return the channel state (enabled or disabled).
*/
- public TraceEnablement getState();
+ TraceEnablement getState();
/**
* Sets the channel state (enablement) to the given value.
* @param state - state to set.
*/
- public void setState(TraceEnablement state);
+ void setState(TraceEnablement state);
/**
* Sets the channel state (enablement) to the value specified by the given name.
* @param stateName - state to set.
*/
- public void setState(String stateName);
+ void setState(String stateName);
/**
* @return all event information as array.
*/
- public IEventInfo[] getEvents();
+ IEventInfo[] getEvents();
/**
* Sets the event information specified by given list.
* @param events - all event information to set.
*/
- public void setEvents(List<IEventInfo> events);
+ void setEvents(List<IEventInfo> events);
/**
* Adds a single event information.
* @param event - event information to add.
*/
- public void addEvent(IEventInfo event);
+ void addEvent(IEventInfo event);
}
/**********************************************************************
- * 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.core.control.model;
* <p>
* Interface for retrieval of trace domain information.
* </p>
- *
+ *
* @author Bernd Hufmann
*/
public interface IDomainInfo extends ITraceInfo {
-
+
/**
- * @return information about all channels
+ * @return information about all channels
*/
- public IChannelInfo[] getChannels();
-
+ IChannelInfo[] getChannels();
+
/**
* Sets the channel information specified by given list.
* @param channels - all channel information to set.
*/
- public void setChannels(List<IChannelInfo> channels);
-
+ void setChannels(List<IChannelInfo> channels);
+
/**
* Adds a single channel information.
* @param channel - channel information to add.
*/
- public void addChannel(IChannelInfo channel);
-
+ void addChannel(IChannelInfo channel);
+
/**
* @return true if domain is kernel, false for UST
*/
- public boolean isKernel();
-
+ boolean 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);
+ void setIsKernel(boolean isKernel);
}
/**********************************************************************
- * 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.core.control.model;
* <p>
* Interface for retrieval of trace event information.
* </p>
- *
+ *
* @author Bernd Hufmann
*/
public interface IEventInfo extends IBaseEventInfo {
/**
* @return the event state (enabled or disabled).
*/
- public TraceEnablement getState();
-
+ TraceEnablement getState();
+
/**
* Sets the event state (enablement) to the given value.
* @param state - state to set.
*/
- public void setState(TraceEnablement state);
-
+ void setState(TraceEnablement state);
+
/**
* Sets the event state (enablement) to the value specified by the given name.
* @param stateName - state to set.
*/
- public void setState(String stateName);
-
+ void setState(String stateName);
+
}
/**
* @return the event field type
*/
- public String getFieldType();
+ String getFieldType();
/**
* Sets field type string
*
* @param fieldType - sting of event field type
*/
- public void setFieldType(String fieldType);
+ void setFieldType(String fieldType);
}
/**********************************************************************
- * 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.core.control.model;
* <p>
* Interface for retrieval of probe event information.
* </p>
- *
+ *
* @author Bernd Hufmann
*/
public interface IProbeEventInfo extends IEventInfo {
/**
* @return the address of the probe. (null if not used)
*/
- public String getAddress();
-
+ String getAddress();
+
/**
* Sets the address of the probe.
* @param address - a address (null if not used)
*/
- public void setAddress(String address);
-
+ void setAddress(String address);
+
/**
* @return the offset applied to the symbol (null if not used).
*/
- public String getOffset();
-
+ String getOffset();
+
/**
* Sets the offset applied to the symbol.
* @param offset - a offset ((null if not used)
*/
- public void setOffset(String offset);
+ void setOffset(String offset);
/**
* @return the symbol name. ((null if not used))
*/
- public String getSymbol();
-
+ String getSymbol();
+
/**
* Sets the symbol name.
* @param symbol - a symbol name ((null if not used))
*/
- public void setSymbol(String symbol);
+ void setSymbol(String symbol);
}
/**
* @return the session state state (active or inactive).
*/
- public TraceSessionState getSessionState();
+ TraceSessionState getSessionState();
/**
* Sets the session state to the given value.
* @param state - state to set.
*/
- public void setSessionState(TraceSessionState state);
+ void setSessionState(TraceSessionState state);
/**
* Sets the event state to the value specified by the given name.
* @param stateName - state to set.
*/
- public void setSessionState(String stateName);
+ void setSessionState(String stateName);
/**
* @return path string where session is located.
*/
- public String getSessionPath();
+ String getSessionPath();
/**
* Sets the path string (where session is located) to the given value.
* @param path - session path to set.
*/
- public void setSessionPath(String path);
+ void setSessionPath(String path);
/**
* @return all domain information as array.
*/
- public IDomainInfo[] getDomains();
+ IDomainInfo[] getDomains();
/**
* Sets all domain information specified by given list.
* @param domains - all domain information to set.
*/
- public void setDomains(List<IDomainInfo> domains);
+ void setDomains(List<IDomainInfo> domains);
/**
* Adds a single domain information.
* @param domainInfo domain information to add.
*/
- public void addDomain(IDomainInfo domainInfo);
+ void addDomain(IDomainInfo domainInfo);
/**
* Returns if session is streamed over network
* @return <code>true</code> if streamed over network else <code>false</code>
*/
- public boolean isStreamedTrace();
+ boolean isStreamedTrace();
/**
* Sets whether the trace is streamed or not
* @param isStreamedTrace <code>true</code> if streamed over network else <code>false</code>
*/
- public void setStreamedTrace(boolean isStreamedTrace);
+ void setStreamedTrace(boolean isStreamedTrace);
}
/**********************************************************************
- * Copyright (c) 2012 Ericsson
+ * Copyright (c) 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
/**
* @return the name of the information element.
*/
- public String getName();
+ String getName();
/**
* Sets the name of the information element.
* @param name
* The name to assign
*/
- public void setName(String name);
+ void setName(String name);
}
/**********************************************************************
- * 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.core.control.model;
* <p>
* Interface for retrieval of UST provider information.
* </p>
- *
+ *
* @author Bernd Hufmann
*/
public interface IUstProviderInfo extends ITraceInfo {
-
+
/**
* @return the process ID of the UST provider.
*/
- public int getPid();
+ int getPid();
/**
* Sets the process ID of the UST provider to the given value.
* @param pid - process ID to set
*/
- public void setPid(int pid);
-
+ void setPid(int pid);
+
/**
* @return all event information as array.
*/
- public IBaseEventInfo[] getEvents();
-
+ IBaseEventInfo[] getEvents();
+
/**
* Sets the event information specified by given list.
* @param events - all event information to set.
*/
- public void setEvents(List<IBaseEventInfo> events);
-
+ void setEvents(List<IBaseEventInfo> events);
+
/**
* Adds a single event information.
* @param event - event information to add.
*/
- public void addEvent(IBaseEventInfo event);
+ void addEvent(IBaseEventInfo event);
}
/**********************************************************************
- * 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.dialogs;
* <p>
* Interface for providing information about contexts to be added to channels/events.
* </p>
- *
+ *
* @author Bernd Hufmann
*/
public interface IAddContextDialog {
* Sets the available contexts to choose from.
* @param contexts - a list of available contexts.
*/
- public void setAvalibleContexts(List<String> contexts);
-
+ void setAvalibleContexts(List<String> contexts);
+
/**
* @return array of contexts to be added
*/
- public List<String> getContexts();
+ List<String> getContexts();
// ------------------------------------------------------------------------
// Operations
/**********************************************************************
- * 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
* The message in the dialog window
* @return If the user clicked OK (true) or Cancel (false)
*/
- public boolean openConfirm(Shell parent, String title, String message);
+ boolean openConfirm(Shell parent, String title, String message);
}
/**
* @return the session name.
*/
- public String getSessionName();
+ String getSessionName();
/**
* @return the session path (null for default path)
*/
- public String getSessionPath();
+ String getSessionPath();
/**
* @return true for default location else false
*/
- public boolean isDefaultSessionPath();
+ boolean isDefaultSessionPath();
/**
* Initializes the dialog box.
* @param group - the session group
*/
- public void initialize(TraceSessionGroup group);
+ void initialize(TraceSessionGroup group);
/**
* @return true if traces is to be streamed else false.
*/
- public boolean isStreamedTrace();
+ boolean isStreamedTrace();
/**
* Get the network URL in case control and data is configured together otherwise null
* If it returns a non-null value, getControlUrl() and getDataUrl() have to return null.
* @return The network URL or null.
*/
- public String getNetworkUrl();
+ String getNetworkUrl();
/**
* Get the control URL in case control and data is configured separately.
*
* @return The control URL or null.
*/
- public String getControlUrl();
+ String getControlUrl();
/**
* Get the data URL in case control and data is configured separately.
*
* @return The data URL or null.
*/
- public String getDataUrl();
+ String getDataUrl();
// ------------------------------------------------------------------------
// Operations
/**********************************************************************
- * 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
/**
* @return the configuration info for the new channel.
*/
- public IChannelInfo getChannelInfo();
+ IChannelInfo getChannelInfo();
/**
* Sets the domain component
* @param domain - the trace domain component
*/
- public void setDomainComponent(TraceDomainComponent domain);
+ void setDomainComponent(TraceDomainComponent domain);
/**
* @return true for Kernel domain. False for UST.
*/
- public boolean isKernel();
+ boolean isKernel();
/**
* Sets the whether dialog is for Kernel or UST
* @param isKernel true for kernel domain else UST
*/
- public void setHasKernel(boolean isKernel);
+ void setHasKernel(boolean isKernel);
// ------------------------------------------------------------------------
// Operations
/**********************************************************************
- * 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.dialogs;
* <p>
* Interface for providing information about Kernel or UST events to be enabled.
* </p>
- *
+ *
* @author Bernd Hufmann
*/
public interface IEnableEventsDialog extends IEnableKernelEvents, IEnableUstEvents {
/**
* @return the session the events shall be enabled.
*/
- public boolean isKernel();
-
+ boolean isKernel();
+
/**
* Sets the trace provider group.
* @param providerGroup - a trace provider group
*/
- public void setTraceProviderGroup(TraceProviderGroup providerGroup);
-
+ void setTraceProviderGroup(TraceProviderGroup providerGroup);
+
/**
* Sets the trace domain component.
* @param domain - a domain of the events (null if not known)
*/
- public void setTraceDomainComponent(TraceDomainComponent domain);
+ void setTraceDomainComponent(TraceDomainComponent domain);
// ------------------------------------------------------------------------
// Operations
/**********************************************************************
- * 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.dialogs;
* <p>
* Interface for providing information about kernel events to be enabled.
* </p>
- *
+ *
* @author Bernd Hufmann
*/
public interface IEnableKernelEvents {
// ------------------------------------------------------------------------
// Accessors
// ------------------------------------------------------------------------
-
+
/**
* @return a flag whether the tracepoints shall be configured.
*/
- public boolean isTracepoints();
-
+ boolean isTracepoints();
+
/**
* @return a flag indicating whether all tracepoints shall be enabled or not.
*/
- public boolean isAllTracePoints();
+ boolean isAllTracePoints();
/**
* @return a flag whether the syscalls shall be configured.
*/
- public boolean isSysCalls();
-
+ boolean isSysCalls();
+
/**
* @return a flag indicating whether syscalls shall be enabled or not.
*/
- public boolean isAllSysCalls();
+ boolean isAllSysCalls();
/**
* @return a list of event names to be enabled.
*/
- public List<String> getEventNames();
+ List<String> getEventNames();
/**
* @return a flag whether the dynamic probe shall be configured.
*/
- public boolean isDynamicProbe();
-
+ boolean isDynamicProbe();
+
/**
* @return event name of the dynamic probe (or null if no dynamic probe).
*/
- public String getProbeEventName();
+ String getProbeEventName();
/**
* @return the dynamic probe (or null if no dynamic probe).
*/
- public String getProbeName();
+ String getProbeName();
/**
* @return a flag whether the dynamic function entry/return probe shall be configured.
*/
- public boolean isDynamicFunctionProbe();
-
+ boolean isDynamicFunctionProbe();
+
/**
* @return event name of the dynamic function entry/exit probe (or null if no dynamic probe).
*/
- public String getFunctionEventName();
+ String getFunctionEventName();
/**
* @return the dynamic function entry/exit probe (or null if no dynamic probe).
*/
- public String getFunction();
+ String getFunction();
-// /**
-// * @return a flag whether events using wildcards should be enabled
-// */
-// public boolean isWildcard();
-//
-// /**
-// * @return a wildcard
-// */
-// public String getWildcard();
-//
-// /**
-// * @return a flag whether events using log levels should be enabled
-// */
-// public boolean isLogLevel();
-//
-// /**
-// * @return a log level type (loglevel or loglevel-only)
-// */
-// public LogLevelType getLogLevelType();
-//
-// /**
-// * @return a log level
-// */
-// public TraceLogLevel getLogLevel();
-//
-// /**
-// * @return a event name for the log level enable action
-// */
-// public String getLogLevelEventName();
-
}
\ No newline at end of file
/**
* @return a flag whether the tracepoints shall be configured.
*/
- public boolean isTracepoints();
+ boolean isTracepoints();
/**
* @return a flag indicating whether all tracepoints shall be enabled or not.
*/
- public boolean isAllTracePoints();
+ boolean isAllTracePoints();
/**
* @return a list of event names to be enabled.
*/
- public List<String> getEventNames();
+ List<String> getEventNames();
/**
* @return a flag whether events using wildcards should be enabled
*/
- public boolean isWildcard();
+ boolean isWildcard();
/**
* @return a wildcard
*/
- public String getWildcard();
+ String getWildcard();
/**
* @return a flag whether events using log levels should be enabled
*/
- public boolean isLogLevel();
+ boolean isLogLevel();
/**
* @return a log level type (loglevel or loglevel-only)
*/
- public LogLevelType getLogLevelType();
+ LogLevelType getLogLevelType();
/**
* @return a log level
*/
- public TraceLogLevel getLogLevel();
+ TraceLogLevel getLogLevel();
/**
* @return a event name for the log level enable action
*/
- public String getLogLevelEventName();
+ String getLogLevelEventName();
/**
* @return a filter expression
*/
- public String getFilterExpression();
+ String getFilterExpression();
}
/**
* @return the session the events shall be enabled.
*/
- public TraceSessionComponent getSession();
+ TraceSessionComponent getSession();
/**
* @return the channel the events shall be enabled. Null for default channel.
*/
- public TraceChannelComponent getChannel();
+ TraceChannelComponent getChannel();
/**
* Sets flag about domain.
* @param isKernel - true for kernel, false for UST
*/
- public void setIsKernel(boolean isKernel);
+ void setIsKernel(boolean isKernel);
/**
* Sets available session.
* @param sessions - a array of available sessions.
*/
- public void setSessions(TraceSessionComponent[] sessions);
+ void setSessions(TraceSessionComponent[] sessions);
/**
* Returns the filter expression.
* @return the filter expression or null for no filtering
*/
- public String getFilterExpression();
+ String getFilterExpression();
// ------------------------------------------------------------------------
// Operations
/**********************************************************************
- * 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.dialogs;
* <p>
* Interface for dialog box for updating file import information.
* </p>
- *
+ *
* @author Bernd Hufmann
*/
public interface IImportConfirmationDialog {
-
+
// ------------------------------------------------------------------------
// Accessors
// ------------------------------------------------------------------------
/**
* @param name old trace name.
*/
- public void setTraceName(String name);
+ void setTraceName(String name);
/**
* @return the new trace name if not overwrite.
*/
- public String getNewTraceName();
-
+ String getNewTraceName();
+
/**
- *
+ *
* @return true to overwrite existing trace.
*/
- public boolean isOverwrite();
-
+ boolean isOverwrite();
+
// ------------------------------------------------------------------------
// Operations
// ------------------------------------------------------------------------
/**********************************************************************
- * 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
/**
* @return a list of trace paths to import.
*/
- public List<ImportFileInfo> getTracePathes();
+ List<ImportFileInfo> getTracePathes();
/**
* @return the project to import the traces to
*/
- public IProject getProject();
+ IProject getProject();
/**
* Sets the session containing the traces to import
* @param session The trace session
*/
- public void setSession(TraceSessionComponent session);
+ void setSession(TraceSessionComponent session);
// ------------------------------------------------------------------------
// Operations
/**
* @return the connection name (alias).
*/
- public String getConnectionName();
+ String getConnectionName();
/**
* @return the host name (IP address or DNS name)
*/
- public String getHostName();
+ String getHostName();
/**
* @return port of IP connection to be used
*/
- public int getPort();
+ int getPort();
/**
* Sets the trace control root
* @param parent - the trace control parent
*/
- public void setTraceControlParent(ITraceControlComponent parent);
+ void setTraceControlParent(ITraceControlComponent parent);
/**
* Sets the available hosts to select.
* @param hosts - the available hosts
*/
- public void setHosts(IHost[] hosts);
+ void setHosts(IHost[] hosts);
/**
* Set the port of the IP connection to be used.
* @param port - the IP port to set
*/
- public void setPort(int port);
+ void setPort(int port);
// ------------------------------------------------------------------------
// Operations
/**********************************************************************
- * 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;
/**
* <p>
- * 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.
* </p>
- *
+ *
* @author Bernd Hufmann
*/
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<ITraceControlComponent> children);
+ void setChildren(List<ITraceControlComponent> 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<ITraceControlComponent> getChildren(Class<? extends ITraceControlComponent> clazz);
+ List<ITraceControlComponent> getChildren(Class<? extends ITraceControlComponent> 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
/**
* 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);
}
/**********************************************************************
- * 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;
/**
* <p>
- * Listener interface a class can implement to be notified about changes
- * of components
+ * Listener interface a class can implement to be notified about changes
+ * of components
* </p>
- *
+ *
* @author Bernd Hufmann
*/
public interface ITraceControlComponentChangedListener {
* @param parent - the parent where the child was added.
* @param component - the child that was added.
*/
- public void componentAdded(ITraceControlComponent parent, ITraceControlComponent component);
+ void componentAdded(ITraceControlComponent parent, ITraceControlComponent component);
/**
* Interface for notifications about the removal of a child.
* @param parent - the parent where the child was removed.
* @param component - the child that was removed.
*/
- public void componentRemoved(ITraceControlComponent parent, ITraceControlComponent component);
+ void componentRemoved(ITraceControlComponent parent, ITraceControlComponent component);
/**
* NInterface for notifications about the change of a component.
* @param component - the component that was changed.
*/
- public void componentChanged(ITraceControlComponent component);
+ void componentChanged(ITraceControlComponent component);
}
/**********************************************************************
- * 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
*
* @return 0 if successful else >0
*/
- public int getResult();
+ int getResult();
/**
* Sets the command result value.
* @param result
* The integer result to set
*/
- public void setResult(int result);
+ void setResult(int result);
/**
* @return returns the command output.
*/
- public String[] getOutput();
+ String[] getOutput();
/**
* Sets the command output.
* @param output
* The output (as an array of Strings) to assign
*/
- public void setOutput(String[] output);
+ void setOutput(String[] output);
}
\ No newline at end of file
/**********************************************************************
- * 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
* @throws ExecutionException
* If the command fails
*/
- public void connect() throws ExecutionException;
+ void connect() throws ExecutionException;
/**
* Method to disconnect the command shell.
*/
- public void disconnect();
+ void disconnect();
/**
* Method to execute a command on the command shell.
* @throws ExecutionException
* If the command fails
*/
- public ICommandResult executeCommand(String command,
+ ICommandResult executeCommand(String command,
IProgressMonitor monitor) throws ExecutionException;
/**
* @throws ExecutionException
* If the command fails
*/
- public ICommandResult executeCommand(final String command,
+ ICommandResult executeCommand(final String command,
final IProgressMonitor monitor, final boolean checkReturnValue)
throws ExecutionException;
*
* @return shell service object, or <code>null</code> if not found.
*/
- public IShellService getShellService();
+ IShellService getShellService();
/**
* Find the first terminal service.
*
* @return shell service object, or <code>null</code> if not found.
*/
- public ITerminalService getTerminalService();
+ ITerminalService getTerminalService();
/**
* Find the first IShellServiceSubSystem service.
*
* @return shell service subsystem, or <code>null</code> if not found.
*/
- public ISubSystem getShellServiceSubSystem();
+ ISubSystem getShellServiceSubSystem();
/**
* Find the first ITerminalServiceSubSystem service.
*
* @return shell service subsystem, or <code>null</code> if not found.
*/
- public ISubSystem getTerminalServiceSubSystem();
+ ISubSystem getTerminalServiceSubSystem();
/**
* Finds the File Service Subsystem.
*
* @return file service subsystem, or <code>null</code> if not found.
*/
- public IFileServiceSubSystem getFileServiceSubSystem();
+ IFileServiceSubSystem getFileServiceSubSystem();
/**
* @return port of IP connection to be used
*/
- public int getPort();
+ int getPort();
/**
* Sets the port of the IP connection.
* @param port - the IP port to set
*/
- public void setPort(int port);
+ void setPort(int port);
/**
* Connects the shell service sub system.
* @throws ExecutionException
* If the connection fails
*/
- public void connect(IRSECallback callback) throws ExecutionException;
+ void connect(IRSECallback callback) throws ExecutionException;
/**
* Disconnects from the shell service sub system.
* @throws ExecutionException
* If the disconnect command fails
*/
- public void disconnect() throws ExecutionException;
+ void disconnect() throws ExecutionException;
/**
* Creates a command shell.
* @throws ExecutionException
* If the command fails
*/
- public ICommandShell createCommandShell() throws ExecutionException;
+ ICommandShell createCommandShell() throws ExecutionException;
/**
* Method to add a communication listener to the connector service defined
* @param listener
* - listener to add
*/
- public void addCommunicationListener(ICommunicationsListener listener);
+ void addCommunicationListener(ICommunicationsListener listener);
/**
* Method to remove a communication listener from the connector service
* @param listener
* - listener to remove
*/
- public void removeCommunicationListener(ICommunicationsListener listener);
+ void removeCommunicationListener(ICommunicationsListener listener);
}
\ No newline at end of file
projects / deliverable / tracecompass.git / commitdiff
