ScrollableListDialog.java
| Index Score | ||
|---|---|---|
 |
 |
edu.rice.cs.util.swing |
 |
 |
DrJava |
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 | |
|---|---|---|
| JAVA0020 | JAVA0020 Field name does not have required form |  |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| EXEC_COMMENTS | Comments in executable code | |
| UNIQUE_OPERANDS | Number of unique operands | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| SIZE | Size of the file in bytes | |
| DECL_COMMENTS | Comments in declarations | |
| EXITS | Procedure exits | |
| PROGRAM_VOLUME | Halstead program volume | |
| PARAMS | Number of formal parameter declarations | |
| JAVA0256 | JAVA0256 Assignment of external collection/array to field | |
| JAVA0018 | JAVA0018 Method name does not have required form | |
| UNIQUE_OPERATORS | Number of unique operators | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| FUNCTIONS | Number of function declarations | |
| JAVA0076 | JAVA0076 Use of magic number | |
| JAVA0029 | JAVA0029 Private method not used | |
| JAVA0100 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| LOOPS | Number of loops | |
| JAVA0130 | JAVA0130 Non-static method does not use instance fields | |
| COMMENTS | Comment lines | |
| WHITESPACE | Number of whitespace lines | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
/*BEGIN_COPYRIGHT_BLOCK
*
* Copyright (c) 2001-2008, JavaPLT group at Rice University (drjava@rice.edu)
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* * Neither the names of DrJava, the JavaPLT group, Rice University, nor the
* names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* This software is Open Source Initiative approved Open Source Software.
* Open Source Initative Approved is a trademark of the Open Source Initiative.
*
* This file is part of DrJava. Download the current version of this project
* from http://www.drjava.org/ or http://sourceforge.net/projects/drjava/
*
* END_COPYRIGHT_BLOCK*/
package edu.rice.cs.util.swing;
import javax.swing.*;
import java.awt.BorderLayout;
import java.awt.Dimension;
import java.awt.EventQueue;
import java.awt.FlowLayout;
import java.awt.Frame;
import java.awt.Toolkit;
import java.awt.event.*;
import java.util.ArrayList;
import java.util.List;
import java.util.Vector;
/** <p>The ScrollableListDialog is a popup dialog with a message and a scrollable list of items. A ScrollableListDialog
* should be used when a message may need to display a variable number of items, for example, when reporting missing
* files.</p>
* <p>The message (also know as the leader text) is displayed above the items with an optional icon. The items are
* displayed in a scrollable list. Buttons are added below the list of items.</p>
* <p>This dialog is somewhat styled after {@link javax.swing.JOptionPane} and uses the message-type constants from
* JOptionPane.</p>
*
* @author Chris Warrington
* @version $Id$
* @since 2007-03-06
*/
public class ScrollableListDialog<T> extends JDialog {
/** The default width for this dialog. */
private static final int DEFAULT_WIDTH = 400;
/** The default height for this dialog. */
private static final int DEFAULT_HEIGHT = 450;
/** The ratio of the screen width to use by default. */
private static final double WIDTH_RATIO = .75;
/** The ratio of the screen height to use by default. */
private static final double HEIGHT_RATIO = .50;
/** The list of items displayed. */
protected final JList list;
/** The number of the button that was pressed to close the dialog. */
protected int _buttonPressed = -1;
/** The list of items being listed. */
protected List<T> listItems;
/** Factory design pattern. Used to create new ScrollableListDialogs with
* less complicated and ambiguous constructors. */
public static class Builder<T> {
protected Frame _owner;
protected String _dialogTitle;
protected String _leaderText;
protected List<T> _listItems = new ArrayList<T>();
protected List<T> _selectedItems = new ArrayList<T>();
protected int _messageType = JOptionPane.PLAIN_MESSAGE;
protected int _width = DEFAULT_WIDTH;
protected int _height = DEFAULT_HEIGHT;
protected Icon _icon = null;
protected boolean _fitToScreen = true;
protected List<JButton> _buttons = new ArrayList<JButton>();
protected boolean _selectable = false;
public Builder() { addOkButton(); }
public Builder<T> setOwner(Frame owner) { _owner = owner; return this; }
public Builder<T> setTitle(String dialogTitle) { _dialogTitle = dialogTitle; return this; }
public Builder<T> setText(String leaderText) { _leaderText = leaderText; return this; }
public Builder<T> setItems(List<T> listItems) { _listItems = listItems; return this; }
public Builder<T> setSelectedItems(List<T> selItems) { _selectedItems = selItems; return this; }
public Builder<T> setMessageType(int messageType) { _messageType = messageType; return this; }
public Builder<T> setWidth(int width) { _width = width; return this; }
public Builder<T> setHeight(int height) { _height = height; return this; }
public Builder<T> setIcon(Icon icon) { _icon = icon; return this; }
public Builder<T> setFitToScreen(boolean fts) { _fitToScreen = fts; return this; }
public Builder<T> clearButtons() { _buttons.clear(); return this; }
public Builder<T> addOkButton() { _buttons.add(new JButton("OK")); return this; }
public Builder<T> addButton(JButton b) { _buttons.add(b); return this; }
public Builder<T> setSelectable(boolean b) { _selectable = b; return this; }
public ScrollableListDialog<T> build() {
return new ScrollableListDialog<T>(_owner, _dialogTitle, _leaderText, _listItems, _selectedItems, _messageType,
_width, _height, _icon, _fitToScreen, _buttons, _selectable);
}
}
/** <p>Creates a new ScrollableListDialog with the given title, leader
* text, items, message type, width, height, and icon. The list of
* items is used to construct an internal string list that is not
* backed by the original list. Changes made to the list or items
* after dialog construction will not be reflected in the dialog.</p>
*
* <p>The message type must be one of the message types from
* {@link javax.swing.JOptionPane}. The message type controlls which
* default icon is used. If {@code icon} is non-null, it is used
* instead of the default icon.</p>
*
* @param owner The frame that owns this dialog. May be {@code null}.
* @param dialogTitle The text to use as the dialog title.
* @param leaderText Text to display before the list of items.
* @param listItems The items to display in the list.
* @param selItems The items selected at the beginning.
* @param messageType The type of dialog message.
* @param width The width of the dialog box.
* @param height The height of the dialog box.
* @param icon The icon to display. May be {@code null}.
* @param fitToScreen If {@code true}, the width and height of the dialog will be calculated using the screen
* dimensions, {@link #WIDTH_RATIO}, and {@link #HEIGHT_RATIO}. If {@code false}, the provided width and
* height will be used.
* @param buttons The list of buttons to display
*
* @throws IllegalArgumentException if {@code listItems} is {@code null.}
* @throws IllegalArgumentException if the message type is unknown or {@code listItems} is {@code null.}
*/
@SuppressWarnings("unchecked")
private ScrollableListDialog(Frame owner, String dialogTitle, String leaderText, List<T> listItems, List<T> selItems,
int messageType, int width, int height, Icon icon, boolean fitToScreen,
List<JButton> buttons, boolean selectable) {
super(owner, dialogTitle, true);
this.listItems = listItems;
if (!_isknownMessageType(messageType)) {
throw new IllegalArgumentException("The message type \"" + messageType + "\" is unknown");
}
if (listItems == null) throw new IllegalArgumentException("listItems cannot be null");
/* create the leader text panel */
JLabel dialogIconLabel = null;
if (icon != null) { //use the user-provided icon
dialogIconLabel = new JLabel(icon);
}
else { //lookup the message-dependent icon
Icon messageIcon = _getIcon(messageType);
if (messageIcon != null) dialogIconLabel = new JLabel(messageIcon);
}
final JLabel leaderLabel = new JLabel(leaderText);
final JPanel leaderPanel = new JPanel();
leaderPanel.setLayout(new FlowLayout(FlowLayout.LEFT));
if (dialogIconLabel != null) leaderPanel.add(dialogIconLabel);
leaderPanel.add(leaderLabel);
/* create the item list box */
//copy the items string representations into a vector
final Vector<String> dataAsStrings = new Vector<String>(listItems.size());
//keep track of the longest string for use later
String longestString = "";
for (T obj : listItems) {
if (obj != null) {
final String objAsString = obj.toString();
//update longest string
if (objAsString.length() > longestString.length()) {
longestString = objAsString;
}
dataAsStrings.add(objAsString);
}
}
if (selectable) {
final Vector<String> selAsStrings = new Vector<String>(selItems.size());
for (T obj : selItems) {
if (obj != null) {
final String objAsString = obj.toString();
selAsStrings.add(objAsString);
}
}
list = new CheckBoxJList(dataAsStrings, selAsStrings);
//let the user select several
list.setSelectionMode(ListSelectionModel.MULTIPLE_INTERVAL_SELECTION);
}
else {
list = new JList(dataAsStrings);
//let the user select several
list.setSelectionMode(ListSelectionModel.SINGLE_SELECTION);
}
//use the longest string to calculate item cell widths and heights
list.setPrototypeCellValue(longestString);
//create a scrollable view around the list
final JScrollPane scrollPane = new JScrollPane(list);
/* create the button panel */
final JPanel buttonPanel = new JPanel();
buttonPanel.setLayout(new FlowLayout(FlowLayout.CENTER));
//allow children to add additional buttons, if overridden
_addButtons(buttonPanel, buttons);
/* create the dialog */
final JPanel contentPanel = new JPanel();
contentPanel.setLayout(new BorderLayout(10, 5));
contentPanel.setBorder(BorderFactory.createEmptyBorder(5, 10, 0, 10));
contentPanel.add(leaderPanel, BorderLayout.NORTH);
contentPanel.add(scrollPane, BorderLayout.CENTER);
contentPanel.add(buttonPanel, BorderLayout.SOUTH);
getContentPane().add(contentPanel);
/* calculate the dialog's dimensions */
Dimension dialogSize = new Dimension();
if (fitToScreen) {
//use the screen dimensions to calculate the dialog's
Dimension screenSize = Toolkit.getDefaultToolkit().getScreenSize();
int screenBasedWidth = (int) (WIDTH_RATIO * screenSize.getWidth());
int screenBasedHeight = (int) (HEIGHT_RATIO * screenSize.getHeight());
dialogSize.setSize(Math.max(DEFAULT_WIDTH, screenBasedWidth),
Math.max(DEFAULT_HEIGHT, screenBasedHeight));
} else {
//use the user-provided dimensions
dialogSize.setSize(width, height);
}
setSize(dialogSize);
}
/**
* A method to check if they given message type is a know message
* type.
*
* @param messageType The message type to check
* @return {@code true} if the message type is known, {@code false} otherwise
*/
private boolean _isknownMessageType(int messageType) {
return messageType == JOptionPane.ERROR_MESSAGE ||
messageType == JOptionPane.INFORMATION_MESSAGE ||
messageType == JOptionPane.WARNING_MESSAGE ||
messageType == JOptionPane.QUESTION_MESSAGE ||
messageType == JOptionPane.PLAIN_MESSAGE;
}
/**
* Lookup the icon associated with the given messageType. The message
* type must be one of the message types from
* {@link javax.swing.JOptionPane}.
*
* @param messageType The message for which the icon is requested.
* @return The message's icon or {@code null} is no icon was found.
*/
private Icon _getIcon(int messageType) {
assert _isknownMessageType(messageType);
/* The OptionPane.xxxIcon constants were taken from
* javax.swing.plaf.basic.BasicOptionPaneUI, which may changed
* without notice.
*/
if (messageType == JOptionPane.ERROR_MESSAGE) {
return UIManager.getIcon("OptionPane.errorIcon");
} else if (messageType == JOptionPane.INFORMATION_MESSAGE) {
return UIManager.getIcon("OptionPane.informationIcon");
} else if (messageType == JOptionPane.WARNING_MESSAGE) {
return UIManager.getIcon("OptionPane.warningIcon");
} else if (messageType == JOptionPane.QUESTION_MESSAGE) {
return UIManager.getIcon("OptionPane.questionIcon");
} else if (messageType == JOptionPane.PLAIN_MESSAGE) {
return null;
} else {
//should never get here
assert false;
}
return null;
}
/**
* Adds buttons to the bottom of the dialog. By default, a single
* "OK" button is added that calls {@link #closeDialog}. It
* is also set as the dialog's default button.
*
* Inheritors should feel free the change settings of the panel such
* as the layout manager. However, no guarantees are made that every
* change will work with every version of this class.
*
* @param buttonPanel The JPanel that should contain the buttons.
* @param buttons The list of buttons
*/
protected void _addButtons(JPanel buttonPanel, List<JButton> buttons) {
int i = 0;
for (JButton b: buttons) {
final int j = i++;
b.addActionListener(new ActionListener() {
public void actionPerformed(ActionEvent notUsed) {
_buttonPressed = j;
closeDialog();
}
});
buttonPanel.add(b);
}
getRootPane().setDefaultButton(buttons.get(0));
}
/**
* Shows the dialog.
*/
public void showDialog() {
pack();
setVisible(true);
}
/**
* Should be called when the dialog should be closed. The default
* implementation simply hides the dialog.
*/
protected void closeDialog() {
setVisible(false);
}
/** Return the number of the button that was pressed to close the dialog. */
public int getButtonPressed() { return _buttonPressed; }
/** Return a list of the selected items. */
public List<T> getSelectedItems() {
ArrayList<T> l = new ArrayList<T>();
for (int i: list.getSelectedIndices()) l.add(listItems.get(i));
return l;
}
/** A simple main method for testing purposes.
* @param args Not used.
*/
public static void main(String args[]) {
final List<String> data = new java.util.ArrayList<String>();
data.add("how");
data.add("now");
data.add("brown");
data.add("cow");
EventQueue.invokeLater(new Runnable() {
public void run() {
ScrollableListDialog<String> ld = new ScrollableListDialog.Builder<String>()
.setOwner(null)
.setTitle("TITLE")
.setText("LEADER")
.setItems(data)
.setMessageType(JOptionPane.ERROR_MESSAGE)
.build();
ld.pack();
ld.setVisible(true);
}
});
}
}
The table below shows all metrics for ScrollableListDialog.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 46.00 | Number of blocks | |
| BLOCK_COMMENT | 44.00 | Number of block comment lines | |
| COMMENTS | 143.00 | Comment lines | |
| COMMENT_DENSITY | 0.83 | Comment density | |
| COMPARISONS | 20.00 | Number of comparison operators | |
| CYCLOMATIC | 46.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 19.00 | Comments in declarations | |
| DOC_COMMENT | 88.00 | Number of javadoc comment lines | |
| ELOC | 172.00 | Effective lines of code | |
| EXEC_COMMENTS | 17.00 | Comments in executable code | |
| EXITS | 45.00 | Procedure exits | |
| FUNCTIONS | 27.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 51.83 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 65.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 | 1.00 | JAVA0005 Imports not in specified order | |
| JAVA0006 | 0.00 | JAVA0006 Empty finally block | |
| JAVA0007 | 0.00 | JAVA0007 Should not declare public field | |
| JAVA0008 | 0.00 | JAVA0008 Empty catch block | |
| JAVA0009 | 0.00 | JAVA0009 Protected member in final class | |
| JAVA0010 | 0.00 | JAVA0010 Non-instantiable class does not contain a non-private static member | |
| JAVA0011 | 0.00 | JAVA0011 Abstract class does not contain an abstract method | |
| JAVA0012 | 0.00 | JAVA0012 Non-constructor method with same name as declaring class | |
| JAVA0013 | 0.00 | JAVA0013 Non-blank final field is not static | |
| JAVA0014 | 0.00 | JAVA0014 Class with only static members has non-private constructor | |
| JAVA0015 | 0.00 | JAVA0015 Package class contains public nested type | |
| JAVA0016 | 0.00 | JAVA0016 Abstract class contains public constructor | |
| JAVA0017 | 0.00 | JAVA0017 Class name does not have required form | |
| JAVA0018 | 3.00 | JAVA0018 Method name does not have required form | |
| JAVA0019 | 0.00 | JAVA0019 Interface name does not have required form | |
| JAVA0020 | 13.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 | 1.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 | 3.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 | 3.00 | JAVA0076 Use of magic number | |
| JAVA0077 | 0.00 | JAVA0077 Private field not used in declaring class | |
| JAVA0078 | 0.00 | JAVA0078 Floating point values compared with == | |
| JAVA0079 | 0.00 | JAVA0079 Use of instance to reference static member | |
| JAVA0080 | 0.00 | JAVA0080 Import declaration not used | |
| JAVA0081 | 0.00 | JAVA0081 Boolean literal in comparison | |
| JAVA0082 | 0.00 | JAVA0082 Unnecessary widening cast | |
| JAVA0083 | 0.00 | JAVA0083 Unnecessary instanceof test | |
| JAVA0084 | 0.00 | JAVA0084 Should use compound assignment operator | |
| JAVA0085 | 0.00 | JAVA0085 Use of sun.* class | |
| JAVA0087 | 0.00 | JAVA0087 Use of Thread.sleep() | |
| JAVA0089 | 0.00 | JAVA0089 Use of restricted package | |
| JAVA0092 | 0.00 | JAVA0092 Use of restricted type | |
| JAVA0093 | 0.00 | JAVA0093 Redundant assignment | |
| JAVA0094 | 0.00 | JAVA0094 Field hides a superclass field | |
| JAVA0095 | 0.00 | JAVA0095 Uninitialized private field | |
| JAVA0096 | 0.00 | JAVA0096 Field in nested class hides outer field | |
| JAVA0098 | 0.00 | JAVA0098 Minimize use of implicit field initializers | |
| JAVA0100 | 1.00 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| JAVA0101 | 0.00 | JAVA0101 Unnecessary modifier for field in interface | |
| JAVA0102 | 0.00 | JAVA0102 Last statement in finalize() not super.finalize() | |
| JAVA0103 | 0.00 | JAVA0103 Explicit call to finalize() | |
| JAVA0104 | 0.00 | JAVA0104 finalize() only calls super.finalize() | |
| JAVA0105 | 0.00 | JAVA0105 Duplicate import declaration | |
| JAVA0106 | 0.00 | JAVA0106 Unnecessary import from current package | |
| JAVA0108 | 1.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 0.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 2.00 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0111 | 0.00 | JAVA0111 Incorrect javadoc: @return tag for void method | |
| JAVA0112 | 0.00 | JAVA0112 Incorrect javadoc: no exception 'exception' in throws | |
| JAVA0113 | 0.00 | JAVA0113 Incorrect javadoc: no @author tag | |
| JAVA0114 | 0.00 | JAVA0114 Incorrect javadoc: no @version tag | |
| JAVA0115 | 0.00 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0116 | 0.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 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 | 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 | 1.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 | 1.00 | JAVA0138 N parameters defined for method (maximum: M) | |
| JAVA0139 | 0.00 | JAVA0139 Definition of main other than public static void main(java.lang.String[]) | |
| JAVA0141 | 0.00 | JAVA0141 Unnecessary modifier for method in interface | |
| JAVA0143 | 0.00 | JAVA0143 Synchronized method | |
| JAVA0144 | 0.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 0.00 | JAVA0145 Tab character used in source file | |
| JAVA0150 | 0.00 | JAVA0150 java.lang.Error (or subclass) thrown | |
| JAVA0153 | 0.00 | JAVA0153 Inefficient conversion of integer to string | |
| JAVA0159 | 0.00 | JAVA0159 Inefficient conversion of string to integer | |
| JAVA0160 | 0.00 | JAVA0160 Method does not throw specified exception | |
| JAVA0161 | 0.00 | JAVA0161 Conditional wait() not in loop | |
| JAVA0163 | 0.00 | JAVA0163 Empty statement | |
| JAVA0165 | 0.00 | JAVA0165 Conflicting return statement in finally block | |
| JAVA0166 | 0.00 | JAVA0166 Generic exception caught | |
| JAVA0167 | 0.00 | JAVA0167 ThreadDeath not rethrown | |
| JAVA0169 | 0.00 | JAVA0169 Unnecessary catch block: exception 'exception' | |
| JAVA0170 | 0.00 | JAVA0170 Caught exception not derived from java.lang.Exception | |
| JAVA0171 | 0.00 | JAVA0171 Unused local variable | |
| JAVA0173 | 0.00 | JAVA0173 Unused method parameter | |
| JAVA0174 | 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 | 1.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 | 3.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 | 0.00 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| JAVA0271 | 0.00 | JAVA0271 Minimize use of on-demand (.*) static imports | |
| JAVA0272 | 0.00 | JAVA0272 Thread.run() called | |
| JAVA0273 | 0.00 | JAVA0273 Non-final derivative of Thread calls start() in constructor | |
| JAVA0274 | 0.00 | JAVA0274 Serializable class has a synchronized readObject() | |
| JAVA0275 | 0.00 | JAVA0275 Serializable class has a synchronized writeObject() and no other synchronized methods | |
| JAVA0276 | 0.00 | JAVA0276 Unnecessary use of String constructor | |
| JAVA0277 | 0.00 | JAVA0277 Iterator.next() implementation does not throw NoSuchElementException | |
| JAVA0278 | 0.00 | JAVA0278 Unnecessary use of Boolean constructor | |
| JAVA0279 | 0.00 | JAVA0279 Serialization method readObject or readObjectNoData calls an overridable method | |
| JAVA0280 | 0.00 | JAVA0280 IllegalMonitorStateException caught | |
| JAVA0281 | 0.00 | JAVA0281 Iterator.next() not called in loop | |
| JAVA0282 | 0.00 | JAVA0282 Call to Iterator.next() in loop which does not test Iterator.hasNext() | |
| JAVA0283 | 0.00 | JAVA0283 Control variable not updated in loop body | |
| JAVA0284 | 0.00 | JAVA0284 Explicit garbage collection | |
| JAVA0285 | 0.00 | JAVA0285 Dereference of potentially null variable | |
| JAVA0286 | 0.00 | JAVA0286 Dereference of null variable | |
| JAVA0287 | 0.00 | JAVA0287 Unnecessary null check | |
| JAVA0288 | 0.00 | JAVA0288 Inconsistent null check | |
| LINES | 380.00 | Number of lines in the source file | |
| LINE_COMMENT | 11.00 | Number of line comments | |
| LOC | 198.00 | Lines of code | |
| LOGICAL_LINES | 137.00 | Number of statements | |
| LOOPS | 0.00 | Number of loops | |
| NEST_DEPTH | 4.00 | Maximum nesting depth | |
| OPERANDS | 569.00 | Number of operands | |
| OPERATORS | 1090.00 | Number of operators | |
| PARAMS | 30.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 1659.00 | Halstead program length | |
| PROGRAM_VOCAB | 305.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 35.00 | Number of return points from functions | |
| SIZE | 16053.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 258.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 47.00 | Number of unique operators | |
| WHITESPACE | 39.00 | Number of whitespace lines | |