DataInstaller.java
| Index Score | ||
|---|---|---|
 |
 |
pcgen.gui |
 |
 |
PCGen |
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 |  |
| LOC | Lines of code | |
| EXEC_COMMENTS | Comments in executable code | |
| DECL_COMMENTS | Comments in declarations | |
| LOGICAL_LINES | Number of statements | |
| OPERANDS | Number of operands | |
| ELOC | Effective lines of code | |
| PROGRAM_LENGTH | Halstead program length | |
| LINES | Number of lines in the source file | |
| OPERATORS | Number of operators | |
| UNIQUE_OPERANDS | Number of unique operands | |
| SIZE | Size of the file in bytes | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| JAVA0130 | JAVA0130 Non-static method does not use instance fields | |
| JAVA0177 | JAVA0177 Variable declaration missing initializer | |
| BLOCKS | Number of blocks | |
| COMPARISONS | Number of comparison operators | |
| LINE_COMMENT | Number of line comments | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
| RETURNS | Number of return points from functions | |
| COMMENTS | Comment lines | |
| CYCLOMATIC | Cyclomatic complexity | |
| DOC_COMMENT | Number of javadoc comment lines | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| UNIQUE_OPERATORS | Number of unique operators | |
| PROGRAM_VOLUME | Halstead program volume | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| JAVA0032 | JAVA0032 Switch statement missing default | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0043 | JAVA0043 Inner class does not use outer class | |
| JAVA0173 | JAVA0173 Unused method parameter | |
| JAVA0100 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
/*
* DataInstaller.java
* Copyright 2007 (C) James Dempsey
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* Created on 22/12/2007
*
* $Id: DataInstaller.java 6527 2008-06-11 23:34:55Z thpr $
*/
package pcgen.gui;
import java.awt.Component;
import java.awt.Dimension;
import java.awt.GridBagConstraints;
import java.awt.GridBagLayout;
import java.awt.Insets;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.io.BufferedOutputStream;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.util.ArrayList;
import java.util.Enumeration;
import java.util.List;
import java.util.zip.ZipEntry;
import java.util.zip.ZipFile;
import javax.swing.ButtonGroup;
import javax.swing.JButton;
import javax.swing.JFileChooser;
import javax.swing.JFrame;
import javax.swing.JLabel;
import javax.swing.JOptionPane;
import javax.swing.JPanel;
import javax.swing.JRadioButton;
import javax.swing.JScrollPane;
import javax.swing.JTextField;
import javax.swing.SwingConstants;
import javax.swing.filechooser.FileFilter;
import pcgen.core.InstallableCampaign;
import pcgen.core.SettingsHandler;
import pcgen.core.InstallableCampaign.Destination;
import pcgen.core.utils.CoreUtility;
import pcgen.core.utils.MessageType;
import pcgen.core.utils.ShowMessageDelegate;
import pcgen.gui.utils.IconUtilitities;
import pcgen.gui.utils.JLabelPane;
import pcgen.gui.utils.Utility;
import pcgen.persistence.PersistenceLayerException;
import pcgen.persistence.lst.InstallLoader;
import pcgen.util.Logging;
import pcgen.util.PropertyFactory;
/**
* <code>DataInstaller</code> is responsible for managing the installation of
* a data set including the selection of the set and the install options.
*
* Last Editor: $Author: thpr $
* Last Edited: $Date: 2008-06-11 19:34:55 -0400 (Wed, 11 Jun 2008) $
*
* @author James Dempsey <jdempsey@users.sourceforge.net>
* @version $Revision: 6527 $
*/
public class DataInstaller extends JFrame
{
/**
* Filter class to only display potential zip format data sets.
*/
private final class DataPackFilter extends FileFilter
{
/* (non-Javadoc)
* @see javax.swing.filechooser.FileFilter#accept(java.io.File)
*/
public boolean accept(File f)
{
if (f.isDirectory())
{
return true;
}
if (f.getName().endsWith(".zip"))
{
return true;
}
return false;
}
/* (non-Javadoc)
* @see javax.swing.filechooser.FileFilter#getDescription()
*/
public String getDescription()
{
return "Data Sets (*.zip)";
}
}
/**
* The listener for receiving and processing action events from installer
* buttons.
*/
private final class InstallerButtonListener implements ActionListener
{
/* (non-Javadoc)
* @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)
*/
public void actionPerformed(ActionEvent actionEvent)
{
JButton source = (JButton) actionEvent.getSource();
if (source == null)
{
// Do nothing
}
else if (source == cancel)
{
setVisible(false);
DataInstaller.this.dispose();
}
else if (source == selectButton)
{
JFileChooser chooser =
new JFileChooser(new File(System
.getProperty("user.dir")));
chooser.setDialogTitle(PropertyFactory
.getString("in_diChooserTitle"));
chooser.addChoosableFileFilter(new DataPackFilter());
int result = chooser.showOpenDialog(DataInstaller.this);
if (result != JFileChooser.APPROVE_OPTION)
{
return;
}
File dataset = chooser.getSelectedFile();
readDataSet(dataset);
}
else if (source == installButton)
{
if (installDataSource(currDataSet, getSelectedDestination()))
{
PCGen_Frame1.getInst().getMainSource().refreshCampaigns();
ShowMessageDelegate.showMessageDialog(PropertyFactory
.getFormattedString("in_diInstalled", campaign
.getDisplayName()), TITLE, MessageType.INFORMATION);
}
}
}
}
/** The name of the OUTPUTSHEETS folder. */
private static final String OUTPUTSHEETS_FOLDER = "outputsheets/";
/** The name of the DATA folder. */
private static final String DATA_FOLDER = "data/";
/** The standard window title. */
private static final String TITLE = PropertyFactory.getString("in_dataInstaller");
/** The component to display the path of the selected data set. */
private JTextField dataSetSel;
/** The select button. */
private JButton selectButton;
/** The data set detail display component. */
private JLabelPane dataSetDetails;
/** The button for the data location. */
private JRadioButton locDataButton;
/** The button for the vendor data location. */
private JRadioButton locVendorDataButton;
/** The install button. */
private JButton installButton;
/** The cancel. */
private JButton cancel;
/** The listener. */
private InstallerButtonListener listener = new InstallerButtonListener();
/** The campaign. */
private InstallableCampaign campaign;
/** The current data set. */
private File currDataSet;
/**
* Instantiates a new data installer.
*
* @param owner the parent window of the dialog.
*/
public DataInstaller(Component owner)
{
initComponents();
IconUtilitities.maybeSetIcon(this, IconUtilitities.RESOURCE_APP_ICON);
pcgen.gui.utils.Utility.centerFrame(this, false);
}
/**
* Check for any non standard files being installed and check with the
* user if there are. Note if the user says no to installing the non
* standard files they will be removed from the file list
*
* @param files the names of the files being installed.
*
* @return Should the install process continue
*/
private boolean checkNonStandardOK(List<String> files)
{
List<String> nonStandardFiles = new ArrayList<String>();
for (String filename : files)
{
if (!filename.toLowerCase().startsWith(DATA_FOLDER)
&& !filename.toLowerCase().startsWith(OUTPUTSHEETS_FOLDER))
{
nonStandardFiles.add(filename);
}
}
if (!nonStandardFiles.isEmpty())
{
StringBuffer msg = new StringBuffer();
for (String filename : nonStandardFiles)
{
msg.append(' ').append(filename).append("\n");
}
int result = JOptionPane.showConfirmDialog(this, PropertyFactory
.getFormattedString("in_diNonStandardFiles", msg.toString()),
TITLE, JOptionPane.YES_NO_CANCEL_OPTION);
if (result == JOptionPane.CANCEL_OPTION)
{
return false;
}
if (result == JOptionPane.NO_OPTION)
{
for (String filename : nonStandardFiles)
{
files.remove(filename);
}
}
}
return true;
}
/**
* Check for any files that would be overwritten and confirm it is ok
* with the user.
*
* @param files the names of the files being installed.
* @param destDir the destination data directory
*
* @return true, if successful
*/
private boolean checkOverwriteOK(List<String> files, File destDir)
{
List<String> existingFiles = new ArrayList<String>();
List<String> existingFilesCorr = new ArrayList<String>();
for (String filename : files)
{
String correctedFilename = correctFileName(destDir, filename);
if (new File(correctedFilename).exists())
{
existingFiles.add(filename);
existingFilesCorr.add(correctedFilename);
}
}
if (!existingFiles.isEmpty())
{
StringBuffer msg = new StringBuffer();
for (String filename : existingFilesCorr)
{
msg.append(' ').append(filename).append("\n");
}
int result = JOptionPane.showConfirmDialog(this, PropertyFactory
.getFormattedString("in_diOverwriteFiles", msg.toString()),
TITLE, JOptionPane.YES_NO_CANCEL_OPTION);
if (result == JOptionPane.CANCEL_OPTION)
{
return false;
}
if (result == JOptionPane.NO_OPTION)
{
for (String filename : existingFiles)
{
files.remove(filename);
}
}
}
return true;
}
/**
* Copy the contents of the input stream to the output stream. Used
* here to write the zipped file to the install location.
*
* @param in the input stream
* @param out the output stream
*
* @throws IOException Signals that an I/O exception has occurred.
*/
private final void copyInputStream(InputStream in, OutputStream out)
throws IOException
{
byte[] buffer = new byte[1024];
int len;
while ((len = in.read(buffer)) >= 0)
{
out.write(buffer, 0, len);
}
in.close();
out.close();
}
/**
* Correct the file name to account for the selected data directory and
* preference based folder locations such as output sheets.
*
* @param destDir the destination data directory
* @param fileName the file name to be corrected.
*
* @return the corrected file name.
*/
private String correctFileName(File destDir, String fileName)
{
if (fileName.toLowerCase().startsWith(DATA_FOLDER))
{
fileName = destDir.getAbsolutePath() + fileName.substring(4);
}
else if (fileName.toLowerCase().startsWith(OUTPUTSHEETS_FOLDER))
{
fileName =
SettingsHandler.getPcgenOutputSheetDir().getAbsolutePath()
+ fileName.substring(12);
}
return fileName;
}
/**
* Creates the directories needed by the installer, where they
* do not already exist.
*
* @param directories the directories
* @param destDir the destination data directory
*
* @return true, if successful
*/
private boolean createDirectories(List<String> directories, File destDir)
{
for (String dirname : directories)
{
String corrDirname = correctFileName(destDir, dirname);
File dir = new File(corrDirname);
if (!dir.exists())
{
Logging.log(Logging.INFO, "Creating directory: " + dir);
if (!dir.mkdirs())
{
ShowMessageDelegate.showMessageDialog(PropertyFactory
.getFormattedString("in_diDirNotCreated", destDir
.getAbsoluteFile()), TITLE, MessageType.ERROR);
return false;
}
}
}
return true;
}
/**
* Creates the files in the archive, as filtered by previous user actions.
*
* @param dataSet the data set (campaign) to be installed.
* @param destDir the destination data directory
* @param files the list of file names
*
* @return true, if all files created ok
*/
private boolean createFiles(File dataSet, File destDir, List<String> files)
{
String corrFilename = "";
ZipFile in;
// Open the ZIP file
try
{
in = new ZipFile(dataSet);
}
catch (IOException e)
{
Logging.errorPrint("Failed to read data set " + dataSet
+ " due to ", e);
ShowMessageDelegate.showMessageDialog(PropertyFactory
.getFormattedString("in_diBadDataSet", dataSet), TITLE,
MessageType.ERROR);
return false;
}
try
{
for (String filename : files)
{
ZipEntry entry = in.getEntry(filename);
corrFilename = correctFileName(destDir, filename);
Logging.debugPrint("Extracting file: " + filename + " to "
+ corrFilename);
copyInputStream(
in.getInputStream(entry),
new BufferedOutputStream(new FileOutputStream(corrFilename)));
}
in.close();
}
catch (IOException e)
{
// Report the error
Logging.errorPrint("Failed to read data set " + dataSet
+ " or write file " + corrFilename + " due to ", e);
ShowMessageDelegate.showMessageDialog(PropertyFactory
.getFormattedString("in_diWriteFail", corrFilename), TITLE,
MessageType.ERROR);
return false;
}
return true;
}
/**
* Gets the currently selected destination.
*
* @return the selected destination
*/
private Destination getSelectedDestination()
{
if (locDataButton.isSelected())
{
return Destination.DATA;
}
if (locVendorDataButton.isSelected())
{
return Destination.VENDORDATA;
}
return null;
}
/**
* Build the user interface ready for display.
*/
private void initComponents()
{
GridBagConstraints gbc = new GridBagConstraints();
gbc.fill = GridBagConstraints.HORIZONTAL;
gbc.anchor = GridBagConstraints.WEST;
gbc.insets = new Insets(2, 2, 2, 2);
GridBagLayout gridbag = new GridBagLayout();
setTitle(TITLE);
setLayout(gridbag);
// Data set selection row
Utility.buildConstraints(gbc, 0, 0, 1, 1, 0.0, 0.0);
JLabel dataSetLabel = new JLabel(PropertyFactory.getString("in_diDataSet"), SwingConstants.RIGHT);
gridbag.setConstraints(dataSetLabel, gbc);
add(dataSetLabel, gbc);
Utility.buildConstraints(gbc, 1, 0, 2, 1, 1.0, 0.0);
dataSetSel = new JTextField("", SwingConstants.WEST);
dataSetSel.setEditable(false);
gridbag.setConstraints(dataSetSel, gbc);
add(dataSetSel, gbc);
Utility.buildConstraints(gbc, 3, 0, 1, 1, 0.0, 0.0);
gbc.fill = GridBagConstraints.NONE;
selectButton = new JButton(PropertyFactory.getString("in_select"));
gridbag.setConstraints(selectButton, gbc);
add(selectButton, gbc);
selectButton.addActionListener(listener);
// Data set details row
Utility.buildConstraints(gbc, 0, 1, 4, 1, 1.0, 1.0);
dataSetDetails = new JLabelPane();
dataSetDetails.setPreferredSize(new Dimension(400, 200));
dataSetDetails.setEditable(false);
dataSetDetails.setBackground(getBackground());
gbc.fill = GridBagConstraints.BOTH;
JScrollPane jScrollPane = new JScrollPane();
jScrollPane.setViewportView(dataSetDetails);
gridbag.setConstraints(jScrollPane, gbc);
add(jScrollPane, gbc);
// Location row
Utility.buildConstraints(gbc, 0, 2, 1, 1, 0.0, 0.0);
gbc.fill = GridBagConstraints.HORIZONTAL;
JLabel locLabel = new JLabel(PropertyFactory.getString("in_diLocation"), SwingConstants.RIGHT);
gridbag.setConstraints(locLabel, gbc);
add(locLabel, gbc);
ButtonGroup exclusiveGroup = new ButtonGroup();
locDataButton =
new JRadioButton(PropertyFactory
.getString("in_diData"));
Utility.setDescription(locDataButton, PropertyFactory
.getString("in_diData_tip"));
exclusiveGroup.add(locDataButton);
locVendorDataButton =
new JRadioButton(PropertyFactory
.getString("in_diVendorData"));
Utility.setDescription(locVendorDataButton, PropertyFactory
.getString("in_diVendorData_tip"));
exclusiveGroup.add(locVendorDataButton);
JPanel optionsPanel = new JPanel();
optionsPanel.add(locDataButton);
optionsPanel.add(locVendorDataButton);
Utility.buildConstraints(gbc, 1, 2, 3, 1, 0.0, 0.0);
gridbag.setConstraints(optionsPanel, gbc);
gbc.fill = GridBagConstraints.NONE;
gbc.anchor = GridBagConstraints.WEST;
add(optionsPanel, gbc);
// Buttons row
installButton = new JButton(PropertyFactory.getString("in_diInstall"));
installButton.addActionListener(listener);
cancel = new JButton(PropertyFactory.getString("in_cancel"));
cancel.addActionListener(listener);
JPanel buttonsPanel = new JPanel();
buttonsPanel.add(installButton);
buttonsPanel.add(cancel);
Utility.buildConstraints(gbc, 2, 3, 2, 1, 0.0, 0.0);
gridbag.setConstraints(buttonsPanel, gbc);
gbc.fill = GridBagConstraints.NONE;
gbc.anchor = GridBagConstraints.EAST;
add(buttonsPanel, gbc);
pack();
}
/**
* Install a data set (campaign) into the current PCGen install.
*
* @param dataSet the data set (campaign) to be installed.
* @param dest The location the data is to be installed to.
*
* @return true, if install data source
*/
private boolean installDataSource(File dataSet, Destination dest)
{
// Get the directory the data is to be stored in
if (dataSet == null)
{
ShowMessageDelegate.showMessageDialog(PropertyFactory
.getFormattedString("in_diDataSetNotSelected"), TITLE,
MessageType.ERROR);
return false;
}
if (dest == null)
{
ShowMessageDelegate.showMessageDialog(PropertyFactory
.getFormattedString("in_diDataFolderNotSelected"), TITLE,
MessageType.ERROR);
return false;
}
File destDir;
switch (dest)
{
case VENDORDATA:
destDir = SettingsHandler.getPcgenVendorDataDir();
break;
case DATA:
default:
destDir = SettingsHandler.getPccFilesLocation();
break;
}
// Check chosen dir exists
if (!destDir.exists())
{
ShowMessageDelegate.showMessageDialog(PropertyFactory
.getFormattedString("in_diDataFolderNotExist", destDir
.getAbsoluteFile()), TITLE, MessageType.ERROR);
return false;
}
// Scan for non standard files and files that would be overwritten
List<String> directories = new ArrayList<String>();
List<String> files = new ArrayList<String>();
if (!populateFileAndDirLists(dataSet, directories, files))
{
return false;
}
if (!checkNonStandardOK(files))
{
return false;
}
if (!checkOverwriteOK(files, destDir))
{
return false;
}
if (!createDirectories(directories, destDir))
{
return false;
}
// Navigate through the zip file, processing each file
return createFiles(dataSet, destDir, files);
}
/**
* Populate the lists of files and directories to be installed.
*
* @param dataSet the data set (campaign) to be installed.
* @param directories the list of directory names
* @param files the list of file names
*
* @return true, if populate file and dir lists
*/
@SuppressWarnings("unchecked")
private boolean populateFileAndDirLists(File dataSet,
List<String> directories, List<String> files)
{
// Navigate through the zip file, processing each file
try
{
// Open the ZIP file
ZipFile in = new ZipFile(dataSet);
Enumeration entries = in.entries();
while (entries.hasMoreElements())
{
ZipEntry entry = (ZipEntry) entries.nextElement();
if (entry.isDirectory())
{
directories.add(entry.getName());
}
else if (!entry.getName().equalsIgnoreCase("install.lst"))
{
files.add(entry.getName());
}
}
in.close();
}
catch (IOException e)
{
// Report the error
Logging.errorPrint("Failed to read data set " + dataSet
+ " due to ", e);
ShowMessageDelegate.showMessageDialog(PropertyFactory
.getFormattedString("in_diBadDataSet", dataSet), TITLE,
MessageType.ERROR);
return false;
}
return true;
}
/**
* Read data set.
*
* @param dataSet the data set
*
* @return true, if successful
*/
private boolean readDataSet(File dataSet)
{
try
{
// Open the ZIP file
ZipFile in = new ZipFile(dataSet);
// Get the install file in a case insensitive manner
ZipEntry installEntry = null;
@SuppressWarnings("unchecked")
Enumeration entries = in.entries();
while (entries.hasMoreElements())
{
ZipEntry entry = (ZipEntry) entries.nextElement();
if (entry.getName().equalsIgnoreCase("install.lst"))
{
installEntry = entry;
break;
}
}
if (installEntry == null)
{
// Report that it isn't a valid data set
Logging.errorPrint("File " + dataSet
+ " is not a valid datsset - no Install.lst file");
ShowMessageDelegate.showMessageDialog(
PropertyFactory.getFormattedString("in_diNoInstallFile",
dataSet.getName()), TITLE, MessageType.WARNING);
in.close();
return false;
}
// Parse the install file
InputStream inStream = in.getInputStream(installEntry);
StringBuffer installInfo = new StringBuffer();
byte[] b = new byte[512];
int len = 0;
while ((len = inStream.read(b)) != -1)
{
installInfo.append((new String(b, "UTF8")).substring(0, len));
}
final InstallLoader loader = new InstallLoader();
loader.loadLstString(null, dataSet.toURI(), installInfo.toString());
campaign = loader.getCampaign();
in.close();
}
catch (IOException e)
{
// Report the error
Logging.errorPrint("Failed to read data set " + dataSet
+ " due to ", e);
ShowMessageDelegate.showMessageDialog(PropertyFactory
.getFormattedString("in_diBadDataSet", dataSet), TITLE,
MessageType.ERROR);
return false;
}
catch (PersistenceLayerException e)
{
Logging.errorPrint("Failed to parse data set " + dataSet
+ " due to ", e);
ShowMessageDelegate.showMessageDialog(PropertyFactory
.getFormattedString("in_diBadDataSet", dataSet), TITLE,
MessageType.ERROR);
return false;
}
// Validate that the campaign is compatible with our version
if (campaign.getMinDevVer() != null
&& !CoreUtility.isPriorToCurrent(campaign.getMinDevVer()))
{
if (CoreUtility.isCurrMinorVer(campaign.getMinDevVer()))
{
Logging.errorPrint("Dataset " + campaign.getDisplayName()
+ " needs at least PCGen version "
+ campaign.getMinDevVer()
+ " to run. It could not be installed.");
ShowMessageDelegate.showMessageDialog(PropertyFactory
.getFormattedString("in_diVersionTooOldDev", campaign
.getMinDevVer(), campaign.getMinVer()), TITLE,
MessageType.WARNING);
return false;
}
}
if (campaign.getMinVer() != null
&& !CoreUtility.isPriorToCurrent(campaign.getMinVer()))
{
Logging.errorPrint("Dataset " + campaign.getDisplayName()
+ " needs at least PCGen version " + campaign.getMinVer()
+ " to run. It could not be installed.");
ShowMessageDelegate.showMessageDialog(PropertyFactory
.getFormattedString("in_diVersionTooOld", campaign.getMinVer()),
TITLE, MessageType.WARNING);
return false;
}
// Display the info
dataSetSel.setText(dataSet.getAbsolutePath());
dataSetDetails.setText(MainSource.buildInfoLabel(campaign));
if (campaign.getDest() == null)
{
locDataButton.setSelected(false);
locVendorDataButton.setSelected(false);
}
else
{
switch (campaign.getDest())
{
case DATA:
locDataButton.setSelected(true);
break;
case VENDORDATA:
locVendorDataButton.setSelected(true);
break;
}
}
currDataSet = dataSet;
toFront();
return true;
}
}
The table below shows all metrics for DataInstaller.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 74.00 | Number of blocks | |
| BLOCK_COMMENT | 31.00 | Number of block comment lines | |
| COMMENTS | 173.00 | Comment lines | |
| COMMENT_DENSITY | 0.42 | Comment density | |
| COMPARISONS | 52.00 | Number of comparison operators | |
| CYCLOMATIC | 69.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 32.00 | Comments in declarations | |
| DOC_COMMENT | 121.00 | Number of javadoc comment lines | |
| ELOC | 410.00 | Effective lines of code | |
| EXEC_COMMENTS | 21.00 | Comments in executable code | |
| EXITS | 95.00 | Procedure exits | |
| FUNCTIONS | 15.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 90.00 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 66.00 | Interface complexity | |
| JAVA0001 | 0.00 | JAVA0001 Package name does not contain only lower case letters | |
| JAVA0002 | 1.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 | 1.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 | 1.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 | 1.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 | 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 | 0.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 | 0.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 0.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 | 3.00 | JAVA0130 Non-static method does not use instance fields | |
| JAVA0131 | 0.00 | JAVA0131 Compatible method does not override base | |
| JAVA0132 | 0.00 | JAVA0132 Method overload with compatible signature | |
| JAVA0133 | 0.00 | JAVA0133 Non-synchronized method overrides synchronized method | |
| JAVA0135 | 0.00 | JAVA0135 Only one of Object.equals and Object.hashCode defined: missing 'method' | |
| JAVA0136 | 0.00 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0137 | 0.00 | JAVA0137 Non-abstract class missing constructor | |
| JAVA0138 | 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 | 0.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 1654.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 | 3.00 | JAVA0177 Variable declaration missing initializer | |
| JAVA0179 | 0.00 | JAVA0179 Local variable hides visible field | |
| JAVA0233 | 0.00 | JAVA0233 Definition of serialVersionUID other than 'private static final long serialVersionUID' | |
| JAVA0234 | 1.00 | JAVA0234 Class is Serializable but does not define serialVersionUID | |
| JAVA0235 | 0.00 | JAVA0235 Class defines serialVersionUID but does not implement Serializable | |
| JAVA0236 | 0.00 | JAVA0236 Attempt to clone an object which does not implement Cloneable | |
| JAVA0237 | 0.00 | JAVA0237 Class implements Cloneable but does not have public clone method | |
| JAVA0238 | 0.00 | JAVA0238 Clone method does not call super.clone() | |
| JAVA0239 | 0.00 | JAVA0239 Class declares 'readObject' or 'writeObject' but does not implement Serializable | |
| JAVA0240 | 0.00 | JAVA0240 Serializable class which declares readObject or writeObject but not both | |
| JAVA0241 | 0.00 | JAVA0241 'readObject' or 'writeObject' should be declared private in Serializable class | |
| JAVA0242 | 0.00 | JAVA0242 Transient field in non-Serializable class | |
| JAVA0243 | 0.00 | JAVA0243 'readResolve' or 'writeReplace' should be declared private or protected | |
| JAVA0244 | 0.00 | JAVA0244 Field or method name in subclass differs only by case from inherited field or method | |
| JAVA0245 | 0.00 | JAVA0245 JUnit TestCase with non-trivial constructor | |
| JAVA0246 | 0.00 | JAVA0246 JUnit assertXXX statement missing message parameter | |
| JAVA0247 | 0.00 | JAVA0247 JUnit 'setUp()' and 'tearDown()' should call super method | |
| JAVA0248 | 0.00 | JAVA0248 JUnit method 'setUp' or 'tearDown' with incorrect signature | |
| JAVA0249 | 0.00 | JAVA0249 JUnit TestCase 'suite()' should be declared static | |
| JAVA0250 | 0.00 | JAVA0250 JUnit TestCase declares testXXX method with incorrect signature | |
| JAVA0251 | 0.00 | JAVA0251 Use '%n' for line breaks in printf/format for platform independence | |
| JAVA0252 | 0.00 | JAVA0252 'enum' is a Java 1.5 reserved word | |
| JAVA0253 | 0.00 | JAVA0253 Not all enum constants consumed in switch statement | |
| JAVA0254 | 0.00 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| JAVA0255 | 0.00 | JAVA0255 Result of method invocation not used | |
| JAVA0256 | 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 | 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 | 806.00 | Number of lines in the source file | |
| LINE_COMMENT | 21.00 | Number of line comments | |
| LOC | 567.00 | Lines of code | |
| LOGICAL_LINES | 262.00 | Number of statements | |
| LOOPS | 4.00 | Number of loops | |
| NEST_DEPTH | 4.00 | Maximum nesting depth | |
| OPERANDS | 1193.00 | Number of operands | |
| OPERATORS | 2086.00 | Number of operators | |
| PARAMS | 21.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 3279.00 | Halstead program length | |
| PROGRAM_VOCAB | 389.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 45.00 | Number of return points from functions | |
| SIZE | 22297.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 338.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 51.00 | Number of unique operators | |
| WHITESPACE | 66.00 | Number of whitespace lines | |