FreeCol.java
| Index Score | ||
|---|---|---|
 |
 |
net.sf.freecol |
 |
|
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 | |
|---|---|---|
| JAVA0266 | JAVA0266 Use of System.out |  |
| LOGICAL_LINES | Number of statements | |
| SIZE | Size of the file in bytes | |
| BLOCKS | Number of blocks | |
| PROGRAM_LENGTH | Halstead program length | |
| OPERATORS | Number of operators | |
| OPERANDS | Number of operands | |
| ELOC | Effective lines of code | |
| EXITS | Procedure exits | |
| UNIQUE_OPERANDS | Number of unique operands | |
| LOC | Lines of code | |
| CYCLOMATIC | Cyclomatic complexity | |
| JAVA0119 | JAVA0119 Control variable changed within body of for loop | |
| JAVA0049 | JAVA0049 Nested block at depth N (maximum: M) | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| LINES | Number of lines in the source file | |
| COMPARISONS | Number of comparison operators | |
| JAVA0166 | JAVA0166 Generic exception caught | |
| JAVA0076 | JAVA0076 Use of magic number | |
| JAVA0177 | JAVA0177 Variable declaration missing initializer | |
| JAVA0267 | JAVA0267 Use of System.err | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| DECL_COMMENTS | Comments in declarations | |
| JAVA0265 | JAVA0265 Use of Throwable.printStackTrace() | |
| EXEC_COMMENTS | Comments in executable code | |
| DOC_COMMENT | Number of javadoc comment lines | |
| RETURNS | Number of return points from functions | |
| JAVA0270 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| JAVA0144 | JAVA0144 Line exceeds maximum M characters | |
| UNIQUE_OPERATORS | Number of unique operators | |
| NEST_DEPTH | Maximum nesting depth | |
| PROGRAM_VOLUME | Halstead program volume | |
| COMMENTS | Comment lines | |
| JAVA0136 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0030 | JAVA0030 Private field not used | |
| JAVA0123 | JAVA0123 Use all three components of for loop | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| LOOPS | Number of loops | |
| JAVA0100 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| FUNCTIONS | Number of function declarations | |
| PARAMS | Number of formal parameter declarations | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| 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;
import java.awt.Dimension;
import java.awt.GraphicsEnvironment;
import java.awt.Image;
import java.awt.Point;
import java.awt.Rectangle;
import java.awt.Toolkit;
import java.io.BufferedReader;
import java.io.File;
import java.io.FileReader;
import java.io.IOException;
import java.lang.Thread.UncaughtExceptionHandler;
import java.util.Locale;
import java.util.jar.Attributes;
import java.util.jar.Manifest;
import java.util.logging.Handler;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.swing.ImageIcon;
import javax.swing.JLabel;
import javax.swing.JWindow;
import javax.swing.SwingUtilities;
import javax.swing.UIManager;
import javax.swing.UnsupportedLookAndFeelException;
import javax.xml.stream.XMLInputFactory;
import javax.xml.stream.XMLStreamReader;
import javax.xml.stream.events.XMLEvent;
import net.sf.freecol.client.ClientOptions;
import net.sf.freecol.client.FreeColClient;
import net.sf.freecol.client.gui.ImageLibrary;
import net.sf.freecol.client.gui.i18n.Messages;
import net.sf.freecol.client.gui.plaf.FreeColLookAndFeel;
import net.sf.freecol.client.gui.sound.MusicLibrary;
import net.sf.freecol.client.gui.sound.SfxLibrary;
import net.sf.freecol.common.FreeColException;
import net.sf.freecol.common.Specification;
import net.sf.freecol.common.io.FreeColDataFile;
import net.sf.freecol.common.io.FreeColSavegameFile;
import net.sf.freecol.common.io.FreeColTcFile;
import net.sf.freecol.common.logging.DefaultHandler;
import net.sf.freecol.common.networking.NoRouteToServerException;
import net.sf.freecol.common.option.LanguageOption;
import net.sf.freecol.common.resources.ResourceManager;
import net.sf.freecol.server.FreeColServer;
/**
* This class is responsible for handling the command-line arguments
* and starting either the stand-alone server or the client-GUI.
*
* @see net.sf.freecol.client.FreeColClient FreeColClient
* @see net.sf.freecol.server.FreeColServer FreeColServer
*/
public final class FreeCol {
public static final String META_SERVER_ADDRESS = "meta.freecol.org";
public static final int META_SERVER_PORT = 3540;
/**
* The space not being used in windowed mode.
*/
private static final int DEFAULT_WINDOW_SPACE = 100;
private static final Logger logger = Logger.getLogger(FreeCol.class.getName());
/**
* Initialized on first access. @See #getSpecification
*/
private static Specification specification;
private static final String FREECOL_VERSION = "test";
private static String FREECOL_REVISION;
private static final String MIN_JDK_VERSION = "1.5";
private static final String FILE_SEP = System.getProperty("file.separator");
private static final String DEFAULT_SPLASH_FILE = "splash.jpg";
private static final String DEFAULT_TC = "freecol";
private static boolean windowed = false,
sound = true,
javaCheck = true,
memoryCheck = true,
consoleLogging = false;
private static Dimension windowSize = new Dimension(-1, -1);
private static String dataFolder = "data" + FILE_SEP;
private static FreeColClient freeColClient;
private static boolean standAloneServer = false;
private static boolean inDebugMode = false;
private static int serverPort;
private static String serverName = null;
private static final int DEFAULT_PORT = 3541;
private static File mainUserDirectory;
private static File saveDirectory;
private static File tcUserDirectory;
private static String tc = DEFAULT_TC;
private static File savegameFile = null;
private static File clientOptionsFile = null;
private static Level logLevel = Level.INFO;
private FreeCol() {
// Hide constructor
}
/**
* The entrypoint.
*
* @param args The command-line arguments.
*/
public static void main(String[] args) {
try {
Manifest manifest = new Manifest(FreeCol.class.getResourceAsStream("/META-INF/MANIFEST.MF"));
Attributes attribs = manifest.getMainAttributes();
String revision = attribs.getValue("Revision");
FREECOL_REVISION = FREECOL_VERSION + " (Revision: " + revision + ")";
} catch (Exception e) {
System.out.println("Unable to load Manifest.");
FREECOL_REVISION = FREECOL_VERSION;
}
// Display splash screen:
JWindow splash = null;
for (int i=0; i<args.length; i++) {
if (args[i].startsWith("--splash")) {
String splashFile = DEFAULT_SPLASH_FILE;
if (args[i].indexOf('=') > 0) {
splashFile = args[i].substring(args[i].indexOf('=') + 1);
}
splash = displaySplash(splashFile);
break;
}
}
createAndSetDirectories();
initLogging();
Locale.setDefault(getLocale());
handleArgs(args);
if (javaCheck && !checkJavaVersion()) {
removeSplash(splash);
System.err.println("Java version " + MIN_JDK_VERSION +
" or better is recommended in order to run FreeCol." +
" Use --no-java-check to skip this check.");
return;
}
int minMemory = 128; // million bytes
if (memoryCheck && Runtime.getRuntime().maxMemory() < minMemory * 1000000) {
removeSplash(splash);
System.out.println("You need to assign more memory to the JVM. Restart FreeCol with:");
System.out.println("java -Xmx" + minMemory + "M -jar FreeCol.jar");
return;
}
try {
FreeColDataFile baseData = new FreeColDataFile(new File(dataFolder, "base"));
try {
ResourceManager.setBaseMapping(baseData.getResourceMapping());
} finally {
baseData.close();
}
} catch (IOException e) {
removeSplash(splash);
System.err.println("Could not find base data directory.");
return;
}
FreeColTcFile tcData;
try {
tcData = new FreeColTcFile(new File(dataFolder, tc));
try {
ResourceManager.setTcMapping(tcData.getResourceMapping());
} finally {
tcData.close();
}
} catch (IOException e) {
removeSplash(splash);
System.err.println("Could not load: " + tc);
return;
}
ResourceManager.update();
if (standAloneServer) {
logger.info("Starting stand-alone server.");
try {
final FreeColServer freeColServer;
if (savegameFile != null) {
FreeColSavegameFile fis = null;
try {
// Get suggestions for "singleplayer" and "public game" settings from the file:
fis = new FreeColSavegameFile(savegameFile);
XMLStreamReader in = FreeColServer.createXMLStreamReader(fis);
in.nextTag();
final boolean defaultSingleplayer = Boolean.valueOf(in.getAttributeValue(null, "singleplayer")).booleanValue();
final boolean defaultPublicServer;
final String publicServerStr = in.getAttributeValue(null, "publicServer");
if (publicServerStr != null) {
defaultPublicServer = Boolean.valueOf(publicServerStr).booleanValue();
} else {
defaultPublicServer = false;
}
in.close();
freeColServer = new FreeColServer(savegameFile, defaultPublicServer, defaultSingleplayer, serverPort, serverName);
} catch (Exception e) {
removeSplash(splash);
System.out.println("Could not load savegame.");
return;
} finally {
if (fis!=null) {
fis.close();
}
}
} else {
try {
freeColServer = new FreeColServer(true, false, serverPort, serverName);
} catch (NoRouteToServerException e) {
removeSplash(splash);
System.out.println(Messages.message("server.noRouteToServer"));
System.exit(1);
return;
}
}
Runtime runtime = Runtime.getRuntime();
runtime.addShutdownHook(new Thread() {
public void run() {
freeColServer.getController().shutdown();
}
});
} catch (IOException e) {
removeSplash(splash);
System.err.println("Error while loading server: " + e);
System.exit(-1);
}
} else {
final Rectangle bounds = GraphicsEnvironment.getLocalGraphicsEnvironment().getMaximumWindowBounds();
if (windowSize.width == -1 || windowSize.height == -1) {
// Allow room for frame handles, taskbar etc if using windowed mode:
windowSize.width = bounds.width - DEFAULT_WINDOW_SPACE;
windowSize.height = bounds.height - DEFAULT_WINDOW_SPACE;
}
final Dimension preloadSize;
if (windowed) {
preloadSize = windowSize;
} else {
preloadSize = new Dimension(bounds.width, bounds.height);
}
ResourceManager.preload(preloadSize);
try {
UIManager.setLookAndFeel(new FreeColLookAndFeel(dataFolder, preloadSize));
} catch (UnsupportedLookAndFeelException e) {
logger.warning("Could not load the \"FreeCol Look and Feel\"");
} catch (FreeColException e) {
removeSplash(splash);
e.printStackTrace();
System.out.println("\nThe data files could not be found by FreeCol. Please make sure");
System.out.println("they are present. If FreeCol is looking in the wrong directory");
System.out.println("then run the game with a command-line parameter:");
System.out.println("");
printUsage();
return;
}
// This needs to be initialized before ImageLibrary
try {
Specification.createSpecification(tcData.getSpecificationInputStream());
} catch (IOException e) {
removeSplash(splash);
System.err.println("Could not load specification.xml for: " + tc);
return;
}
// TODO: don't use same datafolder for both images and music because the images are best kept inside the .JAR file.
logger.info("Now starting to load images.");
ImageLibrary lib;
try {
lib = new ImageLibrary(dataFolder);
} catch (FreeColException e) {
removeSplash(splash);
e.printStackTrace();
System.out.println("\nThe data files could not be found by FreeCol. Please make sure");
System.out.println("they are present. If FreeCol is looking in the wrong directory");
System.out.println("then run the game with a command-line parameter:");
System.out.println("");
printUsage();
return;
}
MusicLibrary musicLibrary = null;
SfxLibrary sfxLibrary = null;
if (sound) {
try {
musicLibrary = new MusicLibrary(dataFolder);
} catch (FreeColException e) {
System.out.println("The music files could not be loaded by FreeCol. Disabling music.");
}
try {
sfxLibrary = new SfxLibrary(dataFolder);
} catch (FreeColException e) {
System.out.println("The sfx files could not be loaded by FreeCol. Disabling sfx.");
}
}
freeColClient = new FreeColClient(windowed, windowSize, lib, musicLibrary, sfxLibrary);
if (savegameFile != null) {
final FreeColClient theFreeColClient = freeColClient;
final File theSavegameFile = savegameFile;
SwingUtilities.invokeLater(new Runnable() {
public void run() {
theFreeColClient.getConnectController().loadGame(theSavegameFile);
}
});
}
}
removeSplash(splash);
}
/**
* Displays a splash screen.
* @return The splash screen. It should be removed by the caller
* when no longer needed by a call to removeSplash().
*/
private static JWindow displaySplash(String filename) {
try {
Image im = Toolkit.getDefaultToolkit().getImage(filename);
JWindow f = new JWindow();
f.getContentPane().add(new JLabel(new ImageIcon(im)));
f.pack();
Point center = GraphicsEnvironment.getLocalGraphicsEnvironment().getCenterPoint();
f.setLocation(center.x - f.getWidth() / 2, center.y - f.getHeight() / 2);
f.setVisible(true);
return f;
} catch (Exception e) {
logger.log(Level.WARNING, "Exception while displaying splash screen", e);
return null;
}
}
/**
* Removes splash screen.
*/
private static void removeSplash(JWindow splash) {
if (splash != null) {
splash.setVisible(false);
splash.dispose();
}
}
/**
* Initialize loggers.
*/
private static void initLogging() {
final Logger baseLogger = Logger.getLogger("");
final Handler[] handlers = baseLogger.getHandlers();
for (int i = 0; i < handlers.length; i++) {
baseLogger.removeHandler(handlers[i]);
}
try {
baseLogger.addHandler(new DefaultHandler(consoleLogging, mainUserDirectory));
if (inDebugMode) {
logLevel = Level.FINEST;
}
Logger freecolLogger = Logger.getLogger("net.sf.freecol");
freecolLogger.setLevel(logLevel);
} catch (FreeColException e) {
e.printStackTrace();
}
Thread.setDefaultUncaughtExceptionHandler(new UncaughtExceptionHandler() {
public void uncaughtException(Thread thread, Throwable e) {
baseLogger.log(Level.WARNING, "Uncaught exception from thread: " + thread, e);
}
});
}
/**
* Determines the <code>Locale</code> to be used.
* @return Currently this method returns the locale set by
* the ClientOptions (read directly from "options.xml").
* This behavior will probably be changed.
*/
public static Locale getLocale() {
XMLInputFactory xif = XMLInputFactory.newInstance();
XMLStreamReader in = null;
try {
in = xif.createXMLStreamReader(new BufferedReader(new FileReader(getClientOptionsFile())));
in.nextTag();
/**
* The following code was contributed by armcode to fix
* bug #[ 2045521 ] "Exception in Freecol.log on starting
* game". I was never able to reproduce the bug, but the
* patch did no harm either.
*/
for(int eventid = in.getEventType();eventid != XMLEvent.END_DOCUMENT; eventid = in.getEventType()) {
//TODO: Is checking for XMLEvent.ATTRIBUTE needed?
if(eventid == XMLEvent.START_ELEMENT) {
if (ClientOptions.LANGUAGE.equals(in.getAttributeValue(null, "id"))) {
return LanguageOption.getLocale(in.getAttributeValue(null, "value"));
}
}
in.nextTag();
}
//We don't have a language option in our file, it is either not there or the file is corrupt
logger.log(Level.WARNING, "Language setting not found in client options file. Using default.");
return Locale.getDefault();
} catch (Exception e) {
logger.log(Level.WARNING, "Exception while loading options.", e);
return Locale.getDefault();
} finally {
try {
if (in != null) {
in.close();
}
} catch (Exception e) {
logger.log(Level.WARNING, "Exception while closing stream.", e);
return Locale.getDefault();
}
}
}
/**
* Returns the default server network port.
* @return The port number.
*/
public static int getDefaultPort() {
return DEFAULT_PORT;
}
/**
* Returns the file containing the client options.
* @return The file.
*/
public static File getClientOptionsFile() {
return clientOptionsFile;
}
/**
* Returns the specification object for Freecol.
*
* @return the specification to be used by all other classes.
*/
public static Specification getSpecification() {
return Specification.getSpecification();
}
/**
* Gets the <code>FreeColClient</code>.
* @return The <code>FreeColClient</code>, or <code>null</code>
* if the game is run as a standalone server.
*/
public static FreeColClient getFreeColClient() {
return freeColClient;
}
/**
* Creates a freecol dir for the current user.
*
* The directory is created within the current user's
* home directory. This directory will be called "freecol"
* and underneath that directory a "save" directory will
* be created.
*/
private static File createAndSetDirectories() {
// TODO: The location of the save directory should be determined by the installer.;
String freeColDirectoryName = "/".equals(System.getProperty("file.separator")) ?
".freecol" : "freecol";
mainUserDirectory = new File(System.getProperty("user.home"), freeColDirectoryName);
if (mainUserDirectory.exists()) {
if (mainUserDirectory.isFile()) {
System.out.println("Could not create " + freeColDirectoryName + " under "
+ System.getProperty("user.home") + " because there "
+ "already exists a regular file with the same name.");
return null;
}
} else {
mainUserDirectory.mkdir();
}
saveDirectory = new File(mainUserDirectory, "save");
if (saveDirectory.exists()) {
if (saveDirectory.isFile()) {
System.out.println("Could not create freecol/save under "
+ System.getProperty("user.home") + " because there "
+ "already exists a regular file with the same name.");
return null;
}
} else {
saveDirectory.mkdir();
}
tcUserDirectory = new File(mainUserDirectory, tc);
if (tcUserDirectory.exists()) {
if (tcUserDirectory.isFile()) {
System.out.println("Could not create freecol/" + tc + " under "
+ System.getProperty("user.home") + " because there "
+ "already exists a regular file with the same name.");
return null;
}
} else {
tcUserDirectory.mkdir();
}
clientOptionsFile = new File(tcUserDirectory, "options.xml");
return mainUserDirectory;
}
/**
* Returns the directory where the savegames should be put.
* @return The directory where the savegames should be put.
*/
public static File getSaveDirectory() {
return saveDirectory;
}
/**
* Returns the data directory.
* @return The directory where the data files are located.
*/
public static File getDataDirectory() {
if (dataFolder.equals("")) {
return new File("data");
} else {
return new File(dataFolder);
}
}
/**
* Returns the directory where the autogenerated savegames
* should be put.
*
* @return The directory.
*/
public static File getAutosaveDirectory() {
return saveDirectory;
}
/**
* Ensure that the Java version is good enough. JDK 1.4 or better is
* required.
*
* @return true if Java version is at least 1.4.0.
*/
private static boolean checkJavaVersion() {
// Must use string comparison because some JVM's provide
// versions like "1.4.1"
String version = System.getProperty("java.version");
boolean success = (version.compareTo(MIN_JDK_VERSION) >= 0);
return success;
}
/**
* Checks the command-line arguments and takes appropriate actions
* for each of them.
*
* @param args The command-line arguments.
*/
private static void handleArgs(String[] args) {
for (int i = 0; i < args.length; i++) {
if (args[i].equals("--freecol-data")) {
i++;
if (i < args.length) {
dataFolder = args[i];
// append a file separator to the data folder if necessary
if ( ! dataFolder.endsWith(FILE_SEP)) {
dataFolder += FILE_SEP;
}
} else {
printUsage();
System.exit(0);
}
} else if (args[i].equals("--tc")) {
i++;
if (i < args.length) {
tc = args[i];
} else {
printUsage();
System.exit(0);
}
} else if (args[i].equals("--log-console")) {
consoleLogging = true;
initLogging();
} else if (args[i].equals("--log-level")) {
i++;
if (i < args.length) {
String logLevelString = args[i].toUpperCase();
try {
logLevel = Level.parse(logLevelString);
initLogging();
} catch (IllegalArgumentException e) {
printUsage();
System.exit(1);
}
} else {
printUsage();
System.exit(0);
}
} else if (args[i].equals("--no-java-check")) {
javaCheck = false;
} else if (args[i].length() >= 10 && args[i].substring(0, 10).equals("--windowed")) {
if (args[i].length() > 10 && args[i].charAt(10) != ' ') {
// TODO: Check if the input values are legal.
try {
int x = 0;
int j = 10;
if (args[i].charAt(10) == '=') {
j++;
}
for (; args[i].charAt(j) != 'x'; j++) {
x *= 10;
x += Character.digit(args[i].charAt(j), 10);
}
int y = 0;
for (j++; j < args[i].length() && args[i].charAt(j) != ' '; j++) {
y *= 10;
y += Character.digit(args[i].charAt(j), 10);
}
windowSize = new Dimension(x, y);
} catch (Exception e) {
printUsage();
System.exit(0);
}
} else if (args[i].length() != 10) {
printUsage();
System.exit(0);
}
windowed = true;
} else if (args[i].length() > 16 && args[i].substring(0, 16).equals("--default-locale")) {
if (args[i].charAt(16) == '=') {
// slightly ugly: strip encoding from LC_MESSAGES
String languageID = args[i].substring(17);
int index = languageID.indexOf('.');
if (index > 0) {
languageID = languageID.substring(0, index);
}
Locale.setDefault(LanguageOption.getLocale(languageID));
} else {
printUsage();
System.exit(0);
}
} else if (args[i].equals("--no-sound")) {
sound = false;
} else if (args[i].equals("--no-memory-check")) {
memoryCheck = false;
} else if (args[i].equals("--usage") || args[i].equals("--help")) {
printUsage();
System.exit(0);
} else if (args[i].equals("--version")) {
System.out.println("FreeCol " + getVersion());
System.exit(0);
} else if (args[i].equals("--debug")) {
inDebugMode = true;
} else if (args[i].equals("--server")) {
standAloneServer = true;
i++;
if (i >= args.length) {
printUsage();
System.out.println("You will need to specify a port number when using the \"--server\" option.");
System.exit(1);
}
try {
serverPort = Integer.parseInt(args[i]);
} catch (NumberFormatException nfe) {
printUsage();
System.out.println("The text after the \"--server\" option should be a valid port number.");
System.exit(1);
}
} else if (args[i].equals("--load-savegame")) {
i++;
if (i < args.length) {
savegameFile = new File(args[i]);
setSaveDirectory(savegameFile.getParentFile());
if (!savegameFile.exists() || !savegameFile.isFile()) {
savegameFile = new File(getSaveDirectory(), args[i]);
if (!savegameFile.exists() || !savegameFile.isFile()) {
System.out.println("The given savegame file could not be found: " + args[i]);
System.exit(1);
}
}
} else {
printUsage();
System.exit(0);
}
} else if (args[i].equals("--server-help")) {
printServerUsage();
System.exit(0);
} else if (args[i].equals("--server-name")) {
if (!standAloneServer) {
printServerUsage();
System.exit(1);
}
i++;
if (i >= args.length) {
printUsage();
System.out.println("You will need to specify a name when using the \"--server-name\" option.");
System.exit(1);
}
serverName = args[i];
} else if (args[i].startsWith("--splash")) {
// Ignore - already handled;
} else {
printUsage();
System.exit(1);
}
}
}
/**
* Gets the current version of game.
*
* @return The current version of the game using the format "x.y.z",
* where "x" is major, "y" is minor and "z" is revision.
*/
public static String getVersion() {
return FREECOL_VERSION;
}
/**
* Gets the current revision of game.
*
* @return The current version and SVN Revision of the game.
*/
public static String getRevision() {
return FREECOL_REVISION;
}
/**
* Checks if the program is in "Debug mode".
* @return <code>true</code> if the program is in debug
* mode and <code>false</code> otherwise.
*/
public static boolean isInDebugMode() {
return inDebugMode;
}
/**
* Sets the "debug mode" to be active or not.
* @param debug Should be <code>true</code> in order
* to active debug mode and <code>false</code>
* otherwise.
*/
public static void setInDebugMode(boolean debug) {
inDebugMode = debug;
}
/**
* Prints the command-line usage for the server options.
*/
private static void printServerUsage() {
System.out.println("Usage: java -Xmx512M -jar FreeCol.jar --server PORT [OPTIONS]");
System.out.println("");
System.out.println("Starts a stand-alone server on the specifed port");
System.out.println("");
System.out.println("Options:");
System.out.println("--server-name NAME");
System.out.println(" specifies a custom name for the server");
System.out.println("--load-savegame SAVEGAME_FILE");
System.out.println(" loads the given savegame.");
System.out.println("--no-java-check");
System.out.println(" skips the java version check");
System.out.println();
}
/**
* Prints the command-line usage (the 'help' for command-line
* arguments).
*/
private static void printUsage() {
System.out.println("Usage: java -Xmx512M -jar FreeCol.jar [OPTIONS]");
System.out.println("");
System.out.println("Options:");
System.out.println("--default-locale=LANGUAGE[_COUNTRY[_VARIANT]]");
System.out.println(" sets the default locale.");
System.out.println("--freecol-data DIR");
System.out.println(" DIR should be the directory with FreeCol's data files, it");
System.out.println(" has a subdirectory called 'images'");
System.out.println("--load-savegame SAVEGAME_FILE");
System.out.println(" loads the given savegame.");
System.out.println("--log-level=LOGLEVEL");
System.out.println(" sets the log-level to LOGLEVEL.");
System.out.println("--no-java-check");
System.out.println(" skips the java version check");
System.out.println("--no-memory-check");
System.out.println(" skips the memory check");
System.out.println("--no-sound");
System.out.println(" runs FreeCol without sound");
System.out.println("--server PORT");
System.out.println(" starts a stand-alone server on the specifed port");
System.out.println("--server-help");
System.out.println(" displays a help screen for the more advanced server options");
System.out.println("--splash[=SPLASH_IMAGE_FILE]");
System.out.println(" displays a splash screen while loading the game");
System.out.println("--tc NAME");
System.out.println(" Loads the total conversion with the given NAME");
System.out.println("--usage");
System.out.println(" displays this help screen");
System.out.println("--version");
System.out.println(" displays the version number");
System.out.println("--windowed[[=]WIDTHxHEIGHT]");
System.out.println(" runs FreeCol in windowed mode instead of full screen mode");
System.out.println();
}
public static void setSaveDirectory(File saveDirectory) {
FreeCol.saveDirectory = saveDirectory;
}
}
The table below shows all metrics for FreeCol.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 145.00 | Number of blocks | |
| BLOCK_COMMENT | 0.00 | Number of block comment lines | |
| COMMENTS | 155.00 | Comment lines | |
| COMMENT_DENSITY | 0.29 | Comment density | |
| COMPARISONS | 74.00 | Number of comparison operators | |
| CYCLOMATIC | 118.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 25.00 | Comments in declarations | |
| DOC_COMMENT | 140.00 | Number of javadoc comment lines | |
| ELOC | 528.00 | Effective lines of code | |
| EXEC_COMMENTS | 15.00 | Comments in executable code | |
| EXITS | 93.00 | Procedure exits | |
| FUNCTIONS | 26.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 88.75 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 56.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 | 1.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 | 7.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 | 14.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 | 2.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 0.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 1.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 | 2.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 1.00 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0118 | 0.00 | JAVA0118 Missing javadoc: type 'type' | |
| JAVA0119 | 6.00 | JAVA0119 Control variable changed within body of for loop | |
| JAVA0123 | 1.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 | 0.00 | JAVA0143 Synchronized method | |
| JAVA0144 | 2.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 12.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 | 1.00 | JAVA0165 Conflicting return statement in finally block | |
| JAVA0166 | 6.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 | 5.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 | 3.00 | JAVA0265 Use of Throwable.printStackTrace() | |
| JAVA0266 | 68.00 | JAVA0266 Use of System.out | |
| JAVA0267 | 5.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 | 0.00 | JAVA0287 Unnecessary null check | |
| JAVA0288 | 0.00 | JAVA0288 Inconsistent null check | |
| LINES | 860.00 | Number of lines in the source file | |
| LINE_COMMENT | 15.00 | Number of line comments | |
| LOC | 620.00 | Lines of code | |
| LOGICAL_LINES | 378.00 | Number of statements | |
| LOOPS | 6.00 | Number of loops | |
| NEST_DEPTH | 6.00 | Maximum nesting depth | |
| OPERANDS | 1536.00 | Number of operands | |
| OPERATORS | 2839.00 | Number of operators | |
| PARAMS | 8.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 4375.00 | Halstead program length | |
| PROGRAM_VOCAB | 473.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 48.00 | Number of return points from functions | |
| SIZE | 33173.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 424.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 49.00 | Number of unique operators | |
| WHITESPACE | 85.00 | Number of whitespace lines | |