Style fixes

git-svn-id: http://svn.dmdirc.com/trunk@512 00569f92-eb28-0410-84fd-f71c24880f

src/uk/org/ownage/dmdirc/logger/DebugLevel.java

@@ -23,11 +23,11 @@
 package uk.org.ownage.dmdirc.logger;
 
 /**
- * Specific debug levels allowed by Logger
+ * Specific debug levels allowed by Logger.
  */
 public enum DebugLevel {        
     /**
-     * Normal debug messages
+     * debug levels recognised by the logger.
      */
-    NORMAL
-}
+    NORMAL,
+}

src/uk/org/ownage/dmdirc/logger/ErrorLevel.java

@@ -23,23 +23,11 @@
 package uk.org.ownage.dmdirc.logger;
 
 /**
- * Specific error levels allowed by Logger
+ * Specific error levels allowed by Logger.
  */
 public enum ErrorLevel {        
     /**
-     * Fatal error
+     * error levels recognised by the logger.
      */
-    FATAL, 
-    /**
-     * Standard error
-     */
-    ERROR, 
-    /**
-     * Warning error
-     */
-    WARNING, 
-    /**
-     * Informational error
-     */
-    INFO
-}
+    FATAL, ERROR, WARNING, INFO,
+}

src/uk/org/ownage/dmdirc/logger/LogLevel.java

@@ -23,27 +23,12 @@
 package uk.org.ownage.dmdirc.logger;
 
 /**
- * Specific log levels allowed by the Logger
+ * Specific log levels allowed by the Logger.
  */
 public enum LogLevel {        
     /**
-     * Core log messages
+     * log levels recognised by the logger.
      */
-    CORE, 
-    /**
-     * Command parser log messages
-     */
-    COMMAND, 
-    /**
-     * Parser log messages
-     */
-    PARSER, 
-    /**
-     * Plugin log messages
-     */
-    PLUGIN, 
-    /**
-     * UI log messages
-     */
-    UI
-}
+    CORE, COMMAND, PARSER,PLUGIN, UI,
+}
+

src/uk/org/ownage/dmdirc/logger/Logger.java

@@ -22,105 +22,107 @@
 
 package uk.org.ownage.dmdirc.logger;
 
-import java.awt.event.WindowAdapter;
-import java.awt.event.WindowEvent;
-import java.beans.PropertyChangeEvent;
-import java.beans.PropertyChangeListener;
-import java.io.BufferedWriter;
 import java.io.FileWriter;
 import java.io.IOException;
 import java.io.PrintWriter;
 import java.text.SimpleDateFormat;
 import java.util.Date;
+
 import javax.swing.JDialog;
 import javax.swing.JOptionPane;
+
 import uk.org.ownage.dmdirc.Config;
 import uk.org.ownage.dmdirc.ui.FatalErrorDialog;
 import uk.org.ownage.dmdirc.ui.MainFrame;
 
 /**
  * Logger class for an applications, provides logging, error logging and debug
- * logging
+ * logging.
  */
-public class Logger {
+public final class Logger {
     
     /**
-     * Logging Printwriter
+     * Logging Printwriter.
      */
-    private static PrintWriter logWriter = null;
+    private static PrintWriter logWriter;
     
     /**
-     * Debug Printwriter
+     * Debug Printwriter.
      */
-    private static PrintWriter debugWriter = null;
+    private static PrintWriter debugWriter;
     
     /**
-     * Error Printwriter
+     * Error Printwriter.
      */
-    private static PrintWriter errorWriter = null;
+    private static PrintWriter errorWriter;
     
     /**
-     * dialog used to report errors to the ui
+     * dialog used to report errors to the ui.
      */
     private static JDialog dialog;
     
     /**
-     * JOptionPane used as part of some dialogs
+     * JOptionPane used as part of some dialogs.
      */
     private static JOptionPane optionPane;
     
     /**
-     * Date formatter, used for logging and displaying messages
+     * Date formatter, used for logging and displaying messages.
      */
     private static SimpleDateFormat formatter;
     
     /**
-     * Prevents creation a new instance of Logger
+     * Prevents creation a new instance of Logger.
      */
     private Logger() {
     }
     
     /**
-     * Record an error message for the application, notifying the user if appropriate
-     * @param level error level
-     * @param message Error message/cause
+     * Record an error message for the application, notifying the user
+     * if appropriate.
+     * @param level error level.
+     * @param message Error message/cause.
      */
-    public static void error(ErrorLevel level, String message) {
+    public static void error(final ErrorLevel level, final String message) {
         if (logWriter == null || debugWriter == null || errorWriter == null) {
             createWriters();
         }
         
         switch (level) {
             case FATAL:
-                errorWriter.println(formatter.format(new Date())+": ERROR: "+level+" :"+message);
-                dialog = new FatalErrorDialog(MainFrame.getMainFrame(), true, new String[]{message});
+                errorWriter.println(formatter.format(new Date()) + ": ERROR: "
+                        + level + " :" + message);
+                dialog = new FatalErrorDialog(MainFrame.getMainFrame(), true,
+                        new String[]{message});
                 dialog.pack();
                 dialog.setLocationRelativeTo(MainFrame.getMainFrame());
                 dialog.setVisible(true);
                 break;
             default:
-                errorWriter.println(formatter.format(new Date())+": ERROR: "+level+" :"+message);
-                System.err.println(formatter.format(new Date())+": ERROR: "+level+" :"+message);
+                errorWriter.println(formatter.format(new Date()) + ": ERROR: "
+                        + level + " :" + message);
+                System.err.println(formatter.format(new Date()) + ": ERROR: "
+                        + level + " :" + message);
                 break;
         }
     }
     
     /**
      * Record an error message for the application at the error error level,
-     * notifying the user if appropriate
-     * @param message Error message/cause
+     * notifying the user if appropriate.
+     * @param message Error message/cause.
      */
-    public static void error(String message) {
+    public static void error(final String message) {
         error(ErrorLevel.ERROR, message);
     }
     
     /**
      * Record an error message for the application, notifying the user if
-     * appropriate
-     * @param level error level
-     * @param exception Cause of error
+     * appropriate.
+     * @param level error level.
+     * @param exception Cause of error.
      */
-    public static void error(ErrorLevel level, Exception exception) {
+    public static void error(final ErrorLevel level, final Exception exception) {
         String[] message;
         int i;
         
@@ -128,17 +130,17 @@ public class Logger {
             createWriters();
         }
         
-        StackTraceElement[] stackTrace = exception.getStackTrace();
+        final StackTraceElement[] stackTrace = exception.getStackTrace();
         switch (level) {
             case FATAL:
-                errorWriter.println(formatter.format(new Date())+
-                        ": ERROR: "+level+" :"+exception);
-                message = new String[stackTrace.length+1];
+                errorWriter.println(formatter.format(new Date())
+                + ": ERROR: " + level + " :" + exception);
+                message = new String[stackTrace.length + 1];
                 message[0] = exception.toString();
                 i = 1;
-                for (StackTraceElement traceElement: stackTrace) {
-                    message[i] = "\t"+traceElement.toString();
-                    errorWriter.println("\t"+traceElement);
+                for (StackTraceElement traceElement : stackTrace) {
+                    message[i] = "\t" + traceElement.toString();
+                    errorWriter.println("\t" + traceElement);
                     i++;
                 }
                 dialog = new FatalErrorDialog(MainFrame.getMainFrame(),
@@ -148,13 +150,13 @@ public class Logger {
                 dialog.setVisible(true);
                 break;
             default:
-                System.err.println(formatter.format(new Date())+
-                        ": ERROR: "+level+" :"+exception);
-                errorWriter.println(formatter.format(new Date())+
-                        ": ERROR: "+level+" :"+exception);
-                for (StackTraceElement traceElement: stackTrace) {
-                    System.err.println("\t"+traceElement);
-                    errorWriter.println("\t"+traceElement);
+                System.err.println(formatter.format(new Date())
+                + ": ERROR: " + level + " :" + exception);
+                errorWriter.println(formatter.format(new Date())
+                + ": ERROR: " + level + " :" + exception);
+                for (StackTraceElement traceElement : stackTrace) {
+                    System.err.println("\t" + traceElement);
+                    errorWriter.println("\t" + traceElement);
                 }
                 break;
         }
@@ -162,21 +164,21 @@ public class Logger {
     
     /**
      * Record an error message for the application at the error error level,
-     * notifying the user if appropriate
-     * @param exception Cause of error
+     * notifying the user if appropriate.
+     * @param exception Cause of error.
      */
-    public static void error(Exception exception) {
+    public static void error(final Exception exception) {
         error(ErrorLevel.ERROR, exception);
     }
     
     /**
      * Record an debug message for the application, notifying the user if
-     * appropriate
-     * @param level debug level
-     * @param message Debug message
+     * appropriate.
+     * @param level debug level.
+     * @param message Debug message.
      */
-    public static void debug(DebugLevel level, String message) {
-        if (!Config.hasOption("logging","debugLogging")
+    public static void debug(final DebugLevel level, final String message) {
+        if (!Config.hasOption("logging", "debugLogging")
         && !Config.getOption("logging", "debugLogging").equals("true")) {
             return;
         }
@@ -186,35 +188,35 @@ public class Logger {
         
         switch(level) {
             default:
-                if (Config.hasOption("logging","debugLoggingSysOut")
+                if (Config.hasOption("logging", "debugLoggingSysOut")
                 && Config.getOption("logging", "debugLoggingSysOut")
                 .equals("true")) {
-                    System.out.println(formatter.format(new Date())+
-                            ": DEBUG: "+level+" :"+message);
+                    System.out.println(formatter.format(new Date()) 
+                    + ": DEBUG: " + level + " :" + message);
                 }
                 
-                debugWriter.println(formatter.format(new Date())+
-                        ": DEBUG: "+level+" :"+message);
+                debugWriter.println(formatter.format(new Date()) 
+                + ": DEBUG: " + level + " :" + message);
                 break;
         }
     }
     
     /**
      * Record an debug message for the application at the normal debug level,
-     * notifying the user if appropriate
-     * @param message Debug message
+     * notifying the user if appropriate.
+     * @param message Debug message.
      */
-    public static void debug(String message) {
+    public static void debug(final String message) {
         debug(DebugLevel.NORMAL, message);
     }
     
     /**
-     * Record a log message for the application
-     * @param level log level
-     * @param message Log message
+     * Record a log message for the application.
+     * @param level log level.
+     * @param message Log message.
      */
-    public static void log(LogLevel level, String message) {
-        if (!Config.hasOption("logging","programLogging")
+    public static void log(final LogLevel level, final String message) {
+        if (!Config.hasOption("logging", "programLogging")
         && !Config.getOption("logging", "programLogging").equals("true")) {
             return;
         }
@@ -224,28 +226,31 @@ public class Logger {
         
         switch(level) {
             default:
-                logWriter.println(formatter.format(new Date())+
-                        ": LOG: "+level+" :"+message);
+                logWriter.println(formatter.format(new Date()) 
+                + ": LOG: " + level + " :" + message);
                 break;
         }
     }
     
     /**
-     * Initialises the the loggers writers (debug, error, log) and date formatter
+     * Initialises the the loggers writers (debug, error, log) and date formatter.
      */
     private static void createWriters() {
         try {
             if (logWriter == null) {
                 logWriter = new PrintWriter(
-                        new FileWriter(Config.getConfigDir()+"log.log", true), true);
+                        new FileWriter(Config.getConfigDir() 
+                        + "log.log", true), true);
             }
             if (debugWriter == null) {
                 debugWriter = new PrintWriter(
-                        new FileWriter(Config.getConfigDir()+"debug.log", true), true);
+                        new FileWriter(Config.getConfigDir() 
+                        + "debug.log", true), true);
             }
             if (errorWriter == null) {
                 errorWriter = new PrintWriter(
-                        new FileWriter(Config.getConfigDir()+"error.log", true), true);
+                        new FileWriter(Config.getConfigDir() 
+                        + "error.log", true), true);
             }
         } catch (IOException ex) {
             Logger.error(ErrorLevel.WARNING, ex);
@@ -257,4 +262,4 @@ public class Logger {
             formatter = new SimpleDateFormat("EEE, d MMM yyyy HH:mm:ss Z");
         }
     }
-}
+}

src/uk/org/ownage/dmdirc/ui/framemanager/tree/TreeFrameManager.java

@@ -35,6 +35,7 @@ import java.awt.event.MouseMotionListener;
 import java.awt.event.MouseWheelEvent;
 import java.awt.event.MouseWheelListener;
 import java.util.Hashtable;
+
 import javax.swing.JComponent;
 import javax.swing.JMenuItem;
 import javax.swing.JPopupMenu;
@@ -54,6 +55,7 @@ import javax.swing.tree.DefaultTreeModel;
 import javax.swing.tree.ExpandVetoException;
 import javax.swing.tree.TreePath;
 import javax.swing.tree.TreeSelectionModel;
+
 import uk.org.ownage.dmdirc.Channel;
 import uk.org.ownage.dmdirc.Config;
 import uk.org.ownage.dmdirc.FrameContainer;
@@ -65,86 +67,86 @@ import uk.org.ownage.dmdirc.logger.Logger;
 import uk.org.ownage.dmdirc.ui.framemanager.FrameManager;
 
 /**
- * Manages open windows in the application in a tree style view
+ * Manages open windows in the application in a tree style view.
  */
-public class TreeFrameManager implements FrameManager, TreeModelListener,
+public final class TreeFrameManager implements FrameManager, TreeModelListener,
         TreeSelectionListener, TreeExpansionListener, TreeWillExpandListener,
         MouseListener, ActionListener, MouseMotionListener, MouseWheelListener,
         KeyListener {
     
     /**
-     * display tree
+     * display tree.
      */
     private JTree tree;
     
     /**
-     * Scrollpane for the tree
+     * Scrollpane for the tree.
      */
     private JScrollPane scrollPane;
     
     /**
-     * root node
+     * root node.
      */
     private DefaultMutableTreeNode root;
     
     /**
-     * node renderer
+     * node renderer.
      */
     private TreeViewTreeCellRenderer renderer;
     
     /**
-     * data model
+     * data model.
      */
     private TreeViewModel model;
     
     /**
-     * node storage, used for adding and deleting nodes correctly
+     * node storage, used for adding and deleting nodes correctly.
      */
     private Hashtable<FrameContainer, DefaultMutableTreeNode> nodes;
     
     /**
-     * stores colour associated with a node, cheap hack till i rewrite the model
+     * stores colour associated with a node, cheap hack till i rewrite the model.
      */
     private Hashtable<FrameContainer, Color> nodeColours;
     
     /**
      * stores background colour associated with a node,
-     * cheap hack till i rewrite the model
+     * cheap hack till i rewrite the model.
      */
     private DefaultMutableTreeNode rolloverNode;
     
     /**
-     * popup menu for menu items on nodes
+     * popup menu for menu items on nodes.
      */
     private JPopupMenu popup;
     
     /**
-     * close menu item used in popup menus
+     * close menu item used in popup menus.
      */
     private JMenuItem closeMenuItem;
     
     /**
-     * The object that is currently selected
+     * The object that is currently selected.
      */
     private FrameContainer selected;
     
     /**
-     *Parent component for the frame manager
+     *Parent component for the frame manager.
      */
     private JComponent parent;
     
     /**
-     * whether the mouse button is currently pressed
+     * whether the mouse button is currently pressed.
      */
     private boolean mouseClicked = true;
     
     /**
-     *node under right click operation
+     *node under right click operation.
      */
     private DefaultMutableTreeNode popupNode;
     
     /**
-     * creates a new instance of the TreeFrameManager
+     * creates a new instance of the TreeFrameManager.
      */
     public TreeFrameManager() {
         nodes = new Hashtable<FrameContainer, DefaultMutableTreeNode>();
@@ -172,8 +174,8 @@ public class TreeFrameManager implements FrameManager, TreeModelListener,
     }
     /**
      * Indicates whether this frame manager can be positioned vertically
-     * (i.e., at the side of the screen)
-     * @return True iff the frame manager can be positioned vertically
+     * (i.e., at the side of the screen).
+     * @return True iff the frame manager can be positioned vertically.
      */
     public boolean canPositionVertically() {
         return true;
@@ -181,18 +183,18 @@ public class TreeFrameManager implements FrameManager, TreeModelListener,
     
     /**
      * Indicates whether this frame manager can be positioned horizontally
-     * (i.e., at the top or bottom of the screen)
-     * @return True iff the frame manager can be positioned horizontally
+     * (i.e., at the top or bottom of the screen).
+     * @return True iff the frame manager can be positioned horizontally.
      */
     public boolean canPositionHorizontally() {
         return false;
     }
     
     /**
-     * Indicates that there is a new active frame
-     * @param source The object that now has focus
+     * Indicates that there is a new active frame.
+     * @param source The object that now has focus.
      */
-    public void setSelected(FrameContainer source) {
+    public void setSelected(final FrameContainer source) {
         selected = source;
         SwingUtilities.invokeLater(new Runnable() {
             public void run() {
@@ -202,16 +204,16 @@ public class TreeFrameManager implements FrameManager, TreeModelListener,
     }
     
     /**
-     * Retrieves the currently selected object
-     * @return The object that is currently selected
+     * Retrieves the currently selected object.
+     * @return The object that is currently selected.
      */
     public FrameContainer getSelected() {
         return selected;
     }
     
     /**
-     * Retrieves the currently selected node
-     * @return The node that is currently selected
+     * Retrieves the currently selected node.
+     * @return The node that is currently selected.
      */
     public DefaultMutableTreeNode getSelectedNode() {
         return nodes.get(selected);
@@ -219,11 +221,11 @@ public class TreeFrameManager implements FrameManager, TreeModelListener,
     
     /**
      * Shows an event notification to the user by colouring the corresponding
-     * element to the source a specific colour
-     * @param source The object requesting notification
-     * @param colour The colour that should be used to indicate the notification
+     * element to the source a specific colour.
+     * @param source The object requesting notification.
+     * @param colour The colour that should be used to indicate the notification.
      */
-    public void showNotification(FrameContainer source, Color colour) {
+    public void showNotification(final FrameContainer source, final Color colour) {
         if (nodeColours != null) {
             nodeColours.put(source, colour);
             SwingUtilities.invokeLater(new Runnable() {
@@ -235,10 +237,10 @@ public class TreeFrameManager implements FrameManager, TreeModelListener,
     }
     
     /**
-     * Sets the rollover node and repaints the tree
-     * @param node rollover node
+     * Sets the rollover node and repaints the tree.
+     * @param node rollover node.
      */
-    public void showRollover(DefaultMutableTreeNode node) {
+    public void showRollover(final DefaultMutableTreeNode node) {
         rolloverNode = node;
         SwingUtilities.invokeLater(new Runnable() {
             public void run() {
@@ -248,29 +250,29 @@ public class TreeFrameManager implements FrameManager, TreeModelListener,
     }
     
     /**
-     * retrives the rollover node
-     * @return rollover node
+     * retrives the rollover node.
+     * @return rollover node.
      */
     public DefaultMutableTreeNode getRollover() {
         return rolloverNode;
     }
     
     /**
-     * Clears a notification from a frame and its node
-     * @param source Frame to remove notification from
+     * Clears a notification from a frame and its node.
+     * @param source Frame to remove notification from.
      */
-    public void clearNotification(FrameContainer source) {
+    public void clearNotification(final FrameContainer source) {
         if (nodeColours != null && nodeColours.containsKey(source)) {
             nodeColours.remove(source);
         }
     }
     
     /**
-     * retrieves the colour of a specific node
-     * @param source node to check colour of
-     * @return colour of the node
+     * retrieves the colour of a specific node.
+     * @param source node to check colour of.
+     * @return colour of the node.
      */
-    public Color getNodeColour(FrameContainer source) {
+    public Color getNodeColour(final FrameContainer source) {
         if (nodeColours != null && nodeColours.containsKey(source)) {
             return nodeColours.get(source);
         }
@@ -278,16 +280,16 @@ public class TreeFrameManager implements FrameManager, TreeModelListener,
     }
     
     /**
-     * Sets the parent component in the main UI
-     * @param parent parent component
+     * Sets the parent component in the main UI.
+     * @param newParent parent component.
      */
-    public void setParent(JComponent parent) {
-        this.parent = parent;
+    public void setParent(final JComponent newParent) {
+        this.parent = newParent;
         scrollPane = new JScrollPane(tree);
         scrollPane.setAutoscrolls(false);
         parent.setLayout(new BorderLayout());
         parent.add(scrollPane);
-        scrollPane.setPreferredSize(new Dimension(parent.getWidth(), 0));;
+        scrollPane.setPreferredSize(new Dimension(parent.getWidth(), 0));
         tree.setForeground(parent.getForeground());
         tree.setBorder(new EmptyBorder(5, 5, 5, 5));
         tree.setVisible(true);
@@ -295,11 +297,11 @@ public class TreeFrameManager implements FrameManager, TreeModelListener,
     }
     
     /**
-     * adds a server to the tree
-     * @param server associated server
+     * adds a server to the tree.
+     * @param server associated server.
      */
-    public void addServer(Server server) {
-        DefaultMutableTreeNode node = new DefaultMutableTreeNode();
+    public void addServer(final Server server) {
+        final DefaultMutableTreeNode node = new DefaultMutableTreeNode();
         nodes.put(server, node);
         node.setUserObject(server);
         model.insertNodeInto(node, root);
@@ -310,20 +312,20 @@ public class TreeFrameManager implements FrameManager, TreeModelListener,
     }
     
     /**
-     * removes a server from the tree
-     * @param server associated server
+     * removes a server from the tree.
+     * @param server associated server.
      */
-    public void delServer(Server server) {
+    public void delServer(final Server server) {
         model.removeNodeFromParent(nodes.get(server));
     }
     
     /**
-     * adds a channel to the tree
-     * @param server associated server
-     * @param channel associated framecontainer
+     * adds a channel to the tree.
+     * @param server associated server.
+     * @param channel associated framecontainer.
      */
-    public void addChannel(Server server, Channel channel) {
-        DefaultMutableTreeNode node = new DefaultMutableTreeNode();
+    public void addChannel(final Server server, final Channel channel) {
+        final DefaultMutableTreeNode node = new DefaultMutableTreeNode();
         nodes.put(channel, node);
         node.setUserObject(channel);
         model.insertNodeInto(node, nodes.get(server));
@@ -331,21 +333,21 @@ public class TreeFrameManager implements FrameManager, TreeModelListener,
     }
     
     /**
-     * deletes a channel from the tree
-     * @param server associated server
-     * @param channel associated framecontainer
+     * deletes a channel from the tree.
+     * @param server associated server.
+     * @param channel associated framecontainer.
      */
-    public void delChannel(Server server, Channel channel) {
+    public void delChannel(final Server server, final Channel channel) {
         model.removeNodeFromParent(nodes.get(channel));
     }
     
     /**
-     * adds a query to the tree
-     * @param server associated server
-     * @param query associated framecontainer
+     * adds a query to the tree.
+     * @param server associated server.
+     * @param query associated framecontainer.
      */
-    public void addQuery(Server server, Query query) {
-        DefaultMutableTreeNode node = new DefaultMutableTreeNode();
+    public void addQuery(final Server server, final Query query) {
+        final DefaultMutableTreeNode node = new DefaultMutableTreeNode();
         nodes.put(query, node);
         node.setUserObject(query);
         model.insertNodeInto(node, nodes.get(server));
@@ -353,134 +355,134 @@ public class TreeFrameManager implements FrameManager, TreeModelListener,
     }
     
     /**
-     * deletes a query from the tree
-     * @param server associated server
-     * @param query associated framecontainer
+     * deletes a query from the tree.
+     * @param server associated server.
+     * @param query associated framecontainer.
      */
-    public void delQuery(Server server, Query query) {
+    public void delQuery(final Server server, final Query query) {
         model.removeNodeFromParent(nodes.get(query));
     }
     
     /**
-     * adds a raw to the tree
-     * @param server associated server
-     * @param raw associated framecontainer
+     * adds a raw to the tree.
+     * @param server associated server.
+     * @param raw associated framecontainer.
      */
-    public void addRaw(Server server, Raw raw) {
-        DefaultMutableTreeNode node = new DefaultMutableTreeNode();
+    public void addRaw(final Server server, final Raw raw) {
+        final DefaultMutableTreeNode node = new DefaultMutableTreeNode();
         nodes.put(raw, node);
         node.setUserObject(raw);
         model.insertNodeInto(node, nodes.get(server));
     }
     
     /**
-     * deletes a raw from the tree
-     * @param server associated server
-     * @param raw associated framecontainer
+     * deletes a raw from the tree.
+     * @param server associated server.
+     * @param raw associated framecontainer.
      */
-    public void delRaw(Server server, Raw raw) {
+    public void delRaw(final Server server, final Raw raw) {
         model.removeNodeFromParent(nodes.get(raw));
     }
     
     /**
-     * valled whenever the value of the selection changes
-     * @param e selection event
+     * valled whenever the value of the selection changes.
+     * @param e selection event.
      */
-    public void valueChanged(TreeSelectionEvent e) {
-        DefaultMutableTreeNode node =
+    public void valueChanged(final TreeSelectionEvent e) {
+        final DefaultMutableTreeNode node =
                 (DefaultMutableTreeNode) tree.getLastSelectedPathComponent();
         
-        if (node == null) return;
+        if (node == null) { return; }
         
-        Object nodeInfo = node.getUserObject();
+        final Object nodeInfo = node.getUserObject();
         if (nodeInfo instanceof FrameContainer) {
-            ((FrameContainer)nodeInfo).activateFrame();
+            ((FrameContainer) nodeInfo).activateFrame();
         } else {
             Logger.error(ErrorLevel.WARNING, "Unknown node type.");
         }
     }
     
     /**
-     * Called after the tree has been expanded
-     * @param event expansion event
+     * Called after the tree has been expanded.
+     * @param event expansion event.
      */
-    public void treeExpanded(TreeExpansionEvent event) {
+    public void treeExpanded(final TreeExpansionEvent event) {
     }
     
     /**
-     * Called after the tree has been collapsed
-     * @param event expansion event
+     * Called after the tree has been collapsed.
+     * @param event expansion event.
      */
-    public void treeCollapsed(TreeExpansionEvent event) {
+    public void treeCollapsed(final TreeExpansionEvent event) {
     }
     
     /**
-     * Called when the tree is about to expand
-     * @param event expansion event
-     * @throws javax.swing.tree.ExpandVetoException thrown to prevent
+     * Called when the tree is about to expand.
+     * @param event expansion event.
+     * @throws javax.swing.tree.ExpandVetoException thrown to prevent.
      * node expanding
      */
-    public void treeWillExpand(TreeExpansionEvent event) throws
+    public void treeWillExpand(final TreeExpansionEvent event) throws
             ExpandVetoException {
     }
     
     /**
-     * Called when the tree is about to collapse
-     * @param event expansion event
-     * @throws javax.swing.tree.ExpandVetoException throw to prevent
+     * Called when the tree is about to collapse.
+     * @param event expansion event.
+     * @throws javax.swing.tree.ExpandVetoException throw to prevent.
      * node collapsing
      */
-    public void treeWillCollapse(TreeExpansionEvent event) throws
+    public void treeWillCollapse(final TreeExpansionEvent event) throws
             ExpandVetoException {
     }
     
     /**
-     * called after a node, or set of nodes, changes
-     * @param e change event
+     * called after a node, or set of nodes, changes.
+     * @param e change event.
      */
-    public void treeNodesChanged(TreeModelEvent e) {
+    public void treeNodesChanged(final TreeModelEvent e) {
     }
     
     /**
-     * called after a node has been inserted into the tree
-     * @param e change event
+     * called after a node has been inserted into the tree.
+     * @param e change event.
      */
-    public void treeNodesInserted(TreeModelEvent e) {
+    public void treeNodesInserted(final TreeModelEvent e) {
     }
     
     /**
-     * Called when a node is removed from the tree
-     * @param e change event
+     * Called when a node is removed from the tree.
+     * @param e change event.
      */
-    public void treeNodesRemoved(TreeModelEvent e) {
+    public void treeNodesRemoved(final TreeModelEvent e) {
     }
     
     /**
-     * Called when a tree changes structure
-     * @param e change event
+     * Called when a tree changes structure.
+     * @param e change event.
      */
-    public void treeStructureChanged(TreeModelEvent e) {
+    public void treeStructureChanged(final TreeModelEvent e) {
     }
     
     /**
      * Invoked when the mouse button has been clicked (pressed and released)
      * on a component.
-     * @param e mouse event
+     * @param e mouse event.
      */
-    public void mouseClicked(MouseEvent e) {
+    public void mouseClicked(final MouseEvent e) {
     }
     
     /**
      * Invoked when a mouse button has been pressed on a component.
-     * @param e mouse event
+     * @param e mouse event.
      */
-    public void mousePressed(MouseEvent e) {
+    public void mousePressed(final MouseEvent e) {
         mouseClicked = true;
         if (e.isPopupTrigger()) {
-            JTree source = (JTree)e.getSource();
-            TreePath path = tree.getPathForLocation(e.getX(), e.getY());
+            final JTree source = (JTree) e.getSource();
+            final TreePath path = tree.getPathForLocation(e.getX(), e.getY());
             if (path != null) {
-                popupNode = (DefaultMutableTreeNode)path.getLastPathComponent();
+                popupNode = (DefaultMutableTreeNode) path.getLastPathComponent();
                 popup.show(source, e.getX(), e.getY());
             }
         }
@@ -488,75 +490,74 @@ public class TreeFrameManager implements FrameManager, TreeModelListener,
     
     /**
      * Invoked when a mouse button has been released on a component.
-     * @param e mouse event
+     * @param e mouse event.
      */
-    public void mouseReleased(MouseEvent e) {
+    public void mouseReleased(final MouseEvent e) {
         mouseClicked = false;
     }
     
     /**
      * Invoked when the mouse enters a component.
-     * @param e mouse event
+     * @param e mouse event.
      */
-    public void mouseEntered(MouseEvent e) {
+    public void mouseEntered(final MouseEvent e) {
     }
     
     /**
      * Invoked when the mouse exits a component.
-     * @param e mouse event
+     * @param e mouse event.
      */
-    public void mouseExited(MouseEvent e) {
+    public void mouseExited(final MouseEvent e) {
     }
     
     /**
      * Invoked when an action occurs.
-     * @param e action event
+     * @param e action event.
      */
-    public void actionPerformed(ActionEvent e) {
+    public void actionPerformed(final ActionEvent e) {
         if (e.getSource() == closeMenuItem && popupNode != null) {
-            ((FrameContainer)popupNode.getUserObject()).close();
+            ((FrameContainer) popupNode.getUserObject()).close();
             popupNode = null;
         }
     }
     
     /**
      * Invoked when a mouse button is pressed on a component and then dragged.
-     * @param e mouse event
+     * @param e mouse event.
      */
-    public void mouseDragged(MouseEvent e) {
+    public void mouseDragged(final MouseEvent e) {
         TreePath selectedPath, currentSelectedPath, oldSelectedPath = null;
         DefaultMutableTreeNode node = null;
-        DefaultTreeModel treeModel = (DefaultTreeModel)tree.getModel();
-        int selRow = tree.getRowForLocation(e.getX(), e.getY());
-        if (selRow < 0) {
+        final DefaultTreeModel treeModel = (DefaultTreeModel) tree.getModel();
+        if (tree.getRowForLocation(e.getX(), e.getY()) < 0) {
             currentSelectedPath = oldSelectedPath;
             oldSelectedPath = null;
             if (currentSelectedPath != null) {
-                node = (DefaultMutableTreeNode)currentSelectedPath.getLastPathComponent();
-                if (Config.hasOption("ui", "rolloverEnabled") &&
-                        Config.getOption("ui", "rolloverEnabled").equals("true")) {
+                node = (DefaultMutableTreeNode) currentSelectedPath.getLastPathComponent();
+                if (Config.hasOption("ui", "rolloverEnabled") 
+                && Config.getOption("ui", "rolloverEnabled").equals("true")) {
                     this.showRollover(node);
                 }
-                ((FrameContainer)node.getUserObject()).activateFrame();
+                ((FrameContainer) node.getUserObject()).activateFrame();
             } else {
-                if (Config.hasOption("ui", "rolloverEnabled") &&
-                        Config.getOption("ui", "rolloverEnabled").equals("true")) {
+                if (Config.hasOption("ui", "rolloverEnabled") 
+                && Config.getOption("ui", "rolloverEnabled").equals("true")) {
                     this.showRollover(node);
                 }
             }
         } else {
             selectedPath = tree.getPathForLocation(e.getX(), e.getY());
-            if ((oldSelectedPath== null) || !selectedPath.equals(oldSelectedPath)) {
+            if ((oldSelectedPath == null) || !selectedPath.equals(oldSelectedPath)) {
                 oldSelectedPath = selectedPath;
-                node = (DefaultMutableTreeNode)oldSelectedPath.getLastPathComponent();
-                if (Config.hasOption("ui", "rolloverEnabled") &&
-                        Config.getOption("ui", "rolloverEnabled").equals("true")) {
+                node = (DefaultMutableTreeNode) oldSelectedPath.getLastPathComponent();
+                if (Config.hasOption("ui", "rolloverEnabled") 
+                && Config.getOption("ui", "rolloverEnabled").equals("true")) {
                     this.showRollover(node);
                 }
-                ((FrameContainer)node.getUserObject()).activateFrame();
+                ((FrameContainer) node.getUserObject()).activateFrame();
             } else {
-                if (Config.hasOption("ui", "rolloverEnabled") &&
-                        Config.getOption("ui", "rolloverEnabled").equals("true")) {
+                if (Config.hasOption("ui", "rolloverEnabled") 
+                && Config.getOption("ui", "rolloverEnabled").equals("true")) {
                     this.showRollover(node);
                 }
             }
@@ -566,29 +567,28 @@ public class TreeFrameManager implements FrameManager, TreeModelListener,
     /**
      * Invoked when the mouse cursor has been moved onto a component but no
      * buttons have been pushed.
-     * @param e mouse event
+     * @param e mouse event.
      */
-    public void mouseMoved(MouseEvent e) {
-        if (Config.hasOption("ui", "rolloverEnabled") &&
-                Config.getOption("ui", "rolloverEnabled").equals("true")) {
+    public void mouseMoved(final MouseEvent e) {
+        if (Config.hasOption("ui", "rolloverEnabled") 
+        && Config.getOption("ui", "rolloverEnabled").equals("true")) {
             TreePath selectedPath, currentSelectedPath, oldSelectedPath = null;
             DefaultMutableTreeNode node;
-            DefaultTreeModel treeModel = (DefaultTreeModel)tree.getModel();
-            int selRow = tree.getRowForLocation(e.getX(), e.getY());
-            if (selRow < 0) {
+            final DefaultTreeModel treeModel = (DefaultTreeModel) tree.getModel();
+            if (tree.getRowForLocation(e.getX(), e.getY()) < 0) {
                 currentSelectedPath = oldSelectedPath;
                 oldSelectedPath = null;
                 if (currentSelectedPath != null) {
-                    node = (DefaultMutableTreeNode)currentSelectedPath.getLastPathComponent();
+                    node = (DefaultMutableTreeNode) currentSelectedPath.getLastPathComponent();
                     this.showRollover(node);
                 } else {
                     this.showRollover(null);
                 }
             } else {
                 selectedPath = tree.getPathForLocation(e.getX(), e.getY());
-                if ((oldSelectedPath== null) || !selectedPath.equals(oldSelectedPath)) {
+                if ((oldSelectedPath == null) || !selectedPath.equals(oldSelectedPath)) {
                     oldSelectedPath = selectedPath;
-                    node = (DefaultMutableTreeNode)oldSelectedPath.getLastPathComponent();
+                    node = (DefaultMutableTreeNode) oldSelectedPath.getLastPathComponent();
                     this.showRollover(node);
                 } else {
                     this.showRollover(null);
@@ -599,12 +599,11 @@ public class TreeFrameManager implements FrameManager, TreeModelListener,
     
     /**
      * Invoked when the mouse wheel is rotated.
-     * @param e mouse event
+     * @param e mouse event.
      */
-    public void mouseWheelMoved(MouseWheelEvent e) {
+    public void mouseWheelMoved(final MouseWheelEvent e) {
         //get the number of notches (used only for direction)
-        int notches = e.getWheelRotation();
-        if (notches < 0) {
+        if (e.getWheelRotation() < 0) {
             changeFocus(true);
         } else {
             changeFocus(false);
@@ -612,20 +611,19 @@ public class TreeFrameManager implements FrameManager, TreeModelListener,
     }
     
     /**
-     * Activates the node above or below the active node in the tree
+     * Activates the node above or below the active node in the tree.
      *
-     *@param direction true = up, false = down
+     *@param direction true = up, false = down.
      */
-    private void changeFocus(boolean direction) {
+    private void changeFocus(final boolean direction) {
         DefaultMutableTreeNode thisNode, nextNode;
-        TreePath path;
         
         if (getSelectedNode() == null) {
             //no selected node, get the root node
             thisNode = root;
             //are there any servers to select?
             if (thisNode.getChildCount() > 0) {
-                thisNode = (DefaultMutableTreeNode)thisNode.getChildAt(0);
+                thisNode = (DefaultMutableTreeNode) thisNode.getChildAt(0);
             } else {
                 //then wait till there are
                 return;
@@ -635,13 +633,13 @@ public class TreeFrameManager implements FrameManager, TreeModelListener,
             thisNode = getSelectedNode();
         }
         //are we going up or down?
-        if (direction){
+        if (direction) {
             //up
             if (thisNode.getUserObject() instanceof Server) {
                 if (thisNode.getParent().getIndex(thisNode) == 0) {
                     //first server - last child of parent's last child
                     nextNode = (DefaultMutableTreeNode)
-                    ((DefaultMutableTreeNode)((DefaultMutableTreeNode)
+                    ((DefaultMutableTreeNode) ((DefaultMutableTreeNode)
                     thisNode.getParent()).getLastChild()).getLastChild();
                 } else {
                     //other servers - last child of previous sibling
@@ -651,7 +649,7 @@ public class TreeFrameManager implements FrameManager, TreeModelListener,
             } else {
                 if (thisNode.getParent().getIndex(thisNode) == 0) {
                     //first frame - parent
-                    nextNode = (DefaultMutableTreeNode)thisNode.getParent();
+                    nextNode = (DefaultMutableTreeNode) thisNode.getParent();
                 } else {
                     //other frame - previous sibling
                     nextNode = thisNode.getPreviousSibling();
@@ -661,15 +659,15 @@ public class TreeFrameManager implements FrameManager, TreeModelListener,
             //down
             if (thisNode.getUserObject() instanceof Server) {
                 //all servers - get the first child
-                nextNode = (DefaultMutableTreeNode)thisNode.getFirstChild();
+                nextNode = (DefaultMutableTreeNode) thisNode.getFirstChild();
             } else {
-                if (thisNode.getParent().getIndex(thisNode) ==
-                        thisNode.getParent().getChildCount()-1) {
+                if (thisNode.getParent().getIndex(thisNode)
+                == thisNode.getParent().getChildCount() - 1) {
                     //last frame - get the parents next sibling
-                    nextNode = ((DefaultMutableTreeNode)thisNode.getParent()).getNextSibling();
+                    nextNode = ((DefaultMutableTreeNode) thisNode.getParent()).getNextSibling();
                     //parent doesnt have a next sibling, get the first child of the grandparent
                     if (nextNode == null) {
-                        nextNode = (DefaultMutableTreeNode)((DefaultMutableTreeNode)
+                        nextNode = (DefaultMutableTreeNode) ((DefaultMutableTreeNode)
                         thisNode.getParent().getParent()).getFirstChild();
                     }
                 } else {
@@ -679,21 +677,21 @@ public class TreeFrameManager implements FrameManager, TreeModelListener,
             }
         }
         //activate the nodes frame
-        ((FrameContainer)nextNode.getUserObject()).activateFrame();
+        ((FrameContainer) nextNode.getUserObject()).activateFrame();
     }
     
     /**
      * Invoked when a key has been typed.
-     * @param e key event
+     * @param e key event.
      */
-    public void keyTyped(KeyEvent e) {
+    public void keyTyped(final KeyEvent e) {
     }
     
     /**
      * Invoked when a key has been pressed.
-     * @param e key event
+     * @param e key event.
      */
-    public void keyPressed(KeyEvent e) {
+    public void keyPressed(final KeyEvent e) {
         if (e.getKeyCode() == KeyEvent.VK_DOWN) {
             changeFocus(false);
         } else if (e.getKeyCode() == KeyEvent.VK_UP) {
@@ -703,8 +701,8 @@ public class TreeFrameManager implements FrameManager, TreeModelListener,
     
     /**
      * Invoked when a key has been released.
-     * @param e key event
+     * @param e key event.
      */
-    public void keyReleased(KeyEvent e) {
+    public void keyReleased(final KeyEvent e) {
     }
 }

src/uk/org/ownage/dmdirc/ui/framemanager/tree/TreeViewModel.java

@@ -41,9 +41,9 @@ public class TreeViewModel extends DefaultTreeModel {
     /**
      * Creates a tree in which any node can have children.
      *
-     * @param root a TreeNode object that is the root of the tree
+     * @param root a TreeNode object that is the root of the tree.
      */
-    public TreeViewModel(TreeNode root) {
+    public TreeViewModel(final TreeNode root) {
         super(root);
     }
     
@@ -51,21 +51,21 @@ public class TreeViewModel extends DefaultTreeModel {
      * Creates a tree specifying whether any node can have children,
      * or whether only certain nodes can have children.
      * @param asksAllowsChildren true = ask whether child can have chilren,
-     * false all nodes can have chilren
-     * @param root a root TreeNode
+     * false all nodes can have chilren.
+     * @param root a root TreeNode.
      */
-    public TreeViewModel(TreeNode root, boolean asksAllowsChildren) {
+    public TreeViewModel(final TreeNode root, final boolean asksAllowsChildren) {
         super(root, asksAllowsChildren);
     }
     
     /**
-     * Inserts a new node into the tree and fires the appropriate events
-     * @param newChild child to be added
-     * @param parent parent child is to be added too
+     * Inserts a new node into the tree and fires the appropriate events.
+     * @param newChild child to be added.
+     * @param parent parent child is to be added too.
      */
-    public void insertNodeInto(DefaultMutableTreeNode newChild, DefaultMutableTreeNode parent) {
+    public final void insertNodeInto(final DefaultMutableTreeNode newChild, final DefaultMutableTreeNode parent) {
         int index = 0;
-        index = doComparison(newChild, parent);
+        index = getIndex(newChild, parent);
         super.insertNodeInto(newChild, parent, index);
     }
     
@@ -74,13 +74,13 @@ public class TreeViewModel extends DefaultTreeModel {
      */
     /**
      * Compares the new child with the existing children or parent to decide
-     * where it needs to be inserted
+     * where it needs to be inserted.
      *
-     * @param newChild
-     * @param parent
-     * @return
+     * @param newChild new node to be inserted.
+     * @param parent node the new node will be inserted into.
+     * @return index where new node is to be inserted.
      */
-    private int doComparison(DefaultMutableTreeNode newChild, DefaultMutableTreeNode parent) {
+    private int getIndex(final DefaultMutableTreeNode newChild, final DefaultMutableTreeNode parent) {
         if (parent == root) {
             return root.getChildCount();
         }

src/uk/org/ownage/dmdirc/ui/framemanager/tree/TreeViewTreeCellRenderer.java

@@ -27,19 +27,21 @@ import java.awt.Component;
 import java.awt.Dimension;
 import java.awt.Font;
 import java.net.URL;
+
 import javax.swing.ImageIcon;
 import javax.swing.JTree;
 import javax.swing.border.EmptyBorder;
 import javax.swing.border.LineBorder;
 import javax.swing.tree.DefaultMutableTreeNode;
 import javax.swing.tree.DefaultTreeCellRenderer;
+
 import uk.org.ownage.dmdirc.Config;
 import uk.org.ownage.dmdirc.FrameContainer;
 import uk.org.ownage.dmdirc.ui.MainFrame;
 import uk.org.ownage.dmdirc.ui.messages.ColourManager;
 
 /**
- * Displays a node in a tree according to its type
+ * Displays a node in a tree according to its type.
  */
 public class TreeViewTreeCellRenderer extends DefaultTreeCellRenderer {
     
@@ -51,50 +53,49 @@ public class TreeViewTreeCellRenderer extends DefaultTreeCellRenderer {
     private static final long serialVersionUID = 1;
     
     /**
-     * default icon
+     * default icon.
      */
-    ImageIcon defaultIcon;
+    private ImageIcon defaultIcon;
     
     /**
-     * Creates a new instance of TreeViewTreeCellRenderer
+     * Creates a new instance of TreeViewTreeCellRenderer.
      */
     public TreeViewTreeCellRenderer() {
-        ClassLoader cldr = this.getClass().getClassLoader();
-        URL imageURL = cldr.getResource("uk/org/ownage/dmdirc/res/icon.png");
+        final ClassLoader cldr = this.getClass().getClassLoader();
+        final URL imageURL = cldr.getResource("uk/org/ownage/dmdirc/res/icon.png");
         defaultIcon = new ImageIcon(imageURL);
     }
     
     /**
-     * Configures the renderer based on the passed parameters
-     * @param tree JTree for this renderer
-     * @param value node to be renderered
-     * @param sel whether the node is selected
-     * @param expanded whether the node is expanded
-     * @param leaf whether the node is a leaf
-     * @param row the node's row
-     * @param hasFocus whether the node has focus
-     * @return RendererComponent for this node
+     * Configures the renderer based on the passed parameters.
+     * @param tree JTree for this renderer.
+     * @param value node to be renderered.
+     * @param sel whether the node is selected.
+     * @param expanded whether the node is expanded.
+     * @param leaf whether the node is a leaf.
+     * @param row the node's row.
+     * @param hasFocus whether the node has focus.
+     * @return RendererComponent for this node.
      */
-    public Component getTreeCellRendererComponent(JTree tree, Object value,
-            boolean sel, boolean expanded, boolean leaf, int row,
-            boolean hasFocus) {
+    public final Component getTreeCellRendererComponent(final JTree tree, 
+            final Object value, final boolean sel, final boolean expanded, 
+            final boolean leaf, final int row, final boolean hasFocus) {
         
-        Component c = super.getTreeCellRendererComponent(tree, value, sel, expanded, leaf,
+        final Component c = super.getTreeCellRendererComponent(tree, value, sel, expanded, leaf,
                 row, hasFocus);
         
-        DefaultMutableTreeNode node = (DefaultMutableTreeNode)value;
+        final DefaultMutableTreeNode node = (DefaultMutableTreeNode) value;
         
         TreeFrameManager manager = null;
         
         if (MainFrame.hasMainFrame()) {
-            manager = (TreeFrameManager)MainFrame.getMainFrame().getFrameManager();
+            manager = (TreeFrameManager) MainFrame.getMainFrame().getFrameManager();
         }
         
         setBackground(null);
         
         if (manager != null) {
-            DefaultMutableTreeNode rolloverNode = manager.getRollover();
-            if (rolloverNode == value) {
+            if (manager.getRollover() == value) {
                 if (Config.hasOption("ui", "rolloverColour")) {
                     setBackground(ColourManager.getColour(
                             Config.getOption("ui", "rolloverColour")));
@@ -104,15 +105,15 @@ public class TreeViewTreeCellRenderer extends DefaultTreeCellRenderer {
             }
         }
         setForeground(tree.getForeground());
-        setPreferredSize(new Dimension(110, getFont().getSize()+5));
+        setPreferredSize(new Dimension(110, getFont().getSize() + 5));
         
         setOpaque(true);
         if (node.getUserObject() instanceof FrameContainer && manager != null) {
-            Color colour = manager.getNodeColour((FrameContainer)node.getUserObject());
+            final Color colour = manager.getNodeColour((FrameContainer) node.getUserObject());
             if (colour != null) {
                 setForeground(colour);
             }
-            setIcon(((FrameContainer)node.getUserObject()).getIcon());
+            setIcon(((FrameContainer) node.getUserObject()).getIcon());
         } else {
             
             setIcon(defaultIcon);