EmacsKeyBindings.java
| Index Score | ||
|---|---|---|
 |
 |
org.xnap.gui.util |
 |
 |
XNap 3 |
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 | |
|---|---|---|
| JAVA0237 | JAVA0237 Class implements Cloneable but does not have public clone method |  |
| LOC | Lines of code | |
| JAVA0116 | JAVA0116 Missing javadoc: field 'field' | |
| ELOC | Effective lines of code | |
| JAVA0113 | JAVA0113 Incorrect javadoc: no @author tag | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0270 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| OPERANDS | Number of operands | |
| PROGRAM_LENGTH | Halstead program length | |
| OPERATORS | Number of operators | |
| LINES | Number of lines in the source file | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
| DECL_COMMENTS | Comments in declarations | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| SIZE | Size of the file in bytes | |
| EXITS | Procedure exits | |
| LOOPS | Number of loops | |
| JAVA0114 | JAVA0114 Incorrect javadoc: no @version tag | |
| UNIQUE_OPERANDS | Number of unique operands | |
| LOGICAL_LINES | Number of statements | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| BLOCKS | Number of blocks | |
| JAVA0123 | JAVA0123 Use all three components of for loop | |
| CYCLOMATIC | Cyclomatic complexity | |
| FUNCTIONS | Number of function declarations | |
| JAVA0007 | JAVA0007 Should not declare public field | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0234 | JAVA0234 Class is Serializable but does not define serialVersionUID | |
| NEST_DEPTH | Maximum nesting depth | |
/*
* XNap - A P2P framework and client.
*
* See the file AUTHORS for copyright information.
*
* 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.
*
* 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.xnap.gui.util;
import java.awt.event.ActionEvent;
import java.awt.event.InputEvent;
import java.awt.event.KeyEvent;
import java.util.Iterator;
import java.util.LinkedList;
import javax.swing.Action;
import javax.swing.JEditorPane;
import javax.swing.JTextArea;
import javax.swing.JTextField;
import javax.swing.JTextPane;
import javax.swing.KeyStroke;
import javax.swing.text.BadLocationException;
import javax.swing.text.DefaultEditorKit;
import javax.swing.text.Document;
import javax.swing.text.JTextComponent;
import javax.swing.text.Keymap;
import javax.swing.text.TextAction;
import javax.swing.text.Utilities;
import org.apache.log4j.Logger;
/**
* Generic class which activates Emacs keybindings for java input {@link
* JTextComponent}s.
*
* TODO: Some actions don't work at the end of line, that's because they
* depend on built-in actions.
*/
public class EmacsKeyBindings
{
//--- Constant(s) ---
public static final String killLineAction = "emacs-kill-line";
public static final String killRingSaveAction = "emacs-kill-ring-save";
public static final String killRegionAction = "emacs-kill-region";
public static final String backwardKillWordAction
= "emacs-backward-kill-word";
public static final String capitalizeWordAction = "emacs-capitalize-word";
public static final String downcaseWordAction = "emacs-downcase-word";
public static final String killWordAction = "emacs-kill-word";
public static final String setMarkCommandAction
= "emacs-set-mark-command";
public static final String yankAction = "emacs-yank";
public static final String yankPopAction = "emacs-yank-pop";
public static final String upcaseWordAction = "emacs-upcase-word";
public static final JTextComponent.KeyBinding[] EMACS_KEY_BINDINGS = {
new JTextComponent.
KeyBinding(KeyStroke.getKeyStroke(KeyEvent.VK_Y,
InputEvent.CTRL_MASK),
DefaultEditorKit.pasteAction),
new JTextComponent.
KeyBinding(KeyStroke.getKeyStroke(KeyEvent.VK_W,
InputEvent.ALT_MASK),
DefaultEditorKit.copyAction),
new JTextComponent.
KeyBinding(KeyStroke.getKeyStroke(KeyEvent.VK_W,
InputEvent.CTRL_MASK),
DefaultEditorKit.cutAction),
new JTextComponent.
KeyBinding(KeyStroke.getKeyStroke(KeyEvent.VK_E,
InputEvent.CTRL_MASK),
DefaultEditorKit.endLineAction),
new JTextComponent.
KeyBinding(KeyStroke.getKeyStroke(KeyEvent.VK_A,
InputEvent.CTRL_MASK),
DefaultEditorKit.beginLineAction),
new JTextComponent.
KeyBinding(KeyStroke.getKeyStroke(KeyEvent.VK_D,
InputEvent.CTRL_MASK),
DefaultEditorKit.deleteNextCharAction),
new JTextComponent.
KeyBinding(KeyStroke.getKeyStroke(KeyEvent.VK_N,
InputEvent.CTRL_MASK),
DefaultEditorKit.downAction),
new JTextComponent.
KeyBinding(KeyStroke.getKeyStroke(KeyEvent.VK_P,
InputEvent.CTRL_MASK),
DefaultEditorKit.upAction),
new JTextComponent.
KeyBinding(KeyStroke.getKeyStroke(KeyEvent.VK_B,
InputEvent.ALT_MASK),
DefaultEditorKit.previousWordAction),
new JTextComponent.
KeyBinding(KeyStroke.getKeyStroke(KeyEvent.VK_LESS,
InputEvent.ALT_MASK),
DefaultEditorKit.beginAction),
new JTextComponent.
KeyBinding(KeyStroke.getKeyStroke(KeyEvent.VK_LESS,
InputEvent.ALT_MASK
+ InputEvent.SHIFT_MASK),
DefaultEditorKit.endAction),
new JTextComponent.
KeyBinding(KeyStroke.getKeyStroke(KeyEvent.VK_F,
InputEvent.ALT_MASK),
DefaultEditorKit.nextWordAction),
new JTextComponent.
KeyBinding(KeyStroke.getKeyStroke(KeyEvent.VK_F,
InputEvent.CTRL_MASK),
DefaultEditorKit.forwardAction),
new JTextComponent.
KeyBinding(KeyStroke.getKeyStroke(KeyEvent.VK_B,
InputEvent.CTRL_MASK),
DefaultEditorKit.backwardAction),
new JTextComponent.
KeyBinding(KeyStroke.getKeyStroke(KeyEvent.VK_V,
InputEvent.CTRL_MASK),
DefaultEditorKit.pageDownAction),
new JTextComponent.
KeyBinding(KeyStroke.getKeyStroke(KeyEvent.VK_V,
InputEvent.ALT_MASK),
DefaultEditorKit.pageUpAction),
new JTextComponent.
KeyBinding(KeyStroke.getKeyStroke(KeyEvent.VK_D,
InputEvent.ALT_MASK),
EmacsKeyBindings.killWordAction),
new JTextComponent.
KeyBinding(KeyStroke.getKeyStroke(KeyEvent.VK_BACK_SPACE,
InputEvent.ALT_MASK),
EmacsKeyBindings.backwardKillWordAction),
new JTextComponent.
KeyBinding(KeyStroke.getKeyStroke(KeyEvent.VK_SPACE,
InputEvent.CTRL_MASK),
EmacsKeyBindings.setMarkCommandAction),
new JTextComponent.
KeyBinding(KeyStroke.getKeyStroke(KeyEvent.VK_W,
InputEvent.ALT_MASK),
EmacsKeyBindings.killRingSaveAction),
new JTextComponent.
KeyBinding(KeyStroke.getKeyStroke(KeyEvent.VK_W,
InputEvent.CTRL_MASK),
EmacsKeyBindings.killRegionAction),
new JTextComponent.
KeyBinding(KeyStroke.getKeyStroke(KeyEvent.VK_K,
InputEvent.CTRL_MASK),
EmacsKeyBindings.killLineAction),
new JTextComponent.
KeyBinding(KeyStroke.getKeyStroke(KeyEvent.VK_Y,
InputEvent.CTRL_MASK),
EmacsKeyBindings.yankAction),
new JTextComponent.
KeyBinding(KeyStroke.getKeyStroke(KeyEvent.VK_Y,
InputEvent.ALT_MASK),
EmacsKeyBindings.yankPopAction),
new JTextComponent.
KeyBinding(KeyStroke.getKeyStroke(KeyEvent.VK_C,
InputEvent.ALT_MASK),
EmacsKeyBindings.capitalizeWordAction),
new JTextComponent.
KeyBinding(KeyStroke.getKeyStroke(KeyEvent.VK_L,
InputEvent.ALT_MASK),
EmacsKeyBindings.downcaseWordAction),
new JTextComponent.
KeyBinding(KeyStroke.getKeyStroke(KeyEvent.VK_U,
InputEvent.ALT_MASK),
EmacsKeyBindings.upcaseWordAction),
};
//--- Data field(s) ---
private static Logger logger = Logger.getLogger(EmacsKeyBindings.class);
//--- Constructor(s) ---
//--- Method(s) ---
public static void load()
{
JTextComponent[] jtcs = new JTextComponent[] {
new JTextArea(),
new JTextPane(),
new JTextField(),
new JEditorPane(),
};
for (int i = 0; i < jtcs.length; i++) {
Keymap orig = jtcs[i].getKeymap();
Keymap backup = JTextComponent.addKeymap
(jtcs[i].getClass().getName(), null);
Action[] bound = orig.getBoundActions();
for (int j = 0; j < bound.length; j++) {
KeyStroke[] strokes = orig.getKeyStrokesForAction(bound[j]);
for (int k = 0; k < strokes.length; k++) {
backup.addActionForKeyStroke(strokes[k], bound[j]);
}
}
backup.setDefaultAction(orig.getDefaultAction());
}
loadEmacsKeyBindings();
}
public static void unload()
{
JTextComponent[] jtcs = new JTextComponent[] {
new JTextArea(),
new JTextPane(),
new JTextField(),
new JEditorPane(),
};
for (int i = 0; i < jtcs.length; i++) {
Keymap backup = JTextComponent.getKeymap
(jtcs[i].getClass().getName());
if (backup != null) {
Keymap current = jtcs[i].getKeymap();
current.removeBindings();
Action[] bound = backup.getBoundActions();
for (int j = 0; j < bound.length; j++) {
KeyStroke[] strokes =
backup.getKeyStrokesForAction(bound[i]);
for (int k = 0; k < strokes.length; k++) {
current.addActionForKeyStroke(strokes[k], bound[j]);
}
}
current.setDefaultAction(backup.getDefaultAction());
}
}
}
/**
* Activates Emacs keybindings for all text components extending {@link
* JTextComponent}.
*/
private static void loadEmacsKeyBindings()
{
logger.debug("Loading emacs keybindings");
JTextComponent[] jtcs = new JTextComponent[] {
new JTextArea(),
new JTextPane(),
new JTextField(),
new JEditorPane(),
};
for (int i = 0; i < jtcs.length; i++) {
Keymap k = jtcs[i].getKeymap();
JTextComponent.loadKeymap(k, EMACS_KEY_BINDINGS,
jtcs[i].getActions());
k.addActionForKeyStroke(KeyStroke.getKeyStroke
(KeyEvent.VK_D, InputEvent.ALT_MASK),
new KillWordAction(killWordAction));
k.addActionForKeyStroke(KeyStroke.getKeyStroke
(KeyEvent.VK_BACK_SPACE,
InputEvent.ALT_MASK),
new BackwardKillWordAction(backwardKillWordAction));
k.addActionForKeyStroke(KeyStroke.getKeyStroke(KeyEvent.VK_SPACE,
InputEvent.CTRL_MASK),
new SetMarkCommandAction(setMarkCommandAction));
k.addActionForKeyStroke(KeyStroke.getKeyStroke(KeyEvent.VK_W,
InputEvent.ALT_MASK),
new KillRingSaveAction(killRingSaveAction));
k.addActionForKeyStroke(KeyStroke.getKeyStroke(KeyEvent.VK_W,
InputEvent.CTRL_MASK),
new KillRegionAction(killRegionAction));
k.addActionForKeyStroke(KeyStroke.getKeyStroke(KeyEvent.VK_K,
InputEvent.CTRL_MASK),
new KillLineAction(killLineAction));
k.addActionForKeyStroke(KeyStroke.getKeyStroke(KeyEvent.VK_Y,
InputEvent.CTRL_MASK),
new YankAction("emacs-yank"));
k.addActionForKeyStroke(KeyStroke.getKeyStroke(KeyEvent.VK_Y,
InputEvent.ALT_MASK),
new YankPopAction("emacs-yank-pop"));
k.addActionForKeyStroke
(KeyStroke.getKeyStroke(KeyEvent.VK_C, InputEvent.ALT_MASK),
new CapitalizeWordAction(capitalizeWordAction));
k.addActionForKeyStroke
(KeyStroke.getKeyStroke(KeyEvent.VK_L, InputEvent.ALT_MASK),
new DowncaseWordAction(downcaseWordAction));
k.addActionForKeyStroke
(KeyStroke.getKeyStroke(KeyEvent.VK_U, InputEvent.ALT_MASK),
new UpcaseWordAction(upcaseWordAction));
}
}
//--- Inner Class(es) ---
/**
* Kills the next word.
*/
public static class KillWordAction extends TextAction
{
public KillWordAction(String nm)
{
super(nm);
}
public void actionPerformed(ActionEvent e)
{
JTextComponent jtc = getTextComponent(e);
if (jtc != null) {
try {
int offs = jtc.getCaretPosition();
jtc.setSelectionStart(offs);
offs = Utilities.getNextWord(jtc, offs);
jtc.setSelectionEnd(offs);
jtc.cut();
}
catch (BadLocationException ble) {
jtc.getToolkit().beep();
}
}
}
}
/**
* Kills the previous word.
*/
public static class BackwardKillWordAction extends TextAction
{
public BackwardKillWordAction(String nm)
{
super(nm);
}
public void actionPerformed(ActionEvent e)
{
JTextComponent jtc = getTextComponent(e);
if (jtc != null) {
try {
int offs = jtc.getCaretPosition();
jtc.setSelectionEnd(offs);
offs = Utilities.getPreviousWord(jtc, offs);
jtc.setSelectionStart(offs);
jtc.cut();
}
catch (BadLocationException ble) {
jtc.getToolkit().beep();
}
}
}
}
/**
* Copies the marked region and stores it in the killring.
*/
public static class KillRingSaveAction extends TextAction
{
public KillRingSaveAction(String nm)
{
super(nm);
}
public void actionPerformed(ActionEvent e)
{
JTextComponent jtc = getTextComponent(e);
if (jtc != null && SetMarkCommandAction.isMarked(jtc)) {
jtc.setSelectionStart(SetMarkCommandAction.getCaretPosition());
jtc.moveCaretPosition(jtc.getCaretPosition());
jtc.copy();
YankAction.add(jtc.getSelectedText());
SetMarkCommandAction.reset();
// todo reset selection
}
}
}
/**
* Kills the marked region and stores it in the killring.
*/
public static class KillRegionAction extends TextAction
{
public KillRegionAction(String nm)
{
super(nm);
}
public void actionPerformed(ActionEvent e)
{
JTextComponent jtc = getTextComponent(e);
if (jtc != null && SetMarkCommandAction.isMarked(jtc)) {
jtc.setSelectionStart(SetMarkCommandAction.getCaretPosition());
jtc.moveCaretPosition(jtc.getCaretPosition());
SetMarkCommandAction.reset();
YankAction.add(jtc.getSelectedText());
jtc.cut();
}
}
}
/**
* Kills text up to the end of the current line and stores it in the
* killring.
*/
public static class KillLineAction extends TextAction
{
public KillLineAction(String nm)
{
super(nm);
}
public void actionPerformed(ActionEvent e)
{
JTextComponent jtc = getTextComponent(e);
if (jtc != null) {
try {
int start = jtc.getCaretPosition();
int end = Utilities.getRowEnd(jtc, start);
if (start == end && jtc.isEditable()) {
Document doc = jtc.getDocument();
doc.remove(end, 1);
}
else {
jtc.setSelectionStart(start);
jtc.setSelectionEnd(end);
YankAction.add(jtc.getSelectedText());
jtc.cut();
// jtc.replaceSelection("");
}
}
catch (BadLocationException ble) {
jtc.getToolkit().beep();
}
}
}
}
/**
* Sets a beginning mark.
*/
public static class SetMarkCommandAction extends TextAction
{
//--- Constant(s) ---
//--- Data field(s) ---
private static int position = -1;
private static JTextComponent jtc;
//--- Constructor(s) ---
public SetMarkCommandAction(String nm)
{
super(nm);
}
//--- Method(s) ---
public void actionPerformed(ActionEvent e)
{
jtc = getTextComponent(e);
if (jtc != null) {
position = jtc.getCaretPosition();
}
}
public static boolean isMarked(JTextComponent jt)
{
return (jtc == jt && position != -1);
}
public static void reset()
{
jtc = null;
position = -1;
}
public static int getCaretPosition()
{
return position;
}
}
/**
* Pastes text from killring.
*/
public static class YankAction extends TextAction
{
public static LinkedList killring = new LinkedList();
public static int start = -1;
public static int end = -1;
public YankAction(String nm)
{
super(nm);
}
public void actionPerformed(ActionEvent event)
{
JTextComponent jtc = getTextComponent(event);
if (jtc != null) {
try {
start = jtc.getCaretPosition();
jtc.paste();
end = jtc.getCaretPosition();
add(jtc.getText(start, end));
}
catch (Exception e) {
}
}
}
/**
* Uniquely adds <code>item</code> to killring, i.e. if
* <code>item</code> is already in killring, it's moved to the front,
* otherwise it's added as first element.
*/
public static void add(String item)
{
for (Iterator i = killring.iterator(); i.hasNext();) {
if (item.equals((String)i.next())) {
i.remove();
break;
}
}
killring.addFirst(item);
}
/**
* Returns killring successor of <code>item</code> and adds
* <code>item</code> to killring.
*
* @param predecessor
* @return Returns first item if <code>item == null</code>.
*/
public static String getNext(String predecessor)
{
if (killring.size() == 0) {
return null;
}
if (predecessor == null) {
return (String)killring.getFirst();
}
for (Iterator i = killring.iterator(); i.hasNext();) {
if (predecessor.equals((String)i.next())) {
i.remove();
if (i.hasNext()) {
String result = (String)i.next();
killring.addFirst(predecessor);
return result;
}
else {
break;
}
}
}
if (killring.size() == 0) {
return null;
}
String result = (String)killring.getFirst();
killring.addFirst(predecessor);
return result;
}
}
/**
* Pastes an element from the killring cycling through it.
*/
public static class YankPopAction extends TextAction
{
public YankPopAction(String nm)
{
super(nm);
}
public void actionPerformed(ActionEvent event)
{
JTextComponent jtc = getTextComponent(event);
if (jtc != null && YankAction.killring.size() > 0) {
jtc.setSelectionStart(YankAction.start);
jtc.setSelectionEnd(YankAction.end);
String toYank = YankAction.getNext(jtc.getSelectedText());
if (toYank != null) {
jtc.replaceSelection(toYank);
YankAction.end = jtc.getCaretPosition();
}
else {
jtc.getToolkit().beep();
}
}
}
}
/**
* Capitalizes the next word.
*/
public static class CapitalizeWordAction extends TextAction
{
public CapitalizeWordAction(String nm)
{
super(nm);
}
/**
* At first the same code as in {@link
* EmacsKeyBindings.DowncaseWordAction} is performed, to ensure the
* word is in lower case, then the first letter is capialized. */
public void actionPerformed(ActionEvent event)
{
JTextComponent jtc = getTextComponent(event);
if (jtc != null) {
try {
/* downcase code */
int start = jtc.getCaretPosition();
int end = Utilities.getNextWord(jtc, start);
jtc.setSelectionStart(start);
jtc.setSelectionEnd(end);
String word = jtc.getText(start, end - start);
jtc.replaceSelection(word.toLowerCase());
/* actual capitalize code */
int offs = Utilities.getWordStart(jtc, start);
// get first letter
String c = jtc.getText(offs, 1);
// we're at the end of the previous word
if (c.equals(" ")) {
/* ugly java workaround to get the beginning of the
word. */
offs = Utilities.getWordStart(jtc, ++offs);
c = jtc.getText(offs, 1);
}
if (Character.isLetter(c.charAt(0))) {
jtc.setSelectionStart(offs);
jtc.setSelectionEnd(offs + 1);
jtc.replaceSelection(c.toUpperCase());
}
end = Utilities.getWordEnd(jtc, offs);
jtc.setCaretPosition(end);
}
catch (BadLocationException ble) {
jtc.getToolkit().beep();
}
}
}
}
/**
* Renders all characters of the next word to lowercase.
*/
public static class DowncaseWordAction extends TextAction
{
public DowncaseWordAction(String nm)
{
super(nm);
}
public void actionPerformed(ActionEvent event)
{
JTextComponent jtc = getTextComponent(event);
if (jtc != null) {
try {
int start = jtc.getCaretPosition();
int end = Utilities.getNextWord(jtc, start);
jtc.setSelectionStart(start);
jtc.setSelectionEnd(end);
String word = jtc.getText(start, end - start);
jtc.replaceSelection(word.toLowerCase());
}
catch (BadLocationException ble) {
jtc.getToolkit().beep();
}
}
}
}
/**
* Renders all characters of the next word to upppercase.
*/
public static class UpcaseWordAction extends TextAction
{
public UpcaseWordAction(String nm)
{
super(nm);
}
public void actionPerformed(ActionEvent event)
{
JTextComponent jtc = getTextComponent(event);
if (jtc != null) {
try {
int start = jtc.getCaretPosition();
int end = Utilities.getNextWord(jtc, start);
jtc.setSelectionStart(start);
jtc.setSelectionEnd(end);
String word = jtc.getText(start, end - start);
jtc.replaceSelection(word.toUpperCase());
}
catch (BadLocationException ble) {
jtc.getToolkit().beep();
}
}
}
}
}
The table below shows all metrics for EmacsKeyBindings.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 78.00 | Number of blocks | |
| BLOCK_COMMENT | 22.00 | Number of block comment lines | |
| COMMENTS | 96.00 | Comment lines | |
| COMMENT_DENSITY | 0.23 | Comment density | |
| COMPARISONS | 37.00 | Number of comparison operators | |
| CYCLOMATIC | 73.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 26.00 | Comments in declarations | |
| DOC_COMMENT | 61.00 | Number of javadoc comment lines | |
| ELOC | 425.00 | Effective lines of code | |
| EXEC_COMMENTS | 7.00 | Comments in executable code | |
| EXITS | 62.00 | Procedure exits | |
| FUNCTIONS | 30.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 0.56 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 59.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 | 3.00 | JAVA0007 Should not declare public field | |
| JAVA0008 | 1.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 non-protected constructor | |
| JAVA0017 | 0.00 | JAVA0017 Class name does not have required form | |
| JAVA0018 | 0.00 | JAVA0018 Method name does not have required form | |
| JAVA0019 | 0.00 | JAVA0019 Interface name does not have required form | |
| JAVA0020 | 0.00 | JAVA0020 Field name does not have required form | |
| JAVA0021 | 0.00 | JAVA0021 Interface method name does not have required form | |
| JAVA0022 | 0.00 | JAVA0022 Static final field name does not have required form | |
| JAVA0023 | 0.00 | JAVA0023 Empty finalize method | |
| JAVA0024 | 0.00 | JAVA0024 Empty class | |
| JAVA0025 | 0.00 | JAVA0025 Method override is empty | |
| JAVA0026 | 0.00 | JAVA0026 Finalize method with parameters | |
| JAVA0029 | 0.00 | JAVA0029 Private method not used | |
| JAVA0030 | 0.00 | JAVA0030 Private field not used | |
| JAVA0031 | 0.00 | JAVA0031 Case statement not properly closed | |
| JAVA0032 | 0.00 | JAVA0032 Switch statement missing default | |
| JAVA0033 | 0.00 | JAVA0033 default: not last case in switch statement | |
| JAVA0034 | 0.00 | JAVA0034 Missing braces in if statement | |
| JAVA0035 | 0.00 | JAVA0035 Missing braces in for statement | |
| JAVA0036 | 0.00 | JAVA0036 Missing braces in while statement | |
| JAVA0038 | 0.00 | JAVA0038 Non-case label in switch statement | |
| JAVA0039 | 0.00 | JAVA0039 Break statement with label | |
| JAVA0040 | 0.00 | JAVA0040 Switch statement contains N cases (maximum: M) | |
| JAVA0041 | 0.00 | JAVA0041 Nested synchronized block | |
| JAVA0042 | 0.00 | JAVA0042 Empty synchronized statement | |
| JAVA0043 | 0.00 | JAVA0043 Inner class does not use outer class | |
| JAVA0044 | 0.00 | JAVA0044 Serializable class with no instance variables | |
| JAVA0045 | 0.00 | JAVA0045 Serializable class with only transient fields | |
| JAVA0046 | 0.00 | JAVA0046 Name of class not derived from Exception ends with 'Exception' | |
| JAVA0047 | 0.00 | JAVA0047 Serializable class derives from invalid base class | |
| JAVA0048 | 0.00 | JAVA0048 Name of class derived from Exception does not end with 'Exception' | |
| JAVA0049 | 0.00 | JAVA0049 Nested block at depth N (maximum: M) | |
| JAVA0050 | 0.00 | JAVA0050 Class derives from java.lang.Error | |
| JAVA0051 | 0.00 | JAVA0051 Class derives from java.lang.RuntimeException | |
| JAVA0052 | 0.00 | JAVA0052 Class derives from java.lang.Throwable | |
| JAVA0053 | 0.00 | JAVA0053 Unused label | |
| JAVA0054 | 0.00 | JAVA0054 Inheritance depth N exceeds maximum M | |
| JAVA0055 | 0.00 | JAVA0055 Class should be interface | |
| JAVA0056 | 0.00 | JAVA0056 Unnecessary abstract modifier for interface or annotation | |
| JAVA0057 | 0.00 | JAVA0057 Unnecessary default constructor | |
| JAVA0058 | 0.00 | JAVA0058 Constructor calls super() | |
| JAVA0059 | 0.00 | JAVA0059 Method override only calls super() | |
| JAVA0061 | 0.00 | JAVA0061 Inaccessible member in anonymous class | |
| JAVA0062 | 0.00 | JAVA0062 Public class missing public member or protected constructor | |
| JAVA0063 | 0.00 | JAVA0063 Identifier name should not contain '$' | |
| JAVA0064 | 0.00 | JAVA0064 N variations of identifier name (maximum: M) | |
| JAVA0065 | 0.00 | JAVA0065 Unnecessary final modifier for method in final class | |
| JAVA0066 | 0.00 | JAVA0066 Unnecessary modifier for interface nested type | |
| JAVA0067 | 0.00 | JAVA0067 Array descriptor on identifier name | |
| JAVA0068 | 0.00 | JAVA0068 Modifiers not declared in recommended order | |
| JAVA0071 | 0.00 | JAVA0071 Strings compared with == | |
| JAVA0073 | 0.00 | JAVA0073 Integer division in floating-point context | |
| JAVA0074 | 0.00 | JAVA0074 Use of Object.notify() | |
| JAVA0075 | 0.00 | JAVA0075 Method parameter hides field | |
| JAVA0076 | 0.00 | JAVA0076 Use of magic number | |
| JAVA0077 | 0.00 | JAVA0077 Private field not used in declaring class | |
| JAVA0078 | 0.00 | JAVA0078 Floating point values compared with == | |
| JAVA0079 | 0.00 | JAVA0079 Use of instance to reference static member | |
| JAVA0080 | 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 | 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 | 1.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 0.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 0.00 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0111 | 0.00 | JAVA0111 Incorrect javadoc: @return tag for void method | |
| JAVA0112 | 0.00 | JAVA0112 Incorrect javadoc: no exception 'exception' in throws | |
| JAVA0113 | 12.00 | JAVA0113 Incorrect javadoc: no @author tag | |
| JAVA0114 | 12.00 | JAVA0114 Incorrect javadoc: no @version tag | |
| JAVA0115 | 0.00 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0116 | 15.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 16.00 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0118 | 0.00 | JAVA0118 Missing javadoc: type 'type' | |
| JAVA0119 | 0.00 | JAVA0119 Control variable changed within body of for loop | |
| JAVA0123 | 2.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 | 0.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 2078.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 | 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 | 11.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 | 11.00 | JAVA0237 Class implements Cloneable but does not have public clone method | |
| JAVA0238 | 0.00 | JAVA0238 Clone method does not call super.clone() | |
| JAVA0239 | 0.00 | JAVA0239 Class declares 'readObject' or 'writeObject' but does not implement Serializable | |
| JAVA0240 | 0.00 | JAVA0240 Serializable class which declares readObject or writeObject but not both | |
| JAVA0241 | 0.00 | JAVA0241 'readObject' or 'writeObject' should be declared private in Serializable class | |
| JAVA0242 | 0.00 | JAVA0242 Transient field in non-Serializable class | |
| JAVA0243 | 0.00 | JAVA0243 'readResolve' or 'writeReplace' should be declared private or protected | |
| JAVA0244 | 0.00 | JAVA0244 Field or method name in subclass differs only by case from inherited field or method | |
| JAVA0245 | 0.00 | JAVA0245 JUnit TestCase with non-trivial constructor | |
| JAVA0246 | 0.00 | JAVA0246 JUnit assertXXX statement missing message parameter | |
| JAVA0247 | 0.00 | JAVA0247 JUnit 'setUp()' and 'tearDown()' should call super method | |
| JAVA0248 | 0.00 | JAVA0248 JUnit method 'setUp' or 'tearDown' with incorrect signature | |
| JAVA0249 | 0.00 | JAVA0249 JUnit TestCase 'suite()' should be declared static | |
| JAVA0250 | 0.00 | JAVA0250 JUnit TestCase declares testXXX method with incorrect signature | |
| JAVA0251 | 0.00 | JAVA0251 Use '%n' for line breaks in printf/format for platform independence | |
| JAVA0252 | 0.00 | JAVA0252 'enum' is a Java 1.5 reserved word | |
| JAVA0253 | 0.00 | JAVA0253 Not all enum constants consumed in switch statement | |
| JAVA0254 | 0.00 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| JAVA0255 | 0.00 | JAVA0255 Result of method invocation not used | |
| JAVA0256 | 0.00 | JAVA0256 Assignment of external collection/array to field | |
| JAVA0257 | 0.00 | JAVA0257 Use of 'Constant Interface' anti-pattern | |
| JAVA0258 | 0.00 | JAVA0258 Implement Iterable for foreach compatibility | |
| JAVA0259 | 0.00 | JAVA0259 Return of collection/array field | |
| JAVA0260 | 0.00 | JAVA0260 Use 'enum' instead of Enumerated Type pattern | |
| JAVA0261 | 0.00 | JAVA0261 Use specialized Enum collection types | |
| JAVA0262 | 0.00 | JAVA0262 Use of char in integer context | |
| JAVA0263 | 0.00 | JAVA0263 Long literal ends with 'l' instead of 'L' | |
| JAVA0264 | 0.00 | JAVA0264 Integer math in long context - check for overflow | |
| JAVA0265 | 0.00 | JAVA0265 Use of Throwable.printStackTrace() | |
| JAVA0266 | 0.00 | JAVA0266 Use of System.out | |
| JAVA0267 | 0.00 | JAVA0267 Use of System.err | |
| JAVA0269 | 0.00 | JAVA0269 Contents of StringBuffer never used | |
| JAVA0270 | 6.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 | |
| JAVA0289 | 0.00 | null | |
| LINES | 742.00 | Number of lines in the source file | |
| LINE_COMMENT | 13.00 | Number of line comments | |
| LOC | 557.00 | Lines of code | |
| LOGICAL_LINES | 199.00 | Number of statements | |
| LOOPS | 9.00 | Number of loops | |
| NEST_DEPTH | 5.00 | Maximum nesting depth | |
| OPERANDS | 1192.00 | Number of operands | |
| OPERATORS | 2094.00 | Number of operators | |
| PARAMS | 25.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 3286.00 | Halstead program length | |
| PROGRAM_VOCAB | 327.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 34.00 | Number of return points from functions | |
| SIZE | 20022.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 288.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 39.00 | Number of unique operators | |
| WHITESPACE | 89.00 | Number of whitespace lines | |