From 0d9a6d765b693ee77f0ccf19a0289de466aa6a63 Mon Sep 17 00:00:00 2001 From: Francois Chouinard Date: Thu, 22 Mar 2012 18:46:20 -0400 Subject: [PATCH] Fix javadoc warnings --- .../ctf/core/trace/CTFTraceReader.java | 6 +- .../linuxtools/lttng/jni/JniTrace.java | 2 +- .../tmf/stubs/request/TmfDataRequestStub.java | 10 +- .../stubs/request/TmfEventRequestStub.java | 10 +- .../tmf/core/component/TmfDataProvider.java | 9 +- .../core/component/TmfProviderManager.java | 32 ++--- .../tmf/core/ctfadaptor/CtfTmfEvent.java | 2 +- .../tmf/core/ctfadaptor/CtfTmfEventField.java | 9 +- .../linuxtools/tmf/core/event/TmfEvent.java | 6 +- .../tmf/core/event/TmfEventField.java | 4 +- .../tmf/core/experiment/TmfExperiment.java | 21 ++- .../experiment/TmfExperimentCheckpoint.java | 4 +- .../core/filter/model/ITmfFilterTreeNode.java | 4 +- .../core/filter/model/TmfFilterTreeNode.java | 6 +- .../core/filter/xml/TmfFilterXMLWriter.java | 4 +- .../tmf/core/interval/ITmfStateInterval.java | 8 +- .../tmf/core/parser/ITmfEventParser.java | 13 +- .../core/request/TmfCoalescedDataRequest.java | 83 ++++++++--- .../request/TmfCoalescedEventRequest.java | 107 ++++++++++---- .../tmf/core/request/TmfDataRequest.java | 135 +++++++++++------- .../tmf/core/request/TmfEventRequest.java | 97 ++++++++++--- .../historytree/HistoryTreeBackend.java | 2 +- .../linuxtools/tmf/core/trace/ITmfTrace.java | 6 +- .../linuxtools/tmf/core/trace/TmfTrace.java | 6 +- .../tmf/ui/viewers/events/TmfEventsTable.java | 4 +- .../timeAnalysis/ITimeAnalysisViewer.java | 2 +- .../timeAnalysis/TmfTimeAnalysisProvider.java | 10 +- .../timeAnalysis/TmfTimeAnalysisViewer.java | 4 +- .../TmfTimeScaleSelectionEvent.java | 8 +- .../timeAnalysis/model/ITimeEvent.java | 10 +- .../viewers/timeAnalysis/widgets/Utils.java | 30 ++-- .../tmf/ui/views/filter/FilterDialog.java | 4 +- .../views/histogram/HistogramDataModel.java | 2 +- .../views/histogram/IHistogramDataModel.java | 3 +- .../views/statistics/TmfStatisticsView.java | 3 +- .../model/TmfStatisticsTreeRootFactory.java | 10 +- .../tmf/ui/views/uml2sd/DrawableToolTip.java | 11 +- .../tmf/ui/views/uml2sd/SDView.java | 10 +- .../tmf/ui/views/uml2sd/ScrollView.java | 54 ++++--- .../ui/views/uml2sd/core/AsyncMessage.java | 2 - .../tmf/ui/views/uml2sd/core/Frame.java | 16 +-- .../tmf/ui/views/uml2sd/core/GraphNode.java | 11 +- .../tmf/ui/views/uml2sd/core/HotSpot.java | 2 +- .../tmf/ui/views/uml2sd/core/Lifeline.java | 6 +- .../tmf/ui/views/uml2sd/core/Stop.java | 2 - .../views/uml2sd/drawings/ISDPreferences.java | 2 +- .../provider/ISDCollapseProvider.java | 2 +- .../handlers/provider/ISDFilterProvider.java | 2 +- .../handlers/provider/ISDFindProvider.java | 2 +- .../provider/ISDPropertiesProvider.java | 2 +- .../uml2sd/handlers/widgets/Criteria.java | 2 +- .../handlers/widgets/FilterCriteria.java | 3 +- .../handlers/widgets/SearchFilterDialog.java | 11 +- .../uml2sd/handlers/widgets/TabContents.java | 3 +- .../uml2sd/impl/TmfUml2SDSyncLoader.java | 4 +- 55 files changed, 521 insertions(+), 302 deletions(-) diff --git a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/trace/CTFTraceReader.java b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/trace/CTFTraceReader.java index 9117fc52b9..d22ac6bd18 100644 --- a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/trace/CTFTraceReader.java +++ b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/trace/CTFTraceReader.java @@ -92,8 +92,6 @@ public class CTFTraceReader { /** * Copy constructor - * - * @return */ public CTFTraceReader copyFrom() { CTFTraceReader newReader = null; @@ -111,7 +109,7 @@ public class CTFTraceReader { /** * Return the start time of this trace (== timestamp of the first event) * - * @return + * @return the trace start time */ public long getStartTime() { return this.startTime; @@ -267,7 +265,7 @@ public class CTFTraceReader { * * @param timestamp * the timestamp to seek to - * @return + * @return true if the trace has more events following the timestamp */ public boolean seek(long timestamp) { /* diff --git a/org.eclipse.linuxtools.lttng.jni/src/org/eclipse/linuxtools/lttng/jni/JniTrace.java b/org.eclipse.linuxtools.lttng.jni/src/org/eclipse/linuxtools/lttng/jni/JniTrace.java index bf335e5e28..86d91022a8 100644 --- a/org.eclipse.linuxtools.lttng.jni/src/org/eclipse/linuxtools/lttng/jni/JniTrace.java +++ b/org.eclipse.linuxtools.lttng.jni/src/org/eclipse/linuxtools/lttng/jni/JniTrace.java @@ -491,7 +491,7 @@ public abstract class JniTrace extends Jni_C_Common { * Note : If the events were read before, the top event and the event * currently loaded (currentEvent) are most likely the same. * - * @@return The top event in the stack or null if no event is available or if the heap is null. + * @return The top event in the stack or null if no event is available or if the heap is null. * * @see org.eclipse.linuxtools.lttng.jni.JniEvent */ diff --git a/org.eclipse.linuxtools.tmf.core.tests/stubs/org/eclipse/linuxtools/tmf/stubs/request/TmfDataRequestStub.java b/org.eclipse.linuxtools.tmf.core.tests/stubs/org/eclipse/linuxtools/tmf/stubs/request/TmfDataRequestStub.java index 4ef8e8986a..4393c301fc 100644 --- a/org.eclipse.linuxtools.tmf.core.tests/stubs/org/eclipse/linuxtools/tmf/stubs/request/TmfDataRequestStub.java +++ b/org.eclipse.linuxtools.tmf.core.tests/stubs/org/eclipse/linuxtools/tmf/stubs/request/TmfDataRequestStub.java @@ -24,19 +24,23 @@ public class TmfDataRequestStub extends TmfDataRequest { /** * Default constructor + * + * @param dataType */ public TmfDataRequestStub(Class dataType) { super(dataType); } /** - * @param nbRequested + * @param dataType + * @param index */ public TmfDataRequestStub(Class dataType, int index) { super(dataType, index); } /** + * @param dataType * @param index * @param nbRequested */ @@ -45,6 +49,7 @@ public class TmfDataRequestStub extends TmfDataRequest { } /** + * @param dataType * @param index * @param nbRequested * @param blockSize @@ -53,6 +58,9 @@ public class TmfDataRequestStub extends TmfDataRequest { super(dataType, index, nbRequested, blockSize); } + /* (non-Javadoc) + * @see org.eclipse.linuxtools.tmf.core.request.TmfDataRequest#handleData(org.eclipse.linuxtools.tmf.core.event.ITmfEvent) + */ @Override public void handleData(T data) { super.handleData(data); diff --git a/org.eclipse.linuxtools.tmf.core.tests/stubs/org/eclipse/linuxtools/tmf/stubs/request/TmfEventRequestStub.java b/org.eclipse.linuxtools.tmf.core.tests/stubs/org/eclipse/linuxtools/tmf/stubs/request/TmfEventRequestStub.java index a88ba4d7b6..762c1d2b27 100644 --- a/org.eclipse.linuxtools.tmf.core.tests/stubs/org/eclipse/linuxtools/tmf/stubs/request/TmfEventRequestStub.java +++ b/org.eclipse.linuxtools.tmf.core.tests/stubs/org/eclipse/linuxtools/tmf/stubs/request/TmfEventRequestStub.java @@ -24,13 +24,14 @@ import org.eclipse.linuxtools.tmf.core.request.TmfEventRequest; public class TmfEventRequestStub extends TmfEventRequest { /** - * @param range + * @param dataType */ public TmfEventRequestStub(Class dataType) { super(dataType); } /** + * @param dataType * @param range */ public TmfEventRequestStub(Class dataType, TmfTimeRange range) { @@ -38,6 +39,7 @@ public class TmfEventRequestStub extends TmfEventRequest } /** + * @param dataType * @param range * @param nbRequested */ @@ -46,14 +48,18 @@ public class TmfEventRequestStub extends TmfEventRequest } /** + * @param dataType * @param range * @param nbRequested - * @param blockSize Size of the largest blocks expected + * @param blockSize */ public TmfEventRequestStub(Class dataType, TmfTimeRange range, int nbRequested, int blockSize) { super(dataType, range, nbRequested, blockSize); } + /* (non-Javadoc) + * @see org.eclipse.linuxtools.tmf.core.request.TmfDataRequest#handleData(org.eclipse.linuxtools.tmf.core.event.ITmfEvent) + */ @Override public void handleData(T data) { super.handleData(data); diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/component/TmfDataProvider.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/component/TmfDataProvider.java index 87369d5190..8a77096bcc 100644 --- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/component/TmfDataProvider.java +++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/component/TmfDataProvider.java @@ -145,8 +145,6 @@ public abstract class TmfDataProvider extends TmfComponent /** * This method queues the coalesced requests. - * - * @param thread */ @Override public void fireRequest() { @@ -390,9 +388,10 @@ public abstract class TmfDataProvider extends TmfComponent /** * Checks if the data meets the request completion criteria. * - * @param request - * @param data - * @return + * @param request the request + * @param data the data to verify + * @param nbRead the number of events read so far + * @return true if completion criteria is met */ public boolean isCompleted(ITmfDataRequest request, T data, int nbRead) { return request.isCompleted() || nbRead >= request.getNbRequested(); diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/component/TmfProviderManager.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/component/TmfProviderManager.java index e7f4bd6213..7754a1416c 100644 --- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/component/TmfProviderManager.java +++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/component/TmfProviderManager.java @@ -54,27 +54,27 @@ public class TmfProviderManager { /** * Re-registers [provider] as a provider of [eventType] * - * @param dataClass + * @param eventType * @param provider */ - public static void deregister(Class dataClass, TmfDataProvider provider) { - List> list = fProviders.get(dataClass); + public static void deregister(Class eventType, TmfDataProvider provider) { + List> list = fProviders.get(eventType); if (list != null) { list.remove(provider); if (list.size() == 0) - fProviders.remove(dataClass); + fProviders.remove(eventType); } } /** * Returns the list of components that provide [eventType] * - * @param dataClass - * @return + * @param eventType + * @return the list of components that provide [eventType] */ @SuppressWarnings("unchecked") - public static TmfDataProvider[] getProviders(Class dataClass) { - List> list = fProviders.get(dataClass); + public static TmfDataProvider[] getProviders(Class eventType) { + List> list = fProviders.get(eventType); if (list == null) list = new ArrayList>(); TmfDataProvider[] result = new TmfDataProvider[list.size()]; @@ -84,20 +84,20 @@ public class TmfProviderManager { /** * Returns the list of components of type [providerType] that provide [eventType] * - * @param type - * @param clazz - * @return + * @param eventType + * @param providerType + * @return the list of components of type [providerType] that provide [eventType] */ @SuppressWarnings("unchecked") - public static TmfDataProvider[] getProviders(Class dataClass, Class> providerClass) { - if (providerClass == null) { - return getProviders(dataClass); + public static TmfDataProvider[] getProviders(Class eventType, Class> providerType) { + if (providerType == null) { + return getProviders(eventType); } - TmfDataProvider[] list = getProviders(dataClass); + TmfDataProvider[] list = getProviders(eventType); List> result = new ArrayList>(); if (list != null) { for (TmfDataProvider provider : list) { - if (provider.getClass() == providerClass) { + if (provider.getClass() == providerType) { result.add(provider); } } diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/ctfadaptor/CtfTmfEvent.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/ctfadaptor/CtfTmfEvent.java index f54556b0b3..85ee867e79 100644 --- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/ctfadaptor/CtfTmfEvent.java +++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/ctfadaptor/CtfTmfEvent.java @@ -201,7 +201,7 @@ public final class CtfTmfEvent implements ITmfEvent { * this ID is not constant from one trace to another for the same event * types! Use "getEventName()" for a constant reference. * - * @return + * @return the event ID */ public long getID() { return this.typeId; diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/ctfadaptor/CtfTmfEventField.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/ctfadaptor/CtfTmfEventField.java index 88c55e1004..20234a1fde 100644 --- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/ctfadaptor/CtfTmfEventField.java +++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/ctfadaptor/CtfTmfEventField.java @@ -139,7 +139,7 @@ public abstract class CtfTmfEventField implements ITmfEventField { /** * Return the int representing this field's value type * - * @return + * @return the field type */ public abstract int getFieldType(); @@ -147,16 +147,17 @@ public abstract class CtfTmfEventField implements ITmfEventField { * Return this field's value. You can cast it to the correct type depending * on what getFieldType says. * - * @return + * @return the field value */ @Override public abstract Object getValue(); /** - * @name Other methods defined by ITmfEventField, but not used here: the CTF + * Other methods defined by ITmfEventField, but not used here: the CTF * fields do not have sub-fields (yet!) + * + * @return the field names */ - @Override public String[] getFieldNames() { return null; diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/event/TmfEvent.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/event/TmfEvent.java index 18dd135064..af67ecf457 100644 --- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/event/TmfEvent.java +++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/event/TmfEvent.java @@ -83,7 +83,7 @@ public class TmfEvent implements ITmfEvent { * @param timestamp the event timestamp * @param source the event source * @param type the event type - * @param type the event content (payload) + * @param content the event content (payload) * @param reference the event reference */ public TmfEvent(ITmfTrace trace, long rank, ITmfTimestamp timestamp, String source, @@ -180,14 +180,14 @@ public class TmfEvent implements ITmfEvent { // ------------------------------------------------------------------------ /** - * @param trace the new event tarce + * @param trace the new event trace */ protected void setTrace(ITmfTrace trace) { fTrace = trace; } /** - * @param source the new event source + * @param rank the new event rank */ protected void setRank(long rank) { fRank = rank; diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/event/TmfEventField.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/event/TmfEventField.java index 598081cb16..4bfad18740 100644 --- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/event/TmfEventField.java +++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/event/TmfEventField.java @@ -52,7 +52,7 @@ public class TmfEventField implements ITmfEventField { * Constructor for a structural field * * @param name the event field id - * @param subfields the list of subfields + * @param fields the list of subfields */ public TmfEventField(String name, ITmfEventField[] fields) { this(name, null, fields); @@ -73,7 +73,7 @@ public class TmfEventField implements ITmfEventField { * * @param name the event field id * @param value the event field value - * @param subfields the list of subfields + * @param fields the list of subfields */ public TmfEventField(String name, Object value, ITmfEventField[] fields) { if (name == null) { diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/experiment/TmfExperiment.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/experiment/TmfExperiment.java index 8744006fdb..f87ab5f241 100644 --- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/experiment/TmfExperiment.java +++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/experiment/TmfExperiment.java @@ -280,8 +280,8 @@ public class TmfExperiment extends TmfEventProvider impl * Returns the rank of the first event with the requested timestamp. If none, returns the index of the next event * (if any). * - * @param timestamp - * @return + * @param timestamp the event timestamp + * @return the corresponding event rank */ @Override public long getRank(ITmfTimestamp timestamp) { @@ -292,8 +292,8 @@ public class TmfExperiment extends TmfEventProvider impl /** * Returns the timestamp of the event at the requested index. If none, returns null. * - * @param index - * @return + * @param index the event index (rank) + * @return the corresponding event timestamp */ public ITmfTimestamp getTimestamp(int index) { TmfExperimentContext context = seekEvent(index); @@ -538,13 +538,6 @@ public class TmfExperiment extends TmfEventProvider impl return null; } - /** - * Scan the next events from all traces and return the next one in chronological order. - * - * @param context - * @return - */ - // private void dumpContext(TmfExperimentContext context, boolean isBefore) { // TmfContext context0 = context.getContexts()[0]; @@ -562,6 +555,12 @@ public class TmfExperiment extends TmfEventProvider impl // Tracer.trace(result.toString()); // } + /** + * Scan the next events from all traces and return the next one in chronological order. + * + * @param context the trace context + * @return the next event + */ @SuppressWarnings("unchecked") @Override public synchronized ITmfEvent getNextEvent(ITmfContext context) { diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/experiment/TmfExperimentCheckpoint.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/experiment/TmfExperimentCheckpoint.java index c3d8d1e57d..5c86755fe6 100644 --- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/experiment/TmfExperimentCheckpoint.java +++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/experiment/TmfExperimentCheckpoint.java @@ -34,8 +34,8 @@ public class TmfExperimentCheckpoint implements ComparableRemove the node from its parent * *

Shifts all nodes after the removed one to prevent having an empty spot. - * See {@link #replaceChildren(int, ITmfFilterTreeNode)} to replace a node.

+ * See {@link #replaceChild(int, ITmfFilterTreeNode)} to replace a node.

* * @return The removed node. */ @@ -80,7 +80,7 @@ public interface ITmfFilterTreeNode extends ITmfFilter { *

Remove the child from the current node

* *

Shifts all nodes after the removed one to prevent having an empty spot. - * See {@link #replaceChildren(int, ITmfFilterTreeNode)} to replace a node.

+ * See {@link #replaceChild(int, ITmfFilterTreeNode)} to replace a node.

* * @return The removed node. */ diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/filter/model/TmfFilterTreeNode.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/filter/model/TmfFilterTreeNode.java index 809fd9f807..52c5bb85de 100644 --- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/filter/model/TmfFilterTreeNode.java +++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/filter/model/TmfFilterTreeNode.java @@ -152,9 +152,9 @@ public abstract class TmfFilterTreeNode implements ITmfFilterTreeNode, Cloneable public abstract boolean matches(ITmfEvent event); /** - * @param event - * @param field - * @return + * @param event the event + * @param field the field id + * @return the field value */ protected Object getFieldValue(ITmfEvent event, String field) { Object value = null; diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/filter/xml/TmfFilterXMLWriter.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/filter/xml/TmfFilterXMLWriter.java index 3e542498d3..337f003b09 100644 --- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/filter/xml/TmfFilterXMLWriter.java +++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/filter/xml/TmfFilterXMLWriter.java @@ -50,8 +50,8 @@ public class TmfFilterXMLWriter { /** * The XMLParser constructor * - * @param uri The XML file to parse - * @throws ParserConfigurationException + * @param root The tree root + * @throws ParserConfigurationException */ public TmfFilterXMLWriter(final ITmfFilterTreeNode root) throws IOException, ParserConfigurationException { DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance(); diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/interval/ITmfStateInterval.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/interval/ITmfStateInterval.java index 397f1af3f1..fd349e5d7c 100644 --- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/interval/ITmfStateInterval.java +++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/interval/ITmfStateInterval.java @@ -29,28 +29,28 @@ public interface ITmfStateInterval { /** * Retrieve the start time of the interval * - * @return + * @return the start time of the interval */ public long getStartTime(); /** * Retrieve the end time of the interval * - * @return + * @return the end time of the interval */ public long getEndTime(); /** * Retrieve the quark of the attribute this state interval refers to * - * @return + * @return the quark of the attribute this state interval refers to */ public int getAttribute(); /** * Retrieve the state value represented by this interval * - * @return + * @return the state value represented by this interval */ public ITmfStateValue getStateValue(); diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/parser/ITmfEventParser.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/parser/ITmfEventParser.java index 0ba4f3180b..abb07bfd71 100644 --- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/parser/ITmfEventParser.java +++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/parser/ITmfEventParser.java @@ -21,13 +21,20 @@ import org.eclipse.linuxtools.tmf.core.trace.ITmfTrace; /** * ITmfEventParser *

- * TODO: Implement me. Please. */ public interface ITmfEventParser { /** - * @return + * @return a parsed event * @throws IOException */ - public ITmfEvent parseNextEvent(ITmfTrace stream, ITmfContext context) throws IOException; + /** + * Parses the trace event referenced by the context. + * + * @param trace the event stream + * @param context the trace context + * @return the parsed event + * @throws IOException + */ + public ITmfEvent parseNextEvent(ITmfTrace trace, ITmfContext context) throws IOException; } diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/request/TmfCoalescedDataRequest.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/request/TmfCoalescedDataRequest.java index 9b015522e7..5d1ad858f4 100644 --- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/request/TmfCoalescedDataRequest.java +++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/request/TmfCoalescedDataRequest.java @@ -19,7 +19,6 @@ import org.eclipse.linuxtools.tmf.core.event.ITmfEvent; /** * TmfCoalescedDataRequest *

- * TODO: Implement me. Please. */ public class TmfCoalescedDataRequest extends TmfDataRequest { @@ -27,6 +26,9 @@ public class TmfCoalescedDataRequest extends TmfDataRequest // Attributes // ------------------------------------------------------------------------ + /** + * The list of coalesced requests + */ protected Vector> fRequests = new Vector>(); // ------------------------------------------------------------------------ @@ -34,50 +36,99 @@ public class TmfCoalescedDataRequest extends TmfDataRequest // ------------------------------------------------------------------------ /** - * Default constructor + * Request all the events of a given type (high priority) + * Events are returned in blocks of the default size (DEFAULT_BLOCK_SIZE). + * + * @param dataType the requested data type */ public TmfCoalescedDataRequest(Class dataType) { this(dataType, 0, ALL_DATA, DEFAULT_BLOCK_SIZE, ExecutionType.FOREGROUND); } - public TmfCoalescedDataRequest(Class dataType, ExecutionType execType) { - this(dataType, 0, ALL_DATA, DEFAULT_BLOCK_SIZE, execType); + /** + * Request all the events of a given type (given priority) + * Events are returned in blocks of the default size (DEFAULT_BLOCK_SIZE). + * + * @param dataType the requested data type + * @param priority the requested execution priority + */ + public TmfCoalescedDataRequest(Class dataType, ExecutionType priority) { + this(dataType, 0, ALL_DATA, DEFAULT_BLOCK_SIZE, priority); } /** - * @param nbRequested + * Request all the events of a given type from the given index (high priority) + * Events are returned in blocks of the default size (DEFAULT_BLOCK_SIZE). + * + * @param dataType the requested data type + * @param index the index of the first event to retrieve */ public TmfCoalescedDataRequest(Class dataType, int index) { this(dataType, index, ALL_DATA, DEFAULT_BLOCK_SIZE, ExecutionType.FOREGROUND); } - public TmfCoalescedDataRequest(Class dataType, int index, ExecutionType execType) { - this(dataType, index, ALL_DATA, DEFAULT_BLOCK_SIZE, execType); + /** + * Request all the events of a given type from the given index (given priority) + * Events are returned in blocks of the default size (DEFAULT_BLOCK_SIZE). + * + * @param dataType the requested data type + * @param index the index of the first event to retrieve + * @param priority the requested execution priority + */ + public TmfCoalescedDataRequest(Class dataType, int index, ExecutionType priority) { + this(dataType, index, ALL_DATA, DEFAULT_BLOCK_SIZE, priority); } /** - * @param index - * @param nbRequested + * Request 'n' events of a given type from the given index (high priority) + * Events are returned in blocks of the default size (DEFAULT_BLOCK_SIZE). + * + * @param dataType the requested data type + * @param index the index of the first event to retrieve + * @param nbRequested the number of events requested */ public TmfCoalescedDataRequest(Class dataType, int index, int nbRequested) { this(dataType, index, nbRequested, DEFAULT_BLOCK_SIZE, ExecutionType.FOREGROUND); } - public TmfCoalescedDataRequest(Class dataType, int index, int nbRequested, ExecutionType execType) { - this(dataType, index, nbRequested, DEFAULT_BLOCK_SIZE, execType); + /** + * Request 'n' events of a given type from the given index (given priority) + * Events are returned in blocks of the default size (DEFAULT_BLOCK_SIZE). + * + * @param dataType the requested data type + * @param index the index of the first event to retrieve + * @param nbRequested the number of events requested + * @param priority the requested execution priority + */ + public TmfCoalescedDataRequest(Class dataType, int index, int nbRequested, ExecutionType priority) { + this(dataType, index, nbRequested, DEFAULT_BLOCK_SIZE, priority); } /** - * @param index - * @param nbRequested - * @param blockSize + * Request 'n' events of a given type from the given index (high priority). + * Events are returned in blocks of the given size. + * + * @param dataType the requested data type + * @param index the index of the first event to retrieve + * @param nbRequested the number of events requested + * @param blockSize the number of events per block */ public TmfCoalescedDataRequest(Class dataType, int index, int nbRequested, int blockSize) { super(dataType, index, nbRequested, blockSize, ExecutionType.FOREGROUND); } - public TmfCoalescedDataRequest(Class dataType, int index, int nbRequested, int blockSize, ExecutionType execType) { - super(dataType, index, nbRequested, blockSize, execType); + /** + * Request 'n' events of a given type from the given index (given priority). + * Events are returned in blocks of the given size. + * + * @param dataType the requested data type + * @param index the index of the first event to retrieve + * @param nbRequested the number of events requested + * @param blockSize the number of events per block + * @param priority the requested execution priority + */ + public TmfCoalescedDataRequest(Class dataType, int index, int nbRequested, int blockSize, ExecutionType priority) { + super(dataType, index, nbRequested, blockSize, priority); } // ------------------------------------------------------------------------ diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/request/TmfCoalescedEventRequest.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/request/TmfCoalescedEventRequest.java index 588a802e50..ac2b5892ff 100644 --- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/request/TmfCoalescedEventRequest.java +++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/request/TmfCoalescedEventRequest.java @@ -19,7 +19,6 @@ import org.eclipse.linuxtools.tmf.core.event.TmfTimeRange; /** * TmfCoalescedEventRequest *

- * TODO: Implement me. Please. */ public class TmfCoalescedEventRequest extends TmfCoalescedDataRequest implements ITmfEventRequest { @@ -34,57 +33,117 @@ public class TmfCoalescedEventRequest extends TmfCoalescedD // ------------------------------------------------------------------------ /** - * @param range + * Request all the events of a given type (high priority) + * Events are returned in blocks of the default size (DEFAULT_BLOCK_SIZE). + * + * @param dataType the requested data type */ public TmfCoalescedEventRequest(Class dataType) { this(dataType, TmfTimeRange.ETERNITY, ALL_DATA, DEFAULT_BLOCK_SIZE, ExecutionType.FOREGROUND); } - public TmfCoalescedEventRequest(Class dataType, ExecutionType execType) { - this(dataType, TmfTimeRange.ETERNITY, ALL_DATA, DEFAULT_BLOCK_SIZE, execType); + /** + * Request all the events of a given type (given priority) + * Events are returned in blocks of the default size (DEFAULT_BLOCK_SIZE). + * + * @param dataType the requested data type + * @param priority the requested execution priority + */ + public TmfCoalescedEventRequest(Class dataType, ExecutionType priority) { + this(dataType, TmfTimeRange.ETERNITY, ALL_DATA, DEFAULT_BLOCK_SIZE, priority); } /** - * @param range + * Request all the events of a given type for the given time range (high priority) + * Events are returned in blocks of the default size (DEFAULT_BLOCK_SIZE). + * + * @param dataType the requested data type + * @param range the time range of the requested events */ public TmfCoalescedEventRequest(Class dataType, TmfTimeRange range) { this(dataType, range, ALL_DATA, DEFAULT_BLOCK_SIZE, ExecutionType.FOREGROUND); } - public TmfCoalescedEventRequest(Class dataType, TmfTimeRange range, ExecutionType execType) { - this(dataType, range, ALL_DATA, DEFAULT_BLOCK_SIZE, execType); + /** + * Request all the events of a given type for the given time range (given priority) + * Events are returned in blocks of the default size (DEFAULT_BLOCK_SIZE). + * + * @param dataType the requested data type + * @param range the time range of the requested events + * @param priority the requested execution priority + */ + public TmfCoalescedEventRequest(Class dataType, TmfTimeRange range, ExecutionType priority) { + this(dataType, range, ALL_DATA, DEFAULT_BLOCK_SIZE, priority); } /** - * @param range - * @param nbRequested + * Request 'n' events of a given type from the given time range (high priority) + * Events are returned in blocks of the default size (DEFAULT_BLOCK_SIZE). + * + * @param dataType the requested data type + * @param range the time range of the requested events + * @param nbRequested the number of events requested */ public TmfCoalescedEventRequest(Class dataType, TmfTimeRange range, int nbRequested) { this(dataType, range, nbRequested, DEFAULT_BLOCK_SIZE, ExecutionType.FOREGROUND); } - - public TmfCoalescedEventRequest(Class dataType, TmfTimeRange range, int nbRequested, ExecutionType execType) { - this(dataType, range, nbRequested, DEFAULT_BLOCK_SIZE, execType); + + /** + * Request 'n' events of a given type for the given time range (given priority) + * Events are returned in blocks of the default size (DEFAULT_BLOCK_SIZE). + * + * @param dataType the requested data type + * @param range the time range of the requested events + * @param nbRequested the number of events requested + * @param priority the requested execution priority + */ + public TmfCoalescedEventRequest(Class dataType, TmfTimeRange range, int nbRequested, ExecutionType priority) { + this(dataType, range, nbRequested, DEFAULT_BLOCK_SIZE, priority); } - + /** - * @param range - * @param nbRequested - * @param blockSize Size of the largest blocks expected + * Request 'n' events of a given type for the given time range (high priority). + * Events are returned in blocks of the given size. + * + * @param dataType the requested data type + * @param range the time range of the requested events + * @param nbRequested the number of events requested + * @param blockSize the number of events per block */ public TmfCoalescedEventRequest(Class dataType, TmfTimeRange range, int nbRequested, int blockSize) { - super(dataType, 0, nbRequested, blockSize, ExecutionType.FOREGROUND); - fRange = range; + super(dataType, 0, nbRequested, blockSize, ExecutionType.FOREGROUND); + fRange = range; } - public TmfCoalescedEventRequest(Class dataType, TmfTimeRange range, int nbRequested, int blockSize, ExecutionType execType) { - super(dataType, 0, nbRequested, blockSize, execType); - fRange = range; + /** + * Request 'n' events of a given type for the given time range (given priority). + * Events are returned in blocks of the given size. + * + * @param dataType the requested data type + * @param range the time range of the requested events + * @param nbRequested the number of events requested + * @param blockSize the number of events per block + * @param priority the requested execution priority + */ + public TmfCoalescedEventRequest(Class dataType, TmfTimeRange range, int nbRequested, int blockSize, ExecutionType priority) { + super(dataType, 0, nbRequested, blockSize, priority); + fRange = range; } - public TmfCoalescedEventRequest(Class dataType, TmfTimeRange range, int index, int nbRequested, int blockSize, ExecutionType execType) { - super(dataType, index, nbRequested, blockSize, execType); - fRange = range; + /** + * Request 'n' events of a given type for the given time range (given priority). + * Events are returned in blocks of the given size. + * + * @param dataType the requested data type + * @param range the time range of the requested events + * @param index the index of the first event to retrieve + * @param nbRequested the number of events requested + * @param blockSize the number of events per block + * @param priority the requested execution priority + */ + public TmfCoalescedEventRequest(Class dataType, TmfTimeRange range, int index, int nbRequested, int blockSize, ExecutionType priority) { + super(dataType, index, nbRequested, blockSize, priority); + fRange = range; } // ------------------------------------------------------------------------ diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/request/TmfDataRequest.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/request/TmfDataRequest.java index 568d524f6f..2a28f00ddc 100644 --- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/request/TmfDataRequest.java +++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/request/TmfDataRequest.java @@ -114,70 +114,104 @@ public abstract class TmfDataRequest implements ITmfDataReq } /** - * Default constructor + * Request all the events of a given type (high priority) + * Events are returned in blocks of the default size (DEFAULT_BLOCK_SIZE). * - * @param dataType - * the requested data type + * @param dataType the requested data type */ public TmfDataRequest(Class dataType) { this(dataType, 0, ALL_DATA, DEFAULT_BLOCK_SIZE, ExecutionType.FOREGROUND); } - public TmfDataRequest(Class dataType, ExecutionType execType) { - this(dataType, 0, ALL_DATA, DEFAULT_BLOCK_SIZE, execType); + /** + * Request all the events of a given type (given priority) + * Events are returned in blocks of the default size (DEFAULT_BLOCK_SIZE). + * + * @param dataType the requested data type + * @param priority the requested execution priority + */ + public TmfDataRequest(Class dataType, ExecutionType priority) { + this(dataType, 0, ALL_DATA, DEFAULT_BLOCK_SIZE, priority); } /** - * @param dataType - * the requested data type - * @param nbRequested - * the number of data items requested + * Request all the events of a given type from the given index (high priority) + * Events are returned in blocks of the default size (DEFAULT_BLOCK_SIZE). + * + * @param dataType the requested data type + * @param index the index of the first event to retrieve */ public TmfDataRequest(Class dataType, int index) { this(dataType, index, ALL_DATA, DEFAULT_BLOCK_SIZE, ExecutionType.FOREGROUND); } - public TmfDataRequest(Class dataType, int index, ExecutionType execType) { - this(dataType, index, ALL_DATA, DEFAULT_BLOCK_SIZE, execType); + /** + * Request all the events of a given type from the given index (given priority) + * Events are returned in blocks of the default size (DEFAULT_BLOCK_SIZE). + * + * @param dataType the requested data type + * @param index the index of the first event to retrieve + * @param priority the requested execution priority + */ + public TmfDataRequest(Class dataType, int index, ExecutionType priority) { + this(dataType, index, ALL_DATA, DEFAULT_BLOCK_SIZE, priority); } /** - * @param dataType - * the requested data type - * @param index - * the index (rank) of the first event requested - * @param blockSize - * the number of data items per block + * Request 'n' events of a given type from the given index (high priority) + * Events are returned in blocks of the default size (DEFAULT_BLOCK_SIZE). + * + * @param dataType the requested data type + * @param index the index of the first event to retrieve + * @param nbRequested the number of events requested */ public TmfDataRequest(Class dataType, int index, int nbRequested) { this(dataType, index, nbRequested, DEFAULT_BLOCK_SIZE, ExecutionType.FOREGROUND); } - public TmfDataRequest(Class dataType, int index, int nbRequested, ExecutionType execType) { - this(dataType, index, nbRequested, DEFAULT_BLOCK_SIZE, execType); + /** + * Request 'n' events of a given type from the given index (given priority) + * Events are returned in blocks of the default size (DEFAULT_BLOCK_SIZE). + * + * @param dataType the requested data type + * @param index the index of the first event to retrieve + * @param nbRequested the number of events requested + * @param priority the requested execution priority + */ + public TmfDataRequest(Class dataType, int index, int nbRequested, ExecutionType priority) { + this(dataType, index, nbRequested, DEFAULT_BLOCK_SIZE, priority); } /** - * @param dataType - * the requested data type - * @param index - * the index (rank) of the first event requested - * @param nbRequested - * the number of data items requested - * @param blockSize - * the number of data items per block + * Request 'n' events of a given type from the given index (high priority). + * Events are returned in blocks of the given size. + * + * @param dataType the requested data type + * @param index the index of the first event to retrieve + * @param nbRequested the number of events requested + * @param blockSize the number of events per block */ public TmfDataRequest(Class dataType, int index, int nbRequested, int blockSize) { this(dataType, index, nbRequested, blockSize, ExecutionType.FOREGROUND); } - public TmfDataRequest(Class dataType, int index, int nbRequested, int blockSize, ExecutionType execType) { + /** + * Request 'n' events of a given type from the given index (given priority). + * Events are returned in blocks of the given size. + * + * @param dataType the requested data type + * @param index the index of the first event to retrieve + * @param nbRequested the number of events requested + * @param blockSize the number of events per block + * @param priority the requested execution priority + */ + public TmfDataRequest(Class dataType, int index, int nbRequested, int blockSize, ExecutionType priority) { fRequestId = fRequestNumber++; fDataType = dataType; fIndex = index; fNbRequested = nbRequested; fBlockSize = blockSize; - fExecType = execType; + fExecType = priority; fNbRead = 0; fRequestRunning = false; @@ -218,7 +252,7 @@ public abstract class TmfDataRequest implements ITmfDataReq } /** - * @return the index of the first event requested + * @return the execution type (priority) */ @Override public ExecutionType getExecType() { @@ -250,7 +284,7 @@ public abstract class TmfDataRequest implements ITmfDataReq } /** - * @return indicates if the request is completed + * @return indicates if the request is currently running */ @Override public synchronized boolean isRunning() { @@ -266,7 +300,7 @@ public abstract class TmfDataRequest implements ITmfDataReq } /** - * @return indicates if the request is canceled + * @return indicates if the request has failed */ @Override public synchronized boolean isFailed() { @@ -308,23 +342,19 @@ public abstract class TmfDataRequest implements ITmfDataReq // ------------------------------------------------------------------------ /** - * Sets the data object to specified value. To be called by the asynchronous method implementor. - * - * @param data - * Data value to set. - */ - - /** - * Handle a block of incoming data. This method is called every time a block of data becomes available. + * Handle incoming data, one event at a time i.e. this method is invoked + * for every data item obtained by the request. * - * - Data items are received in the order they appear in the stream. - Called by the request processor, in its - * execution thread, every time a block of data becomes available. - Request processor performs a synchronous call - * to handlePartialResult() i.e. its execution threads holds until handlePartialData() returns. - Original data - * items are disposed of on return i.e. keep a reference (or a copy) if some persistence is needed between - * invocations. - When there is no more data, done() is called. + * - Data items are received in the order they appear in the stream + * - Called by the request processor, in its execution thread, every time + * a block of data becomes available. + * - Request processor performs a synchronous call to handleData() i.e. + * its execution threads holds until handleData() returns. + * - Original data items are disposed of on return i.e. keep a reference + * (or a copy) if some persistence is needed between invocations. + * - When there is no more data, done() is called. * - * @param events - * - an events + * @param data a piece of data */ @Override public void handleData(T data) { @@ -340,11 +370,14 @@ public abstract class TmfDataRequest implements ITmfDataReq } /** - * Handle the completion of the request. It is called when there is no more data available either because: - the - * request completed normally - the request failed - the request was canceled + * Handle the completion of the request. It is called when there is no + * more data available either because: + * - the request completed normally + * - the request failed + * - the request was canceled * - * As a convenience, handleXXXX methods are provided. They are meant to be overridden by the application if it needs - * to handle these conditions. + * As a convenience, handleXXXX methods are provided. They are meant to be + * overridden by the application if it needs to handle these conditions. */ @Override public synchronized void handleCompleted() { diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/request/TmfEventRequest.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/request/TmfEventRequest.java index e8ff77ae0f..eb5f9d5987 100644 --- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/request/TmfEventRequest.java +++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/request/TmfEventRequest.java @@ -33,54 +33,114 @@ public abstract class TmfEventRequest extends TmfDataReques // ------------------------------------------------------------------------ /** - * @param range + * Request all the events of a given type (high priority) + * Events are returned in blocks of the default size (DEFAULT_BLOCK_SIZE). + * + * @param dataType the requested data type */ public TmfEventRequest(Class dataType) { this(dataType, TmfTimeRange.ETERNITY, 0, ALL_DATA, DEFAULT_BLOCK_SIZE, ExecutionType.FOREGROUND); } - public TmfEventRequest(Class dataType, ExecutionType execType) { - this(dataType, TmfTimeRange.ETERNITY, 0, ALL_DATA, DEFAULT_BLOCK_SIZE, execType); + /** + * Request all the events of a given type (given priority) + * Events are returned in blocks of the default size (DEFAULT_BLOCK_SIZE). + * + * @param dataType the requested data type + * @param priority the requested execution priority + */ + public TmfEventRequest(Class dataType, ExecutionType priority) { + this(dataType, TmfTimeRange.ETERNITY, 0, ALL_DATA, DEFAULT_BLOCK_SIZE, priority); } /** - * @param range + * Request all the events of a given type for the given time range (high priority) + * Events are returned in blocks of the default size (DEFAULT_BLOCK_SIZE). + * + * @param dataType the requested data type + * @param range the time range of the requested events */ public TmfEventRequest(Class dataType, TmfTimeRange range) { this(dataType, range, 0, ALL_DATA, DEFAULT_BLOCK_SIZE, ExecutionType.FOREGROUND); } - public TmfEventRequest(Class dataType, TmfTimeRange range, ExecutionType execType) { - this(dataType, range, 0, ALL_DATA, DEFAULT_BLOCK_SIZE, execType); + /** + * Request all the events of a given type for the given time range (given priority) + * Events are returned in blocks of the default size (DEFAULT_BLOCK_SIZE). + * + * @param dataType the requested data type + * @param range the time range of the requested events + * @param priority the requested execution priority + */ + public TmfEventRequest(Class dataType, TmfTimeRange range, ExecutionType priority) { + this(dataType, range, 0, ALL_DATA, DEFAULT_BLOCK_SIZE, priority); } /** - * @param range - * @param nbRequested + * Request 'n' events of a given type from the given time range (high priority) + * Events are returned in blocks of the default size (DEFAULT_BLOCK_SIZE). + * + * @param dataType the requested data type + * @param range the time range of the requested events + * @param nbRequested the number of events requested */ public TmfEventRequest(Class dataType, TmfTimeRange range, int nbRequested) { this(dataType, range, 0, nbRequested, DEFAULT_BLOCK_SIZE, ExecutionType.FOREGROUND); } - public TmfEventRequest(Class dataType, TmfTimeRange range, int nbRequested, ExecutionType execType) { - this(dataType, range, 0, nbRequested, DEFAULT_BLOCK_SIZE, execType); + /** + * Request 'n' events of a given type for the given time range (given priority) + * Events are returned in blocks of the default size (DEFAULT_BLOCK_SIZE). + * + * @param dataType the requested data type + * @param range the time range of the requested events + * @param nbRequested the number of events requested + * @param priority the requested execution priority + */ + public TmfEventRequest(Class dataType, TmfTimeRange range, int nbRequested, ExecutionType priority) { + this(dataType, range, 0, nbRequested, DEFAULT_BLOCK_SIZE, priority); } /** - * @param range - * @param nbRequested - * @param blockSize Size of the largest blocks expected + * Request 'n' events of a given type for the given time range (high priority). + * Events are returned in blocks of the given size. + * + * @param dataType the requested data type + * @param range the time range of the requested events + * @param nbRequested the number of events requested + * @param blockSize the number of events per block */ public TmfEventRequest(Class dataType, TmfTimeRange range, int nbRequested, int blockSize) { this(dataType, range, 0, nbRequested, blockSize, ExecutionType.FOREGROUND); } - public TmfEventRequest(Class dataType, TmfTimeRange range, int nbRequested, int blockSize, ExecutionType execType) { - this(dataType, range, 0, nbRequested, blockSize, execType); + /** + * Request 'n' events of a given type for the given time range (given priority). + * Events are returned in blocks of the given size. + * + * @param dataType the requested data type + * @param range the time range of the requested events + * @param nbRequested the number of events requested + * @param blockSize the number of events per block + * @param priority the requested execution priority + */ + public TmfEventRequest(Class dataType, TmfTimeRange range, int nbRequested, int blockSize, ExecutionType priority) { + this(dataType, range, 0, nbRequested, blockSize, priority); } - public TmfEventRequest(Class dataType, TmfTimeRange range, int index, int nbRequested, int blockSize, ExecutionType execType) { - super(dataType, index, nbRequested, blockSize, execType); + /** + * Request 'n' events of a given type for the given time range (given priority). + * Events are returned in blocks of the given size. + * + * @param dataType the requested data type + * @param range the time range of the requested events + * @param index the index of the first event to retrieve + * @param nbRequested the number of events requested + * @param blockSize the number of events per block + * @param priority the requested execution priority + */ + public TmfEventRequest(Class dataType, TmfTimeRange range, int index, int nbRequested, int blockSize, ExecutionType priority) { + super(dataType, index, nbRequested, blockSize, priority); fRange = range; } @@ -103,7 +163,8 @@ public abstract class TmfEventRequest extends TmfDataReques /** * this method is called by the event provider to set the index corresponding * to the time range start time once it is known - * @param index the start time index + * + * @param index the start index */ @Override public void setStartIndex(int index) { diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/statesystem/backend/historytree/HistoryTreeBackend.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/statesystem/backend/historytree/HistoryTreeBackend.java index 2469b3c190..d834cb4442 100644 --- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/statesystem/backend/historytree/HistoryTreeBackend.java +++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/statesystem/backend/historytree/HistoryTreeBackend.java @@ -80,7 +80,7 @@ public class HistoryTreeBackend implements IStateHistoryBackend { /** * Existing history constructor. Use this to open an existing state-file. * - * @param existingFileName + * @param existingStateFile * Filename/location of the history we want to load * @throws IOException * If we can't read the file, if it doesn't exist or is not diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/trace/ITmfTrace.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/trace/ITmfTrace.java index 2b5cf66beb..0054c5feff 100644 --- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/trace/ITmfTrace.java +++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/trace/ITmfTrace.java @@ -82,8 +82,6 @@ public interface ITmfTrace extends ITmfComponent { * Returns a context which can later be used to read the event. * * @param location - * @param timestamp - * @param rank * @return a context object for subsequent reads */ public ITmfContext seekLocation(ITmfLocation location); @@ -118,8 +116,8 @@ public interface ITmfTrace extends ITmfComponent { * Returns the rank of the first event with the requested timestamp. If none, returns the index of the next event * (if any). * - * @param timestamp - * @return + * @param timestamp the requested event timestamp + * @return the corresponding event rank */ public long getRank(ITmfTimestamp timestamp); diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/trace/TmfTrace.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/trace/TmfTrace.java index 8023d1b60e..cb1a159569 100644 --- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/trace/TmfTrace.java +++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/trace/TmfTrace.java @@ -257,8 +257,8 @@ public abstract class TmfTrace extends TmfEventProvider * Returns the rank of the first event with the requested timestamp. If none, returns the index of the next event * (if any). * - * @param timestamp - * @return + * @param timestamp the requested event timestamp + * @return the corresponding event rank */ @Override public long getRank(ITmfTimestamp timestamp) { @@ -304,7 +304,7 @@ public abstract class TmfTrace extends TmfEventProvider * subsequent read. * * @param context - * @return + * @return the event referred to by context */ @SuppressWarnings("unchecked") @Override diff --git a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/viewers/events/TmfEventsTable.java b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/viewers/events/TmfEventsTable.java index 9e8c889dc5..ab962d85f1 100644 --- a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/viewers/events/TmfEventsTable.java +++ b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/viewers/events/TmfEventsTable.java @@ -642,9 +642,9 @@ public class TmfEventsTable extends TmfComponent implements IGotoMarker, IColorS } /** - * @param table + * @param columnData * - * FIXME: Add support for column selection + * FIXME: Add support for column selection */ protected void setColumnHeaders(ColumnData[] columnData) { fTable.setColumnHeaders(columnData); diff --git a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/viewers/timeAnalysis/ITimeAnalysisViewer.java b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/viewers/timeAnalysis/ITimeAnalysisViewer.java index 86818e6c40..c7155afec4 100644 --- a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/viewers/timeAnalysis/ITimeAnalysisViewer.java +++ b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/viewers/timeAnalysis/ITimeAnalysisViewer.java @@ -189,7 +189,7 @@ public interface ITimeAnalysisViewer extends ITmfViewer { /** * Set the top index - * @param the top index + * @param index the top index */ public void setTopIndex(int index); diff --git a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/viewers/timeAnalysis/TmfTimeAnalysisProvider.java b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/viewers/timeAnalysis/TmfTimeAnalysisProvider.java index 89ca2aa0a5..944c8012ee 100644 --- a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/viewers/timeAnalysis/TmfTimeAnalysisProvider.java +++ b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/viewers/timeAnalysis/TmfTimeAnalysisProvider.java @@ -191,7 +191,7 @@ public abstract class TmfTimeAnalysisProvider { * convert it to an internal color index * * @param event - * @return + * @return the internal color index */ public int getEventColorVal(ITimeEvent event) { StateColor colors = getEventColor(event); @@ -234,7 +234,7 @@ public abstract class TmfTimeAnalysisProvider { * Select the color for the different internal variants of events. * * @param event - * @return + * @return the corresponding event color */ public abstract StateColor getEventColor(ITimeEvent event); @@ -244,7 +244,7 @@ public abstract class TmfTimeAnalysisProvider { * [java.lang.Thread] * * @param trace - * @return + * @return the trace class name */ public abstract String getTraceClassName(ITmfTimeAnalysisEntry trace); @@ -261,7 +261,7 @@ public abstract class TmfTimeAnalysisProvider { * True return String value in Upper case * @param extInfo * Verbose, add additional information if applicable - * @return + * @return the event name */ public abstract String getEventName(ITimeEvent event, boolean upper, boolean extInfo); @@ -303,7 +303,7 @@ public abstract class TmfTimeAnalysisProvider { * different icons according to specific event /state combination * * @param obj - * @return + * @return the image icon */ public Image getItemImage(Object obj) { /* diff --git a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/viewers/timeAnalysis/TmfTimeAnalysisViewer.java b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/viewers/timeAnalysis/TmfTimeAnalysisViewer.java index e6f930454e..33a11e7bc5 100644 --- a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/viewers/timeAnalysis/TmfTimeAnalysisViewer.java +++ b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/viewers/timeAnalysis/TmfTimeAnalysisViewer.java @@ -903,7 +903,7 @@ public class TmfTimeAnalysisViewer implements ITimeAnalysisViewer, ITimeDataProv /** * needed in case there's a need to associate a context menu * - * @return + * @return the state control (selection provider) */ @Override public Control getControl() { @@ -913,7 +913,7 @@ public class TmfTimeAnalysisViewer implements ITimeAnalysisViewer, ITimeDataProv /** * Get the selection provider * - * @return + * @return the selection provider */ @Override public ISelectionProvider getSelectionProvider() { diff --git a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/viewers/timeAnalysis/TmfTimeScaleSelectionEvent.java b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/viewers/timeAnalysis/TmfTimeScaleSelectionEvent.java index 27def26d19..9b9dec7b81 100644 --- a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/viewers/timeAnalysis/TmfTimeScaleSelectionEvent.java +++ b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/viewers/timeAnalysis/TmfTimeScaleSelectionEvent.java @@ -49,28 +49,28 @@ public class TmfTimeScaleSelectionEvent extends EventObject { } /** - * @return + * @return the start time */ public long getTime0() { return time0; } /** - * @return + * @return the end time */ public long getTime1() { return time1; } /** - * @return + * @return the selection width */ public int getWidth() { return width; } /** - * @return + * @return the selected time */ public long getSelectedTime() { return selectedTime; diff --git a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/viewers/timeAnalysis/model/ITimeEvent.java b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/viewers/timeAnalysis/model/ITimeEvent.java index 56ca0db2e6..9babd7a1de 100644 --- a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/viewers/timeAnalysis/model/ITimeEvent.java +++ b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/viewers/timeAnalysis/model/ITimeEvent.java @@ -19,11 +19,13 @@ public interface ITimeEvent { public long getTime(); /** - * Returning

  • -1: Considers duration to be from current event till - * the next
  • 0: Duration is not relevant e.g. a Burst / no state - * associated
  • >0: Valid duration value specified - * * @return + * + *
  • -1: Considers duration to be from current event till the next
    • + *
  • 0: Duration is not relevant e.g. a Burst / no state associated
    • + *
  • >0: Valid duration value specified
    • + * + *

    */ public long getDuration(); diff --git a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/viewers/timeAnalysis/widgets/Utils.java b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/viewers/timeAnalysis/widgets/Utils.java index bd9d6d803f..4cd5f8614b 100644 --- a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/viewers/timeAnalysis/widgets/Utils.java +++ b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/viewers/timeAnalysis/widgets/Utils.java @@ -149,27 +149,27 @@ public class Utils { } /** - * Formats time in format: MM:SS:NNN - * - * @param v - * @param option - * 0: MMMM:ss:nnnnnnnnn, 1: HH:MM:ss MMM.mmmm.nnn - * @return + * Formats time in format: MM:SS:NNN + * + * @param time time + * @param format 0: MMMM:ss:nnnnnnnnn, 1: HH:MM:ss MMM.mmmm.nnn + * @param resolution the resolution + * @return the formatted time */ - static public String formatTime(long v, TimeFormat format, Resolution res) { + static public String formatTime(long time, TimeFormat format, Resolution resolution) { // if format is absolute (Calendar) if (format == TimeFormat.ABSOLUTE) { - return formatTimeAbs(v, res); + return formatTimeAbs(time, resolution); } StringBuffer str = new StringBuffer(); - boolean neg = v < 0; + boolean neg = time < 0; if (neg) { - v = -v; + time = -time; str.append('-'); } - long sec = (long) (v * 1E-9); + long sec = (long) (time * 1E-9); // TODO: Expand to make it possible to select the minute, second, nanosecond format //printing minutes is suppressed just sec and ns // if (sec / 60 < 10) @@ -180,7 +180,7 @@ public class Utils { // if (sec < 10) // str.append('0'); str.append(sec); - String ns = formatNs(v, res); + String ns = formatNs(time, resolution); if (!ns.equals("")) { //$NON-NLS-1$ str.append(':'); str.append(ns); @@ -193,7 +193,7 @@ public class Utils { * From input time in nanoseconds, convert to Date format YYYY-MM-dd * * @param absTime - * @return + * @return the formatted date */ public static String formatDate(long absTime) { String sdate = sdateformat.format(new Date((long) (absTime * 1E-6))); @@ -204,7 +204,7 @@ public class Utils { * Formats time in ns to Calendar format: HH:MM:SS MMM.mmm.nnn * * @param time - * @return + * @return the formatted time */ static public String formatTimeAbs(long time, Resolution res) { StringBuffer str = new StringBuffer(); @@ -226,7 +226,7 @@ public class Utils { * * @param time * @param res - * @return + * @return the formatted nanosec */ public static String formatNs(long time, Resolution res) { StringBuffer temp = new StringBuffer(); diff --git a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/filter/FilterDialog.java b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/filter/FilterDialog.java index 4efcb6164a..bf486d99ec 100644 --- a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/filter/FilterDialog.java +++ b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/filter/FilterDialog.java @@ -46,7 +46,7 @@ public class FilterDialog extends Dialog { } /** - * @param fFilter the filter to set + * @param filter the filter to set */ public void setFilter(ITmfFilterTreeNode filter) { fRoot = new TmfFilterNode(null); @@ -59,7 +59,7 @@ public class FilterDialog extends Dialog { } /** - * @return the fFilter + * @return the filter */ public ITmfFilterTreeNode getFilter() { if (fRoot != null && fRoot.hasChildren()) { diff --git a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/histogram/HistogramDataModel.java b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/histogram/HistogramDataModel.java index 31b9065a0d..a2394a0478 100644 --- a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/histogram/HistogramDataModel.java +++ b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/histogram/HistogramDataModel.java @@ -302,7 +302,7 @@ public class HistogramDataModel implements IHistogramDataModel { * * @param width * @param height - * @param bar width + * @param barWidth * @return the result array of size [width] and where the highest value * doesn't exceed [height] */ diff --git a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/histogram/IHistogramDataModel.java b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/histogram/IHistogramDataModel.java index b61d7c24bf..3e793d5394 100644 --- a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/histogram/IHistogramDataModel.java +++ b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/histogram/IHistogramDataModel.java @@ -24,6 +24,7 @@ public interface IHistogramDataModel extends IBaseDistributionModel { /** * Add event to the correct bucket, compacting the if needed. * + * @param eventCount the event to count * @param timestamp the timestamp of the event to count */ public void countEvent(long eventCount, long timestamp); @@ -33,7 +34,7 @@ public interface IHistogramDataModel extends IBaseDistributionModel { * * @param width * @param height - * @param bar width + * @param barWidth * @return the result array of size [width] and where the highest value * doesn't exceed [height] considering the bar width [barWidth] */ diff --git a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/statistics/TmfStatisticsView.java b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/statistics/TmfStatisticsView.java index 4418963f61..39ce347644 100755 --- a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/statistics/TmfStatisticsView.java +++ b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/statistics/TmfStatisticsView.java @@ -455,8 +455,9 @@ public class TmfStatisticsView extends TmfView { /** * Perform the request for an experiment and populates the statistics tree with event. + * * @param experiment experiment for which we need the statistics data. - * @param time range to request + * @param timeRange to request */ @SuppressWarnings("unchecked") protected void requestData(final TmfExperiment experiment, TmfTimeRange timeRange) { diff --git a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/statistics/model/TmfStatisticsTreeRootFactory.java b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/statistics/model/TmfStatisticsTreeRootFactory.java index 86794382ec..24bdc65be9 100755 --- a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/statistics/model/TmfStatisticsTreeRootFactory.java +++ b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/statistics/model/TmfStatisticsTreeRootFactory.java @@ -32,7 +32,7 @@ public class TmfStatisticsTreeRootFactory { /** * Provide a statisticsTree instance per trace * - * @return + * @return the corresponding trace statistics tree */ public static TmfStatisticsTreeNode getStatTreeRoot(String traceUniqueId) { @@ -46,7 +46,7 @@ public class TmfStatisticsTreeRootFactory { /** * * @param traceUniqueId - * @return + * @return the corresponding trace statistics tree */ public static AbsTmfStatisticsTree getStatTree(String traceUniqueId) { if (traceUniqueId == null) @@ -59,10 +59,10 @@ public class TmfStatisticsTreeRootFactory { /** * Add the new trace statistics data in the tree. Can be used later on if the same traces is selected back. * - * @param experimentName + * @param traceUniqueId * the name of the trace which will be used as a key to store the data. Must be different for each traces, otherwise the traces might * be overwritten which would trigger a reload of the same trace. - * @param data + * @param statsData * the information about the trace */ public static void addStatsTreeRoot(String traceUniqueId, AbsTmfStatisticsTree statsData) { @@ -77,7 +77,7 @@ public class TmfStatisticsTreeRootFactory { /** * * @param traceUniqueId - * @return + * @return true if the trace id is known */ public static boolean containsTreeRoot(String traceUniqueId) { return fTreeInstances.containsKey(traceUniqueId); diff --git a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/DrawableToolTip.java b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/DrawableToolTip.java index 4d8be6b97f..cf656fc1a5 100755 --- a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/DrawableToolTip.java +++ b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/DrawableToolTip.java @@ -88,14 +88,13 @@ public class DrawableToolTip implements PaintListener { * Display the tooltip using the given time range(min,max) the current value and the time unit The tooltip will stay * on screen until it is told otherwise * - * @param _value the current in the scale - * @param _min the scale min - * @param _max the scale max - * @param unit the scale unit + * @param value the current in the scale + * @param min the scale min + * @param max the scale max */ - public void showToolTip(ITmfTimestamp _value, ITmfTimestamp min, ITmfTimestamp max) { + public void showToolTip(ITmfTimestamp value, ITmfTimestamp min, ITmfTimestamp max) { minMaxRange = new TmfTimeRange(min.clone(), max.clone()); - currentValue = _value.clone(); + currentValue = value.clone(); int w = toolTipShell.getBounds().width; int h = toolTipShell.getBounds().height; diff --git a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/SDView.java b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/SDView.java index 44b11c329e..6cf17fade5 100755 --- a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/SDView.java +++ b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/SDView.java @@ -848,7 +848,9 @@ public class SDView extends ViewPart { /** * Set the frame and ensure an object is visible from an other thread than the one executing the main loop * - * @param sm + * @param frame + * @param x + * @param y */ public void setFrameAndEnsureVisibleSync(final Frame frame, final int x, final int y) { if (getSDWidget() == null || getSDWidget().isDisposed()) { @@ -866,7 +868,9 @@ public class SDView extends ViewPart { /** * Set the frame and ensure an object is visible * - * @param sm + * @param frame + * @param x + * @param y */ public void setFrameAndEnsureVisible(Frame frame, int x, int y) { getSDWidget().clearSelection(); @@ -882,6 +886,8 @@ public class SDView extends ViewPart { /** * Toggle between default and wait cursors from an other thread than the one executing the main loop + * + * @param wait_ */ public void toggleWaitCursorAsync(final boolean wait_) { if (getSDWidget() == null || getSDWidget().isDisposed()) { diff --git a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/ScrollView.java b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/ScrollView.java index 39ae809cbe..9b8faafbea 100755 --- a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/ScrollView.java +++ b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/ScrollView.java @@ -803,52 +803,52 @@ public class ScrollView extends Composite { /** * Change the size of the contents area. * - * @param w new width of the area. - * @param h new height of the area. + * @param width new width of the area. + * @param height new height of the area. */ - public void resizeContents(int _w, int _h) { + public void resizeContents(int width, int height) { // System.out.println("SV--resizeContents("+_w+","+_h+" ) {"); - if (_w < 0) - _w = 0; - if (_h < 0) - _h = 0; + if (width < 0) + width = 0; + if (height < 0) + height = 0; int oldW = contents_width_; int oldH = contents_height_; - if (_w == oldW && _h == oldH) + if (width == oldW && height == oldH) return; // System.out.println("RESIZE-CONTENTS("+_w+","+_h+")"); - contents_width_ = _w; - contents_height_ = _h; + contents_width_ = width; + contents_height_ = height; - if (oldW > _w) { - int s = _w; - _w = oldW; + if (oldW > width) { + int s = width; + width = oldW; oldW = s; } int vis_width = getVisibleWidth(); int vis_height = getVisibleHeight(); if (oldW < vis_width) { - if (_w > vis_width) { - _w = vis_width; + if (width > vis_width) { + width = vis_width; } - viewcontrol_.redraw(getContentsX() + oldW, 0, _w - oldW, vis_height, true); + viewcontrol_.redraw(getContentsX() + oldW, 0, width - oldW, vis_height, true); } - if (oldH > _h) { - int s = _h; - _h = oldH; + if (oldH > height) { + int s = height; + height = oldH; oldH = s; } if (oldH < vis_height) { - if (_h > vis_height) { - _h = vis_height; + if (height > vis_height) { + height = vis_height; } - viewcontrol_.redraw(0, getContentsY() + oldH, vis_width, _h - oldH, true); + viewcontrol_.redraw(0, getContentsY() + oldH, vis_width, height - oldH, true); } if (updateScrollBarVisiblity()) { layout(); @@ -1247,8 +1247,8 @@ public class ScrollView extends Composite { * @param y * @return org.eclipse.swt.graphics.Point */ - public final Point viewToContents(int _x, int _y) { - Point p = new Point(viewToContentsX(_x), viewToContentsY(_y)); + public final Point viewToContents(int x, int y) { + Point p = new Point(viewToContentsX(x), viewToContentsY(y)); return p; } @@ -1269,8 +1269,8 @@ public class ScrollView extends Composite { * @param y * @return org.eclipse.swt.graphics.Point */ - public final Point contentsToView(int _x, int _y) { - Point p = new Point(contentsToViewX(_x), contentsToViewY(_y)); + public final Point contentsToView(int x, int y) { + Point p = new Point(contentsToViewX(x), contentsToViewY(y)); return p; } @@ -1336,8 +1336,6 @@ public class ScrollView extends Composite { /** * Called when ScrollView view is resized. - * - * @param _event */ protected void viewResized() { // System.out.println("SV--viewResizeEvent()"); diff --git a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/core/AsyncMessage.java b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/core/AsyncMessage.java index 5dfaa9e972..20c58fee29 100755 --- a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/core/AsyncMessage.java +++ b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/core/AsyncMessage.java @@ -164,7 +164,6 @@ public class AsyncMessage extends BaseMessage implements ITimeRange { * A new EventOccurence will be create on this lifeLine.
    * * @param lifeline the message sender - * @param autoCreateEvent if true, create an eventOccurence lifeline given in parameter */ public void autoSetStartLifeline(Lifeline lifeline) { lifeline.getNewEventOccurrence(); @@ -176,7 +175,6 @@ public class AsyncMessage extends BaseMessage implements ITimeRange { * A new EventOccurence will be create on this lifeLine.
    * * @param lifeline the message receiver - * @param autoCreateEvent if true, create an eventOccurence lifeline given in parameter */ public void autoSetEndLifeline(Lifeline lifeline) { lifeline.getNewEventOccurrence(); diff --git a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/core/Frame.java b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/core/Frame.java index 9c0ab261df..2ecc7f0d02 100755 --- a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/core/Frame.java +++ b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/core/Frame.java @@ -237,22 +237,22 @@ public class Frame extends BasicFrame { * Adds a lifeline to the frame lifelines list. The lifeline X drawing order depends on the lifeline addition order * into the frame lifelines list. * - * @param the lifeline to add + * @param lifeline the lifeline to add */ - public void addLifeLine(Lifeline lifeLine) { + public void addLifeLine(Lifeline lifeline) { computeMinMax = true; - if (lifeLine == null) + if (lifeline == null) return; // set the lifeline parent frame - lifeLine.setFrame(this); + lifeline.setFrame(this); // Increate the frame lifeline counter // and set the lifeline drawing order - lifeLine.setIndex(getNewHorizontalIndex()); - if (lifeLine.hasTimeInfo()) { + lifeline.setIndex(getNewHorizontalIndex()); + if (lifeline.hasTimeInfo()) { timeInfo = true; } // add the lifeline to the lifelines list - addNode(lifeLine); + addNode(lifeline); } /** @@ -542,7 +542,7 @@ public class Frame extends BasicFrame { * For drawing performance reason, it is recommended to add synchronous syncMessages in the same order they should * appear along the Y axis in the Frame. * - * @param the message to add + * @param message the message to add */ public void addMessage(BaseMessage message) { addNode(message); diff --git a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/core/GraphNode.java b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/core/GraphNode.java index 97c7f31e8a..606167e5cb 100755 --- a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/core/GraphNode.java +++ b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/core/GraphNode.java @@ -146,7 +146,7 @@ public abstract class GraphNode { * Set the graph node name.
    * It is the name display in the view to label the graph node. * - * @param the name to set + * @param nodeName the name to set */ public void setName(String nodeName) { name = nodeName; @@ -260,10 +260,10 @@ public abstract class GraphNode { * Returns the GraphNode visibility for the given visible area. Wrong visibility calculation, may strongly impact * drawing performance * - * @param vx - * @param vy - * @param vwidth - * @param vheight + * @param x + * @param y + * @param width + * @param height * @return true if visible false otherwise */ public boolean isVisible(int x, int y, int width, int height) { @@ -564,7 +564,6 @@ public abstract class GraphNode { * After, depending on the visible area, only visible GraphNodes are drawn.
    * * @param context the context to draw to - * @param drawFrame indicate if the frame rectangle need to be redrawn * @see org.eclipse.linuxtools.tmf.ui.views.uml2sd.core.GraphNode#draw(IGC) */ protected void drawChildenNodes(IGC context) { diff --git a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/core/HotSpot.java b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/core/HotSpot.java index f9a81bf886..50c1089c2b 100755 --- a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/core/HotSpot.java +++ b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/core/HotSpot.java @@ -74,7 +74,7 @@ public class HotSpot extends GraphNode { /** * Set the lifeline on which the execution occurrence appears. * - * @param theLifeline - the parent lifeline + * @param occ the parent lifeline */ public void setExecution(BasicExecutionOccurrence occ) { execOcc = occ; diff --git a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/core/Lifeline.java b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/core/Lifeline.java index 5d25adaaf7..2092ebd5bd 100755 --- a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/core/Lifeline.java +++ b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/core/Lifeline.java @@ -170,7 +170,7 @@ public class Lifeline extends GraphNode { * operation mostly to store in the frame the greater event found in the diagram (used to determine the frame * height) * - * @param index the new current event occurrence + * @param eventOcc the new current event occurrence */ public void setCurrentEventOccurrence(int eventOcc) { if ((frame != null) && (frame.getMaxEventOccurrence() < eventOcc)) @@ -316,8 +316,8 @@ public class Lifeline extends GraphNode { * Force the lifeline to be drawn at the given coordinate * * @param context - the context to draw into - * @param x1 - the x coordinate - * @param y1 - the y coordinate + * @param x - the x coordinate + * @param y - the y coordinate */ public void draw(IGC context, int x, int y) { // Set the draw color depending if the lifeline must be selected or not diff --git a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/core/Stop.java b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/core/Stop.java index fd21f19f6d..8b3f124b08 100755 --- a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/core/Stop.java +++ b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/core/Stop.java @@ -21,9 +21,7 @@ import org.eclipse.linuxtools.tmf.ui.views.uml2sd.drawings.ISDPreferences; * A stop is never drawn it is assigned to a lifeline.
    *
    * - * @see org.eclipse.linuxtools.tmf.ui.views.uml2sd.core.Lifeline#setStop(Stop) * @author sveyrier - * */ public class Stop extends GraphNode { diff --git a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/drawings/ISDPreferences.java b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/drawings/ISDPreferences.java index 47d63ffae1..b0bb347e09 100755 --- a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/drawings/ISDPreferences.java +++ b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/drawings/ISDPreferences.java @@ -114,7 +114,7 @@ public interface ISDPreferences { /** * Returns the time compression bar selection color * - * @return + * @return the time compression bar selection color */ public IColor getTimeCompressionSelectionColor(); diff --git a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/handlers/provider/ISDCollapseProvider.java b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/handlers/provider/ISDCollapseProvider.java index 55ff866290..6de9365f13 100755 --- a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/handlers/provider/ISDCollapseProvider.java +++ b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/handlers/provider/ISDCollapseProvider.java @@ -26,7 +26,7 @@ public interface ISDCollapseProvider { * Called back when the sequence diagram is requesting 2 lifelines collapsing * * @param lifeline1 - One of the lifeline to collapse - * @param Lifeline2 - The other lifeline to collapse with + * @param lifeline2 - The other lifeline to collapse with */ public void collapseTwoLifelines(Lifeline lifeline1, Lifeline lifeline2); diff --git a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/handlers/provider/ISDFilterProvider.java b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/handlers/provider/ISDFilterProvider.java index 0cf6f60afa..2bbcce0247 100755 --- a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/handlers/provider/ISDFilterProvider.java +++ b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/handlers/provider/ISDFilterProvider.java @@ -28,7 +28,7 @@ public interface ISDFilterProvider extends ISDGraphNodeSupporter { /** * Called when the Filter dialog box OK button is pressed * - * @param toApply user selection made in the dialog box + * @param filters user selection made in the dialog box * @return true if the filter applied */ public boolean filter(List filters); diff --git a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/handlers/provider/ISDFindProvider.java b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/handlers/provider/ISDFindProvider.java index 0e9d6ff11d..3a62ceeb66 100755 --- a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/handlers/provider/ISDFindProvider.java +++ b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/handlers/provider/ISDFindProvider.java @@ -31,7 +31,7 @@ public interface ISDFindProvider extends ISDGraphNodeSupporter { * @param toApply user selection made in the dialog box * @return true if the find got a non empty result */ - public boolean find(Criteria toapply); + public boolean find(Criteria toApply); /** * Called when dialog is closed diff --git a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/handlers/provider/ISDPropertiesProvider.java b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/handlers/provider/ISDPropertiesProvider.java index 25fdf40b83..b4c5260caa 100755 --- a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/handlers/provider/ISDPropertiesProvider.java +++ b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/handlers/provider/ISDPropertiesProvider.java @@ -22,7 +22,7 @@ public interface ISDPropertiesProvider { /** * Returns the IPropertySheetEntry that will fill in the properties view * - * @return + * @return the property sheet entry */ public IPropertySheetPage getPropertySheetEntry(); diff --git a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/handlers/widgets/Criteria.java b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/handlers/widgets/Criteria.java index d78345a61a..058982e175 100755 --- a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/handlers/widgets/Criteria.java +++ b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/handlers/widgets/Criteria.java @@ -239,7 +239,7 @@ public class Criteria { /** * @param to - * @return + * @return usual comparison result (< 0, 0, > 0) */ public boolean compareTo(Criteria to) { boolean retVal = true; diff --git a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/handlers/widgets/FilterCriteria.java b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/handlers/widgets/FilterCriteria.java index 9bcadcc3bd..51e9d03f13 100755 --- a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/handlers/widgets/FilterCriteria.java +++ b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/handlers/widgets/FilterCriteria.java @@ -106,7 +106,7 @@ public class FilterCriteria { } /** - * @param positive The positive to set. + * @param positive_ The positive to set. */ public void setPositive(boolean positive_) { positive = positive_; @@ -120,7 +120,6 @@ public class FilterCriteria { } /** - * @return Returns the class loader name. */ public void setLoaderClassName(String loaderClassName_) { loaderClassName = loaderClassName_; diff --git a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/handlers/widgets/SearchFilterDialog.java b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/handlers/widgets/SearchFilterDialog.java index 0a5f1699eb..d183886b6a 100755 --- a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/handlers/widgets/SearchFilterDialog.java +++ b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/handlers/widgets/SearchFilterDialog.java @@ -100,8 +100,10 @@ public class SearchFilterDialog extends Dialog { } /** - * @param theView - * @param _provider + * @param view_ + * @param provider_ + * @param filter_ + * @param style */ public SearchFilterDialog(SDView view_, ISDGraphNodeSupporter provider_, boolean filter_, int style) { super(view_.getSDWidget().getShell()); @@ -285,8 +287,6 @@ public class SearchFilterDialog extends Dialog { /** * Get the current end-user settings from the dialog to a Criteria - * - * @param content */ public void copyToCriteria() { criteria = new Criteria(); @@ -302,8 +302,7 @@ public class SearchFilterDialog extends Dialog { } /** - * @return - * @todo Generated comment + * @return the tab content */ protected TabContents getTabContents() { TabContents content = null; diff --git a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/handlers/widgets/TabContents.java b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/handlers/widgets/TabContents.java index d7802004ac..8dd468502b 100755 --- a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/handlers/widgets/TabContents.java +++ b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/handlers/widgets/TabContents.java @@ -214,7 +214,7 @@ public class TabContents extends Composite { } /** - * @param t + * @param found */ public void setResult(boolean found) { result.setVisible(!found); @@ -234,7 +234,6 @@ public class TabContents extends Composite { /** * @param okButton - * @todo Generated comment */ public void setOkButton(Button okButton) { parentOkButton = okButton; diff --git a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/impl/TmfUml2SDSyncLoader.java b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/impl/TmfUml2SDSyncLoader.java index 9bf1fe98e0..9bd62fab1f 100644 --- a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/impl/TmfUml2SDSyncLoader.java +++ b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/impl/TmfUml2SDSyncLoader.java @@ -1060,7 +1060,7 @@ public class TmfUml2SDSyncLoader extends TmfComponent implements IUml2SDLoader, /** * Gets time range for time range signal. * @param startTime The start time of time range. - * @return + * @return the time range */ protected TmfTimeRange getSignalTimeRange(ITmfTimestamp startTime) { fLock.lock(); @@ -1099,7 +1099,7 @@ public class TmfUml2SDSyncLoader extends TmfComponent implements IUml2SDLoader, /** * Checks if filter criteria matches a lifeline name (sender or receiver) in given SD event. - * @param sdEvent The SD event to check + * @param lifeline the message receiver * @return true if match else false. */ protected boolean filterLifeLine(String lifeline) { -- 2.34.1