ChordRecognizer.java

Index Score
org.herac.tuxguitar.gui.editors.chord
TuxGuitar

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.

MetricDescription
LOOPSNumber of loops
JAVA0034JAVA0034 Missing braces in if statement
JAVA0076JAVA0076 Use of magic number
JAVA0035JAVA0035 Missing braces in for statement
CYCLOMATICCyclomatic complexity
LINE_COMMENTNumber of line comments
COMPARISONSNumber of comparison operators
OPERATORSNumber of operators
PROGRAM_LENGTHHalstead program length
JAVA0108JAVA0108 Incorrect javadoc: no @param tag for 'parameter'
OPERANDSNumber of operands
LOGICAL_LINESNumber of statements
DECL_COMMENTSComments in declarations
EXEC_COMMENTSComments in executable code
SIZESize of the file in bytes
ELOCEffective lines of code
JAVA0049JAVA0049 Nested block at depth N (maximum: M)
LOCLines of code
JAVA0110JAVA0110 Incorrect javadoc: no @return tag
EXITSProcedure exits
LINESNumber of lines in the source file
JAVA0036JAVA0036 Missing braces in while statement
JAVA0254JAVA0254 Use enhanced for loop construct instead of Iterator
BLOCKSNumber of blocks
PROGRAM_VOCABHalstead program vocabulary
JAVA0067JAVA0067 Array descriptor on identifier name
UNIQUE_OPERANDSNumber of unique operands
JAVA0117JAVA0117 Missing javadoc: method 'method'
JAVA0145JAVA0145 Tab character used in source file
UNIQUE_OPERATORSNumber of unique operators
NEST_DEPTHMaximum nesting depth
FUNCTIONSNumber of function declarations
JAVA0144JAVA0144 Line exceeds maximum M characters
JAVA0111JAVA0111 Incorrect javadoc: @return tag for void method
JAVA0128JAVA0128 Public constructor in non-public class
JAVA0119JAVA0119 Control variable changed within body of for loop
JAVA0283JAVA0283 Control variable not updated in loop body
PROGRAM_VOLUMEHalstead program volume
JAVA0032JAVA0032 Switch statement missing default
INTERFACE_COMPLEXITYInterface complexity
JAVA0126JAVA0126 Method declares unchecked exception in throws
JAVA0123JAVA0123 Use all three components of for loop
PARAMSNumber of formal parameter declarations
RETURNSNumber of return points from functions
JAVA0130JAVA0130 Non-static method does not use instance fields
DOC_COMMENTNumber of javadoc comment lines
package org.herac.tuxguitar.gui.editors.chord; /* Created on 05-March-2007 */ import java.util.ArrayList; import java.util.Iterator; import org.eclipse.swt.SWT; import org.eclipse.swt.events.SelectionAdapter; import org.eclipse.swt.events.SelectionEvent; import org.eclipse.swt.layout.GridData; import org.eclipse.swt.layout.GridLayout; import org.eclipse.swt.widgets.Composite; import org.eclipse.swt.widgets.List; import org.herac.tuxguitar.gui.TuxGuitar; import org.herac.tuxguitar.song.models.TGChord; /** * @author Nikola Kolarovic * */ public class ChordRecognizer extends Composite { // index for parameter array protected static final int TONIC_INDEX = 0; protected static final int CHORD_INDEX = 1; protected static final int ALTERATION_INDEX = 2; protected static final int PLUSMINUS_INDEX = 3; protected static final int BASS_INDEX = 4; protected static final int ADDCHK_INDEX = 5; protected static final int I5_INDEX = 6; protected static final int I9_INDEX = 7; protected static final int I11_INDEX = 8; private ChordDialog dialog; private List proposalList; private java.util.List proposalParameters; // this var keep a control to running threads. private long runningProcess; //------------------------------------------------------------ public ChordRecognizer(ChordDialog dialog, Composite parent,int style) { super(parent,style); this.setLayout(dialog.gridLayout(1,false,0,0)); this.setLayoutData(makeGridData()); this.runningProcess = 0; this.dialog = dialog; this.init(); } //------------------------------------------------------------ public GridData makeGridData(){ GridData data = new GridData(SWT.FILL,SWT.FILL,true,true); data.minimumWidth = 180; return data; } //------------------------------------------------------------ public void init(){ Composite composite = new Composite(this,SWT.NONE); composite.setLayout(new GridLayout()); composite.setLayoutData(new GridData(SWT.FILL,SWT.FILL,true,true)); this.proposalParameters = new ArrayList(); this.proposalList = new List(composite,SWT.BORDER | SWT.H_SCROLL | SWT.V_SCROLL); this.proposalList.setLayoutData(new GridData(SWT.FILL,SWT.FILL,true,true)); this.proposalList.addSelectionListener(new SelectionAdapter() { public void widgetSelected(SelectionEvent e) { if(getDialog().getEditor() != null){ showChord(getProposalList().getSelectionIndex()); } } }); } //------------------------------------------------------------ /** sets the current chord to be selected proposal */ protected void showChord(int index) { int[] params = (int[])this.proposalParameters.get(index); this.dialog.getSelector().adjustWidgets(params[TONIC_INDEX], params[CHORD_INDEX], params[ALTERATION_INDEX], params[BASS_INDEX], params[PLUSMINUS_INDEX], params[ADDCHK_INDEX], params[I5_INDEX], params[I9_INDEX], params[I11_INDEX]); String chordName = this.proposalList.getItem(index); chordName = chordName.substring(0, chordName.indexOf('(')-1); this.dialog.getEditor().getChordName().setText(chordName); this.dialog.getEditor().redraw(); } //------------------------------------------------------------ /** * - Recognizes the chord string * - Fills the component's list with alternative names * - Sets all the ChordSelector fields into recognized chord (tonic, bass, chord, alterations) * - Makes the alternatives and puts them into ChordList * - Writes the chord formula into appropriate label * @param chord chord structure (frets, strings) * @param redecorate is the Chord Editor in editing mode, or it is just changed by ChordSelector */ public void recognize(final TGChord chord,final boolean redecorate,final boolean setChordName) { final long processId = (++ this.runningProcess); final boolean sharp = this.dialog.getSelector().getSharpButton().getSelection(); this.clearProposals(); new Thread( new Runnable() { public void run() { if(!getDialog().isDisposed() && isValidProcess(processId)){ final int params[] = makeProposals(processId, chord,sharp); if (params == null) { // could not recognize anything!? if (isValidProcess(processId) && setChordName) { TuxGuitar.instance().getDisplay().syncExec(new Runnable() { public void run() { if(!getDialog().isDisposed() && isValidProcess(processId)){ getDialog().getEditor().setChordName(""); } } }); } return; } final String chordName = getChordName(params,sharp); // Sets all the ChordSelector fields into recognized chord (tonic, bass, chord, alterations) if (isValidProcess(processId) && redecorate) { TuxGuitar.instance().getDisplay().syncExec(new Runnable() { public void run() { if(!getDialog().isDisposed()){ redecorate(params); } } }); } if (isValidProcess(processId) && setChordName) { TuxGuitar.instance().getDisplay().syncExec(new Runnable() { public void run() { if(!getDialog().isDisposed()){ getDialog().getEditor().setChordName( (chordName != null ? chordName : "" ) ); } } }); } } } } ).start(); } //------------------------------------------------------------ /** Fills the component's list with alternative names * @param chord TGChord to be recognized * @return parameters for adjustWidgets and getChordName methods */ protected int[] makeProposals(final long processId, TGChord chord,final boolean sharp) { int[] tuning = this.dialog.getSelector().getTuning(); java.util.List notesInside = new ArrayList(); // find and put in all the distinct notes for (int i=0; i<tuning.length; i++) { int fret = chord.getStrings()[i]; if (fret!=-1) { Integer note = new Integer((tuning[tuning.length-1-i] + fret) % 12); Iterator it = notesInside.iterator(); boolean found=false; while (it.hasNext()) if (it.next().equals(note)) found=true; if (!found) notesInside.add(note); } } // Now search: // go through all the possible tonics // it is required because tonic isn't mandatory in a chord java.util.List allProposals = new ArrayList(10); for (int tonic=0; tonic<12; tonic++) { Proposal currentProp = null; // first check for the basic chord tones for (int chordIndex = 0; chordIndex < ChordDatabase.length(); chordIndex ++) { ChordDatabase.ChordInfo info = ChordDatabase.get(chordIndex); currentProp = new Proposal(notesInside); // it is more unusual the more we go down the index // except chords "5" and "m", they are quite usual :) currentProp.unusualGrade-=(chordIndex!=ChordDatabase.length() && chordIndex!=4 ? 2*chordIndex : 0); //ChordDatabase.ChordInfo info = (ChordDatabase.ChordInfo)chordItr.next(); boolean foundNote = false; for (int i=0; i<info.getRequiredNotes().length; i++) { // go through all the requred notes Iterator nit = notesInside.iterator(); while (nit.hasNext()) // go through all the needed notes if (((Integer)nit.next()).intValue() == (tonic+info.getRequiredNotes()[i]-1)%12) { foundNote=true; if (tonic+info.getRequiredNotes()[i]-1 == tonic) currentProp.dontHaveGrade+=15; // this means penalty for not having tonic is -65 currentProp.foundNote(tonic+info.getRequiredNotes()[i]-1); // found a note in a chord } } // if something found, add it into a proposal if it's worth if (foundNote) { currentProp.params[TONIC_INDEX] = tonic; currentProp.params[CHORD_INDEX] = chordIndex;//possibleChords.indexOf(info); int foundNotesCount = currentProp.missingNotes.length-currentProp.missingCount; // it is worth if it is missing 1 essential note and/or fifth if (!info.getName().startsWith("dim") && !info.getName().startsWith("aug")) if (!currentProp.isFound(tonic+8-1)) { // hmmm. maybe it's altered fifth? Create a branch for it. if (currentProp.isNeeded(tonic+7-1) || currentProp.isNeeded(tonic+9-1)) { Proposal branchProp = (Proposal)currentProp.clone(); if (branchProp.isNeeded(tonic+9-1)) { branchProp.params[I5_INDEX] = 1; branchProp.foundNote(tonic+8); } else { branchProp.params[I5_INDEX] = 2; branchProp.foundNote(tonic+6); } branchProp.unusualGrade-=35; if (foundNotesCount+1>=info.getRequiredNotes().length-1) { branchProp.dontHaveGrade-=(info.getRequiredNotes().length-(foundNotesCount+1))*50; allProposals.add(branchProp); } } else { currentProp.params[I5_INDEX] = 0; currentProp.dontHaveGrade+=30; } } currentProp.params[I5_INDEX] = 0; if (foundNotesCount>=info.getRequiredNotes().length-1 ) { currentProp.dontHaveGrade-=(info.getRequiredNotes().length-foundNotesCount)*50; allProposals.add(currentProp); } } currentProp=null; } } Iterator props = allProposals.iterator(); java.util.List unsortedProposals = new ArrayList(5); while (props.hasNext()) { // place the still missing alterations notes accordingly... bass also /////////////////////////////////////////////////////////////// final Proposal current = (Proposal)props.next(); boolean bassIsOnlyInBass = true; // ---------------- bass tone ---------------- for (int i=chord.getStrings().length-1; i>=0; i--) { if (chord.getStrings()[i]!=-1) { if (current.params[BASS_INDEX]==-1) {// if we still didn't determine bass current.params[BASS_INDEX] = (tuning[tuning.length-1-i] + chord.getStrings()[i]) % 12; if (current.params[BASS_INDEX]!=current.params[TONIC_INDEX]) current.unusualGrade-=20; } if (current.params[BASS_INDEX]==(tuning[tuning.length-1-i] + chord.getStrings()[i]) % 12 ) bassIsOnlyInBass=false; // if we stumbled upon bass tone again } } if (current.isNeeded(current.params[BASS_INDEX]) && bassIsOnlyInBass) { // do not mark as FOUND if bass is somewhere other than in bass only current.foundNote(current.params[BASS_INDEX]); current.unusualGrade-=20; } // <=11 means "not DIM or AUG or 5" if (current.missingCount>0 && current.params[CHORD_INDEX]<=11) { // ---------------- alteration tones ---------------- // determine seventh -->> 2 is HARDCODED! int seventh; if (current.params[CHORD_INDEX] == 2) seventh=current.params[TONIC_INDEX]+12-1; // plain 7 else seventh=current.params[TONIC_INDEX]+11-1; // b7 if (current.isExisting(seventh)) { if (!current.isFound(seventh)) { current.filled[3]=true; current.foundNote(seventh); } } for (int plusminus=0; plusminus<=2; plusminus++) { for (int i=2; i>=0; i--) // 13, 11, 9 if (current.isNeeded(current.params[TONIC_INDEX]+getAddNote(i, plusminus)) && !current.filled[i]) { current.filled[i]=true; current.plusminusValue[i]=plusminus; if (plusminus!=0) current.unusualGrade-=15; current.foundNote(current.params[TONIC_INDEX]+getAddNote(i, plusminus)); } } } // fill in the list /////////////////////////////////////////////////////////////// if (!(current.filled[3] && !(current.filled[0] || current.filled[1] || current.filled[2])) && // if just found seventh, cancel it current.missingCount==0 && // we don't tollerate notes in chord that are not used in the ChordName current.dontHaveGrade>-51) { findChordLogic(current); unsortedProposals.add(current); } } // first, sort by DontHaveGrade shellsort(unsortedProposals,1); int cut=-1; int howManyIncomplete = ChordSettings.instance().getIncompleteChords(); for (int i=0; i<unsortedProposals.size() && cut==-1; i++) { int prior = ((Proposal)unsortedProposals.get(i)).dontHaveGrade; if (prior<0) cut=i+howManyIncomplete; } // cut the search unsortedProposals=unsortedProposals.subList(0, (cut>0 && cut<unsortedProposals.size() ? cut : unsortedProposals.size())); // sort by unusualGrade shellsort(unsortedProposals,2); int firstNegative = 0; for (int i=0; i<unsortedProposals.size(); i++) { final Proposal current = (Proposal)unsortedProposals.get(i); if (firstNegative==0 && current.unusualGrade<0) firstNegative=current.unusualGrade; if (current.unusualGrade > (firstNegative>=0 ? 0 : firstNegative)-60) { TuxGuitar.instance().getDisplay().syncExec(new Runnable() { public void run() { if(!getDialog().isDisposed() && isValidProcess(processId)){ addProposal(current.params, getChordName(current.params,sharp)+" ("+Math.round(100+current.dontHaveGrade*7/10)+"%)" ); } } }); } } if (this.proposalParameters.size()==0) return null; return (int[])this.proposalParameters.get(0); } //------------------------------------------------------------ /** adjusts widgets on the Recognizer combo */ protected void redecorate(int params[]){ this.dialog.getSelector().adjustWidgets(params[TONIC_INDEX], params[CHORD_INDEX], params[ALTERATION_INDEX], params[BASS_INDEX], params[PLUSMINUS_INDEX], params[ADDCHK_INDEX], params[I5_INDEX], params[I9_INDEX], params[I11_INDEX]); } //------------------------------------------------------------ /** Assembles chord name according to ChordNamingConvention */ protected String getChordName(int[] param, boolean sharp) { return new ChordNamingConvention().createChordName(param[TONIC_INDEX], param[CHORD_INDEX], param[ALTERATION_INDEX], param[PLUSMINUS_INDEX], param[ADDCHK_INDEX] != 0, param[I5_INDEX], param[I9_INDEX], param[I11_INDEX], param[BASS_INDEX], sharp); } //------------------------------------------------------------ /** Return required interval in semitones for add type and +- modificator * @param type 0=add9, 1=add11, 2=add13 * @param selectionIndex 0=usual, 1="+", 2="-" */ protected int getAddNote(int type, int selectionIndex) { int wantedNote = 0; switch (type) { case 0: wantedNote = 3; // add9 break; case 1: wantedNote = 6; // add11 break; case 2: wantedNote = 10; // add13 break; } switch (selectionIndex) { case 1: wantedNote++; break; case 2: wantedNote--; break; default: break; } return --wantedNote; } //------------------------------------------------------------ void findChordLogic(Proposal current) { boolean[] found = current.filled; int[] plusMinus = current.plusminusValue; /*if (!found[3]) current.unusualGrade-=50;*/ current.params[ALTERATION_INDEX]=0; current.params[I9_INDEX]=plusMinus[0]; current.params[I11_INDEX]=plusMinus[1]; current.params[ADDCHK_INDEX]=0; current.params[PLUSMINUS_INDEX]=0; if (found[2]) { // -------------- 13 current.params[ALTERATION_INDEX]=3; current.params[PLUSMINUS_INDEX]=plusMinus[2]; if (!found[1] || !found[0] || !found[3]) { // b7 or 9 or 11 not inside current.unusualGrade-=10; if (!found[1] && !found[0] && !found[3]) current.params[ADDCHK_INDEX]=1; else { // just penalty if something's missing if (!found[3]) // don't-have penalty if seventh is missing current.dontHaveGrade-=25; if (!found[1]) { // if 9 or 11 is missing, it is more unusual current.unusualGrade-=30; current.dontHaveGrade-=10; } if (!found[0]) { current.unusualGrade-=30; current.dontHaveGrade-=10; } } } } else if (found[1]) { // -------------- 11 current.params[ALTERATION_INDEX]=2; current.params[PLUSMINUS_INDEX]=plusMinus[1]; current.params[I11_INDEX]=0; current.unusualGrade-=10; if (!found[0] || !found[3]) { // b7 or 9 not inside if (!found[0] && !found[3]) current.params[ADDCHK_INDEX]=1; else { if (!found[3]) current.dontHaveGrade-=25; if (!found[0]) { current.unusualGrade-=30; current.dontHaveGrade-=10; } } } } else if (found[0]) { // 9 current.params[ALTERATION_INDEX]=1; current.params[I9_INDEX]=0; current.params[I11_INDEX]=0; current.params[PLUSMINUS_INDEX]=plusMinus[0]; current.unusualGrade-=10; if (!found[3]) current.params[ADDCHK_INDEX]=1; } } // ------------------------------------------------------------ /** * Shellsort, using a sequence suggested by Gonnet. * -- a little adopted * @param a List of Proposals, unsorted * @param sortIndex 1 to sort by don'tHaveGrade, 2 to sort by unusualGrade * @return sorted list by selected criteria */ public void shellsort( java.util.List a, int sortIndex ) { int length = a.size(); for( int gap = length / 2; gap > 0; gap = gap == 2 ? 1 : (int) ( gap / 2.2 ) ) for( int i = gap; i < length; i++ ) { Proposal tmp = (Proposal)a.get(i); int j = i; for( ; j >= gap && ( sortIndex == 1 ? tmp.dontHaveGrade > ((Proposal)a.get(j - gap)).dontHaveGrade : tmp.unusualGrade > ((Proposal)a.get(j - gap)).unusualGrade ) ; j -= gap ) a.set(j, a.get(j - gap)); a.set( j , tmp); } } //------------------------------------------------------------ //------------------------------------------------------------ //------------------------------------------------------------ protected void addProposal(int[] params, String name){ this.proposalParameters.add(params); this.proposalList.add(name); } protected void clearProposals(){ this.proposalList.removeAll(); this.proposalParameters.clear(); } protected ChordDialog getDialog(){ return this.dialog; } protected List getProposalList(){ return this.proposalList; } protected boolean isValidProcess(long processId){ return (this.runningProcess == processId); } protected class Proposal implements Cloneable { /* int basicChord = -1; int tonic = -1; int alteration = -1; int add = -1; int i5 = -1; int i9 = -1; int i11 = -1; int bassIndex=-1; */ int[] params; /** grade for chord "unusualness" - Cm is less unusual than E7/9+/C */ int unusualGrade = 0; /** penalty for notes that chord doesn't have */ int dontHaveGrade = -15; /** counts the notes that are in chord but still not recognized */ int missingCount; int[] missingNotes; boolean filled[]={false,false,false,false}; int plusminusValue[]={0,0,0}; private Proposal() { super(); this.params = new int[9]; for (int i=0; i<9; i++) this.params[i]=-1; } /** initialize with needed notes */ public Proposal(java.util.List notes) { this.params = new int[9]; for (int i=0; i<9; i++) this.params[i]=-1; int length = notes.size(); this.missingNotes = new int[length]; for (int i = 0; i< length; i++){ // deep copy, because of clone() method this.missingNotes[i] = ((Integer)notes.get(i)).intValue(); } this.missingCount = length; } /** if note is found, mark it as found in the Missing array*/ void foundNote(int value) { int note = (value % 12); if (this.missingCount!=0) for (int i=0; i<this.missingCount; i++) if (this.missingNotes[i] == note) { // put the found one on the end, switch positions this.missingCount--; int temp = this.missingNotes[i]; this.missingNotes[i]=this.missingNotes[this.missingCount]; this.missingNotes[this.missingCount]=temp; return; } } /** is note already found? */ boolean isFound(int value) { int note = (value % 12); for (int i=this.missingCount; i<this.missingNotes.length; i++) if (this.missingNotes[i] == note) return true; return false; } /** is note required to be found? */ boolean isNeeded(int value) { int note = (value % 12); if (this.missingCount!=0) for (int i=0; i<this.missingCount; i++) if (this.missingNotes[i] == note) return true; return false; } /** does note exist in a chord? (found or not found) */ boolean isExisting(int value) { int note = (value % 12); for (int i=0; i<this.missingNotes.length; i++) if (this.missingNotes[i] == note) return true; return false; } /** calls the Object.clone() method, since it is private (?!!??) */ public Object clone() { Proposal proposal = new Proposal(); for (int i=0; i<9; i++) proposal.params[i] = this.params[i]; proposal.unusualGrade = this.unusualGrade; proposal.dontHaveGrade = this.dontHaveGrade; proposal.missingCount = this.missingCount; proposal.missingNotes = new int[this.missingNotes.length]; for(int i = 0; i < proposal.missingNotes.length; i ++){ proposal.missingNotes[i] = this.missingNotes[i]; } proposal.filled = new boolean[this.filled.length]; for (int i=0; i<proposal.filled.length; i++) proposal.filled[i] = this.filled[i]; proposal.plusminusValue = new int[this.plusminusValue.length]; for (int i=0; i<proposal.plusminusValue.length; i++) proposal.plusminusValue[i] = this.plusminusValue[i]; return proposal; } public boolean equals(Object o) { Proposal another = (Proposal)o; for (int i=0; i<9; i++) if (this.params[i]!=another.params[i]) return false; // not all attributes, but the rest is not needed YET! return true; } } }

The table below shows all metrics for ChordRecognizer.java.

MetricValueDescription
BLOCKS82.00Number of blocks
BLOCK_COMMENT14.00Number of block comment lines
COMMENTS96.00Comment lines
COMMENT_DENSITY 0.24Comment density
COMPARISONS97.00Number of comparison operators
CYCLOMATIC151.00Cyclomatic complexity
DECL_COMMENTS33.00Comments in declarations
DOC_COMMENT40.00Number of javadoc comment lines
ELOC403.00Effective lines of code
EXEC_COMMENTS21.00Comments in executable code
EXITS65.00Procedure exits
FUNCTIONS30.00Number of function declarations
HALSTEAD_DIFFICULTY149.67Halstead difficulty
HALSTEAD_EFFORT 0.00Halstead effort
INTERFACE_COMPLEXITY65.00Interface complexity
JAVA0001 0.00JAVA0001 Package name does not contain only lower case letters
JAVA0002 0.00JAVA0002 Package name does not begin with a top level domain name or country code
JAVA0003 0.00JAVA0003 Minimize use of on-demand (.*) imports
JAVA0004 0.00JAVA0004 Unnecessary import from java.lang
JAVA0005 0.00JAVA0005 Imports not in specified order
JAVA0006 0.00JAVA0006 Empty finally block
JAVA0007 0.00JAVA0007 Should not declare public field
JAVA0008 0.00JAVA0008 Empty catch block
JAVA0009 0.00JAVA0009 Protected member in final class
JAVA0010 0.00JAVA0010 Non-instantiable class does not contain a non-private static member
JAVA0011 0.00JAVA0011 Abstract class does not contain an abstract method
JAVA0012 0.00JAVA0012 Non-constructor method with same name as declaring class
JAVA0013 0.00JAVA0013 Non-blank final field is not static
JAVA0014 0.00JAVA0014 Class with only static members has non-private constructor
JAVA0015 0.00JAVA0015 Package class contains public nested type
JAVA0016 0.00JAVA0016 Abstract class contains public constructor
JAVA0017 0.00JAVA0017 Class name does not have required form
JAVA0018 0.00JAVA0018 Method name does not have required form
JAVA0019 0.00JAVA0019 Interface name does not have required form
JAVA0020 0.00JAVA0020 Field name does not have required form
JAVA0021 0.00JAVA0021 Interface method name does not have required form
JAVA0022 0.00JAVA0022 Static final field name does not have required form
JAVA0023 0.00JAVA0023 Empty finalize method
JAVA0024 0.00JAVA0024 Empty class
JAVA0025 0.00JAVA0025 Method override is empty
JAVA0026 0.00JAVA0026 Finalize method with parameters
JAVA0029 0.00JAVA0029 Private method not used
JAVA0030 0.00JAVA0030 Private field not used
JAVA0031 0.00JAVA0031 Case statement not properly closed
JAVA0032 1.00JAVA0032 Switch statement missing default
JAVA0033 0.00JAVA0033 default: not last case in switch statement
JAVA003423.00JAVA0034 Missing braces in if statement
JAVA003513.00JAVA0035 Missing braces in for statement
JAVA0036 2.00JAVA0036 Missing braces in while statement
JAVA0038 0.00JAVA0038 Non-case label in switch statement
JAVA0039 0.00JAVA0039 Break statement with label
JAVA0040 0.00JAVA0040 Switch statement contains N cases (maximum: M)
JAVA0041 0.00JAVA0041 Nested synchronized block
JAVA0042 0.00JAVA0042 Empty synchronized statement
JAVA0043 0.00JAVA0043 Inner class does not use outer class
JAVA0044 0.00JAVA0044 Serializable class with no instance variables
JAVA0045 0.00JAVA0045 Serializable class with only transient fields
JAVA0046 0.00JAVA0046 Name of class not derived from Exception ends with 'Exception'
JAVA0047 0.00JAVA0047 Serializable class derives from invalid base class
JAVA0048 0.00JAVA0048 Name of class derived from Exception does not end with 'Exception'
JAVA0049 5.00JAVA0049 Nested block at depth N (maximum: M)
JAVA0050 0.00JAVA0050 Class derives from java.lang.Error
JAVA0051 0.00JAVA0051 Class derives from java.lang.RuntimeException
JAVA0052 0.00JAVA0052 Class derives from java.lang.Throwable
JAVA0053 0.00JAVA0053 Unused label
JAVA0054 0.00JAVA0054 Inheritance depth N exceeds maximum M
JAVA0055 0.00JAVA0055 Class should be interface
JAVA0056 0.00JAVA0056 Unnecessary abstract modifier for interface or annotation
JAVA0057 0.00JAVA0057 Unnecessary default constructor
JAVA0058 1.00JAVA0058 Constructor calls super()
JAVA0059 0.00JAVA0059 Method override only calls super()
JAVA0061 0.00JAVA0061 Inaccessible member in anonymous class
JAVA0062 0.00JAVA0062 Public class missing public member or protected constructor
JAVA0063 0.00JAVA0063 Identifier name should not contain '$'
JAVA0064 1.00JAVA0064 N variations of identifier name (maximum: M)
JAVA0065 0.00JAVA0065 Unnecessary final modifier for method in final class
JAVA0066 0.00JAVA0066 Unnecessary modifier for interface nested type
JAVA0067 3.00JAVA0067 Array descriptor on identifier name
JAVA0068 0.00JAVA0068 Modifiers not declared in recommended order
JAVA0071 0.00JAVA0071 Strings compared with ==
JAVA0073 0.00JAVA0073 Integer division in floating-point context
JAVA0074 0.00JAVA0074 Use of Object.notify()
JAVA0075 0.00JAVA0075 Method parameter hides field
JAVA007648.00JAVA0076 Use of magic number
JAVA0077 0.00JAVA0077 Private field not used in declaring class
JAVA0078 0.00JAVA0078 Floating point values compared with ==
JAVA0079 0.00JAVA0079 Use of instance to reference static member
JAVA0080 0.00JAVA0080 Import declaration not used
JAVA0081 0.00JAVA0081 Boolean literal in comparison
JAVA0082 0.00JAVA0082 Unnecessary widening cast
JAVA0083 0.00JAVA0083 Unnecessary instanceof test
JAVA0084 0.00JAVA0084 Should use compound assignment operator
JAVA0085 0.00JAVA0085 Use of sun.* class
JAVA0087 0.00JAVA0087 Use of Thread.sleep()
JAVA0089 0.00JAVA0089 Use of restricted package
JAVA0092 0.00JAVA0092 Use of restricted type
JAVA0093 0.00JAVA0093 Redundant assignment
JAVA0094 0.00JAVA0094 Field hides a superclass field
JAVA0095 0.00JAVA0095 Uninitialized private field
JAVA0096 0.00JAVA0096 Field in nested class hides outer field
JAVA0098 0.00JAVA0098 Minimize use of implicit field initializers
JAVA0100 0.00JAVA0100 Class contains N non-final fields (maximum: M)
JAVA0101 0.00JAVA0101 Unnecessary modifier for field in interface
JAVA0102 0.00JAVA0102 Last statement in finalize() not super.finalize()
JAVA0103 0.00JAVA0103 Explicit call to finalize()
JAVA0104 0.00JAVA0104 finalize() only calls super.finalize()
JAVA0105 0.00JAVA0105 Duplicate import declaration
JAVA0106 0.00JAVA0106 Unnecessary import from current package
JAVA010812.00JAVA0108 Incorrect javadoc: no @param tag for 'parameter'
JAVA0109 0.00JAVA0109 Incorrect javadoc: no parameter 'parameter'
JAVA0110 6.00JAVA0110 Incorrect javadoc: no @return tag
JAVA0111 1.00JAVA0111 Incorrect javadoc: @return tag for void method
JAVA0112 0.00JAVA0112 Incorrect javadoc: no exception 'exception' in throws
JAVA0113 0.00JAVA0113 Incorrect javadoc: no @author tag
JAVA0114 1.00JAVA0114 Incorrect javadoc: no @version tag
JAVA0115 0.00JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception'
JAVA0116 0.00JAVA0116 Missing javadoc: field 'field'
JAVA0117 8.00JAVA0117 Missing javadoc: method 'method'
JAVA0118 0.00JAVA0118 Missing javadoc: type 'type'
JAVA0119 1.00JAVA0119 Control variable changed within body of for loop
JAVA0123 1.00JAVA0123 Use all three components of for loop
JAVA0125 0.00JAVA0125 Continue statement with label
JAVA0126 0.00JAVA0126 Method declares unchecked exception in throws
JAVA0128 1.00JAVA0128 Public constructor in non-public class
JAVA0130 1.00JAVA0130 Non-static method does not use instance fields
JAVA0131 0.00JAVA0131 Compatible method does not override base
JAVA0132 0.00JAVA0132 Method overload with compatible signature
JAVA0133 0.00JAVA0133 Non-synchronized method overrides synchronized method
JAVA0135 1.00JAVA0135 Only one of Object.equals and Object.hashCode defined: missing 'method'
JAVA0136 0.00JAVA0136 N methods defined in class (maximum: M)
JAVA0137 0.00JAVA0137 Non-abstract class missing constructor
JAVA0138 0.00JAVA0138 N parameters defined for method (maximum: M)
JAVA0139 0.00JAVA0139 Definition of main other than public static void main(java.lang.String[])
JAVA0141 0.00JAVA0141 Unnecessary modifier for method in interface
JAVA0143 0.00JAVA0143 Synchronized method
JAVA0144 2.00JAVA0144 Line exceeds maximum M characters
JAVA01451668.00JAVA0145 Tab character used in source file
JAVA0150 0.00JAVA0150 java.lang.Error (or subclass) thrown
JAVA0153 0.00JAVA0153 Inefficient conversion of integer to string
JAVA0159 0.00JAVA0159 Inefficient conversion of string to integer
JAVA0160 0.00JAVA0160 Method does not throw specified exception
JAVA0161 0.00JAVA0161 Conditional wait() not in loop
JAVA0163 0.00JAVA0163 Empty statement
JAVA0165 0.00JAVA0165 Conflicting return statement in finally block
JAVA0166 0.00JAVA0166 Generic exception caught
JAVA0167 0.00JAVA0167 ThreadDeath not rethrown
JAVA0169 0.00JAVA0169 Unnecessary catch block: exception 'exception'
JAVA0170 0.00JAVA0170 Caught exception not derived from java.lang.Exception
JAVA0171 0.00JAVA0171 Unused local variable
JAVA0173 0.00JAVA0173 Unused method parameter
JAVA0174 0.00JAVA0174 Assigned local variable never used
JAVA0175 1.00JAVA0175 Successive assignment to variable
JAVA0176 0.00JAVA0176 Local variable name does not have required form
JAVA0177 1.00JAVA0177 Variable declaration missing initializer
JAVA0179 0.00JAVA0179 Local variable hides visible field
JAVA0233 0.00JAVA0233 Definition of serialVersionUID other than 'private static final long serialVersionUID'
JAVA0234 0.00JAVA0234 Class is Serializable but does not define serialVersionUID
JAVA0235 0.00JAVA0235 Class defines serialVersionUID but does not implement Serializable
JAVA0236 0.00JAVA0236 Attempt to clone an object which does not implement Cloneable
JAVA0237 0.00JAVA0237 Class implements Cloneable but does not have public clone method
JAVA0238 1.00JAVA0238 Clone method does not call super.clone()
JAVA0239 0.00JAVA0239 Class declares 'readObject' or 'writeObject' but does not implement Serializable
JAVA0240 0.00JAVA0240 Serializable class which declares readObject or writeObject but not both
JAVA0241 0.00JAVA0241 'readObject' or 'writeObject' should be declared private in Serializable class
JAVA0242 0.00JAVA0242 Transient field in non-Serializable class
JAVA0243 0.00JAVA0243 'readResolve' or 'writeReplace' should be declared private or protected
JAVA0244 0.00JAVA0244 Field or method name in subclass differs only by case from inherited field or method
JAVA0245 0.00JAVA0245 JUnit TestCase with non-trivial constructor
JAVA0246 0.00JAVA0246 JUnit assertXXX statement missing message parameter
JAVA0247 0.00JAVA0247 JUnit 'setUp()' and 'tearDown()' should call super method
JAVA0248 0.00JAVA0248 JUnit method 'setUp' or 'tearDown' with incorrect signature
JAVA0249 0.00JAVA0249 JUnit TestCase 'suite()' should be declared static
JAVA0250 0.00JAVA0250 JUnit TestCase declares testXXX method with incorrect signature
JAVA0251 0.00JAVA0251 Use '%n' for line breaks in printf/format for platform independence
JAVA0252 0.00JAVA0252 'enum' is a Java 1.5 reserved word
JAVA0253 0.00JAVA0253 Not all enum constants consumed in switch statement
JAVA0254 3.00JAVA0254 Use enhanced for loop construct instead of Iterator
JAVA0255 0.00JAVA0255 Result of method invocation not used
JAVA0256 0.00JAVA0256 Assignment of external collection/array to field
JAVA0257 0.00JAVA0257 Use of 'Constant Interface' anti-pattern
JAVA0258 0.00JAVA0258 Implement Iterable for foreach compatibility
JAVA0259 0.00JAVA0259 Return of collection/array field
JAVA0260 0.00JAVA0260 Use 'enum' instead of Enumerated Type pattern
JAVA0261 0.00JAVA0261 Use specialized Enum collection types
JAVA0262 0.00JAVA0262 Use of char in integer context
JAVA0263 0.00JAVA0263 Long literal ends with 'l' instead of 'L'
JAVA0264 0.00JAVA0264 Integer math in long context - check for overflow
JAVA0265 0.00JAVA0265 Use of Throwable.printStackTrace()
JAVA0266 0.00JAVA0266 Use of System.out
JAVA0267 0.00JAVA0267 Use of System.err
JAVA0269 0.00JAVA0269 Contents of StringBuffer never used
JAVA0270 0.00JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array
JAVA0271 0.00JAVA0271 Minimize use of on-demand (.*) static imports
JAVA0272 0.00JAVA0272 Thread.run() called
JAVA0273 0.00JAVA0273 Non-final derivative of Thread calls start() in constructor
JAVA0274 0.00JAVA0274 Serializable class has a synchronized readObject()
JAVA0275 0.00JAVA0275 Serializable class has a synchronized writeObject() and no other synchronized methods
JAVA0276 0.00JAVA0276 Unnecessary use of String constructor
JAVA0277 0.00JAVA0277 Iterator.next() implementation does not throw NoSuchElementException
JAVA0278 0.00JAVA0278 Unnecessary use of Boolean constructor
JAVA0279 0.00JAVA0279 Serialization method readObject or readObjectNoData calls an overridable method
JAVA0280 0.00JAVA0280 IllegalMonitorStateException caught
JAVA0281 0.00JAVA0281 Iterator.next() not called in loop
JAVA0282 0.00JAVA0282 Call to Iterator.next() in loop which does not test Iterator.hasNext()
JAVA0283 1.00JAVA0283 Control variable not updated in loop body
JAVA0284 0.00JAVA0284 Explicit garbage collection
JAVA0285 0.00JAVA0285 Dereference of potentially null variable
JAVA0286 0.00JAVA0286 Dereference of null variable
JAVA0287 0.00JAVA0287 Unnecessary null check
JAVA0288 0.00JAVA0288 Inconsistent null check
LINES691.00Number of lines in the source file
LINE_COMMENT42.00Number of line comments
LOC493.00Lines of code
LOGICAL_LINES281.00Number of statements
LOOPS27.00Number of loops
NEST_DEPTH 7.00Maximum nesting depth
OPERANDS1352.00Number of operands
OPERATORS2732.00Number of operators
PARAMS28.00Number of formal parameter declarations
PROGRAM_LENGTH4084.00Halstead program length
PROGRAM_VOCAB331.00Halstead program vocabulary
PROGRAM_VOLUME 0.00Halstead program volume
RETURNS37.00Number of return points from functions
SIZE24122.00Size of the file in bytes
UNIQUE_OPERANDS271.00Number of unique operands
UNIQUE_OPERATORS60.00Number of unique operators
WHITESPACE102.00Number of whitespace lines