From 6f4e8ec0ae816788e83accc0de316f7bd783c35c Mon Sep 17 00:00:00 2001 From: Alexandre Montplaisir Date: Thu, 1 Nov 2012 14:28:35 -0400 Subject: [PATCH] tmf/lttng: Fix newly-introduced Javadoc warnings Change-Id: Ic0562e0dbc8538603f9749c8dfe402b5cf34fc01 Signed-off-by: Alexandre Montplaisir Reviewed-on: https://git.eclipse.org/r/8474 --- .../ctf/core/trace/CTFTraceReader.java | 15 +++-- .../ui/viewers/events/LTTng2EventsTable.java | 4 -- .../lttng2/stubs/shells/TestCommandShell.java | 1 + .../handlers/ChangeChannelStateHandler.java | 2 +- .../handlers/ChangeEventStateHandler.java | 2 +- .../views/control/handlers/ImportHandler.java | 4 ++ .../control/service/LTTngControlService.java | 1 + .../core/statesystem/historytree/HTNode.java | 32 +++++----- .../historytree/HistoryTreeBackend.java | 3 + .../tmf/core/component/TmfDataProvider.java | 59 +++++++++++++++++-- .../tmf/core/ctfadaptor/CtfTmfEventField.java | 1 + .../tmf/core/ctfadaptor/CtfTmfTrace.java | 3 + .../tmf/core/event/TmfTimestampFormat.java | 5 +- .../tmf/core/request/TmfDataRequest.java | 20 +++++-- .../statesystem/AbstractStateChangeInput.java | 4 +- .../core/statistics/TmfStateStatistics.java | 4 +- .../tmf/core/trace/TmfCheckpointIndexer.java | 6 +- .../linuxtools/tmf/core/trace/TmfTrace.java | 16 +++-- 18 files changed, 134 insertions(+), 48 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 f705cac142..70626ed8b6 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 @@ -66,10 +66,6 @@ public class CTFTraceReader { */ private long endTime; - protected void setEndTime(long endTime) { - this.endTime = endTime; - } - // ------------------------------------------------------------------------ // Constructors // ------------------------------------------------------------------------ @@ -132,6 +128,17 @@ public class CTFTraceReader { return this.startTime; } + /** + * Set the trace's end time + * + * @param endTime + * The end time to use + */ + protected void setEndTime(long endTime) { + this.endTime = endTime; + } + + // ------------------------------------------------------------------------ // Operations // ------------------------------------------------------------------------ diff --git a/org.eclipse.linuxtools.lttng2.kernel.ui/src/org/eclipse/linuxtools/internal/lttng2/kernel/ui/viewers/events/LTTng2EventsTable.java b/org.eclipse.linuxtools.lttng2.kernel.ui/src/org/eclipse/linuxtools/internal/lttng2/kernel/ui/viewers/events/LTTng2EventsTable.java index f0d1671b54..a2420bd1d4 100644 --- a/org.eclipse.linuxtools.lttng2.kernel.ui/src/org/eclipse/linuxtools/internal/lttng2/kernel/ui/viewers/events/LTTng2EventsTable.java +++ b/org.eclipse.linuxtools.lttng2.kernel.ui/src/org/eclipse/linuxtools/internal/lttng2/kernel/ui/viewers/events/LTTng2EventsTable.java @@ -68,10 +68,6 @@ public class LTTng2EventsTable extends TmfEventsTable { fTable.getColumns()[3].setData(Key.FIELD_ID, ITmfEvent.EVENT_FIELD_CONTENT); } - /** - * @param event - * @return - */ @Override protected ITmfEventField[] extractItemFields(ITmfEvent event) { ITmfEventField[] fields = new TmfEventField[0]; diff --git a/org.eclipse.linuxtools.lttng2.ui.tests/stubs/org/eclipse/linuxtools/internal/lttng2/stubs/shells/TestCommandShell.java b/org.eclipse.linuxtools.lttng2.ui.tests/stubs/org/eclipse/linuxtools/internal/lttng2/stubs/shells/TestCommandShell.java index 0aa5c1f6d4..82537cc8cd 100644 --- a/org.eclipse.linuxtools.lttng2.ui.tests/stubs/org/eclipse/linuxtools/internal/lttng2/stubs/shells/TestCommandShell.java +++ b/org.eclipse.linuxtools.lttng2.ui.tests/stubs/org/eclipse/linuxtools/internal/lttng2/stubs/shells/TestCommandShell.java @@ -22,6 +22,7 @@ import org.eclipse.linuxtools.internal.lttng2.ui.views.control.remote.ICommandSh */ public class TestCommandShell implements ICommandShell { + /** If the shell is connected */ protected boolean fIsConnected = false; @Override diff --git a/org.eclipse.linuxtools.lttng2.ui/src/org/eclipse/linuxtools/internal/lttng2/ui/views/control/handlers/ChangeChannelStateHandler.java b/org.eclipse.linuxtools.lttng2.ui/src/org/eclipse/linuxtools/internal/lttng2/ui/views/control/handlers/ChangeChannelStateHandler.java index 7767489920..742220a658 100644 --- a/org.eclipse.linuxtools.lttng2.ui/src/org/eclipse/linuxtools/internal/lttng2/ui/views/control/handlers/ChangeChannelStateHandler.java +++ b/org.eclipse.linuxtools.lttng2.ui/src/org/eclipse/linuxtools/internal/lttng2/ui/views/control/handlers/ChangeChannelStateHandler.java @@ -67,7 +67,7 @@ abstract public class ChangeChannelStateHandler extends BaseControlViewHandler { * @param domain - the domain of the channels. * @param channelNames - a list of channel names * @param monitor - a progress monitor - * @throws ExecutionException + * @throws ExecutionException If the command fails */ abstract protected void changeState(TraceDomainComponent domain, List channelNames, IProgressMonitor monitor) throws ExecutionException; diff --git a/org.eclipse.linuxtools.lttng2.ui/src/org/eclipse/linuxtools/internal/lttng2/ui/views/control/handlers/ChangeEventStateHandler.java b/org.eclipse.linuxtools.lttng2.ui/src/org/eclipse/linuxtools/internal/lttng2/ui/views/control/handlers/ChangeEventStateHandler.java index d6a6f17011..97639212a0 100644 --- a/org.eclipse.linuxtools.lttng2.ui/src/org/eclipse/linuxtools/internal/lttng2/ui/views/control/handlers/ChangeEventStateHandler.java +++ b/org.eclipse.linuxtools.lttng2.ui/src/org/eclipse/linuxtools/internal/lttng2/ui/views/control/handlers/ChangeEventStateHandler.java @@ -67,7 +67,7 @@ abstract public class ChangeEventStateHandler extends BaseControlViewHandler { * @param channel - channel of events to be enabled * @param eventNames - list event names * @param monitor - a progress monitor - * @throws ExecutionException + * @throws ExecutionException If the command fails */ abstract protected void changeState(TraceChannelComponent channel, List eventNames, IProgressMonitor monitor) throws ExecutionException; diff --git a/org.eclipse.linuxtools.lttng2.ui/src/org/eclipse/linuxtools/internal/lttng2/ui/views/control/handlers/ImportHandler.java b/org.eclipse.linuxtools.lttng2.ui/src/org/eclipse/linuxtools/internal/lttng2/ui/views/control/handlers/ImportHandler.java index 4e5cc56819..44bc336c7b 100644 --- a/org.eclipse.linuxtools.lttng2.ui/src/org/eclipse/linuxtools/internal/lttng2/ui/views/control/handlers/ImportHandler.java +++ b/org.eclipse.linuxtools.lttng2.ui/src/org/eclipse/linuxtools/internal/lttng2/ui/views/control/handlers/ImportHandler.java @@ -56,6 +56,10 @@ public class ImportHandler extends BaseControlViewHandler { // ------------------------------------------------------------------------ // Attributes // ------------------------------------------------------------------------ + + /** + * The command parameter + */ protected CommandParameter fParam; // ------------------------------------------------------------------------ diff --git a/org.eclipse.linuxtools.lttng2.ui/src/org/eclipse/linuxtools/internal/lttng2/ui/views/control/service/LTTngControlService.java b/org.eclipse.linuxtools.lttng2.ui/src/org/eclipse/linuxtools/internal/lttng2/ui/views/control/service/LTTngControlService.java index 5718b9ba36..3a3b375731 100644 --- a/org.eclipse.linuxtools.lttng2.ui/src/org/eclipse/linuxtools/internal/lttng2/ui/views/control/service/LTTngControlService.java +++ b/org.eclipse.linuxtools.lttng2.ui/src/org/eclipse/linuxtools/internal/lttng2/ui/views/control/service/LTTngControlService.java @@ -1169,6 +1169,7 @@ public class LTTngControlService implements ILttngControlService { * - a progress monitor * @return the command result * @throws ExecutionException + * If the command fails */ protected ICommandResult executeCommand(String command, IProgressMonitor monitor) throws ExecutionException { diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/internal/tmf/core/statesystem/historytree/HTNode.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/internal/tmf/core/statesystem/historytree/HTNode.java index b0cc54d936..12b10724c0 100644 --- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/internal/tmf/core/statesystem/historytree/HTNode.java +++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/internal/tmf/core/statesystem/historytree/HTNode.java @@ -2,12 +2,12 @@ * Copyright (c) 2012 Ericsson * Copyright (c) 2010, 2011 École Polytechnique de Montréal * Copyright (c) 2010, 2011 Alexandre Montplaisir - * + * * All rights reserved. This program and the accompanying materials are * made available under the terms of the Eclipse Public License v1.0 which * accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * *******************************************************************************/ package org.eclipse.linuxtools.internal.tmf.core.statesystem.historytree; @@ -27,9 +27,9 @@ import org.eclipse.linuxtools.tmf.core.statevalue.TmfStateValue; /** * The base class for all the types of nodes that go in the History Tree. - * + * * @author alexmont - * + * */ abstract class HTNode { @@ -67,7 +67,7 @@ abstract class HTNode { /** * Reader factory constructor. Build a Node object (of the right type) by * reading a block in the file. - * + * * @param tree * Reference to the HT which will own this node * @param fc @@ -232,7 +232,7 @@ abstract class HTNode { /** * Add an interval to this node - * + * * @param newInterval */ void addInterval(HTInterval newInterval) { @@ -248,7 +248,7 @@ abstract class HTNode { /** * We've received word from the containerTree that newest nodes now exist to * our right. (Puts isDone = true and sets the endtime) - * + * * @param endtime * The nodeEnd time that the node will have * @throws TimeRangeException @@ -286,7 +286,7 @@ abstract class HTNode { * The method to fill up the stateInfo (passed on from the Current State * Tree when it does a query on the SHT). We'll replace the data in that * vector with whatever relevant we can find from this node - * + * * @param stateInfo * The same stateInfo that comes from SHT's doQuery() * @param t @@ -319,7 +319,7 @@ abstract class HTNode { /** * Get a single Interval from the information in this node If the * key/timestamp pair cannot be found, we return null. - * + * * @param key * @param t * @return The Interval containing the information we want, or null if it @@ -471,7 +471,7 @@ abstract class HTNode { /** * Debugging function that prints out the contents of this node - * + * * @param writer * PrintWriter in which we will print the debug output */ @@ -505,20 +505,20 @@ abstract class HTNode { final static int getCommonHeaderSize() { /* * 1 - byte (type) - * + * * 16 - 2x long (start time, end time) - * + * * 16 - 4x int (seq number, parent seq number, intervalcount, strings * section pos.) - * + * * 1 - byte (done or not) */ return 34; } - /** - * @name Abstract methods - */ + // ------------------------------------------------------------------------ + // Abstract methods + // ------------------------------------------------------------------------ protected abstract byte getNodeType(); diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/internal/tmf/core/statesystem/historytree/HistoryTreeBackend.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/internal/tmf/core/statesystem/historytree/HistoryTreeBackend.java index e0116a9ec9..d794831301 100644 --- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/internal/tmf/core/statesystem/historytree/HistoryTreeBackend.java +++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/internal/tmf/core/statesystem/historytree/HistoryTreeBackend.java @@ -35,7 +35,10 @@ import org.eclipse.linuxtools.tmf.core.statevalue.TmfStateValue; */ public class HistoryTreeBackend implements IStateHistoryBackend { + /** The history tree that sits underneath */ protected final HistoryTree sht; + + /** Direct reference to the tree's IO object */ private final HT_IO treeIO; /** Indicates if the history tree construction is done */ 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 2252a8bfb8..0341ef56c5 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 @@ -61,12 +61,21 @@ public abstract class TmfDataProvider extends TmfComponent implements ITmfDataPr // Attributes // ------------------------------------------------------------------------ + /** The type of event handled by this provider */ protected Class fType; + + /** Is there some data being logged? */ protected boolean fLogData; + + /** Are errors being logged? */ protected boolean fLogError; - protected int fQueueSize = DEFAULT_QUEUE_SIZE; + /** Queue of events */ protected BlockingQueue fDataQueue; + + /** Size of the fDataQueue */ + protected int fQueueSize = DEFAULT_QUEUE_SIZE; + private TmfRequestExecutor fExecutor; private int fSignalDepth = 0; @@ -110,6 +119,16 @@ public abstract class TmfDataProvider extends TmfComponent implements ITmfDataPr TmfProviderManager.register(fType, this); } + /** + * Constructor specifying the event type and the queue size. + * + * @param name + * Name of the provider + * @param type + * Type of event that will be handled + * @param queueSize + * Size of the event queue + */ protected TmfDataProvider(String name, Class type, int queueSize) { this(); fQueueSize = queueSize; @@ -232,8 +251,16 @@ public abstract class TmfDataProvider extends TmfComponent implements ITmfDataPr // Coalescing (primitive test...) // ------------------------------------------------------------------------ + /** List of coalesced requests */ protected Vector fPendingCoalescedRequests = new Vector(); + /** + * Create a new request from an existing one, and add it to the coalesced + * requests + * + * @param request + * The request to copy + */ protected void newCoalescedDataRequest(ITmfDataRequest request) { synchronized (fLock) { TmfCoalescedDataRequest coalescedRequest = new TmfCoalescedDataRequest(request.getDataType(), request.getIndex(), @@ -247,6 +274,12 @@ public abstract class TmfDataProvider extends TmfComponent implements ITmfDataPr } } + /** + * Add an existing requests to the list of coalesced ones + * + * @param request + * The request to add to the list + */ protected void coalesceDataRequest(ITmfDataRequest request) { synchronized (fLock) { for (TmfCoalescedDataRequest coalescedRequest : fPendingCoalescedRequests) { @@ -275,6 +308,12 @@ public abstract class TmfDataProvider extends TmfComponent implements ITmfDataPr } } + /** + * Queue a request. + * + * @param request + * The data request + */ protected void queueRequest(final ITmfDataRequest request) { if (fExecutor.isShutdown()) { @@ -355,10 +394,20 @@ public abstract class TmfDataProvider extends TmfComponent implements ITmfDataPr TmfCoreTracer.traceRequest(request, "QUEUED"); //$NON-NLS-1$ } fExecutor.execute(thread); - } - protected void queueBackgroundRequest(final ITmfDataRequest request, final int blockSize, final boolean indexing) { + /** + * Queue a background request + * + * @param request + * The request + * @param blockSize + * The request should be split in chunks of this size + * @param indexing + * Should we index the chunks + */ + protected void queueBackgroundRequest(final ITmfDataRequest request, + final int blockSize, final boolean indexing) { final TmfDataProvider provider = this; @@ -445,7 +494,9 @@ public abstract class TmfDataProvider extends TmfComponent implements ITmfDataPr * specific and will be updated by getNext(). * * @param request - * @return an application specific context; null if request can't be serviced + * The request + * @return Sn application specific context; null if request can't be + * serviced */ protected abstract ITmfContext armRequest(ITmfDataRequest request); 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 177654b049..4d7918e928 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 @@ -59,6 +59,7 @@ public abstract class CtfTmfEventField implements ITmfEventField { // Attributes // ------------------------------------------------------------------------ + /** The name of this field */ protected final String name; // ------------------------------------------------------------------------ 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 e08c0cc40d..abb586bedb 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 @@ -265,10 +265,13 @@ public class CtfTmfTrace extends TmfTrace implements ITmfEventParser { } /** + * Build the state system(s) associated with this trace type. + * * Suppressing the warning, because the 'throws' will usually happen in * sub-classes. * * @throws TmfTraceException + * If there is a problem during the build */ @SuppressWarnings("unused") protected void buildStateSystem() throws TmfTraceException { diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/event/TmfTimestampFormat.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/event/TmfTimestampFormat.java index dac4ee3a5d..e6661fb226 100644 --- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/event/TmfTimestampFormat.java +++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/event/TmfTimestampFormat.java @@ -235,12 +235,15 @@ public class TmfTimestampFormat extends SimpleDateFormat { */ protected String fSupplPatternLetters = "TSCN"; //$NON-NLS-1$ - /** + /* * The bracketing symbols used to mitigate the risk of a format string * that contains escaped sequences that would conflict with our format * extension. */ + /** The open bracket symbol */ protected String fOpenBracket = "[&"; //$NON-NLS-1$ + + /** The closing bracket symbol */ protected String fCloseBracket = "&]"; //$NON-NLS-1$ // ------------------------------------------------------------------------ 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 e7abfb8b25..025657ab0d 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 @@ -90,11 +90,21 @@ public abstract class TmfDataRequest implements ITmfDataRequest { private final Class fDataType; private final ExecutionType fExecType; - private final int fRequestId; // A unique request ID - protected long fIndex; // The index (rank) of the requested event - protected int fNbRequested; // The number of requested events (ALL_DATA for all) - private final int fBlockSize; // The block size (for BG requests) - private int fNbRead; // The number of reads so far + + /** A unique request ID */ + private final int fRequestId; + + /** The index (rank) of the requested event */ + protected long fIndex; + + /** The number of requested events (ALL_DATA for all) */ + protected int fNbRequested; + + /** The block size (for BG requests) */ + private final int fBlockSize; + + /** The number of reads so far */ + private int fNbRead; private final CountDownLatch startedLatch = new CountDownLatch(1); private final CountDownLatch completedLatch = new CountDownLatch(1); diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/statesystem/AbstractStateChangeInput.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/statesystem/AbstractStateChangeInput.java index aea775e9a1..6ec51b52df 100644 --- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/statesystem/AbstractStateChangeInput.java +++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/statesystem/AbstractStateChangeInput.java @@ -43,9 +43,11 @@ public abstract class AbstractStateChangeInput implements IStateChangeInput { private final Thread eventHandlerThread; private boolean ssAssigned; - protected ITmfStateSystemBuilder ss; private ITmfEvent currentEvent; + /** State system in which to insert the state changes */ + protected ITmfStateSystemBuilder ss; + /** * Instantiate a new state provider plugin. * diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/statistics/TmfStateStatistics.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/statistics/TmfStateStatistics.java index 8b9ff6ed51..7eeff57631 100644 --- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/statistics/TmfStateStatistics.java +++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/statistics/TmfStateStatistics.java @@ -330,7 +330,7 @@ public class TmfStateStatistics implements ITmfStatistics { return map; } - protected long checkStartTime(ITmfTimestamp startTs) { + private long checkStartTime(ITmfTimestamp startTs) { long start = startTs.normalize(0, ITmfTimestamp.NANOSECOND_SCALE).getValue(); if (start < stats.getStartTime()) { return stats.getStartTime(); @@ -338,7 +338,7 @@ public class TmfStateStatistics implements ITmfStatistics { return start; } - protected long checkEndTime(ITmfTimestamp endTs) { + private long checkEndTime(ITmfTimestamp endTs) { long end = endTs.normalize(0, ITmfTimestamp.NANOSECOND_SCALE).getValue(); if (end > stats.getCurrentEndTime()) { return stats.getCurrentEndTime(); diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/trace/TmfCheckpointIndexer.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/trace/TmfCheckpointIndexer.java index 3e212807ee..1861403be9 100644 --- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/trace/TmfCheckpointIndexer.java +++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/trace/TmfCheckpointIndexer.java @@ -56,13 +56,13 @@ public class TmfCheckpointIndexer implements ITmfTraceIndexer { // Attributes // ------------------------------------------------------------------------ - // The event trace to index + /** The event trace to index */ protected final ITmfTrace fTrace; - // The interval between checkpoints + /** The interval between checkpoints */ private final int fCheckpointInterval; - // The event trace to index + /** The event trace to index */ private boolean fIsIndexing; /** 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 d8b347cb45..ea18b442fd 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 @@ -109,7 +109,7 @@ public abstract class TmfTrace extends TmfEventProvider implements ITmfTrace { * @param type the trace event type * @param path the trace path * @param cacheSize the trace cache size - * @throws TmfTraceException + * @throws TmfTraceException If something failed during the opening */ protected TmfTrace(final IResource resource, final Class type, final String path, final int cacheSize) throws TmfTraceException { this(resource, type, path, cacheSize, 0); @@ -124,7 +124,7 @@ public abstract class TmfTrace extends TmfEventProvider implements ITmfTrace { * @param path the trace path * @param cacheSize the trace cache size * @param interval the trace streaming interval - * @throws TmfTraceException + * @throws TmfTraceException If something failed during the opening */ protected TmfTrace(final IResource resource, final Class type, final String path, final int cacheSize, final long interval) throws TmfTraceException { this(resource, type, path, cacheSize, interval, null); @@ -138,8 +138,9 @@ public abstract class TmfTrace extends TmfEventProvider implements ITmfTrace { * @param type the trace event type * @param path the trace path * @param cacheSize the trace cache size + * @param interval the trace streaming interval * @param indexer the trace indexer - * @throws TmfTraceException + * @throws TmfTraceException If something failed during the opening */ protected TmfTrace(final IResource resource, final Class type, final String path, final int cacheSize, final long interval, final ITmfTraceIndexer indexer) throws TmfTraceException { @@ -153,9 +154,10 @@ public abstract class TmfTrace extends TmfEventProvider implements ITmfTrace { * @param type the trace event type * @param path the trace path * @param cacheSize the trace cache size + * @param interval the trace streaming interval * @param indexer the trace indexer * @param parser the trace event parser - * @throws TmfTraceException + * @throws TmfTraceException If something failed during the opening */ protected TmfTrace(final IResource resource, final Class type, final String path, final int cacheSize, final long interval, final ITmfTraceIndexer indexer, final ITmfEventParser parser) throws TmfTraceException { @@ -205,7 +207,7 @@ public abstract class TmfTrace extends TmfEventProvider implements ITmfTrace { * @param path the trace path * @param type the trace event type * - * @throws TmfTraceException + * @throws TmfTraceException If something failed during the initialization */ protected void initialize(final IResource resource, final String path, final Class type) throws TmfTraceException { if (path == null) { @@ -252,9 +254,11 @@ public abstract class TmfTrace extends TmfEventProvider implements ITmfTrace { } /** - * The default implementation of TmfTrace uses a TmfStatistics backend. + * The default implementation of TmfTrace uses a TmfStatistics back-end. * Override this if you want to specify another type (or none at all). * + * @throws TmfTraceException + * If there was a problem setting up the statistics * @since 2.0 */ protected void buildStatistics() throws TmfTraceException { -- 2.34.1