diff --git a/src/main/java/org/eclipse/mat/SnapshotException.java b/src/main/java/org/eclipse/mat/SnapshotException.java index 7125f18..f711a66 100644 --- a/src/main/java/org/eclipse/mat/SnapshotException.java +++ b/src/main/java/org/eclipse/mat/SnapshotException.java @@ -28,9 +28,6 @@ public SnapshotException() { /** * Create snapshot exception with message and root cause. - * - * @param message - * @param cause */ public SnapshotException(String message, Throwable cause) { super(message, cause); @@ -38,8 +35,6 @@ public SnapshotException(String message, Throwable cause) { /** * Create snapshot exception with message only. - * - * @param message */ public SnapshotException(String message) { super(message); @@ -47,8 +42,6 @@ public SnapshotException(String message) { /** * Create snapshot exception with root cause only. - * - * @param cause */ public SnapshotException(Throwable cause) { super(cause); diff --git a/src/main/java/org/eclipse/mat/collect/ArrayIntBig.java b/src/main/java/org/eclipse/mat/collect/ArrayIntBig.java index 862e515..b4beb51 100644 --- a/src/main/java/org/eclipse/mat/collect/ArrayIntBig.java +++ b/src/main/java/org/eclipse/mat/collect/ArrayIntBig.java @@ -41,8 +41,7 @@ public ArrayIntBig() { /** * Add int to IntArray. * - * @param element - * int which should be added + * @param element int which should be added */ public final void add(int element) { int index = (length++) & 0x3FF; @@ -55,8 +54,7 @@ public final void add(int element) { /** * Add int[] to IntArray. * - * @param elements - * int[] which should be added + * @param elements int[] which should be added */ public final void addAll(int[] elements) { int free = (length & 0x3FF); @@ -78,8 +76,7 @@ public final void addAll(int[] elements) { /** * Get int at index from IntArray. * - * @param index - * index of int which should be returned + * @param index index of int which should be returned * @return int at index * @throws IndexOutOfBoundsException */ diff --git a/src/main/java/org/eclipse/mat/collect/ArrayIntCompressed.java b/src/main/java/org/eclipse/mat/collect/ArrayIntCompressed.java index 328634e..675d41a 100644 --- a/src/main/java/org/eclipse/mat/collect/ArrayIntCompressed.java +++ b/src/main/java/org/eclipse/mat/collect/ArrayIntCompressed.java @@ -32,8 +32,7 @@ public class ArrayIntCompressed { * Create IntArrayCompressed from bytes formerly got from * {@link #toByteArray()}. * - * @param bytes - * bytes formerly got from {@link #toByteArray()} + * @param bytes bytes formerly got from {@link #toByteArray()} */ public ArrayIntCompressed(byte[] bytes) { // Take data structure @@ -47,12 +46,9 @@ public ArrayIntCompressed(byte[] bytes) { * the number of leading and trailing clear bits. Everything else is stored * in the internal data structure. * - * @param size - * number of ints to be stored - * @param leadingClearBits - * number of leading clear bits - * @param trailingClearBits - * number of trailing clear bits + * @param size number of ints to be stored + * @param leadingClearBits number of leading clear bits + * @param trailingClearBits number of trailing clear bits */ public ArrayIntCompressed(int size, int leadingClearBits, int trailingClearBits) { // Initialize data structure @@ -63,8 +59,7 @@ public ArrayIntCompressed(int size, int leadingClearBits, int trailingClearBits) * Create IntArrayCompressed from ints representing the data to * be stored in compressed form. * - * @param ints - * ints representing the data to be stored in compressed form + * @param ints ints representing the data to be stored in compressed form */ public ArrayIntCompressed(int[] ints) { // Call more general constructor @@ -75,12 +70,9 @@ public ArrayIntCompressed(int[] ints) { * Create IntArrayCompressed from ints representing the data to * be stored in compressed form (from offset to offset+length). * - * @param ints - * ints representing the data to be stored in compressed form - * @param offset - * offset from which on to compress the ints - * @param length - * number of ints to compress from the given array + * @param ints ints representing the data to be stored in compressed form + * @param offset offset from which on to compress the ints + * @param length number of ints to compress from the given array */ public ArrayIntCompressed(int[] ints, int offset, int length) { // Determine leading and trailing clear bits @@ -119,10 +111,8 @@ private void init(int size, int varyingBits, int trailingClearBits) { /** * Set value at the given index. * - * @param index - * index at which the value should be set - * @param value - * value to be set at the given index + * @param index index at which the value should be set + * @param value value to be set at the given index */ public void set(int index, int value) { value >>>= trailingClearBits; @@ -144,8 +134,7 @@ public void set(int index, int value) { /** * Get value from the given index. * - * @param index - * index at which the value should be set + * @param index index at which the value should be set * @return value found at the given index */ public int get(int index) { @@ -174,7 +163,7 @@ public int get(int index) { * IntArrayCompressed can be reconstructed. * * @return bytes representing the internal data structure with which an - * IntArrayCompressed can be reconstructed + * IntArrayCompressed can be reconstructed */ public byte[] toByteArray() { // Return data structure diff --git a/src/main/java/org/eclipse/mat/collect/ArrayLongCompressed.java b/src/main/java/org/eclipse/mat/collect/ArrayLongCompressed.java index 5e5a404..e9099b8 100644 --- a/src/main/java/org/eclipse/mat/collect/ArrayLongCompressed.java +++ b/src/main/java/org/eclipse/mat/collect/ArrayLongCompressed.java @@ -32,8 +32,7 @@ public class ArrayLongCompressed { * Create LongArrayCompressed from bytes formerly got from * {@link #toByteArray()}. * - * @param bytes - * bytes formerly got from {@link #toByteArray()} + * @param bytes bytes formerly got from {@link #toByteArray()} */ public ArrayLongCompressed(byte[] bytes) { // Take data structure @@ -47,12 +46,9 @@ public ArrayLongCompressed(byte[] bytes) { * stored, the number of leading and trailing clear bits. Everything else is * stored in the internal data structure. * - * @param size - * number of longs to be stored - * @param leadingClearBits - * number of leading clear bits - * @param trailingClearBits - * number of trailing clear bits + * @param size number of longs to be stored + * @param leadingClearBits number of leading clear bits + * @param trailingClearBits number of trailing clear bits */ public ArrayLongCompressed(int size, int leadingClearBits, int trailingClearBits) { // Initialize data structure @@ -63,8 +59,7 @@ public ArrayLongCompressed(int size, int leadingClearBits, int trailingClearBits * Create LongArrayCompressed from longs representing the data * to be stored in compressed form. * - * @param longs - * longs representing the data to be stored in compressed form + * @param longs longs representing the data to be stored in compressed form */ public ArrayLongCompressed(long[] longs) { // Call more general constructor @@ -75,12 +70,9 @@ public ArrayLongCompressed(long[] longs) { * Create LongArrayCompressed from longs representing the data * to be stored in compressed form (from offset to offset+length). * - * @param longs - * longs representing the data to be stored in compressed form - * @param offset - * offset from which on to compress the longs - * @param length - * number of longs to compress from the given array + * @param longs longs representing the data to be stored in compressed form + * @param offset offset from which on to compress the longs + * @param length number of longs to compress from the given array */ public ArrayLongCompressed(long[] longs, int offset, int length) { // Determine leading and trailing clear bits @@ -119,10 +111,8 @@ private void init(int size, int varyingBits, int trailingClearBits) { /** * Set value at the given index. * - * @param index - * index at which the value should be set - * @param value - * value to be set at the given index + * @param index index at which the value should be set + * @param value value to be set at the given index */ public void set(int index, long value) { value >>>= trailingClearBits; @@ -144,8 +134,7 @@ public void set(int index, long value) { /** * Get value from the given index. * - * @param index - * index at which the value should be set + * @param index index at which the value should be set * @return value found at the given index */ public long get(int index) { @@ -174,7 +163,7 @@ public long get(int index) { * LongArrayCompressed can be reconstructed. * * @return bytes representing the internal data structure with which an - * LongArrayCompressed can be reconstructed + * LongArrayCompressed can be reconstructed */ public byte[] toByteArray() { // Return data structure diff --git a/src/main/java/org/eclipse/mat/collect/HashMapIntLong.java b/src/main/java/org/eclipse/mat/collect/HashMapIntLong.java index 874a5ff..150af8f 100644 --- a/src/main/java/org/eclipse/mat/collect/HashMapIntLong.java +++ b/src/main/java/org/eclipse/mat/collect/HashMapIntLong.java @@ -25,7 +25,7 @@ public interface Entry { private static NoSuchElementException noSuchElementException = new NoSuchElementException( "This is static exception, there is no stack trace available. It is thrown by get() method."); - //$NON-NLS-1$ + //$NON-NLS-1$ private static final long serialVersionUID = 1L; diff --git a/src/main/java/org/eclipse/mat/hprof/Pass1Parser.java b/src/main/java/org/eclipse/mat/hprof/Pass1Parser.java index 11dc820..267a56e 100644 --- a/src/main/java/org/eclipse/mat/hprof/Pass1Parser.java +++ b/src/main/java/org/eclipse/mat/hprof/Pass1Parser.java @@ -40,7 +40,7 @@ public class Pass1Parser extends AbstractParser { private static final Pattern PATTERN_OBJ_ARRAY = Pattern.compile("^(\\[+)L(.*);$"); //$NON-NLS-1$ private static final Pattern PATTERN_PRIMITIVE_ARRAY = Pattern.compile("^(\\[+)(.)$"); - //$NON-NLS-1$ + //$NON-NLS-1$ private HashMapLongObject class2name = new HashMapLongObject(); private HashMapLongObject thread2id = new HashMapLongObject(); diff --git a/src/main/java/org/eclipse/mat/parser/internal/DominatorTree.java b/src/main/java/org/eclipse/mat/parser/internal/DominatorTree.java index d66fcc3..a0f4966 100644 --- a/src/main/java/org/eclipse/mat/parser/internal/DominatorTree.java +++ b/src/main/java/org/eclipse/mat/parser/internal/DominatorTree.java @@ -162,18 +162,18 @@ public void compute() // retainedSetIdx is still sorted by object id snapshot.getIndexManager() .setReader(IndexManager.Index.DOMINATOR, new IndexWriter.IntIndexStreamer().writeTo( - IndexManager.Index.DOMINATOR.getFile(snapshot.getSnapshotInfo().getPrefix()), - new IteratorInt() { - int nextIndex = 2; + IndexManager.Index.DOMINATOR.getFile(snapshot.getSnapshotInfo().getPrefix()), + new IteratorInt() { + int nextIndex = 2; - public boolean hasNext() { - return nextIndex < dom.length; - } + public boolean hasNext() { + return nextIndex < dom.length; + } - public int next() { - return dom[nextIndex++]; - } - })); + public int next() { + return dom[nextIndex++]; + } + })); int[] objectIds = new int[snapshot.getSnapshotInfo().getNumberOfObjects() + 2]; for (int i = 0; i < objectIds.length; i++) @@ -518,7 +518,7 @@ public void calculateTotalSizesIterative(int e) throws SnapshotException, IOExce dump.getIndexManager() .setReader(Index.O2RETAINED, retained.writeTo( - IndexManager.Index.O2RETAINED.getFile(dump.getSnapshotInfo().getPrefix()))); + IndexManager.Index.O2RETAINED.getFile(dump.getSnapshotInfo().getPrefix()))); retained = null; progressListener.done(); diff --git a/src/main/java/org/eclipse/mat/parser/internal/GarbageCleaner.java b/src/main/java/org/eclipse/mat/parser/internal/GarbageCleaner.java index 84dc732..72e7258 100644 --- a/src/main/java/org/eclipse/mat/parser/internal/GarbageCleaner.java +++ b/src/main/java/org/eclipse/mat/parser/internal/GarbageCleaner.java @@ -209,16 +209,16 @@ public static int[] clean(final PreliminaryIndexImpl idx, final SnapshotImplBuil MessageUtil.format(Messages.GarbageCleaner_Writing, indexFile.getAbsolutePath())); idxManager.setReader(Index.O2CLASS, new IndexWriter.IntIndexStreamer().writeTo(indexFile, new NewObjectIntIterator() { - @Override int doGetNextInt(int index) { - return map[idx.object2classId.get(nextIndex)]; - // return - // map[object2classId.get(nextIndex)]; - } + @Override int doGetNextInt(int index) { + return map[idx.object2classId.get(nextIndex)]; + // return + // map[object2classId.get(nextIndex)]; + } - @Override int[] getMap() { - return map; - } - })); + @Override int[] getMap() { + return map; + } + })); object2classId.close(); object2classId.delete(); @@ -239,20 +239,20 @@ public static int[] clean(final PreliminaryIndexImpl idx, final SnapshotImplBuil // arrayObjects idxManager.setReader(Index.A2SIZE, new IndexWriter.IntIndexStreamer().writeTo(indexFile, new NewObjectIntIterator() { - IOne2OneIndex a2size = preA2size; - int newIndex = 0; - - @Override int doGetNextInt(int index) { - int size = a2size.get(nextIndex); - if (size > 0) arrayObjects.set(newIndex); - newIndex++; - return size; - } - - @Override int[] getMap() { - return map; - } - })); + IOne2OneIndex a2size = preA2size; + int newIndex = 0; + + @Override int doGetNextInt(int index) { + int size = a2size.get(nextIndex); + if (size > 0) arrayObjects.set(newIndex); + newIndex++; + return size; + } + + @Override int[] getMap() { + return map; + } + })); preA2size.close(); preA2size.delete(); diff --git a/src/main/java/org/eclipse/mat/parser/internal/StackFrameImpl.java b/src/main/java/org/eclipse/mat/parser/internal/StackFrameImpl.java index 978b26c..497338d 100644 --- a/src/main/java/org/eclipse/mat/parser/internal/StackFrameImpl.java +++ b/src/main/java/org/eclipse/mat/parser/internal/StackFrameImpl.java @@ -15,10 +15,8 @@ import org.eclipse.mat.snapshot.model.IStackFrame; /** - * * @noextend This class is not intended to be subclassed by clients. May still - * be subject of change - * + * be subject of change */ class StackFrameImpl implements IStackFrame { private String text; diff --git a/src/main/java/org/eclipse/mat/parser/internal/ThreadStackImpl.java b/src/main/java/org/eclipse/mat/parser/internal/ThreadStackImpl.java index 85b4c53..2adad5a 100644 --- a/src/main/java/org/eclipse/mat/parser/internal/ThreadStackImpl.java +++ b/src/main/java/org/eclipse/mat/parser/internal/ThreadStackImpl.java @@ -16,10 +16,8 @@ import org.eclipse.mat.snapshot.model.IThreadStack; /** - * * @noextend This class is not intended to be subclassed by clients. May still - * be subject of change - * + * be subject of change */ class ThreadStackImpl implements IThreadStack { private int threadId; diff --git a/src/main/java/org/eclipse/mat/snapshot/DominatorsSummary.java b/src/main/java/org/eclipse/mat/snapshot/DominatorsSummary.java index 2517d35..4ea1a57 100644 --- a/src/main/java/org/eclipse/mat/snapshot/DominatorsSummary.java +++ b/src/main/java/org/eclipse/mat/snapshot/DominatorsSummary.java @@ -74,7 +74,7 @@ public ClassDominatorRecord[] getClassDominatorRecords() { * Get the dominators summary grouped by class loaders * * @return ClassloaderDominatorRecord[] the array of - * ClassloaderDominatorRecords + * ClassloaderDominatorRecords */ public ClassloaderDominatorRecord[] getClassloaderDominatorRecords() { return getClassloaderDominatorRecords(ClassloaderDominatorRecord.class); @@ -232,8 +232,6 @@ public String getClassName() { /** * Set the name of the class of this record - * - * @param className */ public void setClassName(String className) { this.className = className; @@ -314,8 +312,6 @@ public int getClassloaderId() { /** * set the id of the classloader of the dominators - * - * @param classloaderId */ public void setClassloaderId(int classloaderId) { this.classloaderId = classloaderId; @@ -323,8 +319,6 @@ public void setClassloaderId(int classloaderId) { /** * Add a dominated object to the record - * - * @param objectId */ public boolean addDominated(int objectId) { return this.dominated.add(objectId); diff --git a/src/main/java/org/eclipse/mat/snapshot/IMultiplePathsFromGCRootsComputer.java b/src/main/java/org/eclipse/mat/snapshot/IMultiplePathsFromGCRootsComputer.java index b528611..8c495f2 100644 --- a/src/main/java/org/eclipse/mat/snapshot/IMultiplePathsFromGCRootsComputer.java +++ b/src/main/java/org/eclipse/mat/snapshot/IMultiplePathsFromGCRootsComputer.java @@ -28,10 +28,9 @@ public interface IMultiplePathsFromGCRootsComputer { * This record can be used to get the objects at the next level in the path, * etc... * - * @param progressListener - * - used to track the progress of the computation + * @param progressListener - used to track the progress of the computation * @return MultiplePathsFromGCRootsRecord[] one record for each group of - * paths starting from the same GC root + * paths starting from the same GC root * @throws SnapshotException */ public MultiplePathsFromGCRootsRecord[] getPathsByGCRoot(IProgressListener progressListener) @@ -43,10 +42,9 @@ public MultiplePathsFromGCRootsRecord[] getPathsByGCRoot(IProgressListener progr * element in the int[] is the specified object, and the last is the GC root * object * - * @param progressListener - * - used to track the progress of the computation + * @param progressListener - used to track the progress of the computation * @return Object[] - each element in the array is an int[] representing a - * path + * path * @throws SnapshotException */ public Object[] getAllPaths(IProgressListener progressListener) throws SnapshotException; diff --git a/src/main/java/org/eclipse/mat/snapshot/IPathsFromGCRootsComputer.java b/src/main/java/org/eclipse/mat/snapshot/IPathsFromGCRootsComputer.java index 625848d..7882573 100644 --- a/src/main/java/org/eclipse/mat/snapshot/IPathsFromGCRootsComputer.java +++ b/src/main/java/org/eclipse/mat/snapshot/IPathsFromGCRootsComputer.java @@ -40,9 +40,9 @@ public interface IPathsFromGCRootsComputer { * user might find a problem faster among just a few shorter paths). * * @return int array holding the object ids of the objects forming the path - * from the first element at index 0 (object for which the - * computation was started) to the last element in the int array - * (object identified as GC root) + * from the first element at index 0 (object for which the + * computation was started) to the last element in the int array + * (object identified as GC root) * @throws SnapshotException */ public int[] getNextShortestPath() throws SnapshotException; @@ -52,9 +52,8 @@ public interface IPathsFromGCRootsComputer { * paths. Either all so far collected paths could be dropped in here or just * the last ones if you want to limit the view. * - * @param paths - * paths from GC roots previously returned by - * {@link #getNextShortestPath} + * @param paths paths from GC roots previously returned by + * {@link #getNextShortestPath} * @return tree like data structure holding the paths from GC roots */ public PathsFromGCRootsTree getTree(Collection paths); diff --git a/src/main/java/org/eclipse/mat/snapshot/ISnapshot.java b/src/main/java/org/eclipse/mat/snapshot/ISnapshot.java index e664910..f7d5f9c 100644 --- a/src/main/java/org/eclipse/mat/snapshot/ISnapshot.java +++ b/src/main/java/org/eclipse/mat/snapshot/ISnapshot.java @@ -95,12 +95,10 @@ public interface ISnapshot { *

* Performance: Fast - in memory. * - * @param name - * name for the class - * @param includeSubClasses - * flag indicating whether or not to include also classes derived - * from matching classes (the name isn't taken into account for - * sub classes anymore) + * @param name name for the class + * @param includeSubClasses flag indicating whether or not to include also classes derived + * from matching classes (the name isn't taken into account for + * sub classes anymore) * @return collection of matching classes * @throws SnapshotException */ @@ -115,12 +113,10 @@ public Collection getClassesByName(String name, boolean includeSubClasse *

* Performance: Fast - in memory, but needs iteration over all classes. * - * @param namePattern - * name pattern for the class (regular expression) - * @param includeSubClasses - * flag indicating whether or not to include also classes derived - * from matching classes (the name isn't taken into account for - * sub classes anymore) + * @param namePattern name pattern for the class (regular expression) + * @param includeSubClasses flag indicating whether or not to include also classes derived + * from matching classes (the name isn't taken into account for + * sub classes anymore) * @return collection of matching classes * @throws SnapshotException */ @@ -169,8 +165,7 @@ public Collection getClassesByName(Pattern namePattern, boolean includeS *

* Performance: Relatively fast - single index operation. * - * @param objectId - * object which is referenced + * @param objectId object which is referenced * @return objects referencing the given object * @throws SnapshotException */ @@ -181,8 +176,7 @@ public Collection getClassesByName(Pattern namePattern, boolean includeS *

* Performance: Relatively fast - single index operation. * - * @param objectId - * object which is referencing + * @param objectId object which is referencing * @return objects referenced by the given object * @throws SnapshotException */ @@ -198,11 +192,9 @@ public Collection getClassesByName(Pattern namePattern, boolean includeS * Performance: Fast to slow - on index; depending on the number of objects * and the references. * - * @param objectIds - * objects which are referenced - * @param progressListener - * progress listener informing about the current state of - * execution + * @param objectIds objects which are referenced + * @param progressListener progress listener informing about the current state of + * execution * @return objects referencing the given objects * @throws SnapshotException */ @@ -219,11 +211,9 @@ public int[] getInboundRefererIds(int[] objectIds, IProgressListener progressLis * Performance: Fast to slow - on index; depending on the number of objects * and the references. * - * @param objectIds - * objects which are referencing - * @param progressListener - * progress listener informing about the current state of - * execution + * @param objectIds objects which are referencing + * @param progressListener progress listener informing about the current state of + * execution * @return objects referenced by the given objects * @throws SnapshotException */ @@ -243,15 +233,13 @@ public int[] getOutboundReferentIds(int[] objectIds, IProgressListener progressL * Performance: Fast to slow - on index; depending on the number and length * of GC root paths. * - * @param objectId - * object for which the GC root paths should be determined - * @param excludeMap - * a map specifying paths through which objects have to be - * avoided and not reported. Each entry in the map has the IClass - * as a key, and a Set set, specifying which fields - * exactly from this key class have to be avoided. If for a key - * IClass the value (Set) null is specified, then paths - * through any of the fields will be avoided + * @param objectId object for which the GC root paths should be determined + * @param excludeMap a map specifying paths through which objects have to be + * avoided and not reported. Each entry in the map has the IClass + * as a key, and a Set set, specifying which fields + * exactly from this key class have to be avoided. If for a key + * IClass the value (Set) null is specified, then paths + * through any of the fields will be avoided * @return interactive computer for paths from GC roots to the given object * @throws SnapshotException */ @@ -263,18 +251,16 @@ public IPathsFromGCRootsComputer getPathsFromGCRoots(int objectId, * calculate the shortest path from the GC roots to each of objects in the * specified object set. * - * @param objectIds - * the IDs of the objects for which a shortest path has to be - * calculated - * @param excludeMap - * a map specifying paths through which objects have to be - * avoided and not reported. Each entry in the map has the IClass - * as a key, and a Set set, specifying which fields - * exactly from this key class have to be avoided. If for a key - * IClass the value (Set) null is specified, then paths - * through any of the fields will be avoided + * @param objectIds the IDs of the objects for which a shortest path has to be + * calculated + * @param excludeMap a map specifying paths through which objects have to be + * avoided and not reported. Each entry in the map has the IClass + * as a key, and a Set set, specifying which fields + * exactly from this key class have to be avoided. If for a key + * IClass the value (Set) null is specified, then paths + * through any of the fields will be avoided * @return IMultiplePathsFromGCRootsComputer The object which can be used to - * carry out the actual computation and + * carry out the actual computation and * @throws SnapshotException */ public IMultiplePathsFromGCRootsComputer getMultiplePathsFromGCRoots(int[] objectIds, @@ -292,11 +278,9 @@ public IMultiplePathsFromGCRootsComputer getMultiplePathsFromGCRoots(int[] objec * Performance: Usually extremely slow - on index; depending on the number * of objects and the references (deep). * - * @param objectIds - * objects on which the retained set should be determined - * @param progressListener - * progress listener informing about the current state of - * execution + * @param objectIds objects on which the retained set should be determined + * @param progressListener progress listener informing about the current state of + * execution * @return retained set of objects for the given objects * @throws SnapshotException */ @@ -315,12 +299,9 @@ public int[] getRetainedSet(int[] objectIds, IProgressListener progressListener) * Performance: Usually extremely slow - on index; depending on the number * of objects and the references (deep). * - * @param objectIds - * objects on which the retained set should be determined - * @param fieldNames - * @param progressMonitor - * progress listener informing about the current state of - * execution + * @param objectIds objects on which the retained set should be determined + * @param progressMonitor progress listener informing about the current state of + * execution * @return retained set of objects for the given objects * @throws SnapshotException */ @@ -349,11 +330,9 @@ public int[] getRetainedSet(int[] objectIds, ExcludedReferencesDescriptor[] excl * Performance: Usually fast - for smaller sets this method is much faster * than getRetainedSet * - * @param objectIds - * objects on which the minimum retained set should be determined - * @param progressListener - * progress listener informing about the current state of - * execution + * @param objectIds objects on which the minimum retained set should be determined + * @param progressListener progress listener informing about the current state of + * execution * @return the minimum retained set of objects for the given objects * @throws SnapshotException */ @@ -365,11 +344,9 @@ public int[] getMinRetainedSet(int[] objectIds, IProgressListener progressListen * faster than getting the min. retained set by getMinRetainedSet() and * calculating the size of the min. retained set. * - * @param objectIds - * objects on which the minimum retained set should be determined - * @param listener - * progress listener informing about the current state of - * execution + * @param objectIds objects on which the minimum retained set should be determined + * @param listener progress listener informing about the current state of + * execution * @return the minimum retained set of objects for the given objects * @throws SnapshotException */ @@ -382,9 +359,8 @@ public long getMinRetainedSize(int[] objectIds, IProgressListener listener) * directly dependent objects), i.e. the objects which would get collected * as garbage if the given object would be gone from the heap. * - * @param objectId - * object for which the directly dominated objects should be - * returned + * @param objectId object for which the directly dominated objects should be + * returned * @return objects the given object directly dominates * @throws SnapshotException */ @@ -397,11 +373,10 @@ public long getMinRetainedSize(int[] objectIds, IProgressListener listener) * the given object to be collected as garbage if it would be gone from the * heap. * - * @param objectId - * object for which the directly dominated objects should be - * returned + * @param objectId object for which the directly dominated objects should be + * returned * @return Object id of the dominator. -1 if the object is dominated by the - * root of the dominator tree. + * root of the dominator tree. * @throws SnapshotException */ public int getImmediateDominatorId(int objectId) throws SnapshotException; @@ -416,17 +391,14 @@ public long getMinRetainedSize(int[] objectIds, IProgressListener listener) * be taken and checked, and so on ... until a dominator not matching the * pattern is found or the dominator tree root is reached. * - * @param objectIds - * the objects for which we want the dominator summary (e.g. all - * objects of a given class) - * @param excludePattern - * An exclude pattern. Domminators whose class name matches the - * pattern will be omitted and their dominator will be taken - * @param progressListener - * progress listener informing about the current state of - * execution + * @param objectIds the objects for which we want the dominator summary (e.g. all + * objects of a given class) + * @param excludePattern An exclude pattern. Domminators whose class name matches the + * pattern will be omitted and their dominator will be taken + * @param progressListener progress listener informing about the current state of + * execution * @return DominatorsSummary the returned DominatorSummary contains the - * summary of the dominators grouped by classes or class loaders + * summary of the dominators grouped by classes or class loaders * @throws SnapshotException */ public DominatorsSummary getDominatorsOf(int[] objectIds, Pattern excludePattern, @@ -440,14 +412,12 @@ public DominatorsSummary getDominatorsOf(int[] objectIds, Pattern excludePattern * independent on one another. It is then correct to sum the retained sizes * of the returned objects. * - * @param objectIds - * the objects for which the top-ancestors in the Dominator tree - * have to be found - * @param listener - * progress listener informing about the current state of - * execution + * @param objectIds the objects for which the top-ancestors in the Dominator tree + * have to be found + * @param listener progress listener informing about the current state of + * execution * @return int[] the objects which not in a parent/child relation in the - * dominator tree + * dominator tree * @throws SnapshotException */ public int[] getTopAncestorsInDominatorTree(int[] objectIds, IProgressListener listener) @@ -459,10 +429,9 @@ public int[] getTopAncestorsInDominatorTree(int[] objectIds, IProgressListener l *

* Performance: Relatively fast - single index operation. * - * @param objectId - * id of object you want a convenient object abstraction for + * @param objectId id of object you want a convenient object abstraction for * @return object abstracting the real Java Object from the heap dump - * identified by the given id + * identified by the given id * @throws SnapshotException */ public IObject getObject(int objectId) throws SnapshotException; @@ -476,8 +445,7 @@ public int[] getTopAncestorsInDominatorTree(int[] objectIds, IProgressListener l *

* Performance: Fast - in memory. * - * @param objectId - * id of object you want the GC root info for + * @param objectId id of object you want the GC root info for * @return null if this object is no GC root or GCRootInfo[] if it is * @throws SnapshotException */ @@ -489,10 +457,9 @@ public int[] getTopAncestorsInDominatorTree(int[] objectIds, IProgressListener l *

* Performance: Relatively fast - single index operation. * - * @param objectId - * id of object you want the convenient class abstraction for + * @param objectId id of object you want the convenient class abstraction for * @return object abstracting the real Java Class this object was an - * instance of in the heap dump identified by the given id + * instance of in the heap dump identified by the given id * @throws SnapshotException */ public IClass getClassOf(int objectId) throws SnapshotException; @@ -503,8 +470,7 @@ public int[] getTopAncestorsInDominatorTree(int[] objectIds, IProgressListener l * Performance: Usually fast - in memory for non-array objects and single * index operation for array objects. * - * @param objectId - * id of object for which you want the heap size for + * @param objectId id of object for which you want the heap size for * @return heap size for the given object * @throws SnapshotException */ @@ -517,8 +483,7 @@ public int[] getTopAncestorsInDominatorTree(int[] objectIds, IProgressListener l * size of a set of objects is much faster than iterating over the ids and * calling getHeapSize for each single object * - * @param objectIds - * ids of the objects for which you want the heap size for + * @param objectIds ids of the objects for which you want the heap size for * @return total heap size for the given object set * @throws SnapshotException */ @@ -534,10 +499,9 @@ public int[] getTopAncestorsInDominatorTree(int[] objectIds, IProgressListener l *

* Performance: Relatively fast - single index operation. * - * @param objectId - * id of object for which you want the retained heap size for + * @param objectId id of object for which you want the retained heap size for * @return retained heap size for the given object or 0 if no dominator tree - * was calculated + * was calculated * @throws SnapshotException */ public long getRetainedHeapSize(int objectId) throws SnapshotException; @@ -576,8 +540,7 @@ public int[] getTopAncestorsInDominatorTree(int[] objectIds, IProgressListener l *

* Performance: Fast - in memory. * - * @param objectId - * id of object you want the address for + * @param objectId id of object you want the address for * @return object address * @throws SnapshotException */ @@ -589,8 +552,7 @@ public int[] getTopAncestorsInDominatorTree(int[] objectIds, IProgressListener l *

* Performance: Fast - binary search in memory. * - * @param objectAddress - * address of object you want the id for + * @param objectAddress address of object you want the id for * @return object id * @throws SnapshotException */ @@ -611,7 +573,7 @@ public int[] getTopAncestorsInDominatorTree(int[] objectIds, IProgressListener l *

* * @return SnapshotAddons - extended information, e.g. perm info, OoM stack - * trace info, JVM arguments, etc. + * trace info, JVM arguments, etc. * @throws SnapshotException */ public A getSnapshotAddons(Class addon) throws SnapshotException; @@ -622,8 +584,8 @@ public int[] getTopAncestorsInDominatorTree(int[] objectIds, IProgressListener l *

* * @return IThreadStack - an object representing the call stack of the - * thread. Returns null if no info is available for the object, or - * no stack info is available at all + * thread. Returns null if no info is available for the object, or + * no stack info is available at all * @throws SnapshotException * @since 0.8 */ diff --git a/src/main/java/org/eclipse/mat/snapshot/MultiplePathsFromGCRootsClassRecord.java b/src/main/java/org/eclipse/mat/snapshot/MultiplePathsFromGCRootsClassRecord.java index 8d00dc8..0165d3c 100644 --- a/src/main/java/org/eclipse/mat/snapshot/MultiplePathsFromGCRootsClassRecord.java +++ b/src/main/java/org/eclipse/mat/snapshot/MultiplePathsFromGCRootsClassRecord.java @@ -66,8 +66,6 @@ record = new MultiplePathsFromGCRootsClassRecord(clazz, nextLevel, fromRoots, sn /** * This method is used only when the record is built. Adds one path to the * set of paths - * - * @param path */ public void addPath(int[] path) { paths.add(path); @@ -77,7 +75,7 @@ public void addPath(int[] path) { * Get all the paths going through the object (getObjectId()) * * @return List each element in the list is an int[] representing a - * path + * path */ public List getPaths() { return paths; diff --git a/src/main/java/org/eclipse/mat/snapshot/MultiplePathsFromGCRootsRecord.java b/src/main/java/org/eclipse/mat/snapshot/MultiplePathsFromGCRootsRecord.java index f7e5737..9019308 100644 --- a/src/main/java/org/eclipse/mat/snapshot/MultiplePathsFromGCRootsRecord.java +++ b/src/main/java/org/eclipse/mat/snapshot/MultiplePathsFromGCRootsRecord.java @@ -48,12 +48,9 @@ public void setReferencedRetainedSize(long referencedRetainedSize) { /** * A constructor to create the record * - * @param objectId - * - the ID of the object which is common for all the paths - * @param level - * - the level (depth) in the paths where this objects appears - * @param snapshot - * - an ISnapshot object used for further calculation + * @param objectId - the ID of the object which is common for all the paths + * @param level - the level (depth) in the paths where this objects appears + * @param snapshot - an ISnapshot object used for further calculation */ public MultiplePathsFromGCRootsRecord(int objectId, int level, ISnapshot snapshot) { this.level = level; @@ -70,7 +67,7 @@ public MultiplePathsFromGCRootsRecord(int objectId, int level, ISnapshot snapsho * GC roots to the objects * * @return MultiplePathsFromGCRootsRecord[] Each record in the result - * represents again paths going through one and the same object + * represents again paths going through one and the same object */ public MultiplePathsFromGCRootsRecord[] nextLevel() { int new_level = level + 1; @@ -95,8 +92,6 @@ record = new MultiplePathsFromGCRootsRecord(path[path.length - new_level - 1], n /** * This method is used only when the record is built. Adds one path to the * set of paths - * - * @param path */ public void addPath(int[] path) { paths.add(path); @@ -106,7 +101,7 @@ public void addPath(int[] path) { * Get all the paths going through the object (getObjectId()) * * @return List each element in the list is an int[] representing a - * path + * path */ public List getPaths() { return paths; diff --git a/src/main/java/org/eclipse/mat/snapshot/PathsFromGCRootsTree.java b/src/main/java/org/eclipse/mat/snapshot/PathsFromGCRootsTree.java index b27f2a9..c974d59 100644 --- a/src/main/java/org/eclipse/mat/snapshot/PathsFromGCRootsTree.java +++ b/src/main/java/org/eclipse/mat/snapshot/PathsFromGCRootsTree.java @@ -52,8 +52,7 @@ public int[] getObjectIds() { /** * Get sub tree for a referencing object. * - * @param objId - * referencing object from which on the sub tree is requested + * @param objId referencing object from which on the sub tree is requested * @return sub tree for a referencing object */ public PathsFromGCRootsTree getBranch(int objId) { diff --git a/src/main/java/org/eclipse/mat/snapshot/SnapshotInfo.java b/src/main/java/org/eclipse/mat/snapshot/SnapshotInfo.java index 4251429..1929fd6 100644 --- a/src/main/java/org/eclipse/mat/snapshot/SnapshotInfo.java +++ b/src/main/java/org/eclipse/mat/snapshot/SnapshotInfo.java @@ -41,26 +41,17 @@ public class SnapshotInfo implements Serializable { /** * Construct a snapshot info. * - * @param path - * path from where the snapshot was acquired - * @param jvmInfo - * version of the JVM from which it was acquired - * @param identifierSize - * size of the internal identifiers in the heap dump, i.e. 32 or - * 64 bit - * @param creationDate - * date when the snapshot was acquired/parsed - * @param numberOfObjects - * number of Java objects found in the snapshot - * @param numberOfGCRoots - * number of GC roots found in the snapshot - * @param numberOfClasses - * number of Java Classes found in the snapshot - * @param numberOfClassLoaders - * number of ClassLoaders found in the snapshot - * @param usedHeapSize - * number of bytes used in the heap (the allocated memory may be - * higher) + * @param path path from where the snapshot was acquired + * @param jvmInfo version of the JVM from which it was acquired + * @param identifierSize size of the internal identifiers in the heap dump, i.e. 32 or + * 64 bit + * @param creationDate date when the snapshot was acquired/parsed + * @param numberOfObjects number of Java objects found in the snapshot + * @param numberOfGCRoots number of GC roots found in the snapshot + * @param numberOfClasses number of Java Classes found in the snapshot + * @param numberOfClassLoaders number of ClassLoaders found in the snapshot + * @param usedHeapSize number of bytes used in the heap (the allocated memory may be + * higher) */ public SnapshotInfo(String path, String prefix, String jvmInfo, int identifierSize, Date creationDate, int numberOfObjects, int numberOfGCRoots, int numberOfClasses, @@ -131,7 +122,7 @@ public String getJvmInfo() { * Get size of the internal identifiers in the heap dump, i.e. 32 or 64 bit. * * @return size of the internal identifiers in the heap dump, i.e. 32 or 64 - * bit + * bit */ public int getIdentifierSize() { return identifierSize; @@ -141,7 +132,7 @@ public int getIdentifierSize() { * Get date when the snapshot was acquired/parsed. * * @return creation date, or null if the creation date is not - * known + * known */ public Date getCreationDate() { return creationDate != null ? new Date(creationDate.getTime()) : null; @@ -187,7 +178,7 @@ public int getNumberOfClassLoaders() { * Get number of bytes used in the heap (the allocated memory may be higher) * * @return number of bytes used in the heap (the allocated memory may be - * higher) + * higher) */ public long getUsedHeapSize() { return usedHeapSize; diff --git a/src/main/java/org/eclipse/mat/snapshot/extension/IClassSpecificNameResolver.java b/src/main/java/org/eclipse/mat/snapshot/extension/IClassSpecificNameResolver.java index f17ec63..33a700f 100644 --- a/src/main/java/org/eclipse/mat/snapshot/extension/IClassSpecificNameResolver.java +++ b/src/main/java/org/eclipse/mat/snapshot/extension/IClassSpecificNameResolver.java @@ -26,8 +26,7 @@ public interface IClassSpecificNameResolver { /** * Resolve the name for snapshot object. * - * @param object - * object for which the name should be resolved + * @param object object for which the name should be resolved * @return name for snapshot object * @throws SnapshotException */ diff --git a/src/main/java/org/eclipse/mat/snapshot/model/IObject.java b/src/main/java/org/eclipse/mat/snapshot/model/IObject.java index 233c398..ff462de 100644 --- a/src/main/java/org/eclipse/mat/snapshot/model/IObject.java +++ b/src/main/java/org/eclipse/mat/snapshot/model/IObject.java @@ -81,7 +81,7 @@ public interface Type { * Get retained heap size of this object. * * @return retained heap size of this object (returns 0 if the dominator - * tree wasn't calculated for the corresponding snapshot) + * tree wasn't calculated for the corresponding snapshot) */ public long getRetainedHeapSize(); @@ -98,7 +98,7 @@ public interface Type { * char[]. * * @return class specific name of the given snapshot object or null if it - * can't be resolved + * can't be resolved */ public String getClassSpecificName(); @@ -107,7 +107,7 @@ public interface Type { * {@link #getClassSpecificName()}. * * @return concatenation of {@link #getTechnicalName()} and - * {@link #getClassSpecificName()} + * {@link #getClassSpecificName()} */ public String getDisplayName(); @@ -116,7 +116,7 @@ public interface Type { * the name of the field over which it was referenced. * * @return list of snapshot objects referenced from this snapshot object - * with the name of the field over which it was referenced + * with the name of the field over which it was referenced */ public List getOutboundReferences(); @@ -131,8 +131,7 @@ public interface Type { * are followed and its fields are evaluated. If any of the object * references is null, null is returned. * - * @param field - * the field name in dot notation + * @param field the field name in dot notation * @return the value of the field */ public Object resolveValue(String field) throws SnapshotException; @@ -144,7 +143,7 @@ public interface Type { * object). * * @return {@link GCRootInfo} if the object is a garbage collection root or - * null otherwise + * null otherwise */ public GCRootInfo[] getGCRootInfo() throws SnapshotException; diff --git a/src/main/java/org/eclipse/mat/snapshot/model/IStackFrame.java b/src/main/java/org/eclipse/mat/snapshot/model/IStackFrame.java index c10998f..f7a4395 100644 --- a/src/main/java/org/eclipse/mat/snapshot/model/IStackFrame.java +++ b/src/main/java/org/eclipse/mat/snapshot/model/IStackFrame.java @@ -25,7 +25,7 @@ public interface IStackFrame { * both Java and JNI local objects * * @return int[] and array containing the object Ids. If there are no local - * objects to the frame, and empty array will be returned + * objects to the frame, and empty array will be returned */ public int[] getLocalObjectsIds(); diff --git a/src/main/java/org/eclipse/mat/snapshot/model/IThreadStack.java b/src/main/java/org/eclipse/mat/snapshot/model/IThreadStack.java index e42a063..4de7710 100644 --- a/src/main/java/org/eclipse/mat/snapshot/model/IThreadStack.java +++ b/src/main/java/org/eclipse/mat/snapshot/model/IThreadStack.java @@ -25,8 +25,8 @@ public interface IThreadStack { * stack * * @return {@link IStackFrame}[] an array containing all stack frames. The - * first element of the array contains the top of the stack, and the - * last element the bottom of the stack + * first element of the array contains the top of the stack, and the + * last element the bottom of the stack */ public IStackFrame[] getStackFrames(); diff --git a/src/main/java/org/eclipse/mat/snapshot/registry/ClassSpecificNameResolverRegistry.java b/src/main/java/org/eclipse/mat/snapshot/registry/ClassSpecificNameResolverRegistry.java index b8cdb5b..174f3e0 100644 --- a/src/main/java/org/eclipse/mat/snapshot/registry/ClassSpecificNameResolverRegistry.java +++ b/src/main/java/org/eclipse/mat/snapshot/registry/ClassSpecificNameResolverRegistry.java @@ -58,14 +58,14 @@ private String doResolve(IObject object) { } catch (RuntimeException e) { Logger.getLogger(ClassSpecificNameResolverRegistry.class.getName()) .log(Level.SEVERE, MessageUtil.format( - Messages.ClassSpecificNameResolverRegistry_ErrorMsg_DuringResolving, - object.getTechnicalName()), e); + Messages.ClassSpecificNameResolverRegistry_ErrorMsg_DuringResolving, + object.getTechnicalName()), e); return null; } catch (SnapshotException e) { Logger.getLogger(ClassSpecificNameResolverRegistry.class.getName()) .log(Level.SEVERE, MessageUtil.format( - Messages.ClassSpecificNameResolverRegistry_ErrorMsg_DuringResolving, - object.getTechnicalName()), e); + Messages.ClassSpecificNameResolverRegistry_ErrorMsg_DuringResolving, + object.getTechnicalName()), e); return null; } } @@ -143,8 +143,7 @@ private ClassSpecificNameResolverRegistry() { * Resolve name of the given snapshot object or return null if it can't be * resolved. * - * @param object - * snapshot object for which the name should be resolved + * @param object snapshot object for which the name should be resolved * @return name of the given snapshot object or null if it can't be resolved */ public static String resolve(IObject object) { diff --git a/src/main/java/org/eclipse/mat/util/IProgressListener.java b/src/main/java/org/eclipse/mat/util/IProgressListener.java index 67918d2..fd77ec7 100644 --- a/src/main/java/org/eclipse/mat/util/IProgressListener.java +++ b/src/main/java/org/eclipse/mat/util/IProgressListener.java @@ -64,13 +64,11 @@ public class OperationCanceledException extends RuntimeException { * Notifies that the main task is beginning. This must only be called once * on a given progress monitor instance. * - * @param name - * the name (or description) of the main task - * @param totalWork - * the total number of work units into which the main task is - * been subdivided. If the value is UNKNOWN the - * implementation is free to indicate progress in a way which - * doesn't require the total number of work units in advance. + * @param name the name (or description) of the main task + * @param totalWork the total number of work units into which the main task is + * been subdivided. If the value is UNKNOWN the + * implementation is free to indicate progress in a way which + * doesn't require the total number of work units in advance. */ public void beginTask(String name, int totalWork); @@ -87,7 +85,7 @@ public class OperationCanceledException extends RuntimeException { * requested. * * @return true if cancellation has been requested, and - * false otherwise + * false otherwise * @see #setCanceled(boolean) */ public boolean isCanceled(); @@ -95,10 +93,9 @@ public class OperationCanceledException extends RuntimeException { /** * Sets the cancel state to the given value. * - * @param value - * true indicates that cancelation has been - * requested (but not necessarily acknowledged); - * false clears this flag + * @param value true indicates that cancelation has been + * requested (but not necessarily acknowledged); + * false clears this flag * @see #isCanceled() */ public void setCanceled(boolean value); @@ -107,8 +104,7 @@ public class OperationCanceledException extends RuntimeException { * Notifies that a subtask of the main task is beginning. Subtasks are * optional; the main task might not have subtasks. * - * @param name - * the name (or description) of the subtask + * @param name the name (or description) of the subtask */ public void subTask(String name); @@ -117,8 +113,7 @@ public class OperationCanceledException extends RuntimeException { * completed. Note that this amount represents an installment, as opposed to * a cumulative amount of work done to date. * - * @param work - * the number of work units just completed + * @param work the number of work units just completed */ public void worked(int work); @@ -143,13 +138,10 @@ public enum Severity { /** * Sends a message to the user. * - * @param severity - * Severity as defined in {@link Severity} - * @param message - * The message localized to the current locale. - * @param exception - * The relevant low-level exception, or null if - * none. + * @param severity Severity as defined in {@link Severity} + * @param message The message localized to the current locale. + * @param exception The relevant low-level exception, or null if + * none. */ public void sendUserMessage(Severity severity, String message, Throwable exception); }