GenericFrame.java
| Index Score | ||
|---|---|---|
 |
 |
net.sourceforge.kolmafia.swingui |
 |
 |
KoLmafia |
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 | |
|---|---|---|
| EXITS | Procedure exits |  |
| CYCLOMATIC | Cyclomatic complexity | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| LOC | Lines of code | |
| OPERATORS | Number of operators | |
| PROGRAM_LENGTH | Halstead program length | |
| BLOCKS | Number of blocks | |
| UNIQUE_OPERANDS | Number of unique operands | |
| LOGICAL_LINES | Number of statements | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| LINES | Number of lines in the source file | |
| FUNCTIONS | Number of function declarations | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| ELOC | Effective lines of code | |
| OPERANDS | Number of operands | |
| SIZE | Size of the file in bytes | |
| COMPARISONS | Number of comparison operators | |
| RETURNS | Number of return points from functions | |
| JAVA0007 | JAVA0007 Should not declare public field | |
| JAVA0119 | JAVA0119 Control variable changed within body of for loop | |
| JAVA0116 | JAVA0116 Missing javadoc: field 'field' | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| JAVA0031 | JAVA0031 Case statement not properly closed | |
| WHITESPACE | Number of whitespace lines | |
| JAVA0270 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| UNIQUE_OPERATORS | Number of unique operators | |
| JAVA0130 | JAVA0130 Non-static method does not use instance fields | |
| JAVA0144 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0016 | JAVA0016 Abstract class contains public constructor | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0136 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0173 | JAVA0173 Unused method parameter | |
| JAVA0287 | JAVA0287 Unnecessary null check | |
| EXEC_COMMENTS | Comments in executable code | |
/**
* Copyright (c) 2005-2008, KoLmafia development team
* http://kolmafia.sourceforge.net/
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* [1] Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* [2] 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.
* [3] Neither the name "KoLmafia" 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.
*/
package net.sourceforge.kolmafia.swingui;
import java.awt.BorderLayout;
import java.awt.Dimension;
import java.awt.Frame;
import java.awt.Point;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.awt.event.InputEvent;
import java.awt.event.KeyEvent;
import java.awt.event.WindowEvent;
import java.io.File;
import java.lang.ref.WeakReference;
import java.util.HashMap;
import javax.swing.JCheckBox;
import javax.swing.JComboBox;
import javax.swing.JComponent;
import javax.swing.JFrame;
import javax.swing.JPanel;
import javax.swing.JScrollPane;
import javax.swing.JSplitPane;
import javax.swing.JTabbedPane;
import javax.swing.JToolBar;
import javax.swing.WindowConstants;
import net.java.dev.spellcast.utilities.DataUtilities;
import net.java.dev.spellcast.utilities.JComponentUtilities;
import net.sourceforge.kolmafia.CreateFrameRunnable;
import net.sourceforge.kolmafia.KoLCharacter;
import net.sourceforge.kolmafia.KoLCharacterAdapter;
import net.sourceforge.kolmafia.KoLConstants;
import net.sourceforge.kolmafia.KoLDesktop;
import net.sourceforge.kolmafia.KoLmafiaGUI;
import net.sourceforge.kolmafia.RequestThread;
import net.sourceforge.kolmafia.StaticEntity;
import net.sourceforge.kolmafia.persistence.Preferences;
import net.sourceforge.kolmafia.request.LogoutRequest;
import net.sourceforge.kolmafia.session.ChatManager;
import net.sourceforge.kolmafia.swingui.listener.RefreshSessionListener;
import net.sourceforge.kolmafia.swingui.listener.WorldPeaceListener;
import net.sourceforge.kolmafia.swingui.menu.GlobalMenuBar;
import net.sourceforge.kolmafia.swingui.menu.ScriptMenu;
import net.sourceforge.kolmafia.swingui.panel.CompactSidePane;
import net.sourceforge.kolmafia.swingui.widget.GenericScrollPane;
import net.sourceforge.kolmafia.swingui.widget.RequestPane;
import net.sourceforge.kolmafia.utilities.InputFieldUtilities;
import net.sourceforge.kolmafia.utilities.StringUtilities;
public abstract class GenericFrame
extends JFrame
{
protected HashMap listenerMap;
private GlobalMenuBar menuBar;
public JTabbedPane tabs;
public String lastTitle;
public String frameName;
public JPanel framePanel;
public CompactSidePane sidepane = null;
public KoLCharacterAdapter refreshListener = null;
static
{
GenericFrame.compileScripts();
GenericFrame.compileBookmarks();
}
/**
* Constructs a new <code>KoLFrame</code> with the given title, to be associated with the given
* StaticEntity.getClient().
*/
public GenericFrame()
{
this( "" );
}
/**
* Constructs a new <code>KoLFrame</code> with the given title, to be associated with the given
* StaticEntity.getClient().
*/
public GenericFrame( final String title )
{
this.setTitle( title );
this.setDefaultCloseOperation( WindowConstants.DISPOSE_ON_CLOSE );
this.tabs = this.getTabbedPane();
this.framePanel = new JPanel( new BorderLayout( 0, 0 ) );
this.frameName = this.getClass().getName();
this.frameName = this.frameName.substring( this.frameName.lastIndexOf( "." ) + 1 );
if ( this.shouldAddStatusBar() )
{
JScrollPane statusBar = KoLConstants.commandBuffer.setChatDisplay( new RequestPane() );
JComponentUtilities.setComponentSize( statusBar, new Dimension( 200, 50 ) );
JSplitPane doublePane =
new JSplitPane( JSplitPane.VERTICAL_SPLIT, new GenericScrollPane( this.framePanel ), statusBar );
this.getContentPane().add( doublePane, BorderLayout.CENTER );
doublePane.setOneTouchExpandable( true );
doublePane.setDividerLocation( 0.9 );
}
else
{
this.getContentPane().add( this.framePanel, BorderLayout.CENTER );
}
this.addHotKeys();
boolean shouldAddFrame =
!( this instanceof KoLDesktop ) && !( this instanceof ContactListFrame ) && !( this instanceof LoginFrame );
if ( this instanceof ChatFrame )
{
shouldAddFrame = !ChatManager.usingTabbedChat() || this instanceof TabbedChatFrame;
}
if ( shouldAddFrame )
{
StaticEntity.registerFrame( this );
}
}
public void setJMenuBar( final GlobalMenuBar menuBar )
{
this.menuBar = menuBar;
super.setJMenuBar( menuBar );
}
protected void addActionListener( final JCheckBox component, final ActionListener listener )
{
if ( this.listenerMap == null )
{
this.listenerMap = new HashMap();
}
component.addActionListener( listener );
this.listenerMap.put( component, new WeakReference( listener ) );
}
protected void addActionListener( final JComboBox component, final ActionListener listener )
{
if ( this.listenerMap == null )
{
this.listenerMap = new HashMap();
}
component.addActionListener( listener );
this.listenerMap.put( component, new WeakReference( listener ) );
}
private void removeActionListener( final Object component, final ActionListener listener )
{
if ( component instanceof JCheckBox )
{
( (JCheckBox) component ).removeActionListener( listener );
}
if ( component instanceof JComboBox )
{
( (JComboBox) component ).removeActionListener( listener );
}
}
protected void removeThreadedListeners()
{
if ( this.listenerMap == null )
{
return;
}
Object[] keys = this.listenerMap.keySet().toArray();
for ( int i = 0; i < keys.length; ++i )
{
WeakReference ref = (WeakReference) this.listenerMap.get( keys[ i ] );
if ( ref == null )
{
continue;
}
Object listener = ref.get();
if ( listener == null )
{
continue;
}
if ( listener instanceof ActionListener )
{
this.removeActionListener( keys[ i ], (ActionListener) listener );
}
}
this.listenerMap.clear();
this.listenerMap = null;
}
public boolean appearsInTab()
{
return GenericFrame.appearsInTab( this.frameName );
}
public static boolean appearsInTab( String frameName )
{
String tabSetting = Preferences.getString( "initialDesktop" );
return tabSetting.indexOf( frameName ) != -1;
}
public boolean shouldAddStatusBar()
{
return Preferences.getBoolean( "addStatusBarToFrames" ) && !this.appearsInTab();
}
public JTabbedPane getTabbedPane()
{
return KoLmafiaGUI.getTabbedPane();
}
public void addHotKeys()
{
JComponentUtilities.addGlobalHotKey( this.getRootPane(), KeyEvent.VK_ESCAPE, new WorldPeaceListener() );
JComponentUtilities.addGlobalHotKey( this.getRootPane(), KeyEvent.VK_F5, new RefreshSessionListener() );
if ( !System.getProperty( "os.name" ).startsWith( "Mac" ) )
{
JComponentUtilities.addGlobalHotKey(
this.getRootPane(), KeyEvent.VK_F6, InputEvent.CTRL_MASK, new TabForwardListener() );
JComponentUtilities.addGlobalHotKey(
this.getRootPane(), KeyEvent.VK_F6, InputEvent.CTRL_MASK + InputEvent.SHIFT_MASK,
new TabBackwardListener() );
}
}
private class TabForwardListener
implements ActionListener
{
public void actionPerformed( final ActionEvent e )
{
if ( GenericFrame.this.tabs == null )
{
return;
}
GenericFrame.this.tabs.setSelectedIndex( ( GenericFrame.this.tabs.getSelectedIndex() + 1 ) % GenericFrame.this.tabs.getTabCount() );
}
}
private class TabBackwardListener
implements ActionListener
{
public void actionPerformed( final ActionEvent e )
{
if ( GenericFrame.this.tabs == null )
{
return;
}
GenericFrame.this.tabs.setSelectedIndex( GenericFrame.this.tabs.getSelectedIndex() == 0 ? GenericFrame.this.tabs.getTabCount() - 1 : GenericFrame.this.tabs.getSelectedIndex() - 1 );
}
}
public final void addTab( final String name, final JComponent panel )
{
if ( this.tabs == null )
{
return;
}
this.tabs.setOpaque( true );
GenericScrollPane scroller = new GenericScrollPane( panel );
JComponentUtilities.setComponentSize( scroller, 560, 400 );
this.tabs.add( name, scroller );
}
public final void setTitle( final String newTitle )
{
this.lastTitle = newTitle;
KoLDesktop.setTitle( this, newTitle );
if ( this instanceof LoginFrame )
{
super.setTitle( this.lastTitle );
return;
}
String username = KoLCharacter.getUserName();
if ( username.equals( "" ) )
{
username = "Not Logged In";
}
super.setTitle( this.lastTitle + " (" + username + ")" );
}
public void requestFocus()
{
super.requestFocus();
this.framePanel.requestFocusInWindow();
}
public boolean requestFocus( boolean temporary )
{
super.requestFocus( temporary );
return this.framePanel.requestFocusInWindow();
}
public boolean requestFocusInWindow()
{
super.requestFocusInWindow();
return this.framePanel.requestFocusInWindow();
}
public boolean requestFocusInWindow( boolean temporary )
{
super.requestFocusInWindow( temporary );
return this.framePanel.requestFocusInWindow();
}
public boolean useSidePane()
{
return false;
}
public JToolBar getToolbar()
{
return this.getToolbar( false );
}
public JToolBar getToolbar( final boolean force )
{
JToolBar toolbarPanel = null;
if ( force )
{
toolbarPanel = new JToolBar( "KoLmafia Toolbar" );
this.getContentPane().add( toolbarPanel, BorderLayout.NORTH );
toolbarPanel.setFloatable( false );
return toolbarPanel;
}
switch ( Preferences.getInteger( "toolbarPosition" ) )
{
case 1:
toolbarPanel = new JToolBar( "KoLmafia Toolbar" );
this.getContentPane().add( toolbarPanel, BorderLayout.NORTH );
break;
case 2:
toolbarPanel = new JToolBar( "KoLmafia Toolbar" );
this.getContentPane().add( toolbarPanel, BorderLayout.SOUTH );
break;
case 3:
toolbarPanel = new JToolBar( "KoLmafia Toolbar", JToolBar.VERTICAL );
this.getContentPane().add( toolbarPanel, BorderLayout.WEST );
break;
case 4:
toolbarPanel = new JToolBar( "KoLmafia Toolbar", JToolBar.VERTICAL );
this.getContentPane().add( toolbarPanel, BorderLayout.EAST );
break;
default:
toolbarPanel = new JToolBar( "KoLmafia Toolbar" );
if ( this instanceof LoginFrame || this instanceof ChatFrame )
{
this.getContentPane().add( toolbarPanel, BorderLayout.NORTH );
break;
}
}
if ( toolbarPanel != null )
{
toolbarPanel.setFloatable( false );
}
return toolbarPanel;
}
/**
* Overrides the default behavior of dispose so that the frames are removed from the internal list of existing
* frames. Also allows for automatic exit.
*/
public void dispose()
{
if ( this.isVisible() )
{
this.rememberPosition();
}
// Determine which frame needs to be removed from
// the maintained list of frames.
KoLDesktop.removeTab( this );
StaticEntity.unregisterFrame( this );
KoLConstants.existingFrames.remove( this );
if ( this.refreshListener != null )
{
KoLCharacter.removeCharacterListener( this.refreshListener );
}
this.removeThreadedListeners();
this.getRootPane().resetKeyboardActions();
if ( this.menuBar != null )
{
this.menuBar.dispose();
}
super.dispose();
this.checkForLogout();
}
private void checkForLogout()
{
if ( !KoLConstants.existingFrames.isEmpty() || LoginFrame.instanceExists() )
{
return;
}
GenericFrame.createDisplay( LoginFrame.class );
RequestThread.postRequest( new LogoutRequest() );
}
public String toString()
{
return this.lastTitle;
}
public String getFrameName()
{
return this.frameName;
}
/**
* Method which adds a compact pane to the west side of the component. Note that this method can only be used if the
* KoLFrame on which it is called has not yet added any components. If there are any added components, this method
* will do nothing.
*/
public void addCompactPane()
{
if ( this.sidepane != null )
{
return;
}
this.sidepane = new CompactSidePane();
this.sidepane.run();
this.refreshListener = new KoLCharacterAdapter( this.sidepane );
KoLCharacter.addCharacterListener( this.refreshListener );
this.sidepane.setBackground( KoLConstants.ENABLED_COLOR );
this.getContentPane().add( this.sidepane, BorderLayout.WEST );
}
public void setStatusMessage( final String message )
{
}
public void updateDisplayState( final int displayState )
{
// Change the background of the frame based on
// the current display state -- but only if the
// compact pane has already been constructed.
switch ( displayState )
{
case KoLConstants.ABORT_STATE:
case KoLConstants.ERROR_STATE:
if ( this.sidepane != null )
{
this.sidepane.setBackground( KoLConstants.ERROR_COLOR );
}
this.setEnabled( true );
break;
case KoLConstants.ENABLE_STATE:
if ( this.sidepane != null )
{
this.sidepane.setBackground( KoLConstants.ENABLED_COLOR );
}
this.setEnabled( true );
break;
default:
if ( this.sidepane != null )
{
this.sidepane.setBackground( KoLConstants.DISABLED_COLOR );
}
this.setEnabled( false );
break;
}
}
/**
* Overrides the default isEnabled() method, because the setEnabled() method does not call the superclass's version.
*
* @return <code>true</code>
*/
public final boolean isEnabled()
{
return true;
}
public void setEnabled( final boolean isEnabled )
{
}
public void processWindowEvent( final WindowEvent e )
{
if ( this.isVisible() )
{
this.rememberPosition();
}
super.processWindowEvent( e );
if ( e.getID() == WindowEvent.WINDOW_CLOSING )
{
if ( KoLConstants.existingFrames.contains( this ) )
{
KoLConstants.existingFrames.remove( this );
KoLConstants.removedFrames.add( this );
this.checkForLogout();
}
}
else if ( e.getID() == WindowEvent.WINDOW_ACTIVATED )
{
if ( KoLConstants.removedFrames.contains( this ) )
{
KoLConstants.removedFrames.remove( this );
KoLConstants.existingFrames.add( this );
}
InputFieldUtilities.setActiveWindow( this );
}
}
public void setVisible( final boolean isVisible )
{
if ( isVisible )
{
this.restorePosition();
}
else
{
this.rememberPosition();
}
super.setVisible( isVisible );
if ( isVisible )
{
super.setExtendedState( Frame.NORMAL );
super.repaint();
KoLConstants.removedFrames.remove( this );
}
}
public void pack()
{
if ( !( this instanceof ChatFrame ) )
{
super.pack();
}
if ( !this.isVisible() )
{
this.restorePosition();
}
}
private void rememberPosition()
{
Point p = this.getLocation();
if ( this.tabs == null )
{
Preferences.setString( this.frameName, (int) p.getX() + "," + (int) p.getY() );
}
else
{
Preferences.setString(
this.frameName, (int) p.getX() + "," + (int) p.getY() + "," + this.tabs.getSelectedIndex() );
}
}
private void restorePosition()
{
int xLocation = 0;
int yLocation = 0;
Dimension screenSize = KoLConstants.TOOLKIT.getScreenSize();
String position = Preferences.getString( this.frameName );
if ( position == null || position.indexOf( "," ) == -1 )
{
this.setLocationRelativeTo( null );
if ( !( this instanceof OptionsFrame ) && this.tabs != null && this.tabs.getTabCount() > 0 )
{
this.tabs.setSelectedIndex( 0 );
}
return;
}
String[] location = position.split( "," );
xLocation = StringUtilities.parseInt( location[ 0 ] );
yLocation = StringUtilities.parseInt( location[ 1 ] );
if ( xLocation > 0 && yLocation > 0 && xLocation < screenSize.getWidth() && yLocation < screenSize.getHeight() )
{
this.setLocation( xLocation, yLocation );
}
else
{
this.setLocationRelativeTo( null );
}
if ( location.length > 2 && this.tabs != null )
{
int tabIndex = StringUtilities.parseInt( location[ 2 ] );
if ( tabIndex >= 0 && tabIndex < this.tabs.getTabCount() )
{
this.tabs.setSelectedIndex( tabIndex );
}
else if ( this.tabs.getTabCount() > 0 )
{
this.tabs.setSelectedIndex( 0 );
}
}
}
public static final void createDisplay( final Class frameClass )
{
KoLmafiaGUI.constructFrame( frameClass );
}
public static final void createDisplay( final Class frameClass, final Object[] parameters )
{
CreateFrameRunnable creator = new CreateFrameRunnable( frameClass, parameters );
creator.run();
}
public static final void compileScripts()
{
KoLConstants.scripts.clear();
// Get the list of files in the current directory
File[] scriptList = DataUtilities.listFiles( KoLConstants.SCRIPT_LOCATION );
// Iterate through the files. Do this in two
// passes to make sure that directories start
// up top, followed by non-directories.
int directoryIndex = 0;
for ( int i = 0; i < scriptList.length; ++i )
{
if ( !ScriptMenu.shouldAddScript( scriptList[ i ] ) )
{
}
else if ( scriptList[ i ].isDirectory() )
{
KoLConstants.scripts.add( directoryIndex++ , scriptList[ i ] );
}
else
{
KoLConstants.scripts.add( scriptList[ i ] );
}
}
}
/**
* Utility method to save the entire list of bookmarks to the settings file. This should be called after every
* update.
*/
public static final void saveBookmarks()
{
StringBuffer bookmarkData = new StringBuffer();
for ( int i = 0; i < KoLConstants.bookmarks.getSize(); ++i )
{
if ( i > 0 )
{
bookmarkData.append( '|' );
}
bookmarkData.append( (String) KoLConstants.bookmarks.getElementAt( i ) );
}
Preferences.setString( "browserBookmarks", bookmarkData.toString() );
}
/**
* Utility method to compile the list of bookmarks based on the current settings.
*/
public static final void compileBookmarks()
{
KoLConstants.bookmarks.clear();
String[] bookmarkData = Preferences.getString( "browserBookmarks" ).split( "\\|" );
if ( bookmarkData.length > 1 )
{
for ( int i = 0; i < bookmarkData.length; ++i )
{
KoLConstants.bookmarks.add( bookmarkData[ i ] + "|" + bookmarkData[ ++i ] + "|" + bookmarkData[ ++i ] );
}
}
}
}
The table below shows all metrics for GenericFrame.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 100.00 | Number of blocks | |
| BLOCK_COMMENT | 0.00 | Number of block comment lines | |
| COMMENTS | 70.00 | Comment lines | |
| COMMENT_DENSITY | 0.20 | Comment density | |
| COMPARISONS | 60.00 | Number of comparison operators | |
| CYCLOMATIC | 117.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 8.00 | Comments in declarations | |
| DOC_COMMENT | 61.00 | Number of javadoc comment lines | |
| ELOC | 353.00 | Effective lines of code | |
| EXEC_COMMENTS | 4.00 | Comments in executable code | |
| EXITS | 100.00 | Procedure exits | |
| FUNCTIONS | 42.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 79.47 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 77.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 | 6.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 | 1.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 | 2.00 | JAVA0016 Abstract class contains public constructor | |
| JAVA0017 | 0.00 | JAVA0017 Class name does not have required form | |
| JAVA0018 | 0.00 | JAVA0018 Method name does not have required form | |
| JAVA0019 | 0.00 | JAVA0019 Interface name does not have required form | |
| JAVA0020 | 0.00 | JAVA0020 Field name does not have required form | |
| JAVA0021 | 0.00 | JAVA0021 Interface method name does not have required form | |
| JAVA0022 | 0.00 | JAVA0022 Static final field name does not have required form | |
| JAVA0023 | 0.00 | JAVA0023 Empty finalize method | |
| JAVA0024 | 0.00 | JAVA0024 Empty class | |
| JAVA0025 | 1.00 | JAVA0025 Method override is empty | |
| JAVA0026 | 0.00 | JAVA0026 Finalize method with parameters | |
| JAVA0029 | 0.00 | JAVA0029 Private method not used | |
| JAVA0030 | 0.00 | JAVA0030 Private field not used | |
| JAVA0031 | 1.00 | JAVA0031 Case statement not properly closed | |
| JAVA0032 | 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 | 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 | 6.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 19.00 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0118 | 1.00 | JAVA0118 Missing javadoc: type 'type' | |
| JAVA0119 | 2.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 | 2.00 | JAVA0130 Non-static method does not use instance fields | |
| JAVA0131 | 1.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 | 1.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 | 2.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 1121.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 | 1.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 | 0.00 | JAVA0234 Class is Serializable but does not define serialVersionUID | |
| JAVA0235 | 0.00 | JAVA0235 Class defines serialVersionUID but does not implement Serializable | |
| JAVA0236 | 0.00 | JAVA0236 Attempt to clone an object which does not implement Cloneable | |
| JAVA0237 | 0.00 | JAVA0237 Class implements Cloneable but does not have public clone method | |
| JAVA0238 | 0.00 | JAVA0238 Clone method does not call super.clone() | |
| JAVA0239 | 0.00 | JAVA0239 Class declares 'readObject' or 'writeObject' but does not implement Serializable | |
| JAVA0240 | 0.00 | JAVA0240 Serializable class which declares readObject or writeObject but not both | |
| JAVA0241 | 0.00 | JAVA0241 'readObject' or 'writeObject' should be declared private in Serializable class | |
| JAVA0242 | 0.00 | JAVA0242 Transient field in non-Serializable class | |
| JAVA0243 | 0.00 | JAVA0243 'readResolve' or 'writeReplace' should be declared private or protected | |
| JAVA0244 | 0.00 | JAVA0244 Field or method name in subclass differs only by case from inherited field or method | |
| JAVA0245 | 0.00 | JAVA0245 JUnit TestCase with non-trivial constructor | |
| JAVA0246 | 0.00 | JAVA0246 JUnit assertXXX statement missing message parameter | |
| JAVA0247 | 0.00 | JAVA0247 JUnit 'setUp()' and 'tearDown()' should call super method | |
| JAVA0248 | 0.00 | JAVA0248 JUnit method 'setUp' or 'tearDown' with incorrect signature | |
| JAVA0249 | 0.00 | JAVA0249 JUnit TestCase 'suite()' should be declared static | |
| JAVA0250 | 0.00 | JAVA0250 JUnit TestCase declares testXXX method with incorrect signature | |
| JAVA0251 | 0.00 | JAVA0251 Use '%n' for line breaks in printf/format for platform independence | |
| JAVA0252 | 0.00 | JAVA0252 'enum' is a Java 1.5 reserved word | |
| JAVA0253 | 0.00 | JAVA0253 Not all enum constants consumed in switch statement | |
| JAVA0254 | 0.00 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| JAVA0255 | 0.00 | JAVA0255 Result of method invocation not used | |
| JAVA0256 | 0.00 | JAVA0256 Assignment of external collection/array to field | |
| JAVA0257 | 0.00 | JAVA0257 Use of 'Constant Interface' anti-pattern | |
| JAVA0258 | 0.00 | JAVA0258 Implement Iterable for foreach compatibility | |
| JAVA0259 | 0.00 | JAVA0259 Return of collection/array field | |
| JAVA0260 | 0.00 | JAVA0260 Use 'enum' instead of Enumerated Type pattern | |
| JAVA0261 | 0.00 | JAVA0261 Use specialized Enum collection types | |
| JAVA0262 | 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 | 2.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 | 1.00 | JAVA0287 Unnecessary null check | |
| JAVA0288 | 0.00 | JAVA0288 Inconsistent null check | |
| LINES | 767.00 | Number of lines in the source file | |
| LINE_COMMENT | 9.00 | Number of line comments | |
| LOC | 563.00 | Lines of code | |
| LOGICAL_LINES | 238.00 | Number of statements | |
| LOOPS | 4.00 | Number of loops | |
| NEST_DEPTH | 3.00 | Maximum nesting depth | |
| OPERANDS | 989.00 | Number of operands | |
| OPERATORS | 2308.00 | Number of operators | |
| PARAMS | 25.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 3297.00 | Halstead program length | |
| PROGRAM_VOCAB | 390.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 52.00 | Number of return points from functions | |
| SIZE | 20074.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 336.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 54.00 | Number of unique operators | |
| WHITESPACE | 134.00 | Number of whitespace lines | |