Options.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 | |
| JAVA0267 | JAVA0267 Use of System.err | |
| COMMENTS | Comment lines | |
| SIZE | Size of the file in bytes | |
| LINES | Number of lines in the source file | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| CYCLOMATIC | Cyclomatic complexity | |
| BLOCKS | Number of blocks | |
| JAVA0049 | JAVA0049 Nested block at depth N (maximum: M) | |
| COMPARISONS | Number of comparison operators | |
| JAVA0119 | JAVA0119 Control variable changed within body of for loop | |
| EXITS | Procedure exits | |
| OPERATORS | Number of operators | |
| PROGRAM_LENGTH | Halstead program length | |
| LOC | Lines of code | |
| OPERANDS | Number of operands | |
| ELOC | Effective lines of code | |
| LOOPS | Number of loops | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| UNIQUE_OPERANDS | Number of unique operands | |
| LOGICAL_LINES | Number of statements | |
| FUNCTIONS | Number of function declarations | |
| JAVA0254 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| JAVA0067 | JAVA0067 Array descriptor on identifier name | |
| PARAMS | Number of formal parameter declarations | |
| RETURNS | Number of return points from functions | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| UNIQUE_OPERATORS | Number of unique operators | |
| NEST_DEPTH | Maximum nesting depth | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0136 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0174 | JAVA0174 Assigned local variable never used | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| LINE_COMMENT | Number of line comments | |
| JAVA0100 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| WHITESPACE | Number of whitespace lines | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| EXEC_COMMENTS | Comments in executable code | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
package gnu.dtools.ritopt;
/**
* Options.java
*
* Version:
* $Id: Options.java 2488 2007-11-14 00:25:31Z coezbek $
*/
import java.io.*;
import java.util.HashMap;
import java.util.Iterator;
import net.sf.jabref.Globals;
/**
* This class functions as a repository for options and their modules. It
* facilitates registration of options and modules, as well as processing of
* arguments.<p>
*
* Information such as help, usage, and versions are displayed
* when the respective --help and --version options are specified.
* The --menu option will invoke the built-in menu.<p>
*
* In the example below, the program processes three simple options.
*
* <pre>
* public class AboutMe {
*
* private static StringOption name = new StringOption( "Ryan" );
* private static IntOption age = new IntOption( 19 );
* private static DoubleOption bankBalance = new DoubleOption( 15.15 );
*
* public static void main( String args[] ) {
* Options repo = new Options( "java AboutMe" );
* repo.register( "name", 'n', name, "The person's name." );
* repo.register( "age", 'a', age, "The person's age." );
* repo.register( "balance", 'b', "The person's bank balance.",
* bankBalance );
* repo.process( args );
g * System.err.println( "" + name + ", age " + age + " has a " +
* " bank balance of " + bankBalance + "." );
* }
* }
* </pre>
*
* <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 class Options implements OptionRegistrar, OptionModuleRegistrar,
OptionListener {
/**
* The default verbosity.
*/
public static final int DEFAULT_VERBOSITY = 3;
/**
* This boolean defines whether options are deprecated by default.
*/
public static final boolean DEFAULT_DEPRECATED = false;
/**
* The default reason for deprecation.
*/
public static final String DEFAULT_REASON = "No reason given.";
/**
* The default general module name.
*/
public static final String DEFAULT_GENERAL_MODULE_NAME = "General";
/**
* This boolean defines whether usage should be displayed.
*/
public static final boolean DEFAULT_DISPLAY_USAGE = false; // Mod. Morten A.
/**
* This boolean defines whether the menu should be used.
*/
public static final boolean DEFAULT_USE_MENU = false; // Mod. Morten A.
/**
* The default program name that is display in the usage.
*/
public static final String DEFAULT_PROGRAM_NAME = "java program";
/**
* The default option file.
*/
public static final String DEFAULT_OPTION_FILENAME = "default.opt";
/**
* The program to display in the usage.
*/
private String usageProgram;
/**
* The version to display in the usage.
*/
private String version;
/**
* The default option filename if an option file is not specified.
*/
private String defaultOptionFilename;
/**
* This flag defines whether to display usage when help is displayed.
*/
private boolean displayUsage;
/**
* This boolean defines whether the menu should be used.
*/
private boolean useMenu;
/**
* When this flag is true, debugging information is displayed.
*/
private boolean debugFlag;
/**
* The current module being processed.
*/
private OptionModule currentModule;
/**
* The general option module.
*/
private OptionModule generalModule;
/**
* A map of option modules.
*/
private java.util.HashMap<String, OptionModule> modules;
/**
* Version information is displayed when this option is specified.
*/
private NotifyOption versionOption;
/**
* Create an option repository.
*/
public Options() {
this( DEFAULT_PROGRAM_NAME );
}
/**
* Create an option repository and associated it with a program name.
*
* @param programName A program name like "java Balloons".
*/
public Options( String programName ) {
displayUsage = DEFAULT_DISPLAY_USAGE;
useMenu = DEFAULT_USE_MENU;
defaultOptionFilename = DEFAULT_OPTION_FILENAME;
usageProgram = programName;
modules = new HashMap<String, OptionModule>();
versionOption = new NotifyOption( this, "version", "" );
version = "Version 1.0";
generalModule = new OptionModule( DEFAULT_GENERAL_MODULE_NAME );
currentModule = generalModule;
// Mod. Morten A. ------------------------------------------------
register( "version", 'v',
"Displays version information.", versionOption );
/*register( "help", 'h', "Displays help for each option.", helpOption );
register( "menu", 'm', "Displays the built-in interactive menu.",
menuOption );*/
// End mod. Morten A. ------------------------------------------------
}
/**
* Returns the help information as a string.
*
* @return The help information.
*/
public String getHelp() {
String retval = (displayUsage ? getUsage() + "\n\n" : "" ) +
// Mod. Morten A.
//"Use --menu to invoke the interactive built-in menu.\n\n" +
Option.getHelpHeader() + "\n\n" + generalModule.getHelp();
Iterator<OptionModule> it = modules.values().iterator();
while ( it.hasNext() ) {
OptionModule module = it.next();
retval += "\n\nOption Listing for " + module.getName() + "\n";
retval += module.getHelp() + "\n";
}
return retval;
}
/**
* Returns usage information of this program.
*
* @return The usage information.
*/
public String getUsage() {
return getUsageProgram()
+ " @optionfile :module: OPTIONS ... :module: OPTIONS";
}
/**
* Returns the program name displayed in the usage.
*
* @returns The program name.
*/
public String getUsageProgram() {
return usageProgram;
}
/**
* Returns the version of the program.
*
* @returns The version.
*/
public String getVersion() {
return version;
}
/**
* Returns the option filename to load or write to if one is not
* specified.
*
* @return The default option filename.
*/
public String getDefaultOptionFilename() {
return defaultOptionFilename;
}
/**
* Returns whether debugging information should be displayed.
*
* @return A boolean indicating whether to display help information.
*/
public boolean getDebugFlag() {
return debugFlag;
}
/**
* Returns whether the help information should display usage.
*
* @return A boolean indicating whether help should display usage.
*/
public boolean shouldDisplayUsage() {
return displayUsage;
}
/**
* Returns whether the built-in menu system can be invoked.
*
* @return A boolean indicating whether the build-in menu system
* can be invoked.
*/
public boolean shouldUseMenu() {
return useMenu;
}
/**
* Sets whether usage can be displayed.
*
* @param b A boolean value indicating that usage can be displayed.
*/
public void setDisplayUsage( boolean b ) {
displayUsage = b;
}
/**
* Sets whether the built-in menu system can be used.
*
* @param b A boolean value indicating whether the built-in menu
* system can be used.
*/
public void setUseMenu( boolean b ) {
useMenu = b;
}
/**
* Sets the program to display when the usage is displayed.
*
* @param program The program displayed during usage.
*/
public void setUsageProgram( String program ) {
usageProgram = program;
}
/**
* Sets the version of the program.
*
* @param version The version.
*/
public void setVersion( String version ) {
this.version = version;
}
/**
* Sets the option file to use when an option file is not specified.
*
* @param fn The filename of the default option file.
*/
public void setDefaultOptionFilename( String fn ) {
defaultOptionFilename = fn;
}
/**
* Displays the program's help which includes a description of each
* option. The usage is display if the usage flag is set to true.
*/
public void displayHelp() {
System.err.println( getHelp() );
}
/**
* Displays the version of the program.
*/
public void displayVersion() {
System.err.println( getVersion() +" (build " +Globals.BUILD +")");
}
/**
* Register an option into the repository as a long option.
*
* @param longOption The long option name.
* @param option The option to register.
*/
public void register( String longOption, Option option ) {
generalModule.register( longOption, option );
}
/**
* Register an option into the repository as a short option.
*
* @param shortOption The short option name.
* @param option The option to register.
*/
public void register( char shortOption, Option option ) {
generalModule.register( shortOption, option );
}
/**
* Register an option into the repository both as a short and long option.
*
* @param longOption The long option name.
* @param shortOption The short option name.
* @param option The option to register.
*/
public void register( String longOption, char shortOption,
Option option ) {
generalModule.register( longOption, shortOption, option );
}
/**
* Register an option into the repository both as a short and long option.
* Initialize its description with the description passed.
*
* @param longOption The long option name.
* @param shortOption The short option name.
* @param description The description of the option.
* @param option The option to register.
*/
public void register( String longOption, char shortOption,
String description, Option option ) {
generalModule.register( longOption, shortOption, description, option );
}
/**
* Register an option into the repository both as a short and long option.
* Initialize its description with the description passed.
*
* @param longOption The long option name.
* @param shortOption The short option name.
* @param description The description of the option.
* @param option The option to register.
* @param deprecated A boolean indicating whether an option should
* be deprecated.
*/
public void register( String longOption, char shortOption,
String description, Option option,
boolean deprecated ) {
generalModule.register( longOption, shortOption, description, option,
deprecated );
}
/**
* Register an option module based on its name.
*
* @param module The option module to register.
*/
public void register( OptionModule module ) {
register( module.getName(), module );
}
/**
* Register an option module and associate it with the name passed.
*
* @param name The name associated with the option module.
* @param module The option module to register.
*/
public void register( String name, OptionModule module ) {
modules.put( name.toLowerCase(), module );
}
/**
* Process a string of values representing the invoked options. After
* all the options are processed, any leftover arguments are returned.
*
* @param args The arguments to process.
*
* @return The leftover arguments.
*/
public String[] process( String args[] )
{
String []retval = new String[0];
try {
retval = processOptions( args );
}
catch ( OptionException e ) {
System.err.println( "Error: " + e.getMessage() );
}
/**
catch ( Exception e ) {
System.err.println( "Error: Unexpected Error in ritopt Processing." +
"Check syntax." );
}**/
return retval;
}
/**
* Retrieves an option module based on the name passed.
*
* @param name The name referring to the option module.
*
* @return The option module. Null is returned if the module does not
* exist.
*/
public OptionModule getModule( String name ) {
return modules.get( name.toLowerCase() );
}
/**
* Returns a boolean indicating whether an option module exists.
*
* @param name The name referring to the option module.
*
* @return A boolean value indicating whether the module exists.
*/
public boolean moduleExists( String name ) {
return getModule( name ) != null;
}
/**
* Receives NotifyOption events. If the event command equals "help"
* or "version", the appropriate display methods are invoked.
*
* @param event The event object containing information about the
* invocation.
*/
public void optionInvoked( OptionEvent event ) {
if ( event.getCommand().equals( "help" ) ) {
displayHelp();
}
else if ( event.getCommand().equals( "version" ) ) {
displayVersion();
}
}
/**
* Process a string representing the invoked options. This string
* gets split according to how they would be split when passed to
* a main method. The split array of options gets passed to a
* private method for processing. After all the options are processed,
* any leftover arguments are returned.
*
* @param str The arguments to process.
*
* @return The leftover arguments.
*/
public String[] process( String str ) {
return process( split( str ) );
}
/**
* Splits a string representing command line arguments into several
* strings.
*
* @param str The string to split.
*
* @return The splitted string.
*/
public String[] split( String str ) {
StringBuffer buf = new StringBuffer( str.length() );
java.util.List<String> l = new java.util.ArrayList<String>();
int scnt = Utility.count( str, '"' );
boolean q = false;
if ( (scnt) / 2.0 != (scnt / 2) ) {
throw new OptionProcessingException( "Expecting an end quote." );
}
for ( int n = 0; n < str.length(); n++ ) {
if ( str.charAt( n ) == '"' ) {
q = !q;
}
else if ( str.charAt( n ) == ' ' && !q ) {
l.add( buf.toString() );
buf = new StringBuffer( str.length() );
}
else {
buf.append( str.charAt( n ) );
}
}
if ( buf.length() != 0 ) {
l.add( buf.toString() );
}
Iterator<String> it = l.iterator();
String retval[] = new String[ l.size() ];
int n = 0;
while ( it.hasNext() ) {
retval[ n++ ] = it.next();
}
return retval;
}
/**
* Writes all options and their modules out to an options file.
*
* @param filename The options filename to write.
*/
public void writeOptionFile( String filename ) {
BufferedOutputStream writer = null;
Iterator<OptionModule> it = null;
currentModule = generalModule;
try {
writer =
new BufferedOutputStream( new FileOutputStream( filename ) );
PrintStream ps = new PrintStream( writer );
generalModule.writeFileToPrintStream( ps );
it = modules.values().iterator();
while ( it.hasNext() ) {
OptionModule module = it.next();
module.writeFileToPrintStream( ps );
}
}
catch ( IOException e ) {
throw new OptionProcessingException( e.getMessage() );
}
finally {
try {
if ( writer != null )
writer.close();
}
catch( IOException e ) {
throw new OptionProcessingException( e.getMessage() );
}
}
}
/**
* Loads all options and their modules from an options file.
*
* @param filename The options filename to write.
*/
public void loadOptionFile( String filename ) {
BufferedReader reader = null;
String line = null;
currentModule = generalModule;
try {
reader = new BufferedReader( new FileReader( filename ) );
while ( ( line = reader.readLine() ) != null ) {
line = Utility.stripComments( line, '\"', ';' );
process( line );
}
}
catch ( IOException e ) {
throw new OptionProcessingException( e.getMessage() );
}
finally {
try {
if ( reader != null )
reader.close();
}
catch( IOException e ) {
throw new OptionProcessingException( e.getMessage() );
}
}
}
/**
* Processes an array of strings representing command line arguments.
*
* @param args arguments to process.
*
* @return The leftover arguments.
*/
private String[] processOptions( String args[] ) {
String retval[] = null;
String moduleName = "general";
String optionFile = "";
char shortOption = '\0';
String longOption = "";
for ( int n = 0; n < args.length && retval == null; n++ ) {
boolean moduleInvoked = false;
boolean shortOptionInvoked = false;
boolean longOptionInvoked = false;
boolean readOptionFileInvoked = false;
boolean writeOptionFileInvoked = false;
if ( args[ n ].length() >= 1 ) {
char fc = args[ n ].charAt( 0 );
moduleInvoked = fc == ':';
readOptionFileInvoked = fc == '@';
writeOptionFileInvoked = fc == '%';
}
if ( args[ n ].length() >= 2 ) {
String s = args[ n ].substring( 0, 2 );
shortOptionInvoked = ( !s.equals( "--" ) &&
s.charAt( 0 ) == '-' );
longOptionInvoked = ( s.equals( "--" ) );
}
if ( debugFlag ) {
System.err.println( "Short Option: " + shortOptionInvoked );
System.err.println( "Long Option: " + longOptionInvoked );
System.err.println( "Module: " + moduleInvoked );
System.err.println( "Load Option File: " +
readOptionFileInvoked );
System.err.println( "Write Option File: "
+ writeOptionFileInvoked );
}
if ( moduleInvoked ) {
if ( args[ n ].charAt( args[ n ].length() - 1 ) != ':' ) {
System.err.println( args[ n ] );
throw new
OptionProcessingException(
"Module arguments must start"
+ " with : and end with :."
);
}
else {
moduleName = args[n].substring( 1,
args[n].length() - 1
).toLowerCase();
if ( moduleName.length() == 0
|| moduleName.equals( "general" ) ) {
moduleName = "general";
currentModule = generalModule;
}
else {
currentModule = getModule( moduleName );
}
if ( currentModule == null )
throw new OptionProcessingException( "Module '" +
moduleName +
"' does not exist." );
if ( debugFlag ) {
System.err.println( "Module: " + moduleName );
}
}
moduleInvoked = false;
}
else if ( readOptionFileInvoked ) {
optionFile = Utility.trim( args[ n ].substring( 1 ) );
if ( optionFile.equals( "@" )
|| optionFile.length() == 0 )
optionFile = defaultOptionFilename;
if ( debugFlag ) {
System.err.println( "Option file: '" + optionFile + "'." );
}
loadOptionFile( optionFile );
}
else if ( shortOptionInvoked ) {
shortOption = args[ n ].charAt( 1 );
if ( !Utility.isAlphaNumeric( shortOption ) ) {
throw new OptionProcessingException(
"A short option must be alphanumeric. -" + shortOption
+ " is not acceptable." );
}
if ( debugFlag ) {
System.err.println( "Short option text: " + shortOption );
}
char delim = ( args[ n ].length() >= 3 ) ?
args[ n ].charAt( 2 ) : '\0';
if ( delim == '+' || delim == '-' ) {
currentModule.action( shortOption, delim );
}
else if ( delim == '=' ) {
currentModule.action( shortOption,
args[ n ].substring( 3 ) );
}
else if ( delim == '\0' ) {
String dtext = "+";
if ( n < args.length - 1 ) {
if ( !Utility.contains( args[ n + 1 ].charAt( 0 ),
"-[@" ) ) {
dtext = args[ n + 1 ];
n++;
}
}
currentModule.action( shortOption, dtext );
}
else if ( Utility.isAlphaNumeric( delim ) ) {
for ( int j = 1; j < args[ n ].length(); j++ ) {
if ( Utility.isAlphaNumeric( args[ n ].charAt( j ) ) ) {
currentModule.action( shortOption, "+" );
}
else {
throw new OptionProcessingException(
"A short option must be alphanumeric. -"
+ shortOption + " is not acceptable." );
}
}
}
}
else if ( longOptionInvoked ) {
char lastchar = args[ n ].charAt( args[ n ].length() - 1 );
int eqindex = args[ n ].indexOf( "=" );
if ( eqindex != -1 ) {
longOption = args[ n ].substring( 2, eqindex );
String value = args[ n ].substring( eqindex + 1 );
currentModule.action( longOption, value );
}
else if ( Utility.contains( lastchar, "+-" ) ) {
longOption = args[ n ].substring( 2,
args[ n ].length() - 1 );
currentModule.action( longOption, lastchar );
}
else {
longOption = args[ n ].substring( 2 );
String dtext = "+";
if ( n < args.length - 1 && args[ n + 1 ].length() > 0 ) {
if ( !Utility.contains( args[ n + 1 ].charAt( 0 ),
"-[@" ) ) {
dtext = args[ n + 1 ];
n++;
}
}
currentModule.action( longOption, dtext );
}
if ( debugFlag ) {
System.err.println( "long option: " + longOption );
}
}
else if ( writeOptionFileInvoked ) {
optionFile = Utility.trim( args[ n ].substring( 1 ) );
if ( optionFile.equals( "%" )
|| optionFile.length() == 0 )
optionFile = defaultOptionFilename;
if ( debugFlag ) {
System.err.println( "Option file: '" + optionFile + "'." );
}
writeOptionFile( optionFile );
}
else {
retval = new String[ args.length - n ];
for ( int j = n; j < args.length; j++ ) {
retval[ j - n ] = args[ j ];
}
}
}
if ( retval == null ) retval = new String[ 0 ];
return retval;
}
}
The table below shows all metrics for Options.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 92.00 | Number of blocks | |
| BLOCK_COMMENT | 3.00 | Number of block comment lines | |
| COMMENTS | 325.00 | Comment lines | |
| COMMENT_DENSITY | 1.07 | Comment density | |
| COMPARISONS | 62.00 | Number of comparison operators | |
| CYCLOMATIC | 95.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 53.00 | Comments in declarations | |
| DOC_COMMENT | 318.00 | Number of javadoc comment lines | |
| ELOC | 305.00 | Effective lines of code | |
| EXEC_COMMENTS | 5.00 | Comments in executable code | |
| EXITS | 60.00 | Procedure exits | |
| FUNCTIONS | 33.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 87.03 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 76.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 | 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 | 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 | 6.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 | 4.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 | 2.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 | 1.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 | 0.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 0.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 2.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 | 3.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 | 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 | 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 | 2.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 | 14.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 | 833.00 | Number of lines in the source file | |
| LINE_COMMENT | 4.00 | Number of line comments | |
| LOC | 399.00 | Lines of code | |
| LOGICAL_LINES | 182.00 | Number of statements | |
| LOOPS | 8.00 | Number of loops | |
| NEST_DEPTH | 6.00 | Maximum nesting depth | |
| OPERANDS | 884.00 | Number of operands | |
| OPERATORS | 1660.00 | Number of operators | |
| PARAMS | 34.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 2544.00 | Halstead program length | |
| PROGRAM_VOCAB | 310.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 42.00 | Number of return points from functions | |
| SIZE | 26493.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 259.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 51.00 | Number of unique operators | |
| WHITESPACE | 109.00 | Number of whitespace lines | |