FreeColClient.java
| Index Score | ||
|---|---|---|
 |
 |
net.sf.freecol.client |
 |
 |
FreeCol |
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 | |
|---|---|---|
| DECL_COMMENTS | Comments in declarations |  |
| DOC_COMMENT | Number of javadoc comment lines | |
| COMMENTS | Comment lines | |
| EXITS | Procedure exits | |
| FUNCTIONS | Number of function declarations | |
| SIZE | Size of the file in bytes | |
| LINES | Number of lines in the source file | |
| UNIQUE_OPERANDS | Number of unique operands | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| BLOCKS | Number of blocks | |
| RETURNS | Number of return points from functions | |
| LOGICAL_LINES | Number of statements | |
| CYCLOMATIC | Cyclomatic complexity | |
| JAVA0143 | JAVA0143 Synchronized method | |
| ELOC | Effective lines of code | |
| OPERATORS | Number of operators | |
| LOC | Lines of code | |
| PROGRAM_LENGTH | Halstead program length | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| OPERANDS | Number of operands | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| 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 | |
| UNIQUE_OPERATORS | Number of unique operators | |
| JAVA0100 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| LOOPS | Number of loops | |
| JAVA0075 | JAVA0075 Method parameter hides field | |
| NEST_DEPTH | Maximum nesting depth | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
/**
* Copyright (C) 2002-2007 The FreeCol Team
*
* This file is part of FreeCol.
*
* FreeCol is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 2 of the License, or
* (at your option) any later version.
*
* FreeCol is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with FreeCol. If not, see <http://www.gnu.org/licenses/>.
*/
package net.sf.freecol.client;
import java.awt.Dimension;
import java.awt.GraphicsDevice;
import java.awt.GraphicsEnvironment;
import java.awt.Rectangle;
import java.beans.PropertyChangeEvent;
import java.beans.PropertyChangeListener;
import java.io.File;
import java.util.LinkedList;
import java.util.Locale;
import java.util.Queue;
import java.util.Random;
import java.util.logging.Logger;
import javax.swing.JFrame;
import javax.swing.SwingUtilities;
import net.sf.freecol.FreeCol;
import net.sf.freecol.client.control.ClientModelController;
import net.sf.freecol.client.control.ConnectController;
import net.sf.freecol.client.control.InGameController;
import net.sf.freecol.client.control.InGameInputHandler;
import net.sf.freecol.client.control.MapEditorController;
import net.sf.freecol.client.control.PreGameController;
import net.sf.freecol.client.control.PreGameInputHandler;
import net.sf.freecol.client.gui.Canvas;
import net.sf.freecol.client.gui.FullScreenFrame;
import net.sf.freecol.client.gui.GUI;
import net.sf.freecol.client.gui.ImageLibrary;
import net.sf.freecol.client.gui.WindowedFrame;
import net.sf.freecol.client.gui.action.ActionManager;
import net.sf.freecol.client.gui.i18n.Messages;
import net.sf.freecol.client.gui.sound.MusicLibrary;
import net.sf.freecol.client.gui.sound.SfxLibrary;
import net.sf.freecol.client.gui.sound.SoundLibrary;
import net.sf.freecol.client.gui.sound.SoundPlayer;
import net.sf.freecol.client.networking.Client;
import net.sf.freecol.common.PseudoRandom;
import net.sf.freecol.common.model.Game;
import net.sf.freecol.common.model.Player;
import net.sf.freecol.common.model.UnitType;
import net.sf.freecol.common.networking.Message;
import net.sf.freecol.common.option.AudioMixerOption;
import net.sf.freecol.common.option.LanguageOption;
import net.sf.freecol.common.option.Option;
import net.sf.freecol.common.option.PercentageOption;
import net.sf.freecol.common.option.LanguageOption.Language;
import net.sf.freecol.server.FreeColServer;
import org.w3c.dom.Element;
/**
* The main control class for the FreeCol client. This class both starts and
* keeps references to the GUI and the control objects.
*/
public final class FreeColClient {
private static final Logger logger = Logger.getLogger(FreeColClient.class.getName());
// Control:
private ConnectController connectController;
private PreGameController preGameController;
private PreGameInputHandler preGameInputHandler;
private InGameController inGameController;
private InGameInputHandler inGameInputHandler;
private ClientModelController modelController;
private MapEditorController mapEditorController;
// Gui:
private GraphicsDevice gd;
private JFrame frame;
private Canvas canvas;
private GUI gui;
private ImageLibrary imageLibrary;
private MusicLibrary musicLibrary;
private SfxLibrary sfxLibrary;
@SuppressWarnings("unused")
private SoundPlayer musicPlayer;
private SoundPlayer sfxPlayer;
// Networking:
/**
* The network <code>Client</code> that can be used to send messages to
* the server.
*/
private Client client;
// Model:
private Game game;
private final PseudoRandom _random = new ClientPseudoRandom();
/** The player "owning" this client. */
private Player player;
/** The Server that has been started from the client-GUI. */
private FreeColServer freeColServer = null;
private boolean windowed;
private boolean mapEditor;
private boolean singleplayer;
private final ActionManager actionManager;
private ClientOptions clientOptions;
public final Worker worker;
/**
* Indicated whether or not there is an open connection to the server. This
* is not an indication of the existence of a Connection Object, but instead
* it is an indication of an approved login to a server.
*/
private boolean loggedIn = false;
private Rectangle windowBounds;
/**
* Creates a new <code>FreeColClient</code>. Creates the control objects
* and starts the GUI.
*
* @param windowed Determines if the <code>Canvas</code> should be
* displayed within a <code>JFrame</code> (when
* <code>true</code>) or in fullscreen mode (when
* <code>false</code>).
* @param innerWindowSize The inner size of the window (borders not included).
* @param imageLibrary The object holding the images.
* @param musicLibrary The object holding the music.
* @param sfxLibrary The object holding the sound effects.
*/
public FreeColClient(boolean windowed, final Dimension innerWindowSize,
ImageLibrary imageLibrary, MusicLibrary musicLibrary,
SfxLibrary sfxLibrary) {
boolean headless = "true".equals(System.getProperty("java.awt.headless", "false"));
this.windowed = windowed;
this.imageLibrary = imageLibrary;
this.musicLibrary = musicLibrary;
this.sfxLibrary = sfxLibrary;
mapEditor = false;
clientOptions = new ClientOptions();
actionManager = new ActionManager(this);
if (!headless) {
actionManager.initializeActions();
}
// Control:
connectController = new ConnectController(this);
preGameController = new PreGameController(this);
preGameInputHandler = new PreGameInputHandler(this);
inGameController = new InGameController(this);
inGameInputHandler = new InGameInputHandler(this);
modelController = new ClientModelController(this);
mapEditorController = new MapEditorController(this);
// Gui:
if (!headless) {
SwingUtilities.invokeLater(new Runnable() {
public void run() {
startGUI(innerWindowSize);
}
});
}
worker = new Worker();
worker.start();
if (FreeCol.getClientOptionsFile() != null
&& FreeCol.getClientOptionsFile().exists()) {
clientOptions.load(FreeCol.getClientOptionsFile());
if (!headless) {
Option o = clientOptions.getObject(ClientOptions.LANGUAGE);
o.addPropertyChangeListener(new PropertyChangeListener() {
public void propertyChange(PropertyChangeEvent e) {
if (((Language) e.getNewValue()).getKey().equals(LanguageOption.AUTO)) {
canvas.showInformationMessage("autodetectLanguageSelected");
} else {
Locale l = ((Language) e.getNewValue()).getLocale();
Messages.setMessageBundle(l);
canvas.showInformationMessage("newLanguageSelected", "%language%", l.getDisplayName());
}
}
});
}
}
}
/**
* Starts the GUI by creating and displaying the GUI-objects.
*/
private void startGUI(Dimension innerWindowSize) {
final AudioMixerOption amo = (AudioMixerOption) getClientOptions().getObject(ClientOptions.AUDIO_MIXER);
if (musicLibrary != null) {
musicPlayer = new SoundPlayer(amo,
(PercentageOption) getClientOptions().getObject(ClientOptions.MUSIC_VOLUME),
false,
true);
playMusic("intro");
} else {
musicPlayer = null;
}
if (sfxLibrary != null) {
sfxPlayer = new SoundPlayer(amo,
(PercentageOption) getClientOptions().getObject(ClientOptions.SFX_VOLUME),
true,
false);
} else {
sfxPlayer = null;
}
if (GraphicsEnvironment.isHeadless()) {
logger.info("It seems that the GraphicsEnvironment is headless!");
}
gd = GraphicsEnvironment.getLocalGraphicsEnvironment().getDefaultScreenDevice();
if (!windowed) {
if (!gd.isFullScreenSupported()) {
String fullscreenNotSupported = "\nIt seems that full screen mode is not fully supported for this\nGraphicsDevice. Please try the \"--windowed\" option if you\nexperience any graphical problems while running FreeCol.";
logger.info(fullscreenNotSupported);
System.out.println(fullscreenNotSupported);
/*
* We might want this behavior later: logger.warning("It seems
* that full screen mode is not supported for this
* GraphicsDevice! Using windowed mode instead."); windowed =
* true; setWindowed(true); frame = new
* WindowedFrame(windowSize);
*/
}
Rectangle bounds = gd.getDefaultConfiguration().getBounds();
innerWindowSize = new Dimension(bounds.width - bounds.x, bounds.height - bounds.y);
}
gui = new GUI(this, innerWindowSize, imageLibrary);
canvas = new Canvas(this, innerWindowSize, gui);
changeWindowedMode(windowed);
UnitType galleonType = FreeCol.getSpecification().getUnitType("model.unit.galleon");
frame.setIconImage(imageLibrary.getUnitImageIcon(galleonType).getImage());
SwingUtilities.invokeLater(new Runnable() {
public void run() {
canvas.showMainPanel();
}
});
gui.startCursorBlinking();
}
/**
* Change the windowed mode.
* @param windowed Use <code>true</code> for windowed mode
* and <code>false</code> for fullscreen mode.
*/
public void changeWindowedMode(boolean windowed) {
if (frame != null) {
if (frame instanceof WindowedFrame) {
windowBounds = frame.getBounds();
}
frame.setVisible(false);
frame.dispose();
}
this.windowed = windowed;
if (windowed) {
frame = new WindowedFrame();
} else {
frame = new FullScreenFrame(gd);
}
if (frame instanceof WindowedFrame) {
((WindowedFrame) frame).setCanvas(canvas);
frame.getContentPane().add(canvas);
if (windowBounds != null) {
frame.setBounds(windowBounds);
} else {
frame.pack();
}
} else if (frame instanceof FullScreenFrame) {
((FullScreenFrame) frame).setCanvas(canvas);
frame.getContentPane().add(canvas);
canvas.setSize(frame.getSize());
}
gui.forceReposition();
canvas.updateSizes();
frame.setVisible(true);
}
/**
* Checks if the application is displayed in a window.
* @return <code>true</code> if the application is currently
* displayed in a frame, and <code>false</code> if
* currently in fullscreen mode.
* @see #changeWindowedMode
*/
public boolean isWindowed() {
return windowed;
}
/**
* Writes the client options to the default location.
*
* @see ClientOptions
*/
public void saveClientOptions() {
saveClientOptions(FreeCol.getClientOptionsFile());
}
public void setMapEditor(boolean mapEditor) {
this.mapEditor = mapEditor;
}
public boolean isMapEditor() {
return mapEditor;
}
/**
* Writes the client options to the given file.
*
* @param saveFile The file where the client options should be written.
* @see ClientOptions
*/
public void saveClientOptions(File saveFile) {
getClientOptions().save(saveFile);
}
/**
* Gets the <code>ImageLibrary</code>.
*
* @return The <code>ImageLibrary</code>.
*/
public ImageLibrary getImageLibrary() {
return imageLibrary;
}
/**
* Reads the {@link ClientOptions} from the given file.
*/
public void loadClientOptions() {
loadClientOptions(FreeCol.getClientOptionsFile());
}
/**
* Reads the {@link ClientOptions} from the given file.
*
* @param loadFile The <code>File</code> to read the
* <code>ClientOptions</code> from.
*/
public void loadClientOptions(File loadFile) {
getClientOptions().load(loadFile);
}
/**
* Gets the object responsible for keeping and updating the actions.
*
* @return The <code>ActionManager</code>.
*/
public ActionManager getActionManager() {
return actionManager;
}
/**
* Returns the object keeping the current client options.
*
* @return The <code>ClientOptions</code>.
*/
public ClientOptions getClientOptions() {
return clientOptions;
}
public MapEditorController getMapEditorController() {
return mapEditorController;
}
/**
* Gets the <code>Player</code> that uses this client.
*
* @return The <code>Player</code> made to represent this clients user.
* @see #setMyPlayer(Player)
*/
public Player getMyPlayer() {
return player;
}
/**
* Sets the <code>Player</code> that uses this client.
*
* @param player The <code>Player</code> made to represent this clients
* user.
* @see #getMyPlayer()
*/
public void setMyPlayer(Player player) {
this.player = player;
}
/**
* Sets the <code>FreeColServer</code> which has been started by the
* client gui.
*
* @param freeColServer The <code>FreeColServer</code>.
* @see #getFreeColServer()
*/
public void setFreeColServer(FreeColServer freeColServer) {
this.freeColServer = freeColServer;
}
/**
* Gets the <code>FreeColServer</code> started by the client.
*
* @return The <code>FreeColServer</code> or <code>null</code> if no
* server has been started.
*/
public FreeColServer getFreeColServer() {
return freeColServer;
}
/**
* Sets the <code>Game</code> that we are currently playing.
*
* @param game The <code>Game</code>.
* @see #getGame
*/
public void setGame(Game game) {
this.game = game;
}
/**
* Gets the <code>Game</code> that we are currently playing.
*
* @return The <code>Game</code>.
* @see #setGame
*/
public Game getGame() {
return game;
}
/**
* Gets the <code>Canvas</code> this client uses to display the
* GUI-components.
*
* @return The <code>Canvas</code>.
*/
public Canvas getCanvas() {
return canvas;
}
/**
* Gets the <code>GUI</code> that is being used to draw the map on the
* {@link Canvas}.
*
* @return The <code>GUI</code>.
*/
public GUI getGUI() {
return gui;
}
/**
* Quits the application without any questions.
*/
public void quit() {
getConnectController().quitGame(true);
if (!windowed) {
gd.setFullScreenWindow(null);
}
System.exit(0);
}
/**
* Continue playing after win the game
*/
public void continuePlaying() {
Element continueElement = Message.createNewRootElement("continuePlaying");
client.send(continueElement);
}
/**
* Checks if this client is the game admin.
*
* @return <i>true</i> if the client is the game admin and <i>false</i>
* otherwise. <i>false</i> is also returned if a game have not yet
* been started.
*/
public boolean isAdmin() {
if (getMyPlayer() == null) {
return false;
}
return getMyPlayer().isAdmin();
}
/**
* Sets the type of main window to display.
*
* @param windowed The main window is a full-screen window if set to
* <i>false</i> and a normal window otherwise.
*/
// private void setWindowed(boolean windowed) {
// this.windowed = windowed;
// }
/**
* Sets whether or not this game is a singleplayer game.
*
* @param singleplayer Indicates whether or not this game is a singleplayer
* game.
* @see #isSingleplayer
*/
public void setSingleplayer(boolean singleplayer) {
this.singleplayer = singleplayer;
}
/**
* Is the user playing in singleplayer mode.
*
* @return <i>true</i> if the user is playing in singleplayer mode and
* <i>false</i> otherwise.
* @see #setSingleplayer
*/
public boolean isSingleplayer() {
return singleplayer;
}
/**
* Gets the controller responsible for starting a server and connecting to
* it.
*
* @return The <code>ConnectController</code>.
*/
public ConnectController getConnectController() {
return connectController;
}
/**
* Gets the controller that will be used before the game has been started.
*
* @return The <code>PreGameController</code>.
*/
public PreGameController getPreGameController() {
return preGameController;
}
/**
* Gets the input handler that will be used before the game has been
* started.
*
* @return The <code>PreGameInputHandler</code>.
*/
public PreGameInputHandler getPreGameInputHandler() {
return preGameInputHandler;
}
/**
* Gets the controller that will be used when the game has been started.
*
* @return The <code>InGameController</code>.
*/
public InGameController getInGameController() {
return inGameController;
}
/**
* Gets the input handler that will be used when the game has been started.
*
* @return The <code>InGameInputHandler</code>.
*/
public InGameInputHandler getInGameInputHandler() {
return inGameInputHandler;
}
/**
* Gets the <code>ClientModelController</code>.
*
* @return The <code>ClientModelController</code>.
*/
public ClientModelController getModelController() {
return modelController;
}
/**
* Sets the <code>Client</code> that shall be used to send messages to the
* server.
*
* @param client the <code>Client</code>
* @see #getClient
*/
public void setClient(Client client) {
this.client = client;
}
/**
* Gets the <code>Client</code> that can be used to send messages to the
* server.
*
* @return the <code>Client</code>
* @see #setClient
*/
public Client getClient() {
return client;
}
/**
* Plays the music.
*/
public void playMusic(String music) {
if (musicPlayer != null) {
musicPlayer.play(musicLibrary.get(music));
}
}
/**
* Plays a random music from the given playlist.
*/
public void playMusicOnce(String music) {
if (musicPlayer != null) {
musicPlayer.playOnce(musicLibrary.get(music));
}
}
/**
* Plays a random music from the given playlist.
* @param delay A delay before playing the sound (ms).
*/
public void playMusicOnce(String music, int delay) {
if (musicPlayer != null) {
musicPlayer.playOnce(musicLibrary.get(music), delay);
}
}
/**
* Plays the given sound effect.
*
* @param sound The key sound effect given by {@link SfxLibrary}.
*/
public void playSound(String sound) {
if (sfxPlayer != null) {
sfxPlayer.play(sfxLibrary.get(sound));
}
}
/**
* Plays the given sound effect.
*
* @param sound The key sound effect given by {@link SfxLibrary}.
*/
public void playSound(SoundLibrary.SoundEffect sound) {
if (sfxPlayer != null) {
sfxPlayer.play(sfxLibrary.get(sound));
}
}
/**
* Returns <i>true</i> if this client is logged in to a server or <i>false</i>
* otherwise.
*
* @return <i>true</i> if this client is logged in to a server or <i>false</i>
* otherwise.
*/
public boolean isLoggedIn() {
return loggedIn;
}
/**
* Sets whether or not this client is logged in to a server.
*
* @param loggedIn An indication of whether or not this client is logged in
* to a server.
*/
public void setLoggedIn(boolean loggedIn) {
this.loggedIn = loggedIn;
}
/**
* Get the pseudo-random number generator for the client.
*
* @return random number generator.
*/
public PseudoRandom getPseudoRandom() {
return _random;
}
/**
* This class provides server-generated random numbers for client-side use.
* It requires a server connection. If the connection is unavailable it will
* generate random numbers on the client side rather than failing.
*/
private class ClientPseudoRandom implements PseudoRandom {
ClientPseudoRandom() {
values = new LinkedList<Integer>();
offlineRandom = new Random();
}
/**
* Get the next pseudo-random integer between 0 and n.
*
* @param n The upper bound (exclusive).
* @return random number between 0 (inclusive) and n (exclusive).
*/
public int nextInt(int n) {
if (n <= 0) {
throw new IllegalArgumentException("n must be positive!");
}
// TODO (Erik): get random int in given range.
// This may not be good enough, as the low bits may be less
// random than the entire range. See the Random class for a
// more advanced implementation.
return Math.abs(nextInt() % n);
}
/**
* Get the next pseudo-random integer.
* <p>
* The method requires one network call per {@link #VALUES_PER_CALL}
* requests. If multiple threads are active a single thread may
* theoretically have to wait indefinitely, but in practice this is not
* very likely.
*
* @return next random integer.
*/
private int nextInt() {
Integer i = pop();
while (i == null) {
getNewNumbers();
i = pop();
}
return i.intValue();
}
/**
* Get new numbers to the queue from the server, generate on client side
* if not connected. The method is guaranteed to generate at least one
* new number.
*/
private void getNewNumbers() {
int valuesAdded = 0;
if (isLoggedIn()) {
Element query = Message.createNewRootElement("getRandomNumbers");
query.setAttribute("n", String.valueOf(VALUES_PER_CALL));
// We expect client != null when logged in
Element answer = getClient().ask(query);
if (answer != null && "getRandomNumbersConfirmed".equals(answer.getTagName())) {
for (String s : answer.getAttribute("result").split(",")) {
push(new Integer(s));
++valuesAdded;
}
} else {
logger.warning("Expected getRandomNumbersConfirmed, got "
+ (answer != null ? answer.getTagName() : "null"));
}
}
// Fallback solution on errors (we don't want to crash the game)
if (valuesAdded < 1) {
logger.fine("Generating random number on client side");
push(Integer.valueOf(offlineRandom.nextInt()));
}
}
private synchronized void push(Integer i) {
values.offer(i);
}
private synchronized Integer pop() {
return values.poll();
}
private final Random offlineRandom;
private final Queue<Integer> values;
private static final int VALUES_PER_CALL = 100;
}
}
The table below shows all metrics for FreeColClient.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 87.00 | Number of blocks | |
| BLOCK_COMMENT | 7.00 | Number of block comment lines | |
| COMMENTS | 311.00 | Comment lines | |
| COMMENT_DENSITY | 1.00 | Comment density | |
| COMPARISONS | 24.00 | Number of comparison operators | |
| CYCLOMATIC | 83.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 56.00 | Comments in declarations | |
| DOC_COMMENT | 289.00 | Number of javadoc comment lines | |
| ELOC | 310.00 | Effective lines of code | |
| EXEC_COMMENTS | 6.00 | Comments in executable code | |
| EXITS | 87.00 | Procedure exits | |
| FUNCTIONS | 52.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 61.36 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 81.00 | Interface complexity | |
| JAVA0001 | 0.00 | JAVA0001 Package name does not contain only lower case letters | |
| JAVA0002 | 0.00 | JAVA0002 Package name does not begin with a top level domain name or country code | |
| JAVA0003 | 0.00 | JAVA0003 Minimize use of on-demand (.*) imports | |
| JAVA0004 | 0.00 | JAVA0004 Unnecessary import from java.lang | |
| JAVA0005 | 0.00 | JAVA0005 Imports not in specified order | |
| JAVA0006 | 0.00 | JAVA0006 Empty finally block | |
| JAVA0007 | 0.00 | JAVA0007 Should not declare public field | |
| JAVA0008 | 0.00 | JAVA0008 Empty catch block | |
| JAVA0009 | 0.00 | JAVA0009 Protected member in final class | |
| JAVA0010 | 0.00 | JAVA0010 Non-instantiable class does not contain a non-private static member | |
| JAVA0011 | 0.00 | JAVA0011 Abstract class does not contain an abstract method | |
| JAVA0012 | 0.00 | JAVA0012 Non-constructor method with same name as declaring class | |
| JAVA0013 | 0.00 | JAVA0013 Non-blank final field is not static | |
| JAVA0014 | 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 | 0.00 | JAVA0018 Method name does not have required form | |
| JAVA0019 | 0.00 | JAVA0019 Interface name does not have required form | |
| JAVA0020 | 0.00 | JAVA0020 Field name does not have required form | |
| JAVA0021 | 0.00 | JAVA0021 Interface method name does not have required form | |
| JAVA0022 | 0.00 | JAVA0022 Static final field name does not have required form | |
| JAVA0023 | 0.00 | JAVA0023 Empty finalize method | |
| JAVA0024 | 0.00 | JAVA0024 Empty class | |
| JAVA0025 | 0.00 | JAVA0025 Method override is empty | |
| JAVA0026 | 0.00 | JAVA0026 Finalize method with parameters | |
| JAVA0029 | 0.00 | JAVA0029 Private method not used | |
| JAVA0030 | 0.00 | JAVA0030 Private field not used | |
| JAVA0031 | 0.00 | JAVA0031 Case statement not properly closed | |
| JAVA0032 | 0.00 | JAVA0032 Switch statement missing default | |
| JAVA0033 | 0.00 | JAVA0033 default: not last case in switch statement | |
| JAVA0034 | 0.00 | JAVA0034 Missing braces in if statement | |
| JAVA0035 | 0.00 | JAVA0035 Missing braces in for statement | |
| JAVA0036 | 0.00 | JAVA0036 Missing braces in while statement | |
| JAVA0038 | 0.00 | JAVA0038 Non-case label in switch statement | |
| JAVA0039 | 0.00 | JAVA0039 Break statement with label | |
| JAVA0040 | 0.00 | JAVA0040 Switch statement contains N cases (maximum: M) | |
| JAVA0041 | 0.00 | JAVA0041 Nested synchronized block | |
| JAVA0042 | 0.00 | JAVA0042 Empty synchronized statement | |
| JAVA0043 | 0.00 | JAVA0043 Inner class does not use outer class | |
| JAVA0044 | 0.00 | JAVA0044 Serializable class with no instance variables | |
| JAVA0045 | 0.00 | JAVA0045 Serializable class with only transient fields | |
| JAVA0046 | 0.00 | JAVA0046 Name of class not derived from Exception ends with 'Exception' | |
| JAVA0047 | 0.00 | JAVA0047 Serializable class derives from invalid base class | |
| JAVA0048 | 0.00 | JAVA0048 Name of class derived from Exception does not end with 'Exception' | |
| JAVA0049 | 0.00 | JAVA0049 Nested block at depth N (maximum: M) | |
| JAVA0050 | 0.00 | JAVA0050 Class derives from java.lang.Error | |
| JAVA0051 | 0.00 | JAVA0051 Class derives from java.lang.RuntimeException | |
| JAVA0052 | 0.00 | JAVA0052 Class derives from java.lang.Throwable | |
| JAVA0053 | 0.00 | JAVA0053 Unused label | |
| JAVA0054 | 0.00 | JAVA0054 Inheritance depth N exceeds maximum M | |
| JAVA0055 | 0.00 | JAVA0055 Class should be interface | |
| JAVA0056 | 0.00 | JAVA0056 Unnecessary abstract modifier for interface or annotation | |
| JAVA0057 | 0.00 | JAVA0057 Unnecessary default constructor | |
| JAVA0058 | 0.00 | JAVA0058 Constructor calls super() | |
| JAVA0059 | 0.00 | JAVA0059 Method override only calls super() | |
| JAVA0061 | 0.00 | JAVA0061 Inaccessible member in anonymous class | |
| JAVA0062 | 0.00 | JAVA0062 Public class missing public member or protected constructor | |
| JAVA0063 | 0.00 | JAVA0063 Identifier name should not contain '$' | |
| JAVA0064 | 0.00 | JAVA0064 N variations of identifier name (maximum: M) | |
| JAVA0065 | 0.00 | JAVA0065 Unnecessary final modifier for method in final class | |
| JAVA0066 | 0.00 | JAVA0066 Unnecessary modifier for interface nested type | |
| JAVA0067 | 0.00 | JAVA0067 Array descriptor on identifier name | |
| JAVA0068 | 0.00 | JAVA0068 Modifiers not declared in recommended order | |
| JAVA0071 | 0.00 | JAVA0071 Strings compared with == | |
| JAVA0073 | 0.00 | JAVA0073 Integer division in floating-point context | |
| JAVA0074 | 0.00 | JAVA0074 Use of Object.notify() | |
| JAVA0075 | 1.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 | 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 | 4.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 | 1.00 | JAVA0113 Incorrect javadoc: no @author tag | |
| JAVA0114 | 1.00 | JAVA0114 Incorrect javadoc: no @version tag | |
| JAVA0115 | 0.00 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0116 | 1.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 3.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 | 0.00 | JAVA0130 Non-static method does not use instance fields | |
| JAVA0131 | 0.00 | JAVA0131 Compatible method does not override base | |
| JAVA0132 | 0.00 | JAVA0132 Method overload with compatible signature | |
| JAVA0133 | 0.00 | JAVA0133 Non-synchronized method overrides synchronized method | |
| JAVA0135 | 0.00 | JAVA0135 Only one of Object.equals and Object.hashCode defined: missing 'method' | |
| JAVA0136 | 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 | 2.00 | JAVA0143 Synchronized method | |
| JAVA0144 | 1.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 4.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 | 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 | 1.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 | 803.00 | Number of lines in the source file | |
| LINE_COMMENT | 15.00 | Number of line comments | |
| LOC | 392.00 | Lines of code | |
| LOGICAL_LINES | 207.00 | Number of statements | |
| LOOPS | 1.00 | Number of loops | |
| NEST_DEPTH | 5.00 | Maximum nesting depth | |
| OPERANDS | 843.00 | Number of operands | |
| OPERATORS | 1626.00 | Number of operators | |
| PARAMS | 25.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 2469.00 | Halstead program length | |
| PROGRAM_VOCAB | 362.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 56.00 | Number of return points from functions | |
| SIZE | 25205.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 316.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 46.00 | Number of unique operators | |
| WHITESPACE | 100.00 | Number of whitespace lines | |