Option.java
| Index Score | ||
|---|---|---|
 |
 |
gnu.dtools.ritopt |
 |
 |
JabRef |
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 |  |
| DOC_COMMENT | Number of javadoc comment lines | |
| COMMENTS | Comment lines | |
| FUNCTIONS | Number of function declarations | |
| LINES | Number of lines in the source file | |
| SIZE | Size of the file in bytes | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| WHITESPACE | Number of whitespace lines | |
| JAVA0267 | JAVA0267 Use of System.err | |
| JAVA0016 | JAVA0016 Abstract class contains public constructor | |
| RETURNS | Number of return points from functions | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| CYCLOMATIC | Cyclomatic complexity | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| BLOCKS | Number of blocks | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0136 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0174 | JAVA0174 Assigned local variable never used | |
| EXEC_COMMENTS | Comments in executable code | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| LINE_COMMENT | Number of line comments | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0100 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| LOOPS | Number of loops | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
| UNIQUE_OPERATORS | Number of unique operators | |
package gnu.dtools.ritopt;
/**
* Option.java
*
* Version
* $Id: Option.java 2209 2007-08-01 18:23:38Z coezbek $
*/
/**
* This is the principal base class for all Option classes. It contains
* constructors for short and long option initialization, utility members
* for help reporting and file writing, and deprecation facilities.<p>
*
* Options that provide array support should inherit from the ArrayOption
* class, and follow the guidelines defined both in the Option and
* ArrayOption class descriptions.<p>
*
* Non-abstract subclasses should implement the modify method. When an option
* is invoked, the value of the option is passed to the modify method.<p>
*
* Subclasses should provide several constructors so that registration is
* simple and uniform. Recommended constructors include a default constructor,
* an interface for initialization of short and long options,
* and one that allows both short and long option fields to be
* initialized. If the subclass implementation provides constructors which
* initialize its members then the member parameters must be before
* the short and long option initialization parameters.<p>
*
* Event driven option processing is provided in the NotifyOption class. In
* order to use a NotifyOption, the recipient object must implement the
* OptionListener class. Although it is not required, subclass implementations
* of NotifyOption should implement the OptionNotifier interface.<p>
*
* By default, the Option class considers the width of an output device
* to be eighty characters. It initializes the width of the help fields
* based on this figure. If a field exceeds its field width, it is
* truncated. The width constraints can be changed by invoking the appropriate
* static mutators.<p>
*
* Similar to the help reporting facilities, the same constraints are placed
* on the listing of options provided by the built-in menu interface. These
* constraints can be modified by executing the appropriate static mutators.
* <p>
*
* The Option class provides a facility for writing options files.
* For option file writing, there are only two field width constraints; the
* assignment and the comment.
* <pre>
* Assignment: Comment:
* --longOrShortOption=optionValue ;description goes here [d]
* </pre>
* As shown above, an assignment includes the long or short option text,
* an equal sign, and the option's value. The comment includes the
* description, and "[d]" if the option is deprecated.<p>
*
* If the assignment exceeds its field width, the comment is placed before
* the assignment on a separate line. The comment is truncated if it
* exceeds eighty characters when it is placed before the assignment.
* However, if the assignment does not exceeds its field width and the comment
* does, the comment is truncated, and continued on the next line at the
* columnar position defined by the assignment's field width. Field widths
* may be modified by invoking the appropriate static mutator.<p>
*
* This class also provides a facility for deprecating options. An option is
* deprecated to discourage its use without removing the functionality it
* provides. An option is deprecated by invoking the deprecate method.
* <hr>
*
* <pre>
* Copyright (C) Damian Ryan Eads, 2001. All Rights Reserved.
*
* ritopt is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
* ritopt is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with ritopt; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
* </pre>
*
* @author Damian Eads
*/
public abstract class Option implements OptionModifiable {
/**
* The default width of the option field when the help usage is displayed.
*/
public static final int DEFAULT_HELP_OPTION_SIZE = 22;
/**
* The default width of the type name field when the help usage is
* display.
*/
public static final int DEFAULT_HELP_TYPENAME_SIZE = 10;
/**
* The default width of the description when the help usage is displayed.
*/
public static final int DEFAULT_HELP_DESCRIPTION_SIZE = 48;
/**
* The default width of the deprecated field when the help usage is
* displayed.
*/
public static final int DEFAULT_HELP_DEPRECATED_SIZE = 3;
/**
* The default width of the option field when the menu usage is displayed.
*/
public static final int DEFAULT_MENU_OPTION_SIZE = 15;
/**
* The default width of the type name field when the menu usage is
* displayed.
*/
public static final int DEFAULT_MENU_TYPENAME_SIZE = 10;
/**
* The default width of the description field when the menu usage is
* displayed.
*/
public static final int DEFAULT_MENU_DESCRIPTION_SIZE = 48;
/**
* The default width of the deprecated field when the menu usage is
* displayed.
*/
public static final int DEFAULT_MENU_DEPRECATED_SIZE = 3;
/**
* The default width of the option assignment in an option file.
*/
public static final int DEFAULT_FILE_COMPLETE_OPTION_SIZE = 60;
/**
* The default width of the comment in an option file. If the option
* and the comment exceeds the width of the device, the comment is
* truncated to the next line at the same columnar position of the
* previous comment line. If the option assignment line is longer than
* the width, the comment line is put before the option assignment it
* refers.
*/
public static final int DEFAULT_FILE_COMMENT_SIZE = 16;
/**
* The String holding the value of the long option. If there is no
* long option, this value is set to null.
*/
private String longOption;
/**
* The character holding the value of the short option. If there is no
* short option,t his value is set to '\0'.
*/
private char shortOption;
/**
* The String holding the description of this option.
*/
private String description;
/**
* A flag identifying whether this option is deprecated.
*/
private boolean deprecated;
/**
* The field width for the option specification that is reporter for
* help.
*/
private static int helpOptionSpecificationSize = DEFAULT_HELP_OPTION_SIZE;
/**
* The field width for the type name that is reported for help.
*/
private static int helpTypenameSize = DEFAULT_HELP_TYPENAME_SIZE;
/**
* The field width for the description that is reported during help.
*/
private static int helpDescriptionSize = DEFAULT_HELP_DESCRIPTION_SIZE;
/**
* The field width for the deprecated flag that is reported during
* help.
*/
private static int helpDeprecatedSize = DEFAULT_HELP_DEPRECATED_SIZE;
/**
* The field width for the option specification that is reported when
* the options are listed in the built-in menu.
*/
private static int menuOptionSpecificationSize = DEFAULT_MENU_OPTION_SIZE;
/**
* The field width for the type name that is reported when the options
* are listed in the built-in menu.
*/
private static int menuTypenameSize = DEFAULT_MENU_TYPENAME_SIZE;
/**
* The field width for the description that is reported when the options
* are listed in the built-in menu.
*/
private static int menuDescriptionSize = DEFAULT_MENU_DESCRIPTION_SIZE;
/**
* The field width for the deprecated flag that is reported when the
* options are listed in the build-in menu.
*/
private static int menuDeprecatedSize = DEFAULT_MENU_DEPRECATED_SIZE;
/**
* The field width for the assignment portion of an option that is
* written to a file.
*/
private static int fileCompleteOptionSize =
DEFAULT_FILE_COMPLETE_OPTION_SIZE;
/**
* The field width for the comment portion of an option that is written
* to a file.
*/
private static int fileCommentSize = DEFAULT_FILE_COMMENT_SIZE;
/**
* A field indicating whether an option has been invoked.
*/
protected boolean invoked;
/**
* Returns this option's value as an Object.
*
* @return An object representation of this option.
*/
public abstract Object getObject();
/**
* Returns the option's value as a String. This String should conform
* to the formatting requirements prescribed by a modify method.
*
* @return The option's value as a String conforming to formatting
* requirements.
*/
public abstract String getStringValue();
/**
* Constructs an option with no initial short or long option value,
* and is by default uninvoked and undeprecated, and has a description
* initialized to the empty string.
*/
public Option() {
super();
description = "";
}
/**
* Constructs an option by copying the option passed.
*
* @param option The option to copy for this object's construction.
*/
public Option( Option option ) {
longOption = option.getLongOption();
shortOption = option.getShortOption();
description = option.getDescription();
deprecated = option.isDeprecated();
}
/**
* Constructs an option by initializing its long option with the
* value passed. The short option is equal to the null character,
* and the description is equal to the empty string.
*
* @param longOption The value of the long option
*/
public Option( String longOption ) {
this.longOption = longOption;
this.shortOption = '\0';
description = "";
}
/**
* Constructs an option by initializing its short option with the
* value passed. The long option is equal to null, and the description
* is equal to the empty string.
*
* @param shortOption The value of the short option.
*/
public Option( char shortOption ) {
this.shortOption = shortOption;
this.longOption = null;
description = "";
}
/**
* Constructs an option by initializing its short and long options
* with the values passed. The description is set to the empty string.
*
* @param longOption The value of the long option.
* @param shortOption The value of the short option.
*/
public Option( String longOption, char shortOption ) {
this.longOption = longOption;
this.shortOption = shortOption;
description = "";
}
/**
* Sets the long option.
*
* @param longOption The value to set the long option.
*/
public void setKey( String longOption ) {
this.longOption = longOption;
}
/**
* Sets the short option.
*
* @param shortOption The value to set the short option.
*/
public void setKey( char shortOption ) {
this.shortOption = shortOption;
}
/**
* Sets the short option.
*
* @param shortOption The value to set the short option.
*/
public void setShortOption( char shortOption ) {
setKey( shortOption );
}
/**
* Sets the long option.
*
* @param longOption The value to set the long option.
*/
public void setLongOption( String longOption ) {
setKey( longOption );
}
/**
* Sets the description of this option.
*
* @param description The description of this option.
*/
public void setDescription( String description ) {
this.description = description;
}
/**
* Sets the deprecated flag to the value passed.
*
* @param deprecated A flag indicating whether the option is deprecated.
*/
public void setDeprecated( boolean deprecated ) {
this.deprecated = deprecated;
}
/**
* Sets the field width for the option specification displayed
* in the help report.
*
* @param newSize The size to set the field width.
*/
public static void setHelpOptionSpecificationSize( int newSize ) {
helpOptionSpecificationSize = newSize;
}
/**
* Sets the field width for the type name displayed in the help report.
*
* @param newSize The size to set the field width.
*/
public static void setHelpTypenameSize( int newSize ) {
helpTypenameSize = newSize;
}
/**
* Sets the field width for the description displayed in the help report.
*
* @param newSize The size to set the field width.
*/
public static void setHelpDescriptionSize( int newSize ) {
helpDescriptionSize = newSize;
}
/**
* Sets the field width for the deprecated flag displayed in the
* help report.
*
* @param newSize The size to set the field width.
*/
public static void setHelpDeprecatedSize( int newSize ) {
helpDeprecatedSize = newSize;
}
/**
* Sets the field width for the option specification displayed
* in the menu listing of options.
*
* @param newSize The size to set the field width.
*/
public static void setMenuOptionSpecificationSize( int newSize ) {
menuOptionSpecificationSize = newSize;
}
/**
* Sets the field width for the type name displayed in the menu
* listing of options.
*
* @param newSize The size to set the field width.
*/
public static void setMenuTypenameSize( int newSize ) {
menuTypenameSize = newSize;
}
/**
* Sets the field width for the option description displayed
* in the menu listing of options.
*
* @param newSize The size to set the field width.
*/
public static void setMenuDescriptionSize( int newSize ) {
menuDescriptionSize = newSize;
}
/**
* Sets the field width for the deprecated flag displayed
* in the menu listing of options.
*
* @param newSize The size to set the field width.
*/
public static void setMenuDeprecatedSize( int newSize ) {
menuDeprecatedSize = newSize;
}
/**
* Sets the assignment field width used when options files are written.
*
* @param newSize The size to set the field width.
*/
public static void setFileCompleteOptionSize( int newSize ) {
fileCompleteOptionSize = newSize;
}
/**
* Sets the assignment field width used when options files are written.
*
* @param newSize The size to set the field width.
*/
public static void setFileCommentSize( int newSize ) {
fileCommentSize = newSize;
}
/**
* Sets whether this option has been invoked.
*
* @param A boolean indicating whether this option has been invoked.
*/
public void setInvoked( boolean b ) {
invoked = b;
}
/**
* Deprecates this option.
*/
public void deprecate() {
setDeprecated( true );
}
/**
* Return the name of this option. This method returns the same value as
* the getLongOption accessor.
*
* @return The name of this otpion.
*/
public String getName() {
return longOption;
}
/**
* Return the short option key. There is no short option when this
* character is the null character.
*
* @return The short option key of this option.
*/
public char getShortOption() {
return shortOption;
}
/**
* Return the long option key. There is no long option when this value
* is null.
*
* @return The long option key of this option.
*/
public String getLongOption() {
return longOption;
}
/**
* Return a line used for help reporting.
*
* @return A line used for help reporting.
*/
public String getHelp() {
return getHelpOptionSpecification() + " " + getHelpTypeName() + " "
+ getHelpDescription() + " " + getHelpDeprecated();
}
/**
* Return the option specification field used during help reporting.
*
* @return The option specification field.
*/
public String getHelpOptionSpecification() {
return Utility.expandString(
( ( ( shortOption != '\0' ) ? ( "-" + getShortOption() ) : " " )
+ ( ( longOption != null && shortOption != '\0' ) ? ", " : " " )
+ ( ( longOption != null ) ? "--" + getLongOption(): "" ) ),
helpOptionSpecificationSize );
}
/**
* Return the type name field used during help reporting.
*
* @return The type name field.
*/
public String getHelpTypeName() {
return Utility.expandString( "<" + getTypeName() + ">",
helpTypenameSize );
}
/**
* Return the description field used during help reporting.
*
* @return The description field.
*/
public String getHelpDescription() {
return Utility.expandString( getDescription(),
helpDescriptionSize );
}
/**
* Return the deprecated field used during help reporting.
*
* @return The deprecated field.
*/
public String getHelpDeprecated() {
return Utility.expandString( isDeprecated() ? "[d]" : "",
helpDeprecatedSize );
}
/**
* Return the header displayed at the top of the help report.
*
* @return The header displayed at the top of the help report.
*/
public static String getHelpHeader() {
return Utility.expandString( "Option Name",
helpOptionSpecificationSize ) + " "
+ Utility.expandString( "Type", helpTypenameSize ) + " "
+ Utility.expandString( "Description", helpDescriptionSize );
}
/**
* The description explaining the meaning of this option.
*
* @return This options description.
*/
public String getDescription() {
return description;
}
/**
* The hash key of this option. This is used by classes that implement
* the option registrar class. This method should <b>not</b> be overrided.
*
* @return The hash key of this option.
*/
public String getHashKey() {
return Option.getHashKey( longOption, shortOption );
}
/**
* The hash key of an option if there is no short option. This method
* should <b>not</b> be overrided.
*
* @param longOption The long option.
*
* @return The hash key of this option based on the long option.
*/
public static String getHashKey( String longOption ) {
return "," + ( ( longOption != null ) ? longOption : "" );
}
/**
* The hash key of an option if there is no long option. This method
* should <b>not</b> be overrided.
*
* @param shortOption The short option.
*
* @return The hash key of this option based on the short option.
*/
public static String getHashKey( char shortOption ) {
return "" + ( shortOption != '\0' ) + ",";
}
/**
* The hash key of an option if there both short and long options are
* defined.
*
* @param shortOption The short option.
* @param longOption The long option.
*
* @return The hash key of this option based on both the short and long
* options.
*/
public static String getHashKey( String longOption, char shortOption ) {
return ( ( shortOption == '\0' ) ? "" : "" + shortOption ) +
( ( longOption == null ) ? "," : "," + longOption );
}
/**
* Returns whether this option is deprecated.
*
* @return A boolean indicating whether this option is deprecated.
*/
public boolean isDeprecated() {
return deprecated;
}
/**
* Returns whether this option has been invoked.
*
* @return A boolean indicating whether this option has been invoked.
*/
public boolean isInvoked() {
return invoked;
}
/**
* Returns (a) line(s) representing this option. This line is usually
* later written to an options file.
*
* @return Line(s) representing this option.
*/
public String getOptionFileLine() {
boolean descriptionPrinted = false;
String retval = "";
String optionText = "";
String strval = getStringValue();
if ( longOption != null ) {
optionText += "--" + longOption;
}
else if ( shortOption != '\0' ) {
optionText += "-" + shortOption;
}
if ( optionText.length() > 0
&& Utility.trim( strval ).length() >= 0 ) {
optionText += "=" + strval;
}
if ( optionText.length() <= fileCompleteOptionSize ) {
retval += Utility.expandString( optionText,
fileCompleteOptionSize );
}
else {
retval += "; " + description + "\n";
retval += optionText;
descriptionPrinted = true;
}
if ( !descriptionPrinted ) {
StringBuffer descsplit = new StringBuffer( description );
boolean tmp = false;
while ( descsplit.length() > 0 ) {
String st = "";
int size = 0;
if ( tmp ) {
st += Utility.getSpaces( fileCompleteOptionSize );
}
size = ( descsplit.length() >= fileCommentSize )
? fileCommentSize : descsplit.length();
st += "; " + descsplit.substring( 0, size );
descsplit.delete( 0, size );
retval += st + "\n";
tmp = true;
}
descriptionPrinted = true;
}
return retval;
}
/**
* Returns the field width for the option specification displayed in the
* help report.
*
* @return The field width.
*/
public static int getHelpOptionSpecificationSize() {
return helpOptionSpecificationSize;
}
/**
* Returns the field width for the type name displayed in the help report.
*
* @return The field width.
*/
public static int getHelpTypenameSize() {
return helpTypenameSize;
}
/**
* Returns the field width for the description displayed in the help
* report.
*
* @return The field width.
*/
public static int getHelpDescriptionSize() {
return helpDescriptionSize;
}
/**
* Returns the field width for the deprecated flag displayed in the
* help report.
*
* @return The field width.
*/
public static int getHelpDeprecatedSize() {
return helpDeprecatedSize;
}
/**
* Returns the field width for the option specification displayed in the
* menu listing of options.
*
* @return The field width.
*/
public static int getMenuOptionSpecificationSize() {
return menuOptionSpecificationSize;
}
/**
* Returns the field width for the type name displayed in the
* menu listing of options.
*
* @return The field width.
*/
public static int getMenuTypenameSize() {
return menuTypenameSize;
}
/**
* Returns the field width for the description displayed in the
* menu listing of options.
*
* @return The field width.
*/
public static int getMenuDescriptionSize() {
return menuDescriptionSize;
}
/**
* Returns the field width for the deprecated flag displayed in the
* menu listing of options.
*
* @return The field width.
*/
public static int getMenuDeprecatedSize() {
return menuDeprecatedSize;
}
/**
* Returns the field width for assignment portion of a option file line.
*
* @return The field width.
*/
public static int getFileCompleteOptionSize() {
return fileCompleteOptionSize;
}
/**
* Returns the field width for assignment portion of a option file line.
*
* @return The field width.
*/
public static int getFileCommentSize() {
return fileCommentSize;
}
/**
* Returns the type name of this option.
*
* @return The type name of this option.
*/
public abstract String getTypeName();
/**
* Prepares the option for modification.
*/
public void action() {
if ( deprecated ) {
System.err.print( "Warning: " );
if ( longOption != null ) {
System.err.print( "--" + longOption );
}
if ( shortOption != '\0' && longOption != null ) {
System.err.print( " or " );
}
if ( shortOption != '\0' ) {
System.err.println( "-" + shortOption + " is deprecated." );
}
}
}
} /** Option */
The table below shows all metrics for Option.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 63.00 | Number of blocks | |
| BLOCK_COMMENT | 0.00 | Number of block comment lines | |
| COMMENTS | 484.00 | Comment lines | |
| COMMENT_DENSITY | 2.47 | Comment density | |
| COMPARISONS | 32.00 | Number of comparison operators | |
| CYCLOMATIC | 73.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 81.00 | Comments in declarations | |
| DOC_COMMENT | 484.00 | Number of javadoc comment lines | |
| ELOC | 196.00 | Effective lines of code | |
| EXEC_COMMENTS | 0.00 | Comments in executable code | |
| EXITS | 23.00 | Procedure exits | |
| FUNCTIONS | 54.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 56.04 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 77.00 | Interface complexity | |
| JAVA0001 | 0.00 | JAVA0001 Package name does not contain only lower case letters | |
| JAVA0002 | 1.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 | 0.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 | 5.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 | 0.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 | 1.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 | 0.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 | 1.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 | 1.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 1.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 0.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 | 0.00 | JAVA0113 Incorrect javadoc: no @author tag | |
| JAVA0114 | 1.00 | JAVA0114 Incorrect javadoc: no @version tag | |
| JAVA0115 | 0.00 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0116 | 0.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 0.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 | 0.00 | JAVA0141 Unnecessary modifier for method in interface | |
| JAVA0143 | 0.00 | JAVA0143 Synchronized method | |
| JAVA0144 | 0.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 155.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 | 1.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 | 4.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 | 912.00 | Number of lines in the source file | |
| LINE_COMMENT | 0.00 | Number of line comments | |
| LOC | 259.00 | Lines of code | |
| LOGICAL_LINES | 115.00 | Number of statements | |
| LOOPS | 1.00 | Number of loops | |
| NEST_DEPTH | 4.00 | Maximum nesting depth | |
| OPERANDS | 427.00 | Number of operands | |
| OPERATORS | 969.00 | Number of operators | |
| PARAMS | 26.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 1396.00 | Halstead program length | |
| PROGRAM_VOCAB | 202.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 51.00 | Number of return points from functions | |
| SIZE | 24526.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 160.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 42.00 | Number of unique operators | |
| WHITESPACE | 169.00 | Number of whitespace lines | |