org.jostraca.util
Class ErrorUtil

java.lang.Object
  org.jostraca.util.ErrorUtil

public class ErrorUtil

extends java.lang.Object

Utility class for error handling.

Field Summary

static java.lang.String	CN
static java.lang.String	MSG_FatalInternalError
static java.lang.String	MSG_NonFatalInternalError
static java.lang.String	MSG_was_null

Constructor Summary

ErrorUtil()

Method Summary

static void	collectErrors() Collect errors instead of displaying them.
static void	fatalMsg(java.lang.Exception pException) Handle fatal Exceptions.
static void	fatalMsg(java.lang.String pMsg) Handle fatal error msgs - corrupt startup, etc.
static void	fatalMsg(java.lang.String pMsg, java.lang.Exception pException) Handle non fatal Exceptions
static java.lang.String	getCollectedErrors() Get any collected errors.
static boolean	hasCollectedErrors() True if any collected errors exist.
static boolean	is_null(java.lang.Object pObject) True if pObject is null.
static boolean	is_null(java.lang.Object pObject, java.lang.String pName) True if pObject is null.
static void	nonFatalException(java.lang.Exception pException)
static void	nonFatalException(java.lang.Exception pException, java.lang.String pClassName)
static void	nonFatalException(java.lang.Exception pException, java.lang.String pClassName, java.lang.String pMethodName)
static void	nonFatalIndexOutOfBounds(java.lang.Object pObject, java.lang.String pMsg, int pIndex, int pLower, int pUpper, java.lang.String pArray) Handle index out of bounds.
static void	nonFatalMsg(java.lang.Exception pException) Handle non-fatal Exceptions.
static void	nonFatalMsg(java.lang.String pMsg) Handle non-fatal error msgs - ignored nulls etc.
static void	nonFatalMsg(java.lang.String pMsg, java.lang.Exception pException) Handle non fatal Exceptions
static boolean	not_null(java.lang.Object pObject) False if pObject is null.
static boolean	not_null(java.lang.Object pObject, java.lang.String pName) True if pObject is null.
static void	setOutput(java.io.PrintStream pErrorStream) Custom PrintStream.
static void	setQuiet(boolean pQuiet) True => don't display messages.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CN

public static final java.lang.String CN

See Also:

Constant Field Values

MSG_was_null

public static final java.lang.String MSG_was_null

See Also:

Constant Field Values

MSG_NonFatalInternalError

public static final java.lang.String MSG_NonFatalInternalError

See Also:

Constant Field Values

MSG_FatalInternalError

public static final java.lang.String MSG_FatalInternalError

See Also:

Constant Field Values

Constructor Detail

ErrorUtil

public ErrorUtil()

Method Detail

setQuiet

public static void setQuiet(boolean pQuiet)

True => don't display messages.

setOutput

public static void setOutput(java.io.PrintStream pErrorStream)

Custom PrintStream.

collectErrors

public static void collectErrors()

Collect errors instead of displaying them. Negates previous setOutput. Note: sets quiet mode to false.

getCollectedErrors

public static java.lang.String getCollectedErrors()

Get any collected errors.

hasCollectedErrors

public static boolean hasCollectedErrors()

True if any collected errors exist.

fatalMsg

public static void fatalMsg(java.lang.String pMsg)

Handle fatal error msgs - corrupt startup, etc. This method does NOT exit the JVM.

Parameters:

pMsg - fatal message

fatalMsg

public static void fatalMsg(java.lang.Exception pException)

Handle fatal Exceptions.

Parameters:

pException - fatal Exception

fatalMsg

public static void fatalMsg(java.lang.String pMsg,
                            java.lang.Exception pException)

Handle non fatal Exceptions

Parameters:

pMsg - fatal message

pException - fatal Exception

nonFatalMsg

public static void nonFatalMsg(java.lang.String pMsg)

Handle non-fatal error msgs - ignored nulls etc.

Parameters:

pMsg - non-fatal message

nonFatalMsg

public static void nonFatalMsg(java.lang.Exception pException)

Handle non-fatal Exceptions.

Parameters:

pException - non-fatal Exception

nonFatalMsg

public static void nonFatalMsg(java.lang.String pMsg,
                               java.lang.Exception pException)

Handle non fatal Exceptions

Parameters:

pMsg - non-fatal message

pException - non-fatal Exception

is_null

public static boolean is_null(java.lang.Object pObject)

True if pObject is null. Displays internal error message.

Parameters:

pObject - Object to test

is_null

public static boolean is_null(java.lang.Object pObject,
                              java.lang.String pName)

True if pObject is null. Displays internal error message.

Parameters:

pObject - Object to test

pName - Name of object

not_null

public static boolean not_null(java.lang.Object pObject)

False if pObject is null. Displays internal error message.

Parameters:

pObject - Object to test

not_null

public static boolean not_null(java.lang.Object pObject,
                               java.lang.String pName)

True if pObject is null. Displays internal error message.

Parameters:

pObject - Object to test

pName - Name of object

nonFatalException

public static void nonFatalException(java.lang.Exception pException)

nonFatalException

public static void nonFatalException(java.lang.Exception pException,
                                     java.lang.String pClassName)

nonFatalException

public static void nonFatalException(java.lang.Exception pException,
                                     java.lang.String pClassName,
                                     java.lang.String pMethodName)

nonFatalIndexOutOfBounds

public static void nonFatalIndexOutOfBounds(java.lang.Object pObject,
                                            java.lang.String pMsg,
                                            int pIndex,
                                            int pLower,
                                            int pUpper,
                                            java.lang.String pArray)

Handle index out of bounds. Auto generate class name.

Parameters:

pObject - Object causing error.

pIndex - Value of index

pLower - Lower bound - inclusive

pUpper - Upper bound - exclusive

pArray - Name of array.