OpenDefinitionsDocument.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 |  |
| FUNCTIONS | Number of function declarations | |
| JAVA0141 | JAVA0141 Unnecessary modifier for method in interface | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0115 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| CYCLOMATIC | Cyclomatic complexity | |
| COMMENTS | Comment lines | |
| DOC_COMMENT | Number of javadoc comment lines | |
| JAVA0106 | JAVA0106 Unnecessary import from current package | |
| SIZE | Size of the file in bytes | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0136 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0080 | JAVA0080 Import declaration not used | |
| EXEC_COMMENTS | Comments in executable code | |
| COMPARISONS | Number of comparison operators | |
| BLOCKS | Number of blocks | |
| RETURNS | Number of return points from functions | |
| LOC | Lines of code | |
| LOOPS | Number of loops | |
| EXITS | Procedure exits | |
| ELOC | Effective lines of code | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| OPERANDS | Number of operands | |
| PROGRAM_LENGTH | Halstead program length | |
| OPERATORS | Number of operators | |
| 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 java.util.Vector;
import java.util.List;
import java.io.*;
import java.awt.print.*;
import javax.swing.event.DocumentListener;
import javax.swing.event.UndoableEditListener;
import javax.swing.text.BadLocationException;
import javax.swing.text.Position;
import edu.rice.cs.util.FileOpenSelector;
import edu.rice.cs.drjava.model.FileSaveSelector;
import edu.rice.cs.util.docnavigation.*;
import edu.rice.cs.util.text.AbstractDocumentInterface;
import edu.rice.cs.drjava.model.debug.Breakpoint;
import edu.rice.cs.drjava.model.Finalizable;
import edu.rice.cs.drjava.model.definitions.*;
/** Interface for an open document in DrJava. It may not be resident (in DocumentCache).
* @version $Id: OpenDefinitionsDocument.java 4618 2008-07-28 21:53:19Z rcartwright $
*/
public interface OpenDefinitionsDocument extends DJDocument, Finalizable<DefinitionsDocument>,
Comparable<OpenDefinitionsDocument>, INavigatorItem {
//----- Forwarding Methods -----/
/** The following methods are forwarding methods required by the rest of the program in order for the
* OpenDefinitionsDocument to handle DefinitionsDocuments */
// public int id();
public int commentLines(int selStart, int selEnd);
public int uncommentLines(int selStart, int selEnd);
/** Gets the associated DefinitionsDocument which may force materializing it. */
public DefinitionsDocument getDocument();
public boolean getClassFileInSync();
public void setClassFileInSync(boolean val);
public int getCurrentLine();
public int getCurrentCol();
public int _getOffset(int lineNum);
public String getQualifiedClassName() throws ClassNameNotFoundException;
public String getQualifiedClassName(int pos) throws ClassNameNotFoundException;
public String getLexiName();
public CompoundUndoManager getUndoManager();
public void resetUndoManager();
public File getCachedClassFile();
public void setCachedClassFile(File f);
public DocumentListener[] getDocumentListeners();
public UndoableEditListener[] getUndoableEditListeners();
//----- Regular methods -----/
//----- Getters and Setters -----/
/** Returns the file for this document; does not check whether the file exists. */
public File getRawFile();
/** Returns the file for this document.
* @return the file for this document
* @throws FileMovedException if the document's file no longer exists
*/
public File getFile() throws FileMovedException;
/** Sets this document's file
* @param file the file that this OpenDefinitionsDocument is associated with
*/
public void setFile(File file);
/** Returns the name of this file, or "(Untitled)" if no file. */
public String getFileName();
/** Returns canonical path for well-formed file, "(Untitled)" if no file exists, and absolute path if ill-formed. */
public String getCanonicalPath();
/** Returns canonical path (as defined above) followed by " *" if modified. */
public String getCompletePath();
/** Returns the parent directory of this file, null if it has none. */
public File getParentDirectory();
public Pageable getPageable() throws IllegalStateException;
//----- Simple Predicates -----//
/** @return whether the undo manager can perform any undos. */
public boolean undoManagerCanUndo();
/** @return whether the undo manager can perform any redos. */
public boolean undoManagerCanRedo();
/** Determines if this document in the file system tree below the active project root. */
public boolean inProjectPath();
/** Determines if this document in the file system tree below the specified root. */
public boolean inNewProjectPath(File root);
/** Determines if the document is empty. */
public boolean isEmpty();
/** @return true if the document's file is a project auxiliary file. */
public boolean isAuxiliaryFile();
/** @return true if the document's filename ends with the extension ".java", ".dj0", "dj1", or "dj2". */
public boolean isSourceFile();
/** @return true if the documents file is saved in the current project file. */
public boolean inProject();
/** Returns whether this document is resident in memory. */
public boolean isReady();
/** Returns whether this document is currently untitled (indicating whether it has a file yet or not).
* @return true if the document is untitled and has no file
*/
public boolean isUntitled();
/** Returns true if the file exists on disk, or if the user has located it on disk. Returns false if the
* file has been moved or deleted
*/
public boolean fileExists();
/** Determines if this definitions document has changed since the last save.
* @return true if the document has been modified
*/
public boolean modifiedOnDisk();
/** Resets the document to be unmodified. */
public void resetModification();
/** Returns the date that this document was last modified. */
public long getTimestamp();
//----- Major Operations -----//
/** Adds region r to the browserRegions collection for this */
public void addBrowserRegion(BrowserDocumentRegion r);
/** Removes region r from the browserRegions collection */
public void removeBrowserRegion(BrowserDocumentRegion r);
/** Returns the name of the top level class, if any.
* @throws ClassNameNotFoundException if no top level class name found.
*/
public String getFirstTopLevelClassName() throws ClassNameNotFoundException;
/** If the file exists, returns true. If it does not exist, prompts the user to look it up. If the user
* chooses a file, returns true, false otherwise. */
public boolean verifyExists();
/** Saves the document with a FileWriter. If the file name is already set, the method will use that name
* instead of whatever selector is passed in.
* @param com a selector that picks the file name
* @exception IOException
* @return true if the file was saved, false if the operation was canceled
*/
public boolean saveFile(FileSaveSelector com) throws IOException;
/** Revert the document to the version saved on disk. */
public void revertFile() throws IOException;
/** Saves the document with a FileWriter. The FileSaveSelector will either provide a file name or prompt
* the user for one. It is up to the caller to decide what needs to be done to choose a file to save to.
* Once the file has been saved succssfully, this method fires fileSave(File). If the save fails for any
* reason, the event is not fired.
* @param com a selector that picks the file name.
* @exception IOException
* @return true if the file was saved, false if the operation was canceled
*/
public boolean saveFileAs(FileSaveSelector com) throws IOException;
/** Starts compiling the source. Demands that the definitions be saved before proceeding with the compile.
* Fires the appropriate events as the compiliation proceeds and finishes. Only executes in the event thread.
* @exception IOException if a file with errors cannot be opened
*/
public void startCompile() throws IOException;
/** Runs the main method in this document in the interactions pane. Demands that the definitions be saved
* and compiled before proceeding. Fires an event to signal when execution is about to begin.
* @exception ClassNameNotFoundException propagated from getFirstTopLevelClass()
* @exception IOException propagated from GlobalModel.compileAll()
*/
public void runMain() throws ClassNameNotFoundException, IOException;
/** Starts testing the source using JUnit. Demands that the definitions be saved and compiled before proceeding
* with testing. Fires the appropriate events as the testing proceeds and finishes.
* TODO: this method is redundant and should be deprecated
* @exception IOException if a file with errors cannot be opened
* @exception ClassNotFoundException when the class is compiled to a location not on the classpath.
*/
public void startJUnit() throws ClassNotFoundException, IOException;
/** Generates Javadoc for this document, saving the output to a temporary directory. The location is provided
* to the javadocEnded event on the given listener.
* @param saver FileSaveSelector for saving the file if it needs to be saved
*/
public void generateJavadoc(FileSaveSelector saver) throws IOException;
/** Determines if this definitions document has changed since the last save.
* @return true if the document has been modified
*/
public boolean isModifiedSinceSave();
/** Asks the GlobalModel if it can revert current definitions to version on disk. If ok, it reverts the file
* to the version on disk.
* @return true if the document has been reverted
*/
public boolean revertIfModifiedOnDisk() throws IOException;
/** Returns whether the GlobalModel can abandon this document, asking listeners if isModifiedSinceSave() is true.
* @return true if this document can be abandoned
*/
public boolean canAbandonFile();
/** Saves file at user's discretion before quitting.
* @return true if quitting should continue, false if the user cancelled */
public boolean quitFile();
/** Moves the definitions document to the given line, and returns the resulting character position.
* @param line Destination line number. If line exceeds the number of lines in the document, it is interpreted
* as the last line.
* @return Index into document of where it moved
*/
public int gotoLine(int line);
/** Finds the root directory of the source files.
* @return The root directory of the source files, based on the package statement.
* @throws InvalidPackageException If the package statement is invalid, or if it does not match
* up with the location of the source file.
*/
public File getSourceRoot() throws InvalidPackageException;
/** @return the name of the package currently embedded in document. Forwards to wrapped DefinitionsDocument. */
public String getPackageNameFromDocument();
/** @return the name of the package at the time of the most recent save or load operation. */
public String getPackageName();
/** Sets the cached package name returned by getPackageName(); */
public void setPackage(String s);
/** Searching backwards finds the name of the enclosing named class or interface. NB: ignores comments.
* WARNING: In long source files and when contained in anonymous inner classes, this function might take a LONG time.
* @param pos Position to start from
* @param qual true to find the fully qualified class name
* @return name of the enclosing named class or interface
*/
public String getEnclosingClassName(int pos, boolean qual) throws BadLocationException, ClassNameNotFoundException;
public void preparePrintJob() throws BadLocationException, FileMovedException;
public void print() throws PrinterException, BadLocationException, FileMovedException;
public void cleanUpPrintJob();
/** Checks if the document is modified. If not, searches for the class file
* corresponding to this document and compares the timestamps of the
* class file to that of the source file.
* @return is the class file and this OpenDefinitionsDocument are in sync
*/
public boolean checkIfClassFileInSync();
/** Called when this document is saved so it can notify the cache. */
public void documentSaved();
/** Called when this document is modified so it can notify the cache. */
public void documentModified();
/** Called when this document is reset so it can notify the cache. */
public void documentReset();
/** @return the breakpoint region manager. */
public RegionManager<Breakpoint> getBreakpointManager();
/** @return the bookmark region manager. */
public RegionManager<OrderedDocumentRegion> getBookmarkManager();
// /** @return managers for find result regions. */
// public List<RegionManager<MovingDocumentRegion>> getFindResultsManagers();
// /** Add a region manager for find results to this document.
// * @param rm the global model's region manager */
// public void addFindResultsManager(RegionManager<MovingDocumentRegion> rm);
/** Remove a manager for find results from this document.
* @param rm the global model's region manager. */
public void removeFindResultsManager(RegionManager<MovingDocumentRegion> rm);
/** Remove the browser regions for this document from the browser history manager. */
public void clearBrowserRegions();
/** Called when this document is being closed, removing related state from the debug manager. */
public void removeFromDebugger();
/** Sets the document as modified. */
public void updateModifiedSinceSave();
/** Should be called when closing an ODD to let the ODD clean up after itself. */
public void close();
/** @return the initial vertical scroll the pane should use when initialized. */
public int getInitialVerticalScroll();
/** @return the initial vertical scroll the pane should use when initialized. */
public int getInitialHorizontalScroll();
/** @return the starting location of the cursor selection that should be set in the pane when initialized. */
public int getInitialSelectionStart();
/** @return the final location of the cursor selection that should be set in the pane when it is initialized. */
public int getInitialSelectionEnd();
/** @return the number of lines in this document. */
public int getNumberOfLines();
/** Translates an offset into the components text to a line number.
* @param offset the offset >= 0
* @return the line number >= 0 */
public int getLineOfOffset(int offset);
/** Translates a line number into an offset.
* @param line number >= 0
* @return offset >= 0
*/
public int getOffsetOfLine(int line);
// /** @return the caret position as set by the view. */
// public int getCaretPosition();
/** Creates a WrappedPosition in the document. */
public Position createUnwrappedPosition(int offs) throws BadLocationException;
/** Determines if pos in document is inside a comment or a string. */
public boolean _isShadowed(int pos);
}
The table below shows all metrics for OpenDefinitionsDocument.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 0.00 | Number of blocks | |
| BLOCK_COMMENT | 35.00 | Number of block comment lines | |
| COMMENTS | 188.00 | Comment lines | |
| COMMENT_DENSITY | 1.86 | Comment density | |
| COMPARISONS | 0.00 | Number of comparison operators | |
| CYCLOMATIC | 83.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 79.00 | Comments in declarations | |
| DOC_COMMENT | 140.00 | Number of javadoc comment lines | |
| ELOC | 101.00 | Effective lines of code | |
| EXEC_COMMENTS | 0.00 | Comments in executable code | |
| EXITS | 0.00 | Procedure exits | |
| FUNCTIONS | 83.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 16.98 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 24.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 | 2.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 | 4.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 | 2.00 | JAVA0106 Unnecessary import from current package | |
| JAVA0108 | 8.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 0.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 17.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 | 0.00 | JAVA0114 Incorrect javadoc: no @version tag | |
| JAVA0115 | 6.00 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0116 | 0.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 19.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 | 1.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 | 83.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 | 371.00 | Number of lines in the source file | |
| LINE_COMMENT | 13.00 | Number of line comments | |
| LOC | 102.00 | Lines of code | |
| LOGICAL_LINES | 99.00 | Number of statements | |
| LOOPS | 0.00 | Number of loops | |
| NEST_DEPTH | 0.00 | Maximum nesting depth | |
| OPERANDS | 247.00 | Number of operands | |
| OPERATORS | 552.00 | Number of operators | |
| PARAMS | 24.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 799.00 | Halstead program length | |
| PROGRAM_VOCAB | 182.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 0.00 | Number of return points from functions | |
| SIZE | 16332.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 160.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 22.00 | Number of unique operators | |
| WHITESPACE | 81.00 | Number of whitespace lines | |