From c4767854ba35f787cada0753f8c6935d2f48a388 Mon Sep 17 00:00:00 2001 From: Alexandre Montplaisir Date: Fri, 6 Dec 2013 14:33:11 -0500 Subject: [PATCH] lttng: Update @since annotations for 3.0 Change-Id: I53ec925b49cb24485f0fbaf2c6441b2914f1e452 Signed-off-by: Alexandre Montplaisir Reviewed-on: https://git.eclipse.org/r/19458 Reviewed-by: Marc-Andre Laperle IP-Clean: Marc-Andre Laperle Tested-by: Marc-Andre Laperle Tested-by: Hudson CI --- .../ctf/core/event/io/BitBuffer.java | 4 +++ .../ctf/core/event/types/EnumDeclaration.java | 1 + .../core/event/types/StringDefinition.java | 1 + .../linuxtools/ctf/core/trace/CTFTrace.java | 1 + .../core/analysis/IAnalysisModuleHelper.java | 1 + .../analysis/IAnalysisParameterProvider.java | 1 + .../analysis/TmfAnalysisModuleHelperCE.java | 1 + .../callstack/CallStackStateProvider.java | 2 ++ .../tmf/core/callstack/Messages.java | 2 +- .../tmf/core/component/ITmfEventProvider.java | 2 +- .../tmf/core/component/TmfEventProvider.java | 28 ++++++++++++++----- .../tmf/core/ctfadaptor/CtfIterator.java | 3 ++ .../tmf/core/ctfadaptor/CtfTmfTrace.java | 6 ++++ .../exceptions/StateValueTypeException.java | 1 + .../tmf/core/request/ITmfEventRequest.java | 7 +++-- .../tmf/core/request/TmfEventRequest.java | 9 ++++-- .../core/signal/TmfTraceUpdatedSignal.java | 2 ++ .../ITmfStateSystemAnalysisModule.java | 1 + .../statesystem/TmfStateSystemOperations.java | 1 + .../tmf/core/statevalue/ITmfStateValue.java | 4 ++- .../tmf/core/statevalue/TmfStateValue.java | 4 +++ .../linuxtools/tmf/core/trace/ITmfTrace.java | 3 ++ .../tmf/core/trace/TmfExperiment.java | 6 ++++ .../linuxtools/tmf/core/trace/TmfTrace.java | 12 +++++++- .../indexer/ITmfPersistentlyIndexable.java | 1 + .../tmf/ui/project/model/Messages.java | 9 ++++-- .../tmf/ui/project/model/TmfTraceElement.java | 1 + .../statistics/TmfStatisticsViewer.java | 1 + .../CallStackPresentationProvider.java | 1 + .../tmf/ui/views/filter/CopyHandler.java | 2 +- .../tmf/ui/views/filter/CutHandler.java | 2 +- .../tmf/ui/views/filter/DeleteHandler.java | 2 +- .../tmf/ui/views/filter/PasteHandler.java | 2 +- .../ui/views/histogram/HistogramRequest.java | 4 +-- .../tmf/ui/views/statesystem/Messages.java | 3 +- .../timegraph/ITimeGraphColorListener.java | 1 + .../ITimeGraphPresentationProvider2.java | 2 ++ .../TimeGraphPresentationProvider.java | 7 +++++ .../timegraph/widgets/TimeGraphControl.java | 3 ++ 39 files changed, 119 insertions(+), 25 deletions(-) diff --git a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/io/BitBuffer.java b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/io/BitBuffer.java index 170632634e..41b40d838e 100644 --- a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/io/BitBuffer.java +++ b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/io/BitBuffer.java @@ -120,6 +120,7 @@ public final class BitBuffer { * @throws CTFReaderException * An error occurred reading the long. This exception can be * raised if the buffer tries to read out of bounds + * @since 3.0 */ public long getLong() throws CTFReaderException { return get(BIT_LONG, true); @@ -141,6 +142,7 @@ public final class BitBuffer { * An error occurred reading the data. If more than 64 bits at a * time are read, or the buffer is read beyond its end, this * exception will be raised. + * @since 3.0 */ public long get(int length, boolean signed) throws CTFReaderException { if (length > BIT_LONG) { @@ -595,6 +597,7 @@ public final class BitBuffer { * The new position of the buffer. * @throws CTFReaderException * Thrown on out of bounds exceptions + * @since 3.0 */ public void position(long newPosition) throws CTFReaderException { @@ -609,6 +612,7 @@ public final class BitBuffer { * Sets the position in the buffer. * * @return order The position of the buffer. + * @since 3.0 */ public long position() { return fPosition; diff --git a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/EnumDeclaration.java b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/EnumDeclaration.java index c9b9d8dc32..0d2dda81fb 100644 --- a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/EnumDeclaration.java +++ b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/EnumDeclaration.java @@ -117,6 +117,7 @@ public class EnumDeclaration implements IDeclaration { * Gets a set of labels of the enum * * @return A set of labels of the enum, can be empty but not null + * @since 3.0 */ public Set getLabels() { return Collections.unmodifiableSet(fLabels); diff --git a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/StringDefinition.java b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/StringDefinition.java index ff27e849be..12d599306b 100644 --- a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/StringDefinition.java +++ b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/StringDefinition.java @@ -91,6 +91,7 @@ public class StringDefinition extends Definition { * Sets the string (value) * * @param str the string + * @since 3.0 */ public void setValue(String str) { fString = str; diff --git a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/trace/CTFTrace.java b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/trace/CTFTrace.java index e34b9e923c..65ddffa78b 100644 --- a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/trace/CTFTrace.java +++ b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/trace/CTFTrace.java @@ -364,6 +364,7 @@ public class CTFTrace implements IDefinitionScope { * Method majorIsSet is the major version number set? * * @return boolean is the major set? + * @since 3.0 */ public boolean majorIsSet() { return major != null; diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/analysis/IAnalysisModuleHelper.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/analysis/IAnalysisModuleHelper.java index 2d24065daa..04b46436fe 100644 --- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/analysis/IAnalysisModuleHelper.java +++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/analysis/IAnalysisModuleHelper.java @@ -21,6 +21,7 @@ import org.osgi.framework.Bundle; * creates module from a source when requested. * * @author Geneviève Bastien + * @since 3.0 */ public interface IAnalysisModuleHelper { diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/analysis/IAnalysisParameterProvider.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/analysis/IAnalysisParameterProvider.java index 5b6e5d8da1..2689f203a7 100644 --- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/analysis/IAnalysisParameterProvider.java +++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/analysis/IAnalysisParameterProvider.java @@ -19,6 +19,7 @@ import org.eclipse.linuxtools.tmf.core.trace.ITmfTrace; * not set manually * * @author Geneviève Bastien + * @since 3.0 */ public interface IAnalysisParameterProvider { diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/analysis/TmfAnalysisModuleHelperCE.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/analysis/TmfAnalysisModuleHelperCE.java index 74e0ae7de7..a01ac44eba 100644 --- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/analysis/TmfAnalysisModuleHelperCE.java +++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/analysis/TmfAnalysisModuleHelperCE.java @@ -28,6 +28,7 @@ import org.osgi.framework.Bundle; * elements. * * @author Geneviève Bastien + * @since 3.0 */ public class TmfAnalysisModuleHelperCE implements IAnalysisModuleHelper { diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/callstack/CallStackStateProvider.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/callstack/CallStackStateProvider.java index 9341b6953e..18ee1b179d 100644 --- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/callstack/CallStackStateProvider.java +++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/callstack/CallStackStateProvider.java @@ -144,6 +144,7 @@ public abstract class CallStackStateProvider extends AbstractTmfStateProvider { * The event to check * @return If false, the event will be ignored by the state provider. If * true processing will continue. + * @since 3.0 */ protected abstract boolean considerEvent(ITmfEvent event); @@ -173,6 +174,7 @@ public abstract class CallStackStateProvider extends AbstractTmfStateProvider { * @param event * The event * @return The thread name (as will be shown in the view) + * @since 3.0 */ protected abstract String getThreadName(ITmfEvent event); } diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/callstack/Messages.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/callstack/Messages.java index 6ad46425ed..32d5f5855d 100644 --- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/callstack/Messages.java +++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/callstack/Messages.java @@ -17,7 +17,7 @@ import org.eclipse.osgi.util.NLS; /** * Message bundle for the call stack state provider. * - * @since 2.1 + * @since 3.0 */ public class Messages extends NLS { diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/component/ITmfEventProvider.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/component/ITmfEventProvider.java index 7cc91852e0..4508b4c3c9 100644 --- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/component/ITmfEventProvider.java +++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/component/ITmfEventProvider.java @@ -20,10 +20,10 @@ import org.eclipse.linuxtools.tmf.core.trace.ITmfContext; * This is the interface of the data providers in TMF. Data providers have the * capability of handling data requests. * - * @version 1.0 * @author Francois Chouinard * * @see TmfEventProvider + * @since 3.0 */ public interface ITmfEventProvider extends ITmfComponent { diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/component/TmfEventProvider.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/component/TmfEventProvider.java index 18bfbf8967..5d1a6783d7 100644 --- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/component/TmfEventProvider.java +++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/component/TmfEventProvider.java @@ -42,6 +42,7 @@ import org.eclipse.linuxtools.tmf.core.trace.ITmfContext; *

* * @author Francois Chouinard + * @since 3.0 */ public abstract class TmfEventProvider extends TmfComponent implements ITmfEventProvider { @@ -49,27 +50,33 @@ public abstract class TmfEventProvider extends TmfComponent implements ITmfEvent // Constants // ------------------------------------------------------------------------ - /** Default amount of events per request "chunk" */ + /** Default amount of events per request "chunk" + * @since 3.0 */ public static final int DEFAULT_BLOCK_SIZE = 50000; - /** Default size of the queue */ + /** Default size of the queue + * @since 3.0 */ public static final int DEFAULT_QUEUE_SIZE = 1000; // ------------------------------------------------------------------------ // Attributes // ------------------------------------------------------------------------ - /** List of coalesced requests */ + /** List of coalesced requests + * @since 3.0*/ protected final List fPendingCoalescedRequests = new ArrayList(); - /** The type of event handled by this provider */ + /** The type of event handled by this provider + * @since 3.0*/ protected Class fType; - /** Queue of events */ + /** Queue of events + * @since 3.0*/ protected BlockingQueue fDataQueue; - /** Size of the fDataQueue */ + /** Size of the fDataQueue + * @since 3.0*/ protected int fQueueSize = DEFAULT_QUEUE_SIZE; private final TmfRequestExecutor fExecutor; @@ -185,6 +192,9 @@ public abstract class TmfEventProvider extends TmfComponent implements ITmfEvent // ITmfRequestHandler // ------------------------------------------------------------------------ + /** + * @since 3.0 + */ @Override public void sendRequest(final ITmfEventRequest request) { synchronized (fLock) { @@ -250,6 +260,7 @@ public abstract class TmfEventProvider extends TmfComponent implements ITmfEvent * * @param request * The request to copy + * @since 3.0 */ protected synchronized void newCoalescedEventRequest(ITmfEventRequest request) { TmfCoalescedEventRequest coalescedRequest = new TmfCoalescedEventRequest( @@ -271,6 +282,7 @@ public abstract class TmfEventProvider extends TmfComponent implements ITmfEvent * * @param request * The request to add to the list + * @since 3.0 */ protected void coalesceEventRequest(ITmfEventRequest request) { synchronized (fLock) { @@ -305,6 +317,7 @@ public abstract class TmfEventProvider extends TmfComponent implements ITmfEvent * * @param request * The data request + * @since 3.0 */ protected void queueRequest(final ITmfEventRequest request) { @@ -343,7 +356,7 @@ public abstract class TmfEventProvider extends TmfComponent implements ITmfEvent * The request * @return An application specific context; null if request can't be * serviced - * @since 2.0 + * @since 3.0 */ public abstract ITmfContext armRequest(ITmfEventRequest request); @@ -357,6 +370,7 @@ public abstract class TmfEventProvider extends TmfComponent implements ITmfEvent * @param nbRead * The number of events read so far * @return true if completion criteria is met + * @since 3.0 */ public boolean isCompleted(ITmfEventRequest request, ITmfEvent event, int nbRead) { boolean requestCompleted = isCompleted2(request, nbRead); diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/ctfadaptor/CtfIterator.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/ctfadaptor/CtfIterator.java index 641d155eda..135f1c1cd1 100644 --- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/ctfadaptor/CtfIterator.java +++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/ctfadaptor/CtfIterator.java @@ -246,6 +246,9 @@ public class CtfIterator extends CTFTraceReader return (getRank() >= 0); } + /** + * @since 3.0 + */ @Override public void setLocation(ITmfLocation location) { // FIXME alex: isn't there a cleaner way than a cast here? diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/ctfadaptor/CtfTmfTrace.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/ctfadaptor/CtfTmfTrace.java index 368b68880e..8f8a4570cf 100644 --- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/ctfadaptor/CtfTmfTrace.java +++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/ctfadaptor/CtfTmfTrace.java @@ -461,6 +461,9 @@ public class CtfTmfTrace extends TmfTrace private static int fCheckpointSize = -1; + /** + * @since 3.0 + */ @Override public synchronized int getCheckpointSize() { if (fCheckpointSize == -1) { @@ -479,6 +482,9 @@ public class CtfTmfTrace extends TmfTrace return new TmfBTreeTraceIndexer(this, interval); } + /** + * @since 3.0 + */ @Override public ITmfLocation restoreLocation(ByteBuffer bufferIn) { return new CtfLocation(bufferIn); diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/exceptions/StateValueTypeException.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/exceptions/StateValueTypeException.java index d1eac0c25f..7a2e58a0a8 100644 --- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/exceptions/StateValueTypeException.java +++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/exceptions/StateValueTypeException.java @@ -51,6 +51,7 @@ public class StateValueTypeException extends Exception { * Message to attach to this exception * @param e * Cause of this exception + * @since 3.0 */ public StateValueTypeException(String message, Throwable e) { super(message, e); diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/request/ITmfEventRequest.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/request/ITmfEventRequest.java index f3d7ce162f..927b760857 100644 --- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/request/ITmfEventRequest.java +++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/request/ITmfEventRequest.java @@ -27,10 +27,12 @@ public interface ITmfEventRequest { // Constants // ------------------------------------------------------------------------ - /** The request count for all the events */ + /** The request count for all the events + * @since 3.0*/ static final int ALL_DATA = Integer.MAX_VALUE; - /** The request execution type/priority */ + /** The request execution type/priority + * @since 3.0*/ enum ExecutionType { /** * Backgroung, long-running, lower priority request @@ -58,6 +60,7 @@ public interface ITmfEventRequest { /** * @return request ID + * @since 3.0 */ ExecutionType getExecType(); 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 1900fc4adc..a7749548fb 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 @@ -82,10 +82,12 @@ public abstract class TmfEventRequest implements ITmfEventRequest { /** The requested events time range */ private final TmfTimeRange fRange; - /** The index (rank) of the requested event */ + /** The index (rank) of the requested event + * @since 3.0*/ protected long fIndex; - /** The number of requested events (ALL_DATA for all) */ + /** The number of requested events (ALL_DATA for all) + * @since 3.0*/ protected int fNbRequested; /** The number of reads so far */ @@ -200,6 +202,9 @@ public abstract class TmfEventRequest implements ITmfEventRequest { return fIndex; } + /** + * @since 3.0 + */ @Override public ExecutionType getExecType() { return fExecType; diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/signal/TmfTraceUpdatedSignal.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/signal/TmfTraceUpdatedSignal.java index d8cb31f7b1..73ecbfbe5d 100644 --- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/signal/TmfTraceUpdatedSignal.java +++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/signal/TmfTraceUpdatedSignal.java @@ -40,6 +40,7 @@ public class TmfTraceUpdatedSignal extends TmfSignal { * The new time range of the trace * @param nbEvents * The number of events in the trace + * @since 3.0 */ public TmfTraceUpdatedSignal(Object source, ITmfTrace trace, TmfTimeRange range, long nbEvents) { super(source); @@ -67,6 +68,7 @@ public class TmfTraceUpdatedSignal extends TmfSignal { * Returns the number of events indicated by this signal * * @return the number of events indicated by this signal + * @since 3.0 */ public long getNbEvents() { return fNbEvents; diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/statesystem/ITmfStateSystemAnalysisModule.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/statesystem/ITmfStateSystemAnalysisModule.java index c1d5b95cf1..dfa2cbc48d 100644 --- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/statesystem/ITmfStateSystemAnalysisModule.java +++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/statesystem/ITmfStateSystemAnalysisModule.java @@ -18,6 +18,7 @@ import java.util.Map; * Interface for analysis modules providing state systems * * @author Geneviève Bastien + * @since 3.0 */ public interface ITmfStateSystemAnalysisModule { diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/statesystem/TmfStateSystemOperations.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/statesystem/TmfStateSystemOperations.java index eb278b4584..c74f1ec087 100644 --- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/statesystem/TmfStateSystemOperations.java +++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/statesystem/TmfStateSystemOperations.java @@ -32,6 +32,7 @@ import org.eclipse.linuxtools.tmf.core.util.Pair; * performed on attributes of the state system. * * @author Patrick Tassé + * @since 3.0 */ public final class TmfStateSystemOperations { diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/statevalue/ITmfStateValue.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/statevalue/ITmfStateValue.java index 033e504220..18f3edb479 100644 --- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/statevalue/ITmfStateValue.java +++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/statevalue/ITmfStateValue.java @@ -33,7 +33,8 @@ public interface ITmfStateValue { INTEGER, /** 64-bit integer value */ LONG, - /** IEEE 754 double precision number */ + /** IEEE 754 double precision number + * @since 3.0*/ DOUBLE, /** Variable-length string value */ STRING, @@ -82,6 +83,7 @@ public interface ITmfStateValue { * @return The double contained in the state value * @throws StateValueTypeException * If the contained value cannot be read as a double + * @since 3.0 */ double unboxDouble() throws StateValueTypeException; diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/statevalue/TmfStateValue.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/statevalue/TmfStateValue.java index acb17dfc7a..c11e5c96a8 100644 --- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/statevalue/TmfStateValue.java +++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/statevalue/TmfStateValue.java @@ -110,6 +110,7 @@ public abstract class TmfStateValue implements ITmfStateValue { * @param value * The double value to contain * @return The newly-created TmfStateValue object + * @since 3.0 */ public static TmfStateValue newValueDouble(double value) { /* Lookup in cache for the existence of the same value. */ @@ -164,6 +165,9 @@ public abstract class TmfStateValue implements ITmfStateValue { throw new StateValueTypeException(unboxErrMsg("Long")); //$NON-NLS-1$ } + /** + * @since 3.0 + */ @Override public double unboxDouble() throws StateValueTypeException { throw new StateValueTypeException(unboxErrMsg("Double")); //$NON-NLS-1$ 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 896ae5f813..308474630e 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 @@ -251,6 +251,7 @@ public interface ITmfTrace extends ITmfEventProvider { * @param analysisId * The analysis module id * @return The {@link IAnalysisModule} object + * @since 3.0 */ IAnalysisModule getAnalysisModule(String analysisId); @@ -261,6 +262,7 @@ public interface ITmfTrace extends ITmfEventProvider { * @param moduleclass * Class returned module must extend * @return List of modules of class moduleclass + * @since 3.0 */ Map getAnalysisModules(Class moduleclass); @@ -272,6 +274,7 @@ public interface ITmfTrace extends ITmfEventProvider { * {@link Collections#unmodifiableMap}). * * @return The map of analysis modules + * @since 3.0 */ Map getAnalysisModules(); diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/trace/TmfExperiment.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/trace/TmfExperiment.java index b999bf41cb..48f749992b 100644 --- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/trace/TmfExperiment.java +++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/trace/TmfExperiment.java @@ -621,6 +621,9 @@ public class TmfExperiment extends TmfTrace implements ITmfEventParser, ITmfPers } } + /** + * @since 3.0 + */ @Override public synchronized int getCheckpointSize() { int totalCheckpointSize = 0; @@ -647,6 +650,9 @@ public class TmfExperiment extends TmfTrace implements ITmfEventParser, ITmfPers return totalCheckpointSize; } + /** + * @since 3.0 + */ @Override public ITmfLocation restoreLocation(ByteBuffer bufferIn) { ITmfLocation[] locations = new ITmfLocation[fTraces.length]; 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 7e4685d189..5dcd7574eb 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 @@ -345,11 +345,17 @@ public abstract class TmfTrace extends TmfEventProvider implements ITmfTrace { return status; } + /** + * @since 3.0 + */ @Override public final IAnalysisModule getAnalysisModule(String analysisId) { return fAnalysisModules.get(analysisId); } + /** + * @since 3.0 + */ @Override public Map getAnalysisModules(Class moduleclass) { Map modules = new HashMap(); @@ -361,6 +367,9 @@ public abstract class TmfTrace extends TmfEventProvider implements ITmfTrace { return modules; } + /** + * @since 3.0 + */ @Override public Map getAnalysisModules() { return Collections.unmodifiableMap(fAnalysisModules); @@ -792,6 +801,7 @@ public abstract class TmfTrace extends TmfEventProvider implements ITmfTrace { /** * Refresh the supplementary files resources, so it can pick up new files * that got created. + * @since 3.0 */ public void refreshSupplementaryFiles() { if (fResource != null) { @@ -824,7 +834,7 @@ public abstract class TmfTrace extends TmfEventProvider implements ITmfTrace { * Signal handler for the TmfTraceUpdatedSignal signal * * @param signal The incoming signal - * @since 2.0 + * @since 3.0 */ @TmfSignalHandler public void traceUpdated(final TmfTraceUpdatedSignal signal) { diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/trace/indexer/ITmfPersistentlyIndexable.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/trace/indexer/ITmfPersistentlyIndexable.java index b26a5b2bcc..1011008174 100644 --- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/trace/indexer/ITmfPersistentlyIndexable.java +++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/trace/indexer/ITmfPersistentlyIndexable.java @@ -21,6 +21,7 @@ import org.eclipse.linuxtools.tmf.core.trace.location.ITmfLocation; * persisted to disk. * * @author Marc-Andre Laperle + * @since 3.0 */ public interface ITmfPersistentlyIndexable { diff --git a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/project/model/Messages.java b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/project/model/Messages.java index aabd88cc0f..b4de432410 100644 --- a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/project/model/Messages.java +++ b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/project/model/Messages.java @@ -24,10 +24,12 @@ public class Messages extends NLS { private static final String BUNDLE_NAME = "org.eclipse.linuxtools.tmf.ui.project.model.messages"; //$NON-NLS-1$ - /** Instantiate analysis message box title */ + /** Instantiate analysis message box title + * @since 3.0*/ public static String TmfAnalysisElement_InstantiateAnalysis; - /** The message when analysis view is not available */ + /** The message when analysis view is not available + * @since 3.0*/ public static String TmfAnalysisViewOutput_ViewUnavailable; /** The category of the resource properties */ @@ -79,7 +81,8 @@ public class Messages extends NLS { /** Init error */ public static String TmfOpenTraceHelper_InitError; - /** Analysis view title */ + /** Analysis view title + * @since 3.0*/ public static String TmfAnalysisViewOutput_Title; static { diff --git a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/project/model/TmfTraceElement.java b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/project/model/TmfTraceElement.java index 5041aefb30..b05f4f02b8 100644 --- a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/project/model/TmfTraceElement.java +++ b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/project/model/TmfTraceElement.java @@ -714,6 +714,7 @@ public class TmfTraceElement extends TmfWithFolderElement implements IActionFilt * * @param signal * The incoming signal + * @since 3.0 */ @TmfSignalHandler public void traceOpened(TmfTraceOpenedSignal signal) { diff --git a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/viewers/statistics/TmfStatisticsViewer.java b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/viewers/statistics/TmfStatisticsViewer.java index 06264b523b..16ac50dd9d 100644 --- a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/viewers/statistics/TmfStatisticsViewer.java +++ b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/viewers/statistics/TmfStatisticsViewer.java @@ -450,6 +450,7 @@ public class TmfStatisticsViewer extends TmfViewer { * * @param request * The request to be canceled + * @since 3.0 */ protected void cancelOngoingRequest(ITmfEventRequest request) { if (request != null && !request.isCompleted()) { diff --git a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/callstack/CallStackPresentationProvider.java b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/callstack/CallStackPresentationProvider.java index 14297d0835..49f55d0b5f 100644 --- a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/callstack/CallStackPresentationProvider.java +++ b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/callstack/CallStackPresentationProvider.java @@ -60,6 +60,7 @@ public class CallStackPresentationProvider extends TimeGraphPresentationProvider * * @param view * The callstack view that will contain the time events + * @since 3.0 */ public CallStackPresentationProvider(CallStackView view) { fView = view; diff --git a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/filter/CopyHandler.java b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/filter/CopyHandler.java index 279bc2b9d3..401d87937d 100644 --- a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/filter/CopyHandler.java +++ b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/filter/CopyHandler.java @@ -25,7 +25,7 @@ import org.eclipse.ui.PlatformUI; /** * Handler for copy command in filter view * @author Xavier Raynaud - * @since 2.2 + * @since 3.0 */ public class CopyHandler extends AbstractHandler { diff --git a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/filter/CutHandler.java b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/filter/CutHandler.java index bb1c74f2b7..5de70d43f7 100644 --- a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/filter/CutHandler.java +++ b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/filter/CutHandler.java @@ -20,7 +20,7 @@ import org.eclipse.linuxtools.tmf.core.filter.model.ITmfFilterTreeNode; /** * Handler for cut command in filter view * @author Xavier Raynaud - * @since 2.2 + * @since 3.0 */ public class CutHandler extends CopyHandler { diff --git a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/filter/DeleteHandler.java b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/filter/DeleteHandler.java index 46e74b71d3..00e8064db8 100644 --- a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/filter/DeleteHandler.java +++ b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/filter/DeleteHandler.java @@ -26,7 +26,7 @@ import org.eclipse.ui.PlatformUI; /** * Handler for delete command in filter view * @author Xavier Raynaud - * @since 2.2 + * @since 3.0 */ public class DeleteHandler extends AbstractHandler { diff --git a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/filter/PasteHandler.java b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/filter/PasteHandler.java index da96395c47..84a224f5c6 100644 --- a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/filter/PasteHandler.java +++ b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/filter/PasteHandler.java @@ -25,7 +25,7 @@ import org.eclipse.ui.PlatformUI; /** * Handler for paste command in filter view * @author Xavier Raynaud - * @since 2.2 + * @since 3.0 */ public class PasteHandler extends AbstractHandler { diff --git a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/histogram/HistogramRequest.java b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/histogram/HistogramRequest.java index 7e50f39349..510a2238b2 100644 --- a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/histogram/HistogramRequest.java +++ b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/histogram/HistogramRequest.java @@ -63,7 +63,7 @@ public class HistogramRequest extends TmfEventRequest { * The number of events per block * @param execType * The requested execution priority - * @since 2.0 + * @since 3.0 * */ @Deprecated @@ -96,7 +96,7 @@ public class HistogramRequest extends TmfEventRequest { * The requested execution priority * @param fullRange * Full range or time range for histogram request - * @since 2.2 + * @since 3.0 * */ public HistogramRequest(HistogramDataModel histogram, TmfTimeRange range, diff --git a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/statesystem/Messages.java b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/statesystem/Messages.java index f1e4307db5..c2bb33dbf1 100644 --- a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/statesystem/Messages.java +++ b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/statesystem/Messages.java @@ -76,7 +76,8 @@ public class Messages extends NLS { * @since 2.1*/ public static String TypeLong; - /** Label for type Double */ + /** Label for type Double + * @since 3.0*/ public static String TypeDouble; /** Label for the type String diff --git a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/widgets/timegraph/ITimeGraphColorListener.java b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/widgets/timegraph/ITimeGraphColorListener.java index b34d4b46cc..4983569e0e 100644 --- a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/widgets/timegraph/ITimeGraphColorListener.java +++ b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/widgets/timegraph/ITimeGraphColorListener.java @@ -16,6 +16,7 @@ package org.eclipse.linuxtools.tmf.ui.widgets.timegraph; * A time graph state color change listener * * @author Geneviève Bastien + * @since 3.0 */ public interface ITimeGraphColorListener { diff --git a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/widgets/timegraph/ITimeGraphPresentationProvider2.java b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/widgets/timegraph/ITimeGraphPresentationProvider2.java index aeb7bb0d12..0a33c9dc73 100644 --- a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/widgets/timegraph/ITimeGraphPresentationProvider2.java +++ b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/widgets/timegraph/ITimeGraphPresentationProvider2.java @@ -46,6 +46,7 @@ public interface ITimeGraphPresentationProvider2 extends ITimeGraphPresentationP * * @param listener * The new listener for color settings changes + * @since 3.0 */ public void addColorListener(ITimeGraphColorListener listener); @@ -54,6 +55,7 @@ public interface ITimeGraphPresentationProvider2 extends ITimeGraphPresentationP * * @param listener * The color settings listener to remove + * @since 3.0 */ public void removeColorListener(ITimeGraphColorListener listener); diff --git a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/widgets/timegraph/TimeGraphPresentationProvider.java b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/widgets/timegraph/TimeGraphPresentationProvider.java index bbf2efae2d..93c4c49430 100644 --- a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/widgets/timegraph/TimeGraphPresentationProvider.java +++ b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/widgets/timegraph/TimeGraphPresentationProvider.java @@ -158,6 +158,9 @@ public class TimeGraphPresentationProvider implements ITimeGraphPresentationProv return true; } + /** + * @since 3.0 + */ @Override public void addColorListener(ITimeGraphColorListener listener) { if (!fListeners.contains(listener)) { @@ -165,6 +168,9 @@ public class TimeGraphPresentationProvider implements ITimeGraphPresentationProv } } + /** + * @since 3.0 + */ @Override public void removeColorListener(ITimeGraphColorListener listener) { fListeners.remove(listener); @@ -172,6 +178,7 @@ public class TimeGraphPresentationProvider implements ITimeGraphPresentationProv /** * Notifies listeners of the state table change + * @since 3.0 */ protected void fireColorSettingsChanged() { for (ITimeGraphColorListener listener : fListeners) { diff --git a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/widgets/timegraph/widgets/TimeGraphControl.java b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/widgets/timegraph/widgets/TimeGraphControl.java index 9defd7ef28..bd7fc41dcf 100644 --- a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/widgets/timegraph/widgets/TimeGraphControl.java +++ b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/widgets/timegraph/widgets/TimeGraphControl.java @@ -2410,6 +2410,9 @@ public class TimeGraphControl extends TimeGraphBaseControl fFilters.remove(filter); } + /** + * @since 3.0 + */ @Override public void colorSettingsChanged(StateItem[] stateItems) { /* Destroy previous colors from the resource manager */ -- 2.34.1