Updated logger to use the new FatalErrorDialog

Updated FatalErrorDialog to terminate the application and show the appropriate error message


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

dist/README.TXT

@@ -1,31 +0,0 @@
-========================
-BUILD OUTPUT DESCRIPTION
-========================
-
-When you build an Java application project that has a main class, the IDE
-automatically copies all of the JAR
-files on the projects classpath to your projects dist/lib folder. The IDE
-also adds each of the JAR files to the Class-Path element in the application
-JAR files manifest file (MANIFEST.MF).
-
-To run the project from the command line, go to the dist folder and
-type the following:
-
-java -jar "DMDirc.jar" 
-
-To distribute this project, zip up the dist folder (including the lib folder)
-and distribute the ZIP file.
-
-Notes:
-
-* If two JAR files on the project classpath have the same name, only the first
-JAR file is copied to the lib folder.
-* If the classpath contains a folder of classes or resources, none of the
-classpath elements are copied to the dist folder.
-* If a library on the projects classpath also has a Class-Path element
-specified in the manifest,the content of the Class-Path element has to be on
-the projects runtime path.
-* To set a main class in a standard Java project, right-click the project node
-in the Projects window and choose Properties. Then click Run and enter the
-class name in the Main Class field. Alternatively, you can manually type the
-class name in the manifest Main-Class element.

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

@@ -22,9 +22,12 @@
 
 package uk.org.ownage.dmdirc.logger;
 
+/**
+ * Specific debug levels allowed by Logger
+ */
 public enum DebugLevel {        
-    NORMAL, 
-    FINE, 
-    FINER, 
-    FINEST
+    /**
+     * Normal debug messages
+     */
+    NORMAL
 }

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

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

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

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

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

@@ -35,124 +35,130 @@ 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;
 
 /**
- *
- * @author greboid
+ * Logger class for an applications, provides logging, error logging and debug 
+ * logging
  */
 public class Logger {
     
+    /**
+     * Logfile Printwriter
+     */
     private static PrintWriter logWriter = null;
     
+    /**
+     * dialog used to report errors to the ui
+     */
     private static JDialog dialog;
     
+    /**
+     * JOptionPane used as part of some dialogs
+     */
     private static JOptionPane optionPane;
     
-    private static SimpleDateFormat format;
+    /**
+     * Date formatter, used for logging and displaying messages
+     */
+    private static SimpleDateFormat formatter;
     
-    /** Creates 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
+     */
     public static void error(ErrorLevel level, String message) {
         if (logWriter == null ) createWriter();
         switch (level) {
             case FATAL:
-                logWriter.println(format.format(new Date())+": ERROR: "+level+" :"+message);
-                optionPane = new JOptionPane(message, JOptionPane.ERROR_MESSAGE,
-                        JOptionPane.DEFAULT_OPTION);
-                dialog = new JDialog(MainFrame.getMainFrame(), "Fatal Error",
-                        true);
-                dialog.setContentPane(optionPane);
-                dialog.setDefaultCloseOperation(
-                        JDialog.DO_NOTHING_ON_CLOSE);
-                dialog.addWindowListener(new WindowAdapter() {
-                    public void windowClosing(WindowEvent we) {
-                        System.exit(-1);
-                    }
-                });
-                optionPane.addPropertyChangeListener(
-                        new PropertyChangeListener() {
-                    public void propertyChange(PropertyChangeEvent e) {
-                        if (dialog.isVisible() && e.getSource() == optionPane) {
-                            System.exit(-1);
-                        }
-                    }
-                });
+                logWriter.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:
-                logWriter.println(format.format(new Date())+": ERROR: "+level+" :"+message);
-                System.err.println(format.format(new Date())+": ERROR: "+level+" :"+message);
+                logWriter.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, notifying the user if appropriate
+     * @param level error level
+     * @param exception Cause of error
+     */
     public static void error(ErrorLevel level, Exception exception) {
+        String[] message;
         if (logWriter == null ) createWriter();
-        StackTraceElement[] stacktrace = exception.getStackTrace();
+        StackTraceElement[] stackTrace = exception.getStackTrace();
         switch (level) {
             case FATAL:
-                logWriter.println(format.format(new Date())+": ERROR: "+level+" :"+exception.getMessage());
-                for (StackTraceElement traceElement: stacktrace) {
+                logWriter.println(formatter.format(new Date())+": ERROR: "+level+" :"+exception.getMessage());
+                message = new String[stackTrace.length+1];
+                message[0] = exception.getMessage();
+                int i = 1;
+                for (StackTraceElement traceElement: stackTrace) {
+                    message[i] = traceElement.toString();
                     logWriter.println("\t\t\t\t"+traceElement);
+                    i++;
                 }
-                optionPane = new JOptionPane(exception.getMessage(), JOptionPane.ERROR_MESSAGE,
-                        JOptionPane.DEFAULT_OPTION);
-                dialog = new JDialog(MainFrame.getMainFrame(), "Fatal Error",
-                        true);
-                dialog.setContentPane(optionPane);
-                dialog.setDefaultCloseOperation(
-                        JDialog.DO_NOTHING_ON_CLOSE);
-                dialog.addWindowListener(new WindowAdapter() {
-                    public void windowClosing(WindowEvent we) {
-                        System.exit(-1);
-                    }
-                });
-                optionPane.addPropertyChangeListener(
-                        new PropertyChangeListener() {
-                    public void propertyChange(PropertyChangeEvent e) {
-                        if (dialog.isVisible() && e.getSource() == optionPane) {
-                            System.exit(-1);
-                        }
-                    }
-                });
+                dialog = new FatalErrorDialog(MainFrame.getMainFrame(), true, message);
                 dialog.pack();
                 dialog.setLocationRelativeTo(MainFrame.getMainFrame());
                 dialog.setVisible(true);
                 break;
             default:
-                logWriter.println(format.format(new Date())+": ERROR: "+level+" :"+exception.getMessage());
-                for (StackTraceElement traceElement: stacktrace) {
+                logWriter.println(formatter.format(new Date())+": ERROR: "+level+" :"+exception.getMessage());
+                for (StackTraceElement traceElement: stackTrace) {
                     logWriter.println("\t\t\t\t"+traceElement);
                 }
-                System.err.println(format.format(new Date())+": ERROR: "+level+" :"+exception.getMessage());
+                System.err.println(formatter.format(new Date())+": ERROR: "+level+" :"+exception.getMessage());
                 break;
         }
     }
     
+    /**
+     * Record an debug message for the application, notifying the user if appropriate
+     * @param level debug level
+     * @param message Debug message
+     */
     public static void debug(DebugLevel level, String message) {
         if (logWriter == null ) createWriter();
         switch(level) {
             default:
-                System.out.println(format.format(new Date())+": DEBUG: "+level+" :"+message);
-                logWriter.println(format.format(new Date())+": DEBUG: "+level+" :"+message);
+                System.out.println(formatter.format(new Date())+": DEBUG: "+level+" :"+message);
+                logWriter.println(formatter.format(new Date())+": DEBUG: "+level+" :"+message);
                 break;
         }
     }
     
+    /**
+     * Record a log message for the application
+     * @param level log level
+     * @param message Log message
+     */
     public static void log(LogLevel level, String message) {
         if (logWriter == null ) createWriter();
         switch(level) {
             default:
-                logWriter.println(format.format(new Date())+": LOG: "+level+" :"+message);
+                logWriter.println(formatter.format(new Date())+": LOG: "+level+" :"+message);
                 break;
         }
     }
     
+    /**
+     * Initialises the logfile writer and date formatter
+     */
     private static void createWriter() {
         try {
             logWriter = new PrintWriter(new BufferedWriter(new FileWriter(Config.getConfigDir()+"errors.log")));
@@ -160,9 +166,9 @@ public class Logger {
             Logger.error(ErrorLevel.FATAL, "Oh god, i cant open the error log.");
         }
         if (Config.hasOption("logging", "dateFormat")) {
-            format = new SimpleDateFormat(Config.getOption("logging", "dateFormat"));
+            formatter = new SimpleDateFormat(Config.getOption("logging", "dateFormat"));
         } else {
-            format = new SimpleDateFormat("EEE, d MMM yyyy HH:mm:ss Z");
+            formatter = new SimpleDateFormat("EEE, d MMM yyyy HH:mm:ss Z");
         }
     }
 }

src/uk/org/ownage/dmdirc/ui/FatalErrorDialog.form

@@ -7,6 +7,9 @@
   <SyntheticProperties>
     <SyntheticProperty name="formSizePolicy" type="int" value="1"/>
   </SyntheticProperties>
+  <Events>
+    <EventHandler event="windowClosing" listener="java.awt.event.WindowListener" parameters="java.awt.event.WindowEvent" handler="formWindowClosing"/>
+  </Events>
   <AuxValues>
     <AuxValue name="FormSettings_generateMnemonicsCode" type="java.lang.Boolean" value="false"/>
     <AuxValue name="FormSettings_layoutCodeTarget" type="java.lang.Integer" value="2"/>
@@ -88,6 +91,9 @@
       <Properties>
         <Property name="text" type="java.lang.String" value="OK"/>
       </Properties>
+      <Events>
+        <EventHandler event="actionPerformed" listener="java.awt.event.ActionListener" parameters="java.awt.event.ActionEvent" handler="jButton1ActionPerformed"/>
+      </Events>
     </Component>
   </SubComponents>
 </Form>

src/uk/org/ownage/dmdirc/ui/FatalErrorDialog.java

@@ -6,16 +6,23 @@
 
 package uk.org.ownage.dmdirc.ui;
 
+import java.awt.event.ActionEvent;
+import java.awt.event.ActionListener;
+import uk.org.ownage.dmdirc.logger.Logger;
+
 /**
  *
  * @author  chris
  */
 public class FatalErrorDialog extends javax.swing.JDialog {
     
-    /** Creates new form FatalErrorDialog */
-    public FatalErrorDialog(java.awt.Frame parent, boolean modal) {
+    public FatalErrorDialog(java.awt.Frame parent, boolean modal, String[] message) {
         super(parent, modal);
         initComponents();
+        for (String line: message) {
+            jTextArea1.append(line+"\r\n");
+        }
+        jTextArea1.setCaretPosition(0);
     }
     
     /** This method is called from within the constructor to
@@ -33,6 +40,12 @@ public class FatalErrorDialog extends javax.swing.JDialog {
         jButton1 = new javax.swing.JButton();
 
         setDefaultCloseOperation(javax.swing.WindowConstants.DISPOSE_ON_CLOSE);
+        addWindowListener(new java.awt.event.WindowAdapter() {
+            public void windowClosing(java.awt.event.WindowEvent evt) {
+                formWindowClosing(evt);
+            }
+        });
+
         jLabel1.setFont(new java.awt.Font("Dialog", 1, 18));
         jLabel1.setText("We're sorry...");
 
@@ -46,6 +59,11 @@ public class FatalErrorDialog extends javax.swing.JDialog {
         jScrollPane1.setViewportView(jTextArea1);
 
         jButton1.setText("OK");
+        jButton1.addActionListener(new java.awt.event.ActionListener() {
+            public void actionPerformed(java.awt.event.ActionEvent evt) {
+                jButton1ActionPerformed(evt);
+            }
+        });
 
         org.jdesktop.layout.GroupLayout layout = new org.jdesktop.layout.GroupLayout(getContentPane());
         getContentPane().setLayout(layout);
@@ -78,7 +96,15 @@ public class FatalErrorDialog extends javax.swing.JDialog {
         );
         pack();
     }// </editor-fold>//GEN-END:initComponents
-        
+
+    private void formWindowClosing(java.awt.event.WindowEvent evt) {//GEN-FIRST:event_formWindowClosing
+      System.exit(-1);
+    }//GEN-LAST:event_formWindowClosing
+
+    private void jButton1ActionPerformed(java.awt.event.ActionEvent evt) {//GEN-FIRST:event_jButton1ActionPerformed
+      System.exit(-1);
+    }//GEN-LAST:event_jButton1ActionPerformed
+    
     // Variables declaration - do not modify//GEN-BEGIN:variables
     private javax.swing.JButton jButton1;
     private javax.swing.JLabel jLabel1;