KeyEventTranslator.java
| Index Score | ||
|---|---|---|
 |
 |
org.gjt.sp.jedit.gui |
 |
 |
jEdit |
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 | |
|---|---|---|
| JAVA0034 | JAVA0034 Missing braces in if statement |  |
| JAVA0177 | JAVA0177 Variable declaration missing initializer | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| DECL_COMMENTS | Comments in declarations | |
| CYCLOMATIC | Cyclomatic complexity | |
| JAVA0032 | JAVA0032 Switch statement missing default | |
| UNIQUE_OPERATORS | Number of unique operators | |
| LOC | Lines of code | |
| COMPARISONS | Number of comparison operators | |
| JAVA0031 | JAVA0031 Case statement not properly closed | |
| ELOC | Effective lines of code | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| LINES | Number of lines in the source file | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0116 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| LINE_COMMENT | Number of line comments | |
| RETURNS | Number of return points from functions | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
| EXEC_COMMENTS | Comments in executable code | |
| LOOPS | Number of loops | |
| JAVA0270 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| WHITESPACE | Number of whitespace lines | |
| EXITS | Procedure exits | |
/*
* KeyEventTranslator.java - Hides some warts of AWT event API
* :tabSize=8:indentSize=8:noTabs=false:
* :folding=explicit:collapseFolds=1:
*
* Copyright (C) 2003, 2005 Slava Pestov
*
* This program 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 any later version.
*
* This program 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 this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*/
package org.gjt.sp.jedit.gui;
//{{{ Imports
import java.awt.event.*;
import java.util.HashMap;
import java.util.Map;
import org.gjt.sp.jedit.Debug;
import org.gjt.sp.jedit.OperatingSystem;
import org.gjt.sp.util.Log;
import org.gjt.sp.util.StandardUtilities;
//}}}
/**
* In conjunction with the <code>KeyEventWorkaround</code>, hides some
* warts in the AWT key event API.
*
* @author Slava Pestov
* @version $Id: KeyEventTranslator.java 12617 2008-05-10 21:13:26Z daleanson $
*/
public class KeyEventTranslator
{
//{{{ addTranslation() method
/**
* Adds a keyboard translation.
* @param key1 Translate this key
* @param key2 Into this key
* @since jEdit 4.2pre3
*/
public static void addTranslation(Key key1, Key key2)
{
transMap.put(key1,key2);
} //}}}
//{{{ translateKeyEvent() method
protected static KeyEvent lastKeyPressEvent;
protected static boolean lastKeyPressAccepted;
/**
* Pass this an event from {@link
* KeyEventWorkaround#processKeyEvent(java.awt.event.KeyEvent)}.
* @param evt the KeyEvent to translate
* @since jEdit 4.2pre3
*/
public static Key translateKeyEvent(KeyEvent evt)
{
Key key = translateKeyEvent2(evt);
if (key!=null) {
if (key.isPhantom()) {
key = null;
}
}
return key;
}
/**
* Pass this an event from {@link
* KeyEventWorkaround#processKeyEvent(java.awt.event.KeyEvent)}.
* @param evt the KeyEvent to translate
* @since jEdit 4.2pre3
*/
public static Key translateKeyEvent2(KeyEvent evt)
{
int modifiers = evt.getModifiers();
Key returnValue;
switch(evt.getID())
{
case KeyEvent.KEY_PRESSED:
int keyCode = evt.getKeyCode();
if((keyCode >= KeyEvent.VK_0
&& keyCode <= KeyEvent.VK_9)
|| (keyCode >= KeyEvent.VK_A
&& keyCode <= KeyEvent.VK_Z))
{
if(Debug.ALTERNATIVE_DISPATCHER)
return null;
else
{
returnValue = new Key(
modifiersToString(modifiers),
'\0',Character.toLowerCase(
(char)keyCode));
}
}
else
{
if(keyCode == KeyEvent.VK_TAB)
{
evt.consume();
returnValue = new Key(
modifiersToString(modifiers),
keyCode,'\0');
}
else if(keyCode == KeyEvent.VK_SPACE)
{
// for SPACE or S+SPACE we pass the
// key typed since international
// keyboards sometimes produce a
// KEY_PRESSED SPACE but not a
// KEY_TYPED SPACE, eg if you have to
// do a "<space> to insert ".
if((modifiers & ~InputEvent.SHIFT_MASK) == 0)
returnValue = null;
else
{
returnValue = new Key(
modifiersToString(modifiers),
0,' ');
}
}
else
{
returnValue = new Key(
modifiersToString(modifiers),
keyCode,'\0');
}
}
break;
case KeyEvent.KEY_TYPED:
char ch = evt.getKeyChar();
if(KeyEventWorkaround.isMacControl(evt))
ch |= 0x60;
switch(ch)
{
case '\n':
case '\t':
case '\b':
return null;
case ' ':
if((modifiers & ~InputEvent.SHIFT_MASK) != 0)
return null;
}
int ignoreMods;
if(Debug.ALT_KEY_PRESSED_DISABLED)
{
/* on MacOS, A+ can be user input */
ignoreMods = InputEvent.SHIFT_MASK
| InputEvent.ALT_GRAPH_MASK
| InputEvent.ALT_MASK;
}
else
{
/* on MacOS, A+ can be user input */
ignoreMods = InputEvent.SHIFT_MASK
| InputEvent.ALT_GRAPH_MASK;
}
if((modifiers & InputEvent.ALT_GRAPH_MASK) == 0
&& evt.getWhen()
- KeyEventWorkaround.lastKeyTime < 750L
&& (KeyEventWorkaround.modifiers & ~ignoreMods)
!= 0)
{
if(Debug.ALTERNATIVE_DISPATCHER)
{
returnValue = new Key(
modifiersToString(modifiers),
0,ch);
}
else
return null;
}
else
{
if(ch == ' ')
{
returnValue = new Key(
modifiersToString(modifiers),
0,ch);
}
else
returnValue = new Key(null,0,ch);
}
break;
default:
return null;
}
/* I guess translated events do not have the 'evt' field set
so consuming won't work. I don't think this is a problem as
nothing uses translation anyway */
Key trans = transMap.get(returnValue);
if(trans == null)
return returnValue;
else
return trans;
} //}}}
//{{{ parseKey() method
/**
* Converts a string to a keystroke. The string should be of the
* form <i>modifiers</i>+<i>shortcut</i> where <i>modifiers</i>
* is any combination of A for Alt, C for Control, S for Shift
* or M for Meta, and <i>shortcut</i> is either a single character,
* or a keycode name from the <code>KeyEvent</code> class, without
* the <code>VK_</code> prefix.
* @param keyStroke A string description of the key stroke
* @since jEdit 4.2pre3
*/
public static Key parseKey(String keyStroke)
{
if(keyStroke == null)
return null;
int modifiers = 0;
String key;
int endOfModifiers = keyStroke.indexOf('+');
if(endOfModifiers <= 0) // not found or found at first
{
key = keyStroke;
}
else
{
for(int i = 0; i < endOfModifiers; i++)
{
switch(Character.toUpperCase(keyStroke
.charAt(i)))
{
case 'A':
modifiers |= a;
break;
case 'C':
modifiers |= c;
break;
case 'M':
modifiers |= m;
break;
case 'S':
modifiers |= s;
break;
}
}
key = keyStroke.substring(endOfModifiers + 1);
}
if(key.length() == 1)
{
return new Key(modifiersToString(modifiers),0,key.charAt(0));
}
else if(key.length() == 0)
{
Log.log(Log.ERROR,KeyEventTranslator.class,
"Invalid key stroke: " + keyStroke);
return null;
}
else if(key.equals("SPACE"))
{
return new Key(modifiersToString(modifiers),0,' ');
}
else
{
int ch;
try
{
ch = KeyEvent.class.getField("VK_".concat(key))
.getInt(null);
}
catch(Exception e)
{
Log.log(Log.ERROR,KeyEventTranslator.class,
"Invalid key stroke: "
+ keyStroke);
return null;
}
return new Key(modifiersToString(modifiers),ch,'\0');
}
} //}}}
//{{{ setModifierMapping() method
/**
* Changes the mapping between symbolic modifier key names
* (<code>C</code>, <code>A</code>, <code>M</code>, <code>S</code>) and
* Java modifier flags.
*
* You can map more than one Java modifier to a symobolic modifier, for
* example :
* <p><code><pre>
* setModifierMapping(
* InputEvent.CTRL_MASK,
* InputEvent.ALT_MASK | InputEvent.META_MASK,
* 0,
* InputEvent.SHIFT_MASK);
*<pre></code></p>
*
* You cannot map a Java modifer to more than one symbolic modifier.
*
* @param c The modifier(s) to map the <code>C</code> modifier to
* @param a The modifier(s) to map the <code>A</code> modifier to
* @param m The modifier(s) to map the <code>M</code> modifier to
* @param s The modifier(s) to map the <code>S</code> modifier to
*
* @since jEdit 4.2pre3
*/
public static void setModifierMapping(int c, int a, int m, int s)
{
int duplicateMapping =
(c & a) | (c & m) | (c & s) | (a & m) | (a & s) | (m & s);
if((duplicateMapping & InputEvent.CTRL_MASK) != 0) {
throw new IllegalArgumentException(
"CTRL is mapped to more than one modifier");
}
if((duplicateMapping & InputEvent.ALT_MASK) != 0) {
throw new IllegalArgumentException(
"ALT is mapped to more than one modifier");
}
if((duplicateMapping & InputEvent.META_MASK) != 0) {
throw new IllegalArgumentException(
"META is mapped to more than one modifier");
}
if((duplicateMapping & InputEvent.SHIFT_MASK) != 0) {
throw new IllegalArgumentException(
"SHIFT is mapped to more than one modifier");
}
KeyEventTranslator.c = c;
KeyEventTranslator.a = a;
KeyEventTranslator.m = m;
KeyEventTranslator.s = s;
} //}}}
//{{{ getSymbolicModifierName() method
/**
* Returns a the symbolic modifier name for the specified Java modifier
* flag.
*
* @param mod A modifier constant from <code>InputEvent</code>
*
* @since jEdit 4.2pre3
*/
public static char getSymbolicModifierName(int mod)
{
if((mod & c) != 0)
return 'C';
else if((mod & a) != 0)
return 'A';
else if((mod & m) != 0)
return 'M';
else if((mod & s) != 0)
return 'S';
else
return '\0';
} //}}}
//{{{ modifiersToString() method
private static final int[] MODS = {
InputEvent.CTRL_MASK,
InputEvent.ALT_MASK,
InputEvent.META_MASK,
InputEvent.SHIFT_MASK
};
public static String modifiersToString(int mods)
{
StringBuffer buf = null;
for(int i = 0; i < MODS.length; i++)
{
if((mods & MODS[i]) != 0)
buf = lazyAppend(buf,getSymbolicModifierName(MODS[i]));
}
if(buf == null)
return null;
else
return buf.toString();
} //}}}
//{{{ getModifierString() method
/**
* Returns a string containing symbolic modifier names set in the
* specified event.
*
* @param evt The event
*
* @since jEdit 4.2pre3
*/
public static String getModifierString(InputEvent evt)
{
StringBuilder buf = new StringBuilder();
if(evt.isControlDown())
buf.append(getSymbolicModifierName(InputEvent.CTRL_MASK));
if(evt.isAltDown())
buf.append(getSymbolicModifierName(InputEvent.ALT_MASK));
if(evt.isMetaDown())
buf.append(getSymbolicModifierName(InputEvent.META_MASK));
if(evt.isShiftDown())
buf.append(getSymbolicModifierName(InputEvent.SHIFT_MASK));
return buf.length() == 0 ? null : buf.toString();
} //}}}
static int c, a, m, s;
//{{{ Private members
/** This map is a pool of Key. */
private static final Map<Key, Key> transMap = new HashMap<Key, Key>();
private static StringBuffer lazyAppend(StringBuffer buf, char ch)
{
if(buf == null)
buf = new StringBuffer();
if(buf.indexOf(String.valueOf(ch)) == -1)
buf.append(ch);
return buf;
} //}}}
static
{
if(OperatingSystem.isMacOS())
{
setModifierMapping(
InputEvent.META_MASK, /* == C+ */
InputEvent.CTRL_MASK, /* == A+ */
/* M+ discarded by key event workaround! */
InputEvent.ALT_MASK, /* == M+ */
InputEvent.SHIFT_MASK /* == S+ */);
}
else
{
setModifierMapping(
InputEvent.CTRL_MASK,
InputEvent.ALT_MASK,
InputEvent.META_MASK,
InputEvent.SHIFT_MASK);
}
} //}}}
//{{{ Key class
public static class Key
{
public final String modifiers;
public final int key;
public final char input;
private final int hashCode;
/**
Wether this Key event applies to all jEdit windows (and not only a specific jEdit GUI component).
*/
protected boolean isFromGlobalContext;
/**
Wether this Key event is a phantom key event. A phantom key event is a kind of duplicate key event which
should not - due to its nature of being a duplicate - generate any action on data.
However, phantom key events may be necessary to notify the rest of the GUI that the key event, if it was not a phantom key event but a real key event,
would generate any action and thus would be consumed.
*/
protected boolean isPhantom;
public Key(String modifiers, int key, char input)
{
this.modifiers = modifiers;
this.key = key;
this.input = input;
hashCode = key + input;
}
@Override
public int hashCode()
{
return hashCode;
}
@Override
public boolean equals(Object o)
{
if(o instanceof Key)
{
Key k = (Key)o;
if(StandardUtilities.objectsEqual(modifiers,
k.modifiers) && key == k.key
&& input == k.input)
{
return true;
}
}
return false;
}
@Override
public String toString()
{
return (modifiers == null ? "" : modifiers)
+ '<'
+ Integer.toString(key,16)
+ ','
+ Integer.toString(input,16)
+ '>';
}
public void setIsFromGlobalContext(boolean to) {
isFromGlobalContext = to;
}
public boolean isFromGlobalContext() {
return isFromGlobalContext;
}
public void setIsPhantom(boolean to) {
isPhantom = to;
}
public boolean isPhantom() {
return isPhantom;
}
} //}}}
}
The table below shows all metrics for KeyEventTranslator.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 51.00 | Number of blocks | |
| BLOCK_COMMENT | 27.00 | Number of block comment lines | |
| COMMENTS | 129.00 | Comment lines | |
| COMMENT_DENSITY | 0.48 | Comment density | |
| COMPARISONS | 49.00 | Number of comparison operators | |
| CYCLOMATIC | 78.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 23.00 | Comments in declarations | |
| DOC_COMMENT | 85.00 | Number of javadoc comment lines | |
| ELOC | 271.00 | Effective lines of code | |
| EXEC_COMMENTS | 5.00 | Comments in executable code | |
| EXITS | 40.00 | Procedure exits | |
| FUNCTIONS | 17.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 98.63 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 58.00 | Interface complexity | |
| JAVA0001 | 0.00 | JAVA0001 Package name does not contain only lower case letters | |
| JAVA0002 | 0.00 | JAVA0002 Package name does not begin with a top level domain name or country code | |
| JAVA0003 | 0.00 | JAVA0003 Minimize use of on-demand (.*) imports | |
| JAVA0004 | 0.00 | JAVA0004 Unnecessary import from java.lang | |
| JAVA0005 | 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 | 1.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 | 1.00 | JAVA0031 Case statement not properly closed | |
| JAVA0032 | 2.00 | JAVA0032 Switch statement missing default | |
| JAVA0033 | 0.00 | JAVA0033 default: not last case in switch statement | |
| JAVA0034 | 23.00 | JAVA0034 Missing braces in if statement | |
| JAVA0035 | 0.00 | JAVA0035 Missing braces in for statement | |
| JAVA0036 | 0.00 | JAVA0036 Missing braces in while statement | |
| JAVA0038 | 0.00 | JAVA0038 Non-case label in switch statement | |
| JAVA0039 | 0.00 | JAVA0039 Break statement with label | |
| JAVA0040 | 0.00 | JAVA0040 Switch statement contains N cases (maximum: M) | |
| JAVA0041 | 0.00 | JAVA0041 Nested synchronized block | |
| JAVA0042 | 0.00 | JAVA0042 Empty synchronized statement | |
| JAVA0043 | 0.00 | JAVA0043 Inner class does not use outer class | |
| JAVA0044 | 0.00 | JAVA0044 Serializable class with no instance variables | |
| JAVA0045 | 0.00 | JAVA0045 Serializable class with only transient fields | |
| JAVA0046 | 0.00 | JAVA0046 Name of class not derived from Exception ends with 'Exception' | |
| JAVA0047 | 0.00 | JAVA0047 Serializable class derives from invalid base class | |
| JAVA0048 | 0.00 | JAVA0048 Name of class derived from Exception does not end with 'Exception' | |
| JAVA0049 | 0.00 | JAVA0049 Nested block at depth N (maximum: M) | |
| JAVA0050 | 0.00 | JAVA0050 Class derives from java.lang.Error | |
| JAVA0051 | 0.00 | JAVA0051 Class derives from java.lang.RuntimeException | |
| JAVA0052 | 0.00 | JAVA0052 Class derives from java.lang.Throwable | |
| JAVA0053 | 0.00 | JAVA0053 Unused label | |
| JAVA0054 | 0.00 | JAVA0054 Inheritance depth N exceeds maximum M | |
| JAVA0055 | 0.00 | JAVA0055 Class should be interface | |
| JAVA0056 | 0.00 | JAVA0056 Unnecessary abstract modifier for interface or annotation | |
| JAVA0057 | 0.00 | JAVA0057 Unnecessary default constructor | |
| JAVA0058 | 0.00 | JAVA0058 Constructor calls super() | |
| JAVA0059 | 0.00 | JAVA0059 Method override only calls super() | |
| JAVA0061 | 0.00 | JAVA0061 Inaccessible member in anonymous class | |
| JAVA0062 | 0.00 | JAVA0062 Public class missing public member or protected constructor | |
| JAVA0063 | 0.00 | JAVA0063 Identifier name should not contain '$' | |
| JAVA0064 | 1.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 | 2.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 | 2.00 | JAVA0098 Minimize use of implicit field initializers | |
| JAVA0100 | 0.00 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| JAVA0101 | 0.00 | JAVA0101 Unnecessary modifier for field in interface | |
| JAVA0102 | 0.00 | JAVA0102 Last statement in finalize() not super.finalize() | |
| JAVA0103 | 0.00 | JAVA0103 Explicit call to finalize() | |
| JAVA0104 | 0.00 | JAVA0104 finalize() only calls super.finalize() | |
| JAVA0105 | 0.00 | JAVA0105 Duplicate import declaration | |
| JAVA0106 | 0.00 | JAVA0106 Unnecessary import from current package | |
| JAVA0108 | 0.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 0.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 5.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 | 0.00 | JAVA0114 Incorrect javadoc: no @version tag | |
| JAVA0115 | 0.00 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0116 | 3.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 6.00 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0118 | 1.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 | 0.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 | 1.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 1205.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 | 1.00 | JAVA0166 Generic exception caught | |
| JAVA0167 | 0.00 | JAVA0167 ThreadDeath not rethrown | |
| JAVA0169 | 0.00 | JAVA0169 Unnecessary catch block: exception 'exception' | |
| JAVA0170 | 0.00 | JAVA0170 Caught exception not derived from java.lang.Exception | |
| JAVA0171 | 0.00 | JAVA0171 Unused local variable | |
| JAVA0173 | 0.00 | JAVA0173 Unused method parameter | |
| JAVA0174 | 0.00 | JAVA0174 Assigned local variable never used | |
| JAVA0175 | 0.00 | JAVA0175 Successive assignment to variable | |
| JAVA0176 | 0.00 | JAVA0176 Local variable name does not have required form | |
| JAVA0177 | 4.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 | 2.00 | JAVA0262 Use of char in integer context | |
| JAVA0263 | 0.00 | JAVA0263 Long literal ends with 'l' instead of 'L' | |
| JAVA0264 | 0.00 | JAVA0264 Integer math in long context - check for overflow | |
| JAVA0265 | 0.00 | JAVA0265 Use of Throwable.printStackTrace() | |
| JAVA0266 | 0.00 | JAVA0266 Use of System.out | |
| JAVA0267 | 0.00 | JAVA0267 Use of System.err | |
| JAVA0269 | 0.00 | JAVA0269 Contents of StringBuffer never used | |
| JAVA0270 | 1.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 | 537.00 | Number of lines in the source file | |
| LINE_COMMENT | 17.00 | Number of line comments | |
| LOC | 363.00 | Lines of code | |
| LOGICAL_LINES | 119.00 | Number of statements | |
| LOOPS | 2.00 | Number of loops | |
| NEST_DEPTH | 4.00 | Maximum nesting depth | |
| OPERANDS | 568.00 | Number of operands | |
| OPERATORS | 1156.00 | Number of operators | |
| PARAMS | 20.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 1724.00 | Halstead program length | |
| PROGRAM_VOCAB | 225.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 38.00 | Number of return points from functions | |
| SIZE | 12766.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 167.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 58.00 | Number of unique operators | |
| WHITESPACE | 45.00 | Number of whitespace lines | |