ScrollableListSelectionDialog.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.

MetricDescription
EXEC_COMMENTSComments in executable code
SIZESize of the file in bytes
DECL_COMMENTSComments in declarations
COMMENTSComment lines
DOC_COMMENTNumber of javadoc comment lines
PARAMSNumber of formal parameter declarations
JAVA0034JAVA0034 Missing braces in if statement
INTERFACE_COMPLEXITYInterface complexity
LINESNumber of lines in the source file
PROGRAM_VOCABHalstead program vocabulary
UNIQUE_OPERANDSNumber of unique operands
EXITSProcedure exits
ELOCEffective lines of code
UNIQUE_OPERATORSNumber of unique operators
JAVA0138JAVA0138 N parameters defined for method (maximum: M)
OPERATORSNumber of operators
PROGRAM_LENGTHHalstead program length
LOCLines of code
JAVA0018JAVA0018 Method name does not have required form
JAVA0117JAVA0117 Missing javadoc: method 'method'
BLOCKSNumber of blocks
OPERANDSNumber of operands
LOGICAL_LINESNumber of statements
JAVA0128JAVA0128 Public constructor in non-public class
JAVA0077JAVA0077 Private field not used in declaring class
COMPARISONSNumber of comparison operators
PROGRAM_VOLUMEHalstead program volume
BLOCK_COMMENTNumber of block comment lines
RETURNSNumber of return points from functions
JAVA0126JAVA0126 Method declares unchecked exception in throws
JAVA0110JAVA0110 Incorrect javadoc: no @return tag
JAVA0076JAVA0076 Use of magic number
JAVA0108JAVA0108 Incorrect javadoc: no @param tag for 'parameter'
JAVA0130JAVA0130 Non-static method does not use instance fields
NEST_DEPTHMaximum nesting depth
JAVA0145JAVA0145 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.*; import java.awt.event.*; import java.util.*; import javax.swing.table.AbstractTableModel; /** * <p>The ScrollableListSelectionDialog is a popup dialog with a message * and a scrollable list of items. Each item may be either selected or * unselected. A ScrollableListSelectionDialog should be used when * an operation needs to act on a variable number of items, for * example, when saving modified 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 * table. A column of checkboxes allows selection of the items. 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-04-08 */ public class ScrollableListSelectionDialog extends JDialog { /** A enumeration of the various selection states. */ public enum SelectionState { /** Indicates that an item is selected. */ SELECTED, /** Indicates that an item is not selected. */ UNSELECTED }; /** 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 table displaying the items. */ protected final JTable table; /** The AbstractTableModel backing the table. */ protected final AbstractTableModel tableModel; /** The number of columns in the table. */ private static final int NUM_COLUMNS = 2; /** The column index of the checkboxes column. */ private static final int CHECKBOXES_COLUMN_INDEX = 0; /** The column index of the strings column. */ private static final int STRINGS_COLUMN_INDEX = 1; /** The items in the table. */ protected final Vector<String> dataAsStrings; /** The selected items in the table. This Vector maps to * _dataAsStrings by index. This value may be accessed by multiple * threads. Threads wishing to access it should acquire its * intrinsic lock. */ protected final Vector<Boolean> selectedItems; /** <p>Creates a new ScrollableListSelectionDialog with the given * title, leader text, and items. 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 default sizing, message type, and icon are used. All the * items are selected by default.</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 itemDescription A textual description of the items. This is used as the column heading for the items. * * @throws IllegalArgumentException if {@code listItems} is {@code null.} */ public ScrollableListSelectionDialog(final Frame owner, final String dialogTitle, final String leaderText, final Collection<?> listItems, final String itemDescription) { this(owner, dialogTitle, leaderText, listItems, itemDescription, SelectionState.SELECTED, JOptionPane.PLAIN_MESSAGE); } /** <p>Creates a new ScrollableListSelectionDialog with the given * title, leader text, items, and message type. 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.</p> * * <p>The default sizing and icon are used.</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 itemDescription A textual description of the items. This is used as the column heading for the items. * @param defaultSelection The default selection state (selected or unselected) for the items. * @param messageType The type of dialog message. * * @throws IllegalArgumentException if {@code listItems} is {@code null.} * @throws IllegalArgumentException if the message type is unknown or {@code listItems} is {@code null.} */ public ScrollableListSelectionDialog(final Frame owner, final String dialogTitle, final String leaderText, final Collection<?> listItems, final String itemDescription, final SelectionState defaultSelection, final int messageType) { this(owner, dialogTitle, leaderText, listItems, itemDescription, defaultSelection, messageType, DEFAULT_WIDTH, DEFAULT_HEIGHT, null, true); } /** <p>Creates a new ScrollableListSelectionDialog 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 itemDescription A textual description of the items. This is used as the column heading for the items. * @param defaultSelection The default selection state (selected or unselected) for the items. * @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}. * * @throws IllegalArgumentException if {@code listItems} is {@code null.} * @throws IllegalArgumentException if the message type is unknown or {@code listItems} is {@code null.} */ public ScrollableListSelectionDialog(final Frame owner, final String dialogTitle, final String leaderText, final Collection<?> listItems, final String itemDescription, final SelectionState defaultSelection, final int messageType, final int width, final int height, final Icon icon) { this(owner, dialogTitle, leaderText, listItems, itemDescription, defaultSelection, messageType, width, height, icon, false); } /** <p>Creates a new ScrollableListSelectionDialog 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 itemDescription A textual description of the items. This is used as the column heading for the items. * @param defaultSelection The default selection state (selected or unselected) for the items. * @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. * @throws IllegalArgumentException if {@code listItems} is {@code null.} * @throws IllegalArgumentException if the message type is unknown or {@code listItems} is {@code null.} */ private ScrollableListSelectionDialog(final Frame owner, final String dialogTitle, final String leaderText, final Collection<?> listItems, final String itemDescription, final SelectionState defaultSelection, final int messageType, final int width, final int height, final Icon icon, final boolean fitToScreen) { super(owner, dialogTitle, true); 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 JPanel leaderPanel = new JPanel(); final JLabel leaderLabel = new JLabel(leaderText); leaderPanel.setLayout(new FlowLayout(FlowLayout.LEFT)); if (dialogIconLabel != null) { leaderPanel.add(dialogIconLabel); } leaderPanel.add(leaderLabel); /* create the table */ //copy the items string representations into a vector dataAsStrings = new Vector<String>(listItems.size()); for (Object obj : listItems) { if (obj != null) { final String objAsString = obj.toString(); dataAsStrings.add(objAsString); } } dataAsStrings.trimToSize(); final int numItems = dataAsStrings.size(); selectedItems = new Vector<Boolean>(numItems); synchronized(selectedItems) { for (int i = 0; i < numItems; ++i) { selectedItems.add(i, defaultSelection == SelectionState.SELECTED); } selectedItems.trimToSize(); } assert selectedItems.size() == dataAsStrings.size(); tableModel = new AbstractTableModel() { //@Override - uncomment when we start compiling with Java 6 public int getRowCount() { return numItems; } //@Override - uncomment when we start compiling with Java 6 public int getColumnCount() { return NUM_COLUMNS; } //@Override - uncomment when we start compiling with Java 6 public Object getValueAt(int row, int column) { if (column == CHECKBOXES_COLUMN_INDEX) { assert row >= 0; assert row < numItems; synchronized(selectedItems) { return selectedItems.get(row); } } else if (column == STRINGS_COLUMN_INDEX) { assert row >= 0; assert row < numItems; return dataAsStrings.get(row); } else { assert false; return null; } } @Override public String getColumnName(int column) { if (column == CHECKBOXES_COLUMN_INDEX) { return ""; } else if (column == STRINGS_COLUMN_INDEX) { return itemDescription; } else { assert false; return ""; } } @Override public Class<?> getColumnClass(final int columnIndex) { if (columnIndex == CHECKBOXES_COLUMN_INDEX) { return Boolean.class; } else if (columnIndex == STRINGS_COLUMN_INDEX) { return String.class; } else { assert false; return Object.class; } } @Override public boolean isCellEditable(final int rowIndex, final int columnIndex) { return columnIndex == CHECKBOXES_COLUMN_INDEX; //only checkboxes are editable } @Override public void setValueAt(final Object newValue, final int rowIndex, final int columnIndex) { assert columnIndex == CHECKBOXES_COLUMN_INDEX; assert rowIndex >= 0; assert rowIndex < numItems; assert newValue instanceof Boolean; final Boolean booleanValue = (Boolean)newValue; synchronized(selectedItems) { selectedItems.set(rowIndex, booleanValue); } } }; table = new JTable(tableModel); /* * this listener enabled clicking in the string column to update the * checkbox. */ table.addMouseListener(new MouseAdapter() { @Override public void mouseClicked(final MouseEvent e) { final Point clickPoint = e.getPoint(); // which column was clicked on final int clickColumn = table.columnAtPoint(clickPoint); if (clickColumn == STRINGS_COLUMN_INDEX) { //it was the strings column, so update the check status of the row //Swing does not do this automatically final int clickRow = table.rowAtPoint(clickPoint); if (clickRow >= 0 && clickRow < numItems) { synchronized(selectedItems) { final boolean currentValue = selectedItems.get(clickRow); final boolean newValue = !currentValue; selectedItems.set(clickRow, newValue); /* We are deliberately holding on to the lock while the * listeners are notified. This, in theory, speeds up the * listeners because they don't have to re-acquire the * lock. Because the internals of Swing are unknown, the * lock may need to be released before the listeners are * notified. Only time will tell. * * PS: If it turns out that holding the lock during * the listener updates is a problem, modify this comment * accordingly. Thank you. */ tableModel.fireTableCellUpdated(clickRow, CHECKBOXES_COLUMN_INDEX); } } } } }); //set the column sizes table.getColumnModel().getColumn(CHECKBOXES_COLUMN_INDEX).setMinWidth(15); table.getColumnModel().getColumn(CHECKBOXES_COLUMN_INDEX).setMaxWidth(30); table.getColumnModel().getColumn(CHECKBOXES_COLUMN_INDEX).setPreferredWidth(20); table.getColumnModel().getColumn(CHECKBOXES_COLUMN_INDEX).sizeWidthToFit(); //create a scrollable view around the table final JScrollPane scrollPane = new JScrollPane(table); /* create the select all/select none panel */ final JPanel selectButtonsPanel = new JPanel(); selectButtonsPanel.setLayout(new FlowLayout(FlowLayout.CENTER)); _addSelectButtons(selectButtonsPanel); /* 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); /* create the center panel which contains the scroll pane and the * select all/select none buttons */ final JPanel centerPanel = new JPanel(); centerPanel.setLayout(new BorderLayout()); centerPanel.add(selectButtonsPanel, BorderLayout.NORTH); centerPanel.add(scrollPane, BorderLayout.CENTER); /* 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(centerPanel, BorderLayout.CENTER); contentPanel.add(buttonPanel, BorderLayout.SOUTH); getContentPane().add(contentPanel); /* calculate the dialog's dimensions */ final Dimension dialogSize = new Dimension(); if (fitToScreen) { //use the screen dimensions to calculate the dialog's final 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(final 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(final 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 the &quot;Select All&quot; and &quot;Select None&quot; buttons * to the given panel. * * @param selectButtonsPanel The panel that should contain the buttons. */ private void _addSelectButtons(final JPanel selectButtonsPanel) { final JButton selectAllButton = new JButton("Select All"); edu.rice.cs.drjava.platform.PlatformFactory.ONLY.setMnemonic(selectAllButton,KeyEvent.VK_A); selectAllButton.addActionListener(new SelectAllNoneActionListener(SelectionState.SELECTED)); selectButtonsPanel.add(selectAllButton); final JButton selectNoneButton = new JButton("Select None"); edu.rice.cs.drjava.platform.PlatformFactory.ONLY.setMnemonic(selectNoneButton,KeyEvent.VK_N); selectNoneButton.addActionListener(new SelectAllNoneActionListener(SelectionState.UNSELECTED)); selectButtonsPanel.add(selectNoneButton); } /** Adds buttons to the bottom of the dialog. By default, a single * &quot;OK&quot; 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. */ protected void _addButtons(final JPanel buttonPanel) { final JButton okButton = new JButton("OK"); okButton.addActionListener(new ActionListener() { public void actionPerformed(ActionEvent notUsed) { closeDialog(); } }); buttonPanel.add(okButton); getRootPane().setDefaultButton(okButton); } /** 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); } /** Returns the string representation of those items that are * currently selected. The items will be in the same relative order * as they were at construction time. The resultant collection may be * empty. The resultant collection is unmodifiable. The resultant * collection is simply a snapshot (i.e., It will not be updated as * more items are selected.). This method may be called from * non-event&nbsp;queue threads. * * @return The currently selected items. */ public java.util.List<String> selectedItems() { final java.util.List<String> results = new ArrayList<String>(); synchronized(selectedItems) { /* This entire loop is synchronized so that we get a consistent * view of the selected items. It is also faster. */ for (int i = 0; i < dataAsStrings.size(); ++i) { if (selectedItems.get(i)) { results.add(dataAsStrings.get(i)); } } } return Collections.unmodifiableList(results); } /** An ActionListener that handles the &quot;Select All&quot; and * &quot;Select None&quot; buttons. It will set the selection state * of every item to the given selection state. */ private class SelectAllNoneActionListener implements ActionListener { /** The value that the selection state will be set to when this * listener runs. */ private final boolean _setToValue; /** * Creates a new SelectAllNoneActionListener that will set the state * of every item to the given state. * * @param setToState The state to set all the items to. */ public SelectAllNoneActionListener(SelectionState setToState) { _setToValue = setToState == SelectionState.SELECTED; } /** * The code that runs in response to the button's action. * This is the code that actually sets the selection state of the * items. * * @param notUsed Not used. */ public void actionPerformed(ActionEvent notUsed) { /* See comment in the table's mouse listener for a discussion * about the duration of the lock. */ synchronized(selectedItems) { for (int i = 0; i < selectedItems.size(); ++i) { selectedItems.set(i, _setToValue); } tableModel.fireTableRowsUpdated(0, Math.max(0, selectedItems.size() - 1)); } } } /** A simple main method for testing purposes. * * @param args Not used. */ public static void main(String args[]) { final Collection<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() { ScrollableListSelectionDialog ld = new ScrollableListSelectionDialog(null, "TITLE", "LEADER", data, "Words", SelectionState.SELECTED, JOptionPane.ERROR_MESSAGE) { @Override protected void closeDialog() { super.closeDialog(); Collection<String> si = selectedItems(); for (String i : si) { System.out.println(i); } } }; ld.pack(); ld.setVisible(true); } }); } }

The table below shows all metrics for ScrollableListSelectionDialog.java.

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