remove some of the more weird runtime exception suppression code

Author: Henning Schmiedehausen

src/main/java/org/productivity/java/syslog4j/Syslog.java

@@ -18,6 +18,7 @@
 import org.productivity.java.syslog4j.util.OSDetectUtility;
 import org.productivity.java.syslog4j.util.SyslogUtility;
 
+import com.google.common.base.Preconditions;
 import com.google.common.collect.Maps;
 
 /**
@@ -45,8 +46,6 @@
  */
 public final class Syslog
 {
-    private static boolean SUPPRESS_RUNTIME_EXCEPTIONS = false;
-
     protected static final Map<String, SyslogIF> instances = Maps.newHashMap();
 
     /**
@@ -64,42 +63,6 @@ private Syslog() {
         //
     }
 
-    /**
-     * @return Returns the current version identifier for Syslog4j.
-     */
-    public static final String getVersion() {
-        return Syslog4jVersion.VERSION;
-    }
-
-    /**
-     * @param suppress - true to suppress throwing SyslogRuntimeException in many methods of this class, false to throw exceptions (default)
-     */
-    public static void setSuppressRuntimeExceptions(boolean suppress) {
-        SUPPRESS_RUNTIME_EXCEPTIONS = suppress;
-    }
-
-    /**
-     * @return Returns whether or not to suppress throwing SyslogRuntimeException in many methods of this class.
-     */
-    public static boolean getSuppressRuntimeExceptions() {
-        return SUPPRESS_RUNTIME_EXCEPTIONS;
-    }
-
-    /**
-     * Throws SyslogRuntimeException unless it has been suppressed via setSuppressRuntimeException(boolean).
-     *
-     * @param message
-     * @throws SyslogRuntimeException
-     */
-    private static void throwRuntimeException(String message) throws SyslogRuntimeException {
-        if (SUPPRESS_RUNTIME_EXCEPTIONS) {
-            return;
-
-        } else {
-            throw new SyslogRuntimeException(message.toString());
-        }
-    }
-
     /**
      * Use getInstance(protocol) as the starting point for Syslog4j.
      *
@@ -130,8 +93,7 @@ public static final SyslogIF getInstance(String protocol) throws SyslogRuntimeEx
                 }
             }
 
-            throwRuntimeException(message.toString());
-            return null;
+            throw new SyslogRuntimeException(message.toString());
         }
     }
 
@@ -153,27 +115,17 @@ public static final SyslogIF getInstance(String protocol) throws SyslogRuntimeEx
      * @return Returns an instance of SyslogIF.
      * @throws SyslogRuntimeException
      */
-    public static final SyslogIF createInstance(String protocol, SyslogConfigIF config) throws SyslogRuntimeException {
-
-        if (StringUtils.isBlank(protocol)) {
-            throwRuntimeException("Instance protocol cannot be null or empty");
-            return null;
-        }
-
-        if (config == null) {
-            throwRuntimeException("SyslogConfig cannot be null");
-            return null;
-        }
+    public static final SyslogIF createInstance(String protocol, SyslogConfigIF config) throws SyslogRuntimeException
+    {
+        Preconditions.checkArgument(!StringUtils.isBlank(protocol), "Instance protocol cannot be null or empty");
+        Preconditions.checkArgument(config != null, "SyslogConfig cannot be null");
 
         String syslogProtocol = protocol.toLowerCase();
 
         SyslogIF syslog = null;
 
         synchronized(instances) {
-            if (instances.containsKey(syslogProtocol)) {
-                throwRuntimeException("Syslog protocol \"" + protocol + "\" already defined");
-                return null;
-            }
+            Preconditions.checkState(!instances.containsKey(syslogProtocol), "Syslog protocol \"%s\" already defined", protocol);
 
             try {
                 Class<? extends SyslogIF> syslogClass = config.getSyslogClass();
@@ -295,8 +247,7 @@ public synchronized static final void destroyInstance(String protocol) throws Sy
             }
 
         } else {
-            throwRuntimeException("Cannot destroy protocol \"" + protocol + "\" instance; call shutdown instead");
-            return;
+            throw new SyslogRuntimeException("Cannot destroy protocol \"%s\" instance; call shutdown instead", protocol);
         }
     }
 
@@ -323,8 +274,7 @@ public synchronized static final void destroyInstance(SyslogIF syslog) throws Sy
             }
 
         } else {
-            throwRuntimeException("Cannot destroy protocol \"" + protocol + "\" instance; call shutdown instead");
-            return;
+            throw new SyslogRuntimeException("Cannot destroy protocol \"%s\" instance; call shutdown instead", protocol);
         }
     }
 

src/main/java/org/productivity/java/syslog4j/Syslog4jVersion.java

@@ -1,6 +1,5 @@
 package org.productivity.java.syslog4j;
 
-import java.io.Serializable;
 import java.nio.charset.Charset;
 
 /**
@@ -14,7 +13,7 @@
 * @author <syslog4j@productivity.org>
 * @version $Id: SyslogCharSetIF.java,v 1.3 2008/11/07 15:15:41 cvs Exp $
 */
-public interface SyslogCharSetIF extends Serializable
+public interface SyslogCharSetIF
 {
     Charset getCharSet();
 

src/main/java/org/productivity/java/syslog4j/SyslogCharSetIF.java

@@ -126,10 +126,6 @@ public static void main(String[] args, boolean shutdown) throws Exception {
             if (CALL_SYSTEM_EXIT_ON_FAILURE) { System.exit(1); } else { return; }
         }
 
-        if (!options.quiet) {
-            System.out.println("Syslog " + Syslog.getVersion());
-        }
-
         if (!Syslog.exists(options.protocol)) {
             usage("Protocol \"" + options.protocol + "\" not supported");
             if (CALL_SYSTEM_EXIT_ON_FAILURE) { System.exit(1); } else { return; }

src/main/java/org/productivity/java/syslog4j/SyslogMain.java

@@ -1,6 +1,5 @@
 package org.productivity.java.syslog4j;
 
-import java.io.Serializable;
 
 /**
 * SyslogMessageIF provides a common interface for all Syslog4j event implementations.
@@ -12,6 +11,6 @@
 * @author <syslog4j@productivity.org>
 * @version $Id: SyslogMessageIF.java,v 1.1 2008/11/10 04:38:37 cvs Exp $
 */
-public interface SyslogMessageIF extends Serializable {
+public interface SyslogMessageIF {
     public String createMessage();
 }

src/main/java/org/productivity/java/syslog4j/SyslogMessageIF.java

@@ -1,6 +1,5 @@
 package org.productivity.java.syslog4j;
 
-import java.io.Serializable;
 
 /**
 * SyslogMessageProcessorIF provides an extensible interface for writing custom
@@ -13,7 +12,7 @@
 * @author <syslog4j@productivity.org>
 * @version $Id: SyslogMessageProcessorIF.java,v 1.4 2010/11/28 04:15:18 cvs Exp $
 */
-public interface SyslogMessageProcessorIF extends Serializable {
+public interface SyslogMessageProcessorIF {
     public String createSyslogHeader(SyslogFacility facility, SyslogLevel level, String localName, boolean sendLocalTimestamp, boolean sendLocalName);
 
     public byte[] createPacketData(byte[] header, byte[] message, int start, int length);

src/main/java/org/productivity/java/syslog4j/SyslogMessageProcessorIF.java

@@ -1,6 +1,5 @@
 package org.productivity.java.syslog4j;
 
-import java.io.Serializable;
 
 /**
 * SyslogPoolConfigIF is an interface which provides configuration support
@@ -13,7 +12,7 @@
 * @author <syslog4j@productivity.org>
 * @version $Id: SyslogPoolConfigIF.java,v 1.2 2009/03/29 17:38:58 cvs Exp $
 */
-public interface SyslogPoolConfigIF extends Serializable {
+public interface SyslogPoolConfigIF {
     public int getMaxActive();
     public void setMaxActive(int maxActive);
 

src/main/java/org/productivity/java/syslog4j/SyslogPoolConfigIF.java

@@ -11,12 +11,17 @@
 * @author <syslog4j@productivity.org>
 * @version $Id: SyslogRuntimeException.java,v 1.3 2008/11/13 14:48:36 cvs Exp $
 */
-public class SyslogRuntimeException extends RuntimeException {
-    public SyslogRuntimeException(String arg0) {
-        super(arg0);
+public class SyslogRuntimeException extends RuntimeException
+{
+    public SyslogRuntimeException(String format, Object ... args) {
+        super(String.format(format, args));
     }
 
-    public SyslogRuntimeException(Throwable arg0) {
-        super(arg0);
+    public SyslogRuntimeException(Throwable t) {
+        super(t);
+    }
+
+    public SyslogRuntimeException(Throwable t, String format, Object ... args) {
+        super(String.format(format, args), t);
     }
 }

src/main/java/org/productivity/java/syslog4j/SyslogRuntimeException.java

@@ -1,6 +1,5 @@
 package org.productivity.java.syslog4j.impl;
 
-import java.io.Serializable;
 import java.util.List;
 
 import org.productivity.java.syslog4j.SyslogLevel;
@@ -23,7 +22,7 @@
 * @author <syslog4j@productivity.org>
 * @version $Id: AbstractSyslogWriter.java,v 1.9 2010/10/25 03:50:25 cvs Exp $
 */
-public abstract class AbstractSyslogWriter implements Runnable, Serializable {
+public abstract class AbstractSyslogWriter implements Runnable {
     protected AbstractSyslog syslog = null;
 
     protected List<byte []> queuedMessages = null;

src/main/java/org/productivity/java/syslog4j/impl/AbstractSyslogWriter.java

@@ -18,18 +18,22 @@
 public class NullSyslogBackLogHandler implements SyslogBackLogHandlerIF {
     public static final NullSyslogBackLogHandler INSTANCE = new NullSyslogBackLogHandler();
 
+    @Override
     public void initialize() {
         //
     }
 
+    @Override
     public void down(SyslogIF syslog, String reason) {
         //
     }
 
+    @Override
     public void up(SyslogIF syslog) {
         //
     }
 
+    @Override
     public void log(SyslogIF syslog, SyslogLevel level, String message, String reason) {
         //
     }