DJDocument.java
| Index Score | ||
|---|---|---|
 |
 |
edu.rice.cs.drjava.model |
 |
 |
DrJava |
View: Reasons, Metrics, Source Code
These are the metrics that contribute to the Enerjy Score for this file, ranked by impact. So the metrics listed at the top influence the score to a greater extent that the metrics listed at the bottom.
| Metric | Description | |
|---|---|---|
| DECL_COMMENTS | Comments in declarations |  |
| LINE_COMMENT | Number of line comments | |
| JAVA0115 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0141 | JAVA0141 Unnecessary modifier for method in interface | |
| COMMENTS | Comment lines | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| PARAMS | Number of formal parameter declarations | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| DOC_COMMENT | Number of javadoc comment lines | |
| FUNCTIONS | Number of function declarations | |
| SIZE | Size of the file in bytes | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0136 | JAVA0136 N methods defined in class (maximum: M) | |
| EXEC_COMMENTS | Comments in executable code | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| COMPARISONS | Number of comparison operators | |
| ELOC | Effective lines of code | |
| LOC | Lines of code | |
| OPERATORS | Number of operators | |
| LOGICAL_LINES | Number of statements | |
| PROGRAM_LENGTH | Halstead program length | |
| BLOCKS | Number of blocks | |
| RETURNS | Number of return points from functions | |
| OPERANDS | Number of operands | |
| LOOPS | Number of loops | |
| EXITS | Procedure exits | |
| CYCLOMATIC | Cyclomatic complexity | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
/*BEGIN_COPYRIGHT_BLOCK
*
* Copyright (c) 2001-2008, JavaPLT group at Rice University (drjava@rice.edu)
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* * Neither the names of DrJava, the JavaPLT group, Rice University, nor the
* names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* This software is Open Source Initiative approved Open Source Software.
* Open Source Initative Approved is a trademark of the Open Source Initiative.
*
* This file is part of DrJava. Download the current version of this project
* from http://www.drjava.org/ or http://sourceforge.net/projects/drjava/
*
* END_COPYRIGHT_BLOCK*/
package edu.rice.cs.drjava.model;
import edu.rice.cs.drjava.model.definitions.reducedmodel.*;
import edu.rice.cs.util.text.SwingDocumentInterface;
import edu.rice.cs.util.OperationCanceledException;
import edu.rice.cs.drjava.model.definitions.ClassNameNotFoundException;
import edu.rice.cs.drjava.model.definitions.indent.Indenter;
import java.util.ArrayList;
import javax.swing.text.AttributeSet;
import javax.swing.text.BadLocationException;
import javax.swing.text.StyledDocument;
import javax.swing.ProgressMonitor;
/** Interface shared by the Definitions Document, Open Definitions Document, and Interactions Document. Characteristic
* of native DrJava Documents (as opposed to DrJava plugin documents).
*/
public interface DJDocument extends SwingDocumentInterface {
/** Gets the indent level.
* @return the indent level
*/
public int getIndent();
/** Sets the indent to a particular number of spaces.
* @param indent the size of indent that you want for the document
*/
public void setIndent(int indent);
/** Returns highlight status info for text between start and end, coalescing adjoining blocks with the same status. */
public ArrayList<HighlightStatus> getHighlightStatus(int start, int end);
/** Gets the current location of the cursor the document. Unlike the Swing document model, which is stateless, we must
* maintain a current location as part of the document because the implementation of the reduced model relies on this
* state information.
* @return where the cursor is as the number of characters into the document
*/
public int getCurrentLocation();
/** Change the current location of the document
* @param loc the new absolute location
*/
public void setCurrentLocation(int loc);
/** Moves the current location the specified number of chars (positive is right; negative is left). It is used as a
* helper for setCurrentLocation(int).
* @param dist the distance from the current location to the new location.
*/
public void move(int dist);
// /* Returns whether a block indent operation is in progress on this document. */
// public boolean indentInProgress();
/** Finds the match for the closing brace immediately to the left, assuming there is such a brace.
* @return the relative distance backwards to the offset before the matching brace.
*/
public int balanceBackward();
/* Raw version of balanceBackward. Assume read and reduced locks are already held. */
public int _balanceBackward();
/** Finds the match for the open brace immediately to the right, assuming there is such a brace.
* @return the relative distance forwards to the offset after the matching brace.
*/
public int balanceForward();
/* Raw version of balanceForward. Assume read and reduced locks are already held. */
public int _balanceForward();
// /** Returns the indent information for the current location. */
// public IndentInfo getIndentInformation();
// public ReducedModelState stateAtRelLocation(int dist);
public ReducedModelState _getStateAtCurrent();
// public void resetReducedModelLocation();
/** Searching backwards, finds the position of the enclosing brace. NB: ignores comments.
* @param pos Position to start from
* @param opening opening brace character
* @param closing closing brace character
* @return position of enclosing curly brace, or ERROR_INDEX (-1) if beginning
* of document is reached.
*/
public int _findPrevEnclosingBrace(int pos, char opening, char closing) throws BadLocationException;
/** Searching forwards, finds the position of the enclosing brace.
* NB: ignores comments.
* @param pos Position to start from
* @param opening opening brace character
* @param closing closing brace character
* @return position of enclosing curly brace, or ERROR_INDEX (-1) if beginning
* of document is reached.
*/
public int _findNextEnclosingBrace(int pos, char opening, char closing) throws BadLocationException;
/** Searching backwards, finds the position of the first character that is one
* of the given delimiters. Does not look for delimiters inside paren phrases.
* (eg. skips semicolons used inside for statements.)
* NB: ignores comments.
* @param pos Position to start from
* @param delims array of characters to search for
* @return position of first matching delimiter, or ERROR_INDEX (-1) if beginning
* of document is reached.
*/
public int _findPrevDelimiter(int pos, char[] delims) throws BadLocationException;
/** Searching backwards, finds the position of the first character that is one
* of the given delimiters. Will not look for delimiters inside a paren
* phrase if skipParenPhrases is true.
* NB: ignores comments.
* @param pos Position to start from
* @param delims array of characters to search for
* @param skipParenPhrases whether to look for delimiters inside paren phrases
* (eg. semicolons in a for statement)
* @return position of first matching delimiter, or ERROR_INDEX (-1) if beginning
* of document is reached.
*/
public int _findPrevDelimiter(int pos, char[] delims, boolean skipParenPhrases) throws BadLocationException;
// /** This function finds the given character in the same statement as the given
// * position, and before the given position. It is used by QuestionExistsCharInStmt and
// * QuestionExistsCharInPrevStmt
// */
// public boolean findCharInStmtBeforePos(char findChar, int position);
// /** Finds the position of the first non-whitespace character before pos.
// * NB: Skips comments and all whitespace, including newlines
// * @param pos Position to start from
// * @param whitespace chars considered as white space
// * @return position of first non-whitespace character before pos,
// * or ERROR_INDEX (-1) if begining of document is reached
// */
// public int findPrevCharPos(int pos, char[] whitespace) throws BadLocationException;
/** Default indentation - uses OTHER flag and no progress indicator.
* @param selStart the offset of the initial character of the region to indent
* @param selEnd the offset of the last character of the region to indent
*/
public void indentLines(int selStart, int selEnd);
/** Parameterized indentation for special-case handling.
* @param selStart the offset of the initial character of the region to indent
* @param selEnd the offset of the last character of the region to indent
* @param reason a flag from {@link edu.rice.cs.drjava.model.definitions.indent.Indenter Indenter}
* to indicate the reason for the indent (indent logic may vary slightly based on the trigger action)
* @param pm used to display progress, null if no reporting is desired
*/
public void indentLines(int selStart, int selEnd, Indenter.IndentReason reason, ProgressMonitor pm)
throws OperationCanceledException;
/** Returns the "intelligent" beginning of line. If currPos is to the right of the first non-whitespace character,
* the position of the first non-whitespace character is returned. If currPos is at or to the left of the first
* non-whitespace character, the beginning of the line is returned.
* @param currPos A position on the current line
*/
public int getIntelligentBeginLinePos(int currPos) throws BadLocationException;;
/** Returns the indent level of the start of the statement that the cursor is on. Uses a default set of delimiters.
* (';', '{', '}') and a default set of whitespace characters (' ', '\t', n', ',').
* @param pos Cursor position
*/
public int _getIndentOfCurrStmt(int pos) throws BadLocationException;
/** Returns the indent level of the start of the statement that the cursor is on. Uses a default set of whitespace
* characters (' ', '\t', '\n', ',').
* @param pos Cursor position
*/
public int _getIndentOfCurrStmt(int pos, char[] delims) throws BadLocationException;
/** Returns the indent level of the start of the statement
* that the cursor is on.
* @param pos Cursor position
* @param delims Delimiter characters denoting end of statement
* @param whitespace characters to skip when looking for beginning of next statement
*/
public int _getIndentOfCurrStmt(int pos, char[] delims, char[] whitespace)
throws BadLocationException;
/** Determines if the given character exists on the line where
* the given cursor position is. Does not search in quotes or comments.
* <p>
* <b>Does not work if character being searched for is a '/' or a '*'</b>
* @param pos Cursor position
* @param findChar Character to search for
* @return true if this node's rule holds.
*/
public int findCharOnLine(int pos, char findChar);
/** Returns the absolute position of the beginning of the
* current line. (Just after most recent newline, or 0)
* Doesn't ignore comments.
* @param pos Any position on the current line
* @return position of the beginning of this line
*/
public int _getLineStartPos(int pos);
/** Returns the absolute position of the end of the current
* line. (At the next newline, or the end of the document.)
* @param pos Any position on the current line
* @return position of the end of this line
*/
public int _getLineEndPos(int pos);
/** Returns the absolute position of the first non-whitespace character
* on the current line.
* NB: Doesn't ignore comments.
* @param pos position on the line
* @return position of first non-whitespace character on this line, or the end
* of the line if no non-whitespace character is found.
*/
public int _getLineFirstCharPos(int pos) throws BadLocationException;
/** Finds the position of the first non-whitespace character after pos.
* NB: Skips comments and all whitespace, including newlines
* @param pos Position to start from
* @return position of first non-whitespace character after pos,
* or ERROR_INDEX (-1) if end of document is reached
*/
public int _getFirstNonWSCharPos(int pos) throws BadLocationException;
/** Similar to the single-argument version, but allows including comments.
* @param pos Position to start from
* @param acceptComments if true, find non-whitespace chars in comments
* @return position of first non-whitespace character after pos,
* or ERROR_INDEX (-1) if end of document is reached
*/
public int _getFirstNonWSCharPos(int pos, boolean acceptComments)
throws BadLocationException;
/** Finds the position of the first non-whitespace character after pos.
* NB: Skips comments and all whitespace, including newlines
* @param pos Position to start from
* @param whitespace array of whitespace chars to ignore
* @param acceptComments if true, find non-whitespace chars in comments
* @return position of first non-whitespace character after pos,
* or ERROR_INDEX (-1) if end of document is reached
*/
public int _getFirstNonWSCharPos (int pos, char[] whitespace, boolean acceptComments)
throws BadLocationException;
// public int findPrevNonWSCharPos(int pos) throws BadLocationException;
// /** Returns true if the given position is inside a paren phrase.
// * @param pos the position we're looking at
// * @return true if pos is immediately inside parentheses
// */
// public boolean inParenPhrase(int pos);
// /** Returns true if the reduced model's current position is inside a paren phrase.
// * @return true if pos is immediately inside parentheses
// */
// public boolean posInParenPhrase();
// /** Gets the number of whitespace characters between the current location and the rest of the document or the
// * first non-whitespace character, whichever comes first.
// * @return the number of whitespace characters
// */
// public int getWhiteSpace();
// /** Sets text between previous newline and first non-whitespace character of the line containing pos to tab.
// * @param tab String to be placed between previous newline and first non-whitespace character
// */
// public void setTab(String tab, int pos);
//
// /** Sets text between previous newline and first non-whitespace character of the line containing pos to a prefix
// * consisting of tab spaces.
// * @param tab String to be placed between previous newline and first non-whitespace character
// */
// public void setTab(int tab, int pos);
/** Inserts a string of text into the document. It turns out that this is not where we should do custom processing
* of the insert; that is done in {@link AbstractDJDocument#insertUpdate}.
*/
public void insertString(int offset, String str, AttributeSet a) throws BadLocationException;
/** Removes a block of text from the specified location. We don't update the reduced model here; that happens
* in {@link AbstractDJDocument#removeUpdate}.
*/
public void remove(int offset, int len) throws BadLocationException;
/** Gets the entire text of the document. Without this operation, a client must use locking to perform this
* task safely.
*/
public String getText();
/** Clears the entire text of the document. Without this operation, a client must use locking to perform this
* task safely.
*/
public void clear();
/* Locking operations */
/* Gets the reduced model so it can be locked. */
public ReducedModelControl getReduced();
// /** Swing-style acquireReadLock(). */
// public void acquireReadLock();
//
// /** Swing-style releaseReadLock(). */
// public void releaseReadLock();
//
// /** Swing-style writeLock(). */
// public void acquireWriteLock();
//
// /** Swing-style writeUnlock(). */
// public void releaseWriteLock();
}
The table below shows all metrics for DJDocument.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 0.00 | Number of blocks | |
| BLOCK_COMMENT | 39.00 | Number of block comment lines | |
| COMMENTS | 245.00 | Comment lines | |
| COMMENT_DENSITY | 4.90 | Comment density | |
| COMPARISONS | 0.00 | Number of comparison operators | |
| CYCLOMATIC | 33.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 90.00 | Comments in declarations | |
| DOC_COMMENT | 151.00 | Number of javadoc comment lines | |
| ELOC | 50.00 | Effective lines of code | |
| EXEC_COMMENTS | 0.00 | Comments in executable code | |
| EXITS | 0.00 | Procedure exits | |
| FUNCTIONS | 33.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 16.25 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 45.00 | Interface complexity | |
| JAVA0001 | 0.00 | JAVA0001 Package name does not contain only lower case letters | |
| JAVA0002 | 0.00 | JAVA0002 Package name does not begin with a top level domain name or country code | |
| JAVA0003 | 0.00 | JAVA0003 Minimize use of on-demand (.*) imports | |
| JAVA0004 | 0.00 | JAVA0004 Unnecessary import from java.lang | |
| JAVA0005 | 1.00 | JAVA0005 Imports not in specified order | |
| JAVA0006 | 0.00 | JAVA0006 Empty finally block | |
| JAVA0007 | 0.00 | JAVA0007 Should not declare public field | |
| JAVA0008 | 0.00 | JAVA0008 Empty catch block | |
| JAVA0009 | 0.00 | JAVA0009 Protected member in final class | |
| JAVA0010 | 0.00 | JAVA0010 Non-instantiable class does not contain a non-private static member | |
| JAVA0011 | 0.00 | JAVA0011 Abstract class does not contain an abstract method | |
| JAVA0012 | 0.00 | JAVA0012 Non-constructor method with same name as declaring class | |
| JAVA0013 | 0.00 | JAVA0013 Non-blank final field is not static | |
| JAVA0014 | 0.00 | JAVA0014 Class with only static members has non-private constructor | |
| JAVA0015 | 0.00 | JAVA0015 Package class contains public nested type | |
| JAVA0016 | 0.00 | JAVA0016 Abstract class contains public constructor | |
| JAVA0017 | 0.00 | JAVA0017 Class name does not have required form | |
| JAVA0018 | 0.00 | JAVA0018 Method name does not have required form | |
| JAVA0019 | 0.00 | JAVA0019 Interface name does not have required form | |
| JAVA0020 | 0.00 | JAVA0020 Field name does not have required form | |
| JAVA0021 | 16.00 | JAVA0021 Interface method name does not have required form | |
| JAVA0022 | 0.00 | JAVA0022 Static final field name does not have required form | |
| JAVA0023 | 0.00 | JAVA0023 Empty finalize method | |
| JAVA0024 | 0.00 | JAVA0024 Empty class | |
| JAVA0025 | 0.00 | JAVA0025 Method override is empty | |
| JAVA0026 | 0.00 | JAVA0026 Finalize method with parameters | |
| JAVA0029 | 0.00 | JAVA0029 Private method not used | |
| JAVA0030 | 0.00 | JAVA0030 Private field not used | |
| JAVA0031 | 0.00 | JAVA0031 Case statement not properly closed | |
| JAVA0032 | 0.00 | JAVA0032 Switch statement missing default | |
| JAVA0033 | 0.00 | JAVA0033 default: not last case in switch statement | |
| JAVA0034 | 0.00 | JAVA0034 Missing braces in if statement | |
| JAVA0035 | 0.00 | JAVA0035 Missing braces in for statement | |
| JAVA0036 | 0.00 | JAVA0036 Missing braces in while statement | |
| JAVA0038 | 0.00 | JAVA0038 Non-case label in switch statement | |
| JAVA0039 | 0.00 | JAVA0039 Break statement with label | |
| JAVA0040 | 0.00 | JAVA0040 Switch statement contains N cases (maximum: M) | |
| JAVA0041 | 0.00 | JAVA0041 Nested synchronized block | |
| JAVA0042 | 0.00 | JAVA0042 Empty synchronized statement | |
| JAVA0043 | 0.00 | JAVA0043 Inner class does not use outer class | |
| JAVA0044 | 0.00 | JAVA0044 Serializable class with no instance variables | |
| JAVA0045 | 0.00 | JAVA0045 Serializable class with only transient fields | |
| JAVA0046 | 0.00 | JAVA0046 Name of class not derived from Exception ends with 'Exception' | |
| JAVA0047 | 0.00 | JAVA0047 Serializable class derives from invalid base class | |
| JAVA0048 | 0.00 | JAVA0048 Name of class derived from Exception does not end with 'Exception' | |
| JAVA0049 | 0.00 | JAVA0049 Nested block at depth N (maximum: M) | |
| JAVA0050 | 0.00 | JAVA0050 Class derives from java.lang.Error | |
| JAVA0051 | 0.00 | JAVA0051 Class derives from java.lang.RuntimeException | |
| JAVA0052 | 0.00 | JAVA0052 Class derives from java.lang.Throwable | |
| JAVA0053 | 0.00 | JAVA0053 Unused label | |
| JAVA0054 | 0.00 | JAVA0054 Inheritance depth N exceeds maximum M | |
| JAVA0055 | 0.00 | JAVA0055 Class should be interface | |
| JAVA0056 | 0.00 | JAVA0056 Unnecessary abstract modifier for interface or annotation | |
| JAVA0057 | 0.00 | JAVA0057 Unnecessary default constructor | |
| JAVA0058 | 0.00 | JAVA0058 Constructor calls super() | |
| JAVA0059 | 0.00 | JAVA0059 Method override only calls super() | |
| JAVA0061 | 0.00 | JAVA0061 Inaccessible member in anonymous class | |
| JAVA0062 | 0.00 | JAVA0062 Public class missing public member or protected constructor | |
| JAVA0063 | 0.00 | JAVA0063 Identifier name should not contain '$' | |
| JAVA0064 | 0.00 | JAVA0064 N variations of identifier name (maximum: M) | |
| JAVA0065 | 0.00 | JAVA0065 Unnecessary final modifier for method in final class | |
| JAVA0066 | 0.00 | JAVA0066 Unnecessary modifier for interface nested type | |
| JAVA0067 | 0.00 | JAVA0067 Array descriptor on identifier name | |
| JAVA0068 | 0.00 | JAVA0068 Modifiers not declared in recommended order | |
| JAVA0071 | 0.00 | JAVA0071 Strings compared with == | |
| JAVA0073 | 0.00 | JAVA0073 Integer division in floating-point context | |
| JAVA0074 | 0.00 | JAVA0074 Use of Object.notify() | |
| JAVA0075 | 0.00 | JAVA0075 Method parameter hides field | |
| JAVA0076 | 0.00 | JAVA0076 Use of magic number | |
| JAVA0077 | 0.00 | JAVA0077 Private field not used in declaring class | |
| JAVA0078 | 0.00 | JAVA0078 Floating point values compared with == | |
| JAVA0079 | 0.00 | JAVA0079 Use of instance to reference static member | |
| JAVA0080 | 2.00 | JAVA0080 Import declaration not used | |
| JAVA0081 | 0.00 | JAVA0081 Boolean literal in comparison | |
| JAVA0082 | 0.00 | JAVA0082 Unnecessary widening cast | |
| JAVA0083 | 0.00 | JAVA0083 Unnecessary instanceof test | |
| JAVA0084 | 0.00 | JAVA0084 Should use compound assignment operator | |
| JAVA0085 | 0.00 | JAVA0085 Use of sun.* class | |
| JAVA0087 | 0.00 | JAVA0087 Use of Thread.sleep() | |
| JAVA0089 | 0.00 | JAVA0089 Use of restricted package | |
| JAVA0092 | 0.00 | JAVA0092 Use of restricted type | |
| JAVA0093 | 0.00 | JAVA0093 Redundant assignment | |
| JAVA0094 | 0.00 | JAVA0094 Field hides a superclass field | |
| JAVA0095 | 0.00 | JAVA0095 Uninitialized private field | |
| JAVA0096 | 0.00 | JAVA0096 Field in nested class hides outer field | |
| JAVA0098 | 0.00 | JAVA0098 Minimize use of implicit field initializers | |
| JAVA0100 | 0.00 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| JAVA0101 | 0.00 | JAVA0101 Unnecessary modifier for field in interface | |
| JAVA0102 | 0.00 | JAVA0102 Last statement in finalize() not super.finalize() | |
| JAVA0103 | 0.00 | JAVA0103 Explicit call to finalize() | |
| JAVA0104 | 0.00 | JAVA0104 finalize() only calls super.finalize() | |
| JAVA0105 | 0.00 | JAVA0105 Duplicate import declaration | |
| JAVA0106 | 0.00 | JAVA0106 Unnecessary import from current package | |
| JAVA0108 | 3.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 0.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 6.00 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0111 | 0.00 | JAVA0111 Incorrect javadoc: @return tag for void method | |
| JAVA0112 | 0.00 | JAVA0112 Incorrect javadoc: no exception 'exception' in throws | |
| JAVA0113 | 1.00 | JAVA0113 Incorrect javadoc: no @author tag | |
| JAVA0114 | 1.00 | JAVA0114 Incorrect javadoc: no @version tag | |
| JAVA0115 | 15.00 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0116 | 0.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 4.00 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0118 | 0.00 | JAVA0118 Missing javadoc: type 'type' | |
| JAVA0119 | 0.00 | JAVA0119 Control variable changed within body of for loop | |
| JAVA0123 | 0.00 | JAVA0123 Use all three components of for loop | |
| JAVA0125 | 0.00 | JAVA0125 Continue statement with label | |
| JAVA0126 | 0.00 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0128 | 0.00 | JAVA0128 Public constructor in non-public class | |
| JAVA0130 | 0.00 | JAVA0130 Non-static method does not use instance fields | |
| JAVA0131 | 0.00 | JAVA0131 Compatible method does not override base | |
| JAVA0132 | 0.00 | JAVA0132 Method overload with compatible signature | |
| JAVA0133 | 0.00 | JAVA0133 Non-synchronized method overrides synchronized method | |
| JAVA0135 | 0.00 | JAVA0135 Only one of Object.equals and Object.hashCode defined: missing 'method' | |
| JAVA0136 | 1.00 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0137 | 0.00 | JAVA0137 Non-abstract class missing constructor | |
| JAVA0138 | 0.00 | JAVA0138 N parameters defined for method (maximum: M) | |
| JAVA0139 | 0.00 | JAVA0139 Definition of main other than public static void main(java.lang.String[]) | |
| JAVA0141 | 33.00 | JAVA0141 Unnecessary modifier for method in interface | |
| JAVA0143 | 0.00 | JAVA0143 Synchronized method | |
| JAVA0144 | 0.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 0.00 | JAVA0145 Tab character used in source file | |
| JAVA0150 | 0.00 | JAVA0150 java.lang.Error (or subclass) thrown | |
| JAVA0153 | 0.00 | JAVA0153 Inefficient conversion of integer to string | |
| JAVA0159 | 0.00 | JAVA0159 Inefficient conversion of string to integer | |
| JAVA0160 | 0.00 | JAVA0160 Method does not throw specified exception | |
| JAVA0161 | 0.00 | JAVA0161 Conditional wait() not in loop | |
| JAVA0163 | 0.00 | JAVA0163 Empty statement | |
| JAVA0165 | 0.00 | JAVA0165 Conflicting return statement in finally block | |
| JAVA0166 | 0.00 | JAVA0166 Generic exception caught | |
| JAVA0167 | 0.00 | JAVA0167 ThreadDeath not rethrown | |
| JAVA0169 | 0.00 | JAVA0169 Unnecessary catch block: exception 'exception' | |
| JAVA0170 | 0.00 | JAVA0170 Caught exception not derived from java.lang.Exception | |
| JAVA0171 | 0.00 | JAVA0171 Unused local variable | |
| JAVA0173 | 0.00 | JAVA0173 Unused method parameter | |
| JAVA0174 | 0.00 | JAVA0174 Assigned local variable never used | |
| JAVA0175 | 0.00 | JAVA0175 Successive assignment to variable | |
| JAVA0176 | 0.00 | JAVA0176 Local variable name does not have required form | |
| JAVA0177 | 0.00 | JAVA0177 Variable declaration missing initializer | |
| JAVA0179 | 0.00 | JAVA0179 Local variable hides visible field | |
| JAVA0233 | 0.00 | JAVA0233 Definition of serialVersionUID other than 'private static final long serialVersionUID' | |
| JAVA0234 | 0.00 | JAVA0234 Class is Serializable but does not define serialVersionUID | |
| JAVA0235 | 0.00 | JAVA0235 Class defines serialVersionUID but does not implement Serializable | |
| JAVA0236 | 0.00 | JAVA0236 Attempt to clone an object which does not implement Cloneable | |
| JAVA0237 | 0.00 | JAVA0237 Class implements Cloneable but does not have public clone method | |
| JAVA0238 | 0.00 | JAVA0238 Clone method does not call super.clone() | |
| JAVA0239 | 0.00 | JAVA0239 Class declares 'readObject' or 'writeObject' but does not implement Serializable | |
| JAVA0240 | 0.00 | JAVA0240 Serializable class which declares readObject or writeObject but not both | |
| JAVA0241 | 0.00 | JAVA0241 'readObject' or 'writeObject' should be declared private in Serializable class | |
| JAVA0242 | 0.00 | JAVA0242 Transient field in non-Serializable class | |
| JAVA0243 | 0.00 | JAVA0243 'readResolve' or 'writeReplace' should be declared private or protected | |
| JAVA0244 | 0.00 | JAVA0244 Field or method name in subclass differs only by case from inherited field or method | |
| JAVA0245 | 0.00 | JAVA0245 JUnit TestCase with non-trivial constructor | |
| JAVA0246 | 0.00 | JAVA0246 JUnit assertXXX statement missing message parameter | |
| JAVA0247 | 0.00 | JAVA0247 JUnit 'setUp()' and 'tearDown()' should call super method | |
| JAVA0248 | 0.00 | JAVA0248 JUnit method 'setUp' or 'tearDown' with incorrect signature | |
| JAVA0249 | 0.00 | JAVA0249 JUnit TestCase 'suite()' should be declared static | |
| JAVA0250 | 0.00 | JAVA0250 JUnit TestCase declares testXXX method with incorrect signature | |
| JAVA0251 | 0.00 | JAVA0251 Use '%n' for line breaks in printf/format for platform independence | |
| JAVA0252 | 0.00 | JAVA0252 'enum' is a Java 1.5 reserved word | |
| JAVA0253 | 0.00 | JAVA0253 Not all enum constants consumed in switch statement | |
| JAVA0254 | 0.00 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| JAVA0255 | 0.00 | JAVA0255 Result of method invocation not used | |
| JAVA0256 | 0.00 | JAVA0256 Assignment of external collection/array to field | |
| JAVA0257 | 0.00 | JAVA0257 Use of 'Constant Interface' anti-pattern | |
| JAVA0258 | 0.00 | JAVA0258 Implement Iterable for foreach compatibility | |
| JAVA0259 | 0.00 | JAVA0259 Return of collection/array field | |
| JAVA0260 | 0.00 | JAVA0260 Use 'enum' instead of Enumerated Type pattern | |
| JAVA0261 | 0.00 | JAVA0261 Use specialized Enum collection types | |
| JAVA0262 | 0.00 | JAVA0262 Use of char in integer context | |
| JAVA0263 | 0.00 | JAVA0263 Long literal ends with 'l' instead of 'L' | |
| JAVA0264 | 0.00 | JAVA0264 Integer math in long context - check for overflow | |
| JAVA0265 | 0.00 | JAVA0265 Use of Throwable.printStackTrace() | |
| JAVA0266 | 0.00 | JAVA0266 Use of System.out | |
| JAVA0267 | 0.00 | JAVA0267 Use of System.err | |
| JAVA0269 | 0.00 | JAVA0269 Contents of StringBuffer never used | |
| JAVA0270 | 0.00 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| JAVA0271 | 0.00 | JAVA0271 Minimize use of on-demand (.*) static imports | |
| JAVA0272 | 0.00 | JAVA0272 Thread.run() called | |
| JAVA0273 | 0.00 | JAVA0273 Non-final derivative of Thread calls start() in constructor | |
| JAVA0274 | 0.00 | JAVA0274 Serializable class has a synchronized readObject() | |
| JAVA0275 | 0.00 | JAVA0275 Serializable class has a synchronized writeObject() and no other synchronized methods | |
| JAVA0276 | 0.00 | JAVA0276 Unnecessary use of String constructor | |
| JAVA0277 | 0.00 | JAVA0277 Iterator.next() implementation does not throw NoSuchElementException | |
| JAVA0278 | 0.00 | JAVA0278 Unnecessary use of Boolean constructor | |
| JAVA0279 | 0.00 | JAVA0279 Serialization method readObject or readObjectNoData calls an overridable method | |
| JAVA0280 | 0.00 | JAVA0280 IllegalMonitorStateException caught | |
| JAVA0281 | 0.00 | JAVA0281 Iterator.next() not called in loop | |
| JAVA0282 | 0.00 | JAVA0282 Call to Iterator.next() in loop which does not test Iterator.hasNext() | |
| JAVA0283 | 0.00 | JAVA0283 Control variable not updated in loop body | |
| JAVA0284 | 0.00 | JAVA0284 Explicit garbage collection | |
| JAVA0285 | 0.00 | JAVA0285 Dereference of potentially null variable | |
| JAVA0286 | 0.00 | JAVA0286 Dereference of null variable | |
| JAVA0287 | 0.00 | JAVA0287 Unnecessary null check | |
| JAVA0288 | 0.00 | JAVA0288 Inconsistent null check | |
| LINES | 345.00 | Number of lines in the source file | |
| LINE_COMMENT | 55.00 | Number of line comments | |
| LOC | 50.00 | Lines of code | |
| LOGICAL_LINES | 45.00 | Number of statements | |
| LOOPS | 0.00 | Number of loops | |
| NEST_DEPTH | 0.00 | Maximum nesting depth | |
| OPERANDS | 161.00 | Number of operands | |
| OPERATORS | 329.00 | Number of operators | |
| PARAMS | 45.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 490.00 | Halstead program length | |
| PROGRAM_VOCAB | 131.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 0.00 | Number of return points from functions | |
| SIZE | 15900.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 109.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 22.00 | Number of unique operators | |
| WHITESPACE | 50.00 | Number of whitespace lines | |