SettingsContainer.java
| Index Score | ||
|---|---|---|
 |
 |
de.hunsicker.jalopy.swing |
 |
 |
Jalopy |
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 |  |
| JAVA0020 | JAVA0020 Field name does not have required form | |
| LOC | Lines of code | |
| SIZE | Size of the file in bytes | |
| DECL_COMMENTS | Comments in declarations | |
| ELOC | Effective lines of code | |
| UNIQUE_OPERANDS | Number of unique operands | |
| LINES | Number of lines in the source file | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| LOGICAL_LINES | Number of statements | |
| JAVA0163 | JAVA0163 Empty statement | |
| OPERANDS | Number of operands | |
| PROGRAM_LENGTH | Halstead program length | |
| OPERATORS | Number of operators | |
| JAVA0233 | JAVA0233 Definition of serialVersionUID other than 'private static final long serialVersionUID' | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| BLOCKS | Number of blocks | |
| JAVA0049 | JAVA0049 Nested block at depth N (maximum: M) | |
| JAVA0128 | JAVA0128 Public constructor in non-public class | |
| JAVA0076 | JAVA0076 Use of magic number | |
| JAVA0265 | JAVA0265 Use of Throwable.printStackTrace() | |
| NEST_DEPTH | Maximum nesting depth | |
| JAVA0130 | JAVA0130 Non-static method does not use instance fields | |
| CYCLOMATIC | Cyclomatic complexity | |
| LINE_COMMENT | Number of line comments | |
| JAVA0170 | JAVA0170 Caught exception not derived from java.lang.Exception | |
| WHITESPACE | Number of whitespace lines | |
| JAVA0166 | JAVA0166 Generic exception caught | |
| UNIQUE_OPERATORS | Number of unique operators | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| EXEC_COMMENTS | Comments in executable code | |
| JAVA0123 | JAVA0123 Use all three components of for loop | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0100 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0254 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| JAVA0009 | JAVA0009 Protected member in final class | |
| JAVA0270 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
/*
* Copyright (c) 2001-2002, Marco Hunsicker. All rights reserved.
*
* This software is distributable under the BSD license. See the terms of the
* BSD license in the documentation provided with this software.
*/
package de.hunsicker.jalopy.swing;
import java.awt.BorderLayout;
import java.awt.Color;
import java.awt.Dimension;
import java.awt.FlowLayout;
import java.awt.Font;
import java.io.BufferedWriter;
import java.io.CharArrayWriter;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.Reader;
import java.io.Serializable;
import java.lang.reflect.Constructor;
import java.util.ArrayList;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import javax.swing.BorderFactory;
import javax.swing.JLabel;
import javax.swing.JPanel;
import javax.swing.JScrollPane;
import javax.swing.JTree;
import javax.swing.event.TreeSelectionEvent;
import javax.swing.event.TreeSelectionListener;
import javax.swing.tree.DefaultMutableTreeNode;
import javax.swing.tree.DefaultTreeCellRenderer;
import javax.swing.tree.TreeNode;
import javax.swing.tree.TreePath;
import de.hunsicker.io.IoHelper;
import de.hunsicker.jalopy.storage.Convention;
import de.hunsicker.swing.util.PopupSupport;
import de.hunsicker.util.Helper;
import de.hunsicker.util.ResourceBundleFactory;
/**
* The main container that provides a tree view on the left where users may choose the
* different settings pages that are then displayed.
*
* @author <a href="http://jalopy.sf.net/contact.html">Marco Hunsicker</a>
* @version $Revision: 1.4 $
*/
public final class SettingsContainer
extends JPanel
{
//~ Static variables/initializers ----------------------------------------------------
/** The name for ResourceBundle lookup. */
private static final String BUNDLE_NAME =
"de.hunsicker.jalopy.swing.Bundle" /* NOI18N */;
private static final String EMPTY_STRING = "" /* NOI18N */.intern();
private static final String FILENAME_PAGE = "page.dat" /* NOI18N */;
//~ Instance variables ---------------------------------------------------------------
/** Holds the currently displayed settings page. */
AbstractSettingsPage _curSettingsPanel;
/** The code convention settings. */
// TODO private Convention _settings;
/** Used to display the title of the current settings page. */
JLabel _titleLabel;
/** Panel to add the active settings page. */
JPanel _settingsPanel;
/** The used tree to select the different settings pages. */
JTree _tree;
/** Holds all property pages that have been displayed. */
Map _panels = new HashMap(10); // Map of <String>:<AbstractSettingsPage>
/** Associates preview file names and their contents. */
private Map _previews = new HashMap(); // Map of <String>:<String>
/** Helper class to add popup menu support for text components. */
private PopupSupport _popupSupport;
/** Displays a preview. */
private PreviewFrame _previewFrame;
/** Was this object destroyed? */
private boolean _disposed;
//~ Constructors ---------------------------------------------------------------------
/**
* Creates a new SettingsContainer object.
*
* @param previewFrame frame to display a preview file
*/
public SettingsContainer(PreviewFrame previewFrame)
{
_previewFrame = previewFrame;
initialize();
}
//~ Methods --------------------------------------------------------------------------
/**
* Clears the panel cache.
*/
public void clearCache()
{
_panels.clear();
}
/**
* Releases allocated resources.
*/
public void dispose()
{
if (!_disposed)
{
trackPanel();
clearCache();
_popupSupport.setEnabled(false);
_popupSupport = null;
_disposed = true;
}
}
/**
* Stores the settings of all contained pages.
*
* @throws ValidationException if invalid settings were found.
*/
public void updateSettings()
throws ValidationException
{
for (Iterator i = _panels.values().iterator(); i.hasNext();)
{
AbstractSettingsPage page = (AbstractSettingsPage) i.next();
page.validateSettings();
page.updateSettings();
}
}
/**
* Creates the different nodes to choose the settings pages.
*
* @return the root node of the created node tree.
*/
protected DefaultMutableTreeNode createNodes()
{
DefaultMutableTreeNode root = new DefaultMutableTreeNode("ROOT" /* NOI18N */);
DefaultMutableTreeNode general =
new SettingsNode(
new SettingsNodeInfo(
"general" /* NOI18N */,
ResourceBundleFactory.getBundle(BUNDLE_NAME).getString(
"LBL_GENERAL" /* NOI18N */),
"de.hunsicker.jalopy.swing.GeneralSettingsPage" /* NOI18N */));
DefaultMutableTreeNode printer =
new SettingsNode(
new SettingsNodeInfo(
"printer" /* NOI18N */,
ResourceBundleFactory.getBundle(BUNDLE_NAME).getString(
"LBL_PRINTER" /* NOI18N */),
"de.hunsicker.jalopy.swing.DummyPanel" /* NOI18N */));
DefaultMutableTreeNode braces =
new SettingsNode(
new SettingsNodeInfo(
"braces" /* NOI18N */,
ResourceBundleFactory.getBundle(BUNDLE_NAME).getString(
"LBL_BRACES" /* NOI18N */),
"de.hunsicker.jalopy.swing.BracesSettingsPage" /* NOI18N */));
DefaultMutableTreeNode header =
new SettingsNode(
new SettingsNodeInfo(
"header" /* NOI18N */,
ResourceBundleFactory.getBundle(BUNDLE_NAME).getString(
"LBL_HEADER" /* NOI18N */),
"de.hunsicker.jalopy.swing.HeaderSettingsPage" /* NOI18N */));
DefaultMutableTreeNode footer =
new SettingsNode(
new SettingsNodeInfo(
"footer" /* NOI18N */,
ResourceBundleFactory.getBundle(BUNDLE_NAME).getString(
"LBL_FOOTER" /* NOI18N */),
"de.hunsicker.jalopy.swing.FooterSettingsPage" /* NOI18N */));
DefaultMutableTreeNode imports =
new SettingsNode(
new SettingsNodeInfo(
"imports" /* NOI18N */,
ResourceBundleFactory.getBundle(BUNDLE_NAME).getString(
"LBL_IMPORTS" /* NOI18N */),
"de.hunsicker.jalopy.swing.ImportsSettingsPage" /* NOI18N */));
DefaultMutableTreeNode indentation =
new SettingsNode(
new SettingsNodeInfo(
"indentation" /* NOI18N */,
ResourceBundleFactory.getBundle(BUNDLE_NAME).getString(
"LBL_INDENTATION" /* NOI18N */),
"de.hunsicker.jalopy.swing.IndentationSettingsPage" /* NOI18N */));
DefaultMutableTreeNode separation =
new SettingsNode(
new SettingsNodeInfo(
"separation" /* NOI18N */,
ResourceBundleFactory.getBundle(BUNDLE_NAME).getString(
"LBL_BLANK_LINES" /* NOI18N */),
"de.hunsicker.jalopy.swing.BlankLinesSettingsPage" /* NOI18N */));
DefaultMutableTreeNode javadoc =
new SettingsNode(
new SettingsNodeInfo(
"javadoc" /* NOI18N */,
ResourceBundleFactory.getBundle(BUNDLE_NAME).getString(
"LBL_JAVADOC" /* NOI18N */),
"de.hunsicker.jalopy.swing.JavadocSettingsPage" /* NOI18N */));
DefaultMutableTreeNode messages =
new SettingsNode(
new SettingsNodeInfo(
"messages" /* NOI18N */,
ResourceBundleFactory.getBundle(BUNDLE_NAME).getString(
"LBL_MESSAGES" /* NOI18N */),
"de.hunsicker.jalopy.swing.MessagesSettingsPage" /* NOI18N */));
DefaultMutableTreeNode whitespace =
new SettingsNode(
new SettingsNodeInfo(
"whitespace" /* NOI18N */,
ResourceBundleFactory.getBundle(BUNDLE_NAME).getString(
"LBL_WHITESPACE" /* NOI18N */),
"de.hunsicker.jalopy.swing.WhitespaceSettingsPage" /* NOI18N */));
DefaultMutableTreeNode wrapping =
new SettingsNode(
new SettingsNodeInfo(
"wrapping" /* NOI18N */,
ResourceBundleFactory.getBundle(BUNDLE_NAME).getString(
"LBL_WRAPPING" /* NOI18N */),
"de.hunsicker.jalopy.swing.WrappingSettingsPage" /* NOI18N */));
DefaultMutableTreeNode comments =
new SettingsNode(
new SettingsNodeInfo(
"comments" /* NOI18N */,
ResourceBundleFactory.getBundle(BUNDLE_NAME).getString(
"LBL_COMMENTS" /* NOI18N */),
"de.hunsicker.jalopy.swing.CommentsSettingsPage" /* NOI18N */));
DefaultMutableTreeNode sort =
new SettingsNode(
new SettingsNodeInfo(
"sorting" /* NOI18N */,
ResourceBundleFactory.getBundle(BUNDLE_NAME).getString(
"LBL_SORTING" /* NOI18N */),
"de.hunsicker.jalopy.swing.SortingSettingsPage" /* NOI18N */));
DefaultMutableTreeNode misc =
new SettingsNode(
new SettingsNodeInfo(
"misc" /* NOI18N */,
ResourceBundleFactory.getBundle(BUNDLE_NAME).getString(
"LBL_MISC" /* NOI18N */),
"de.hunsicker.jalopy.swing.MiscSettingsPage" /* NOI18N */));
DefaultMutableTreeNode environment =
new SettingsNode(
new SettingsNodeInfo(
"environment" /* NOI18N */,
ResourceBundleFactory.getBundle(BUNDLE_NAME).getString(
"LBL_ENVIRONMENT" /* NOI18N */),
"de.hunsicker.jalopy.swing.EnvironmentSettingsPage" /* NOI18N */));
DefaultMutableTreeNode inspector =
new SettingsNode(
new SettingsNodeInfo(
"inspector" /* NOI18N */,
ResourceBundleFactory.getBundle(BUNDLE_NAME).getString(
"LBL_INSPECTOR" /* NOI18N */),
"de.hunsicker.jalopy.swing.CodeInspectorSettingsPage" /* NOI18N */));
DefaultMutableTreeNode naming =
new SettingsNode(
new SettingsNodeInfo(
"naming" /* NOI18N */,
ResourceBundleFactory.getBundle(BUNDLE_NAME).getString(
"LBL_NAMING" /* NOI18N */),
"de.hunsicker.jalopy.swing.NamingSettingsPage" /* NOI18N */));
DefaultMutableTreeNode projects =
new SettingsNode(
new SettingsNodeInfo(
"projects" /* NOI18N */,
ResourceBundleFactory.getBundle(BUNDLE_NAME).getString(
"LBL_PROJECTS" /* NOI18N */),
"de.hunsicker.jalopy.swing.ProjectSettingsPage" /* NOI18N */));
root.add(general);
root.add(projects);
root.add(printer);
printer.add(braces);
printer.add(whitespace);
printer.add(indentation);
printer.add(wrapping);
printer.add(separation);
printer.add(comments);
printer.add(imports);
printer.add(environment);
printer.add(javadoc);
printer.add(header);
printer.add(footer);
printer.add(sort);
printer.add(misc);
root.add(inspector);
inspector.add(naming);
root.add(messages);
return root;
}
AbstractSettingsPage getCurrentPage()
{
return _curSettingsPanel;
}
/**
* Returns a handle to the preview frame.
*
* @return the preview frame. Returns <code>null</code> if no preview is available.
*
* @since 1.0b8
*/
PreviewFrame getPreview()
{
return _previewFrame;
}
void displayPreview()
{
displayPreview((SettingsNode) _tree.getLastSelectedPathComponent());
}
void displayPreview(SettingsNode node)
{
if ((_previewFrame != null) && (node != null))
{
if (node.toString().equalsIgnoreCase("general")) {
_previewFrame.setCurrentPage(_curSettingsPanel);
String text = loadPreview("general");
if (text != null)
{
_previewFrame.setText(text);
if (!_previewFrame.isVisible())
{
_previewFrame.setVisible(true);
}
}
else
{
_previewFrame.setText(EMPTY_STRING);
}
}
else
if (!((DefaultMutableTreeNode) node.getParent()).isRoot())
{
// only if the user did not choose to display a custom file, we
// display a different file for every settings page
if (_previewFrame.customFile)
{
if (!_previewFrame.isVisible())
{
_previewFrame.setVisible(true);
}
}
else
{
SettingsNode parent = (SettingsNode) node.getParent();
if (parent.getInfo().key.equals("printer" /* NOI18N */))
{
_previewFrame.setCurrentPage(_curSettingsPanel);
String text = loadPreview(_curSettingsPanel.getPreviewFileName());
if (text != null)
{
_previewFrame.setText(text);
if (!_previewFrame.isVisible())
{
_previewFrame.setVisible(true);
}
}
else
{
_previewFrame.setText(EMPTY_STRING);
}
}
else
{
//_previewFrame.setVisible(false);
if (!EMPTY_STRING.equals(_previewFrame.getText()))
{
_previewFrame.setText(EMPTY_STRING);
}
}
}
}
else if (_previewFrame.isVisible())
{
if (!EMPTY_STRING.equals(_previewFrame.getText()))
{
_previewFrame.setText(EMPTY_STRING);
}
//_previewFrame.setVisible(false);
}
}
}
/**
* Loads the contents of the preview file with the given name.
*
* @param name the name of the preview file (without the file extension).
*
* @return the contents of the specified preview file or the empty string if no
* preview file with the given extension exists. Returns <code>null</code>
* if the user specified a custom preview file (via the file menu) and
* therefore loading one of the build-in preview file makes no sense.
*
* @since 1.0b8
*/
String loadPreview(String name)
{
if (_previewFrame.customFile)
{
return null;
}
if (_previews.containsKey(name))
{
return (String) _previews.get(name);
}
Reader in = null;
InputStream s = null;
BufferedWriter out = null;
try
{
if (name.equalsIgnoreCase("general")) {
s = getClass().getResourceAsStream(
"allTest.javatpl" /* NOI18N */ );
}
else {
s = getClass().getResourceAsStream(
"resources/" /* NOI18N */ + name + ".java.tpl" /* NOI18N */ );
}
if (s != null)
{
in = new InputStreamReader(s);
char[] buf = new char[1024];
CharArrayWriter buffer = new CharArrayWriter(1000);
out = new BufferedWriter(buffer);
for (int i = 0, len = 0; (len = in.read(buf, 0, 1024)) != -1; i++)
{
out.write(buf, 0, len);
}
out.flush();
String contents = buffer.toString();
_previews.put(name, contents);
return contents;
}
}
catch (IOException ex)
{
ex.printStackTrace();
}
finally
{
try
{
if (s != null)
{
s.close();
}
}
catch (IOException ignored)
{
;
}
try
{
if (in != null)
{
in.close();
}
}
catch (IOException ignored)
{
;
}
try
{
if (out != null)
{
out.close();
}
}
catch (IOException ignored)
{
;
}
}
return EMPTY_STRING;
}
private SettingsNodeInfo getLast()
{
File file = new File(Convention.getProjectSettingsDirectory(), FILENAME_PAGE);
if (file.exists() && file.isFile())
{
try
{
return (SettingsNodeInfo) IoHelper.deserialize(file);
}
catch (Throwable ignored)
{
}
}
return new SettingsNodeInfo(
"general" /* NOI18N */,
ResourceBundleFactory.getBundle(BUNDLE_NAME).getString(
"LBL_GENERAL" /* NOI18N */),
"de.hunsicker.jalopy.swing.GeneralSettingsPage" /* NOI18N */);
}
String getTitle(DefaultMutableTreeNode node)
{
TreeNode[] path = node.getPath();
StringBuffer buf = new StringBuffer(30);
for (int i = 0; i < path.length; i++)
{
if (path[i].getParent() != null)
{
buf.append(path[i]);
buf.append(" \u00B7 " /* NOI18N */); // middle dot
}
}
buf.setLength(buf.length() - 3);
return buf.toString();
}
/**
* Initializes the UI.
*/
private void initialize()
{
// TODO _settings =
Convention.getInstance();
List supported = new ArrayList(3);
supported.add("javax." /* NOI18N */);
supported.add("de.hunsicker." /* NOI18N */);
_popupSupport = new PopupSupport(supported);
JPanel spacer = new JPanel();
Dimension space = new Dimension(5, 5);
spacer.setMaximumSize(space);
spacer.setMinimumSize(space);
spacer.setPreferredSize(space);
SettingsNodeInfo info = getLast();
_titleLabel = new JLabel(info.title);
_titleLabel.setFont(
new Font(
_titleLabel.getFont().getName(), Font.BOLD,
_titleLabel.getFont().getSize()));
_titleLabel.setBackground(Color.white);
_titleLabel.setForeground(Color.black);
JPanel titlePanel = new JPanel();
titlePanel.add(_titleLabel);
titlePanel.setLayout(new FlowLayout(FlowLayout.LEFT));
titlePanel.setBackground(Color.white);
titlePanel.setBorder(
BorderFactory.createCompoundBorder(
BorderFactory.createMatteBorder(0, 0, 1, 0, Color.white),
BorderFactory.createMatteBorder(0, 0, 1, 0, new Color(132, 130, 132))));
_curSettingsPanel = loadPanel(info);
_panels.put(info.key, _curSettingsPanel);
_settingsPanel = new JPanel();
_settingsPanel.setLayout(new BorderLayout());
_settingsPanel.add(titlePanel, BorderLayout.NORTH);
_settingsPanel.add(_curSettingsPanel, BorderLayout.CENTER);
DefaultMutableTreeNode root = createNodes();
_tree = new JTree(root);
_tree.setRootVisible(false);
_tree.setShowsRootHandles(true);
_tree.putClientProperty("JTree.lineStyle" /* NOI18N */, "Angled" /* NOI18N */);
_tree.setBorder(
BorderFactory.createCompoundBorder(
_tree.getBorder(), BorderFactory.createEmptyBorder(5, 0, 5, 5)));
DefaultTreeCellRenderer r = (DefaultTreeCellRenderer) _tree.getCellRenderer();
r.setClosedIcon(null);
r.setOpenIcon(null);
r.setLeafIcon(null);
// restore selection of the last session
for (Enumeration childs = root.preorderEnumeration(); childs.hasMoreElements();)
{
DefaultMutableTreeNode node = (DefaultMutableTreeNode) childs.nextElement();
TreePath path = new TreePath(node.getPath());
_tree.expandPath(path);
if (node.getUserObject().equals(info.title))
{
_tree.setSelectionPath(path);
_titleLabel.setText(getTitle(node));
}
}
JScrollPane treeView = new JScrollPane();
treeView.setPreferredSize(new Dimension(130, 400));
treeView.getViewport().add(_tree, null);
_tree.addTreeSelectionListener(new TreeSelectionHandler());
JPanel propertyView = new JPanel();
propertyView.setLayout(new BorderLayout());
propertyView.setPreferredSize(new Dimension(430, 450));
propertyView.add(spacer, BorderLayout.WEST);
propertyView.add(_settingsPanel, BorderLayout.CENTER);
setLayout(new BorderLayout());
add(treeView, BorderLayout.WEST);
add(propertyView, BorderLayout.CENTER);
}
/**
* Loads the panel defined by the given settings info.
*
* @param info settings info.
*
* @return the indicated settings panel.
*/
AbstractSettingsPage loadPanel(SettingsNodeInfo info)
{
try
{
Class[] params = { SettingsContainer.class };
Constructor c = info.getPanelClass().getDeclaredConstructor(params);
Object[] args = { this };
AbstractSettingsPage panel = (AbstractSettingsPage) c.newInstance(args);
panel.setTitle(info.title);
panel.setCategory(info.key);
return panel;
}
catch (Throwable ex)
{
ex.printStackTrace();
}
return null;
}
/**
* Tracks the currently displayed panel.
*/
private void trackPanel()
{
File directory = Convention.getProjectSettingsDirectory();
File file = new File(directory, FILENAME_PAGE);
if (IoHelper.ensureDirectoryExists(directory))
{
try
{
SettingsNodeInfo info =
new SettingsNodeInfo(
_curSettingsPanel.getCategory(), _curSettingsPanel.getTitle(),
_curSettingsPanel.getClass().getName());
IoHelper.serialize(info, file);
}
catch (IOException ex)
{
file.delete();
}
}
}
//~ Inner Classes --------------------------------------------------------------------
/**
* Our customized tree node.
*/
private static class SettingsNode
extends DefaultMutableTreeNode
{
/**
* Creates a new SettingsNode object.
*
* @param userObj the node information
*/
public SettingsNode(Object userObj)
{
super(userObj);
}
/**
* Returns the node information.
*
* @return node information object.
*/
public SettingsNodeInfo getInfo()
{
return (SettingsNodeInfo) getUserObject();
}
}
/**
* Helper class which provides the necessary information for every property node.
* This is the user object for the JTree.
*/
private static class SettingsNodeInfo
implements Serializable
{
/** Use serialVersionUID for interoperability. */
static final long serialVersionUID = 4496045479306791488L;
transient Class panelClass;
String className;
String key;
String title;
int hashCode;
public SettingsNodeInfo(
String key,
String title,
String className)
{
this.key = key;
this.className = className;
this.title = title;
this.hashCode = title.hashCode();
}
/**
* Returns the class to load for the settings page.
*
* @return the class to load for the settings page.
*/
public Class getPanelClass()
{
if (this.panelClass == null)
{
try
{
this.panelClass = Helper.loadClass(this.className, this);
}
catch (ClassNotFoundException ex)
{
this.panelClass = GeneralSettingsPage.class;
}
}
return this.panelClass;
}
public boolean equals(Object o)
{
if (o == this)
{
return true;
}
// we only compare titles so that we can easily search the tree
if (o instanceof String)
{
return this.title.equals(o);
}
return false;
}
public int hashCode()
{
return this.hashCode;
}
public String toString()
{
return this.title;
}
}
/**
* Handler for tree selection events. Displays the selected settings page.
*/
private class TreeSelectionHandler
implements TreeSelectionListener
{
boolean armed = true;
public void valueChanged(TreeSelectionEvent ev)
{
if (this.armed)
{
SettingsNode node = (SettingsNode) _tree.getLastSelectedPathComponent();
// do nothing if no node is selected
if (node == null)
{
return;
}
try
{
_curSettingsPanel.validateSettings();
}
catch (ValidationException ex)
{
// validation failed, so we don't want the selection to
// change revert the old path
this.armed = false;
_tree.setSelectionPath(ev.getOldLeadSelectionPath());
return;
}
// update the title
String title = getTitle(node);
_titleLabel.setText(title);
_settingsPanel.remove(_curSettingsPanel);
SettingsNodeInfo info = node.getInfo();
if (_panels.containsKey(info.key))
{
// load panel from cache
_curSettingsPanel = (AbstractSettingsPage) _panels.get(info.key);
}
else
{
_curSettingsPanel = loadPanel(info);
// update cache
_panels.put(info.key, _curSettingsPanel);
}
displayPreview(node);
_settingsPanel.add(_curSettingsPanel, BorderLayout.CENTER);
_settingsPanel.repaint();
}
else
{
this.armed = true;
}
}
}
}
The table below shows all metrics for SettingsContainer.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 84.00 | Number of blocks | |
| BLOCK_COMMENT | 6.00 | Number of block comment lines | |
| COMMENTS | 122.00 | Comment lines | |
| COMMENT_DENSITY | 0.25 | Comment density | |
| COMPARISONS | 33.00 | Number of comparison operators | |
| CYCLOMATIC | 69.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 36.00 | Comments in declarations | |
| DOC_COMMENT | 97.00 | Number of javadoc comment lines | |
| ELOC | 484.00 | Effective lines of code | |
| EXEC_COMMENTS | 11.00 | Comments in executable code | |
| EXITS | 113.00 | Procedure exits | |
| FUNCTIONS | 23.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 71.43 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 44.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 | 1.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 | 9.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 | 3.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 | 6.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 | 1.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 | 1.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 | 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 | 2.00 | JAVA0128 Public constructor in non-public class | |
| JAVA0130 | 2.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 | 0.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 | 3.00 | JAVA0163 Empty statement | |
| JAVA0165 | 0.00 | JAVA0165 Conflicting return statement in finally block | |
| JAVA0166 | 2.00 | JAVA0166 Generic exception caught | |
| JAVA0167 | 0.00 | JAVA0167 ThreadDeath not rethrown | |
| JAVA0169 | 0.00 | JAVA0169 Unnecessary catch block: exception 'exception' | |
| JAVA0170 | 2.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 | 1.00 | JAVA0233 Definition of serialVersionUID other than 'private static final long serialVersionUID' | |
| JAVA0234 | 2.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 | 1.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 | 2.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 | 1.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 | 900.00 | Number of lines in the source file | |
| LINE_COMMENT | 19.00 | Number of line comments | |
| LOC | 657.00 | Lines of code | |
| LOGICAL_LINES | 263.00 | Number of statements | |
| LOOPS | 4.00 | Number of loops | |
| NEST_DEPTH | 7.00 | Maximum nesting depth | |
| OPERANDS | 1140.00 | Number of operands | |
| OPERATORS | 2053.00 | Number of operators | |
| PARAMS | 11.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 3193.00 | Halstead program length | |
| PROGRAM_VOCAB | 440.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 33.00 | Number of return points from functions | |
| SIZE | 28795.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 391.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 49.00 | Number of unique operators | |
| WHITESPACE | 121.00 | Number of whitespace lines | |