org.osgl.util

Class E

java.lang.Object

org.osgl.util.E

Direct Known Subclasses:

ExceptionNS

public class E
extends Object

Utility class to throw common exceptions

Method Summary

Modifier and Type	Method and Description
static RuntimeException	asRuntimeException(Exception e) Convert an Exception to RuntimeException
static UnexpectedEncodingException	encodingException(UnsupportedEncodingException cause) Wrap the UnsupportedEncodingException into an UnexpectedEncodingException and throw it out.
static void	illegalArgumentIf(boolean tester) Throws out an IllegalArgumentException if tester is true.
static void	illegalArgumentIf(boolean tester, String msg) Throws out an IllegalArgumentException if tester is false.
static void	illegalArgumentIf(boolean tester, String msg, Object... args) Throws out an IllegalArgumentException with error message specified if tester is true.
static void	illegalArgumentIfNot(boolean tester) Throws out an IllegalArgumentException if tester is false.
static void	illegalArgumentIfNot(boolean tester, String msg) Throws out an IllegalArgumentException if tester is true.
static void	illegalArgumentIfNot(boolean tester, String msg, Object... args) Throws out an IllegalArgumentException with error message specified if tester is false.
static void	illegalStateIf(boolean tester) Throws out an IllegalStateException if tester is true.
static void	illegalStateIf(boolean tester, String msg) Throws out an IllegalStateException with error message specified if tester is true.
static void	illegalStateIf(boolean tester, String msg, Object... args) Throws out an IllegalStateException with error message specified if tester is true.
static void	illegalStateIfNot(boolean tester) Throws out an IllegalStateException if tester is false.
static void	illegalStateIfNot(boolean tester, String msg) Throws out an IllegalStateException with error message specified if tester is false.
static void	illegalStateIfNot(boolean tester, String msg, Object... args) Throws out an IllegalStateException with error message specified if tester is false.
static InvalidArgException	invalidArg() Throws out an InvalidArgException.
static InvalidArgException	invalidArg(String msg, Object... args) Throws out an InvalidArgException with error message specified.
static void	invalidArgIf(boolean tester) Throws out an InvalidArgException when tester is true.
static void	invalidArgIf(boolean tester, String msg, Object... args) Throws out an InvalidArgException with error message specified when tester is true.
static void	invalidArgIfNot(boolean tester) Throws out an InvalidArgException when tester is false.
static void	invalidArgIfNot(boolean tester, String msg, Object... args) Throws out an InvalidArgException with error message specified when tester is false.
static ConfigurationException	invalidConfiguration(String message, Object... args) Throws out a ConfigurationException with message specified.
static ConfigurationException	invalidConfiguration(Throwable cause, String message, Object... args) Throws out a ConfigurationException with cause and message specified.
static void	invalidConfigurationIf(boolean tester, String msg, Object... args) Throws out a ConfigurationException with message specified if tester evaluated to true.
static void	invalidConfigurationIfNot(boolean tester, String msg, Object... args) Throws out a ConfigurationException with message specified if tester evaluated to false.
static InvalidRangeException	invalidRange() Throws out an InvalidRangeException.
static InvalidRangeException	invalidRange(String msg, Object... args) Throws out an InvalidRangeException with error message specified.
static void	invalidRangeIf(boolean tester) Throws out an InvalidRangeException when tester is true.
static void	invalidRangeIf(boolean tester, String msg, Object... args) Throws out an InvalidRangeException with error message specified when tester is true.
static void	invalidRangeIfNot(boolean tester) Throws out an InvalidRangeException when tester is false.
static void	invalidRangeIfNot(boolean tester, String msg, Object... args) Throws out an InvalidRangeException with error message specified when tester is false.
static InvalidStateException	invalidState() Throws out an InvalidStateException.
static InvalidStateException	invalidState(String msg, Object... args) Throws out an InvalidStateException with message specified.
static void	invalidStateIf(boolean tester) Throws out an InvalidStateException when tester evaluated to true.
static void	invalidStateIf(boolean tester, String msg, Object... args) Throws out an InvalidStateException when tester evaluated to true.
static UnexpectedIOException	ioException(IOException cause) Wrap the IOException into UnexpectedIOException and throw it out.
static UnexpectedIOException	ioException(String msg, Object... args) Throws out an UnexpectedIOException with error message specified.
static void	NPE(boolean tester) Throws out a NullPointerException when tester evaluated to true.
static void	NPE(Object o1) Throws NullPointerException if o1 is null.
static void	NPE(Object o1, Object o2) Throws out NullPointerException if o1 or o2 is null.
static void	NPE(Object o1, Object o2, Object o3) Throws out NullPointerException if o1 or o2 or o3 is null.
static void	NPE(Object o1, Object o2, Object o3, Object... objects) Throw out NullPointerException if any one of the passed objects is null.
static void	npeIf(boolean tester) Throws out an NullPointerException when tester is true.
static void	npeIfNot(boolean tester) Throws out an NullPointerException when tester is false.
static String	stackTrace(Throwable t) Returns the error stack trace of a Throwable specified as a String.
static ToBeImplemented	tbd() Throws out a ToBeImplemented with message to be implemented.
static ToBeImplemented	tbd(String feature) Throws out a ToBeImplemented with feature specified.
static UnexpectedException	unexpected(String msg, Object... args) Throws out a UnexpectedException with message specified.
static UnexpectedException	unexpected(Throwable cause) Throws out a UnexpectedException with cause specified.
static UnexpectedException	unexpected(Throwable cause, String msg, Object... args) Throws out a UnexpectedException with message and cause specified.
static void	unexpectedIf(boolean tester)
static void	unexpectedIf(boolean tester, String msg, Object... args) Throws out a UnexpectedException with message and cause specified when tester is evaluated to true.
static void	unexpectedIfNot(boolean tester)
static void	unexpectedIfNot(boolean tester, String msg, Object... args) Throws out a UnexpectedException with message and cause specified when tester is not evaluated to true.
static UnsupportedException	unsupport() Throws out an UnsupportedException.
static UnsupportedException	unsupport(String msg, Object... args) Throws out an UnsupportedException with error message specified.
static void	unsupportedIf(boolean tester) Throws out an UnsupportedException if tester is true.
static void	unsupportedIf(boolean tester, String msg) Throws out an UnsupportedException with error message specified if tester is true.
static void	unsupportedIf(boolean tester, String msg, Object... args) Throws out an UnsupportedException with error message specified if tester is true.
static void	unsupportedIfNot(boolean tester) Throws out an UnsupportedException if tester is false.
static void	unsupportedIfNot(boolean tester, String msg) Throws out an UnsupportedException with error message specified if tester is false.
static void	unsupportedIfNot(boolean tester, String msg, Object... args) Throws out an UnsupportedException with error message specified if tester is false.

Methods inherited from class java.lang.Object

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

Method Detail

invalidState

public static InvalidStateException invalidState()

Throws out an InvalidStateException.

invalidState

public static InvalidStateException invalidState(String msg,
                                                 Object... args)

Throws out an InvalidStateException with message specified.

invalidStateIf

public static void invalidStateIf(boolean tester)

Throws out an InvalidStateException when tester evaluated to true.

Parameters:

tester - when true then an InvalidStateException will be thrown out

invalidStateIf

public static void invalidStateIf(boolean tester,
                                  String msg,
                                  Object... args)

Throws out an InvalidStateException when tester evaluated to true.

Parameters:

tester - when true then an InvalidStateException will be thrown out.

msg - the message format template

args - the message format arguments

NPE

public static void NPE(Object o1)

Throws NullPointerException if o1 is null.

Parameters:

o1 - the object to be evaluated.

NPE

public static void NPE(Object o1,
                       Object o2)

Throws out NullPointerException if o1 or o2 is null.

Parameters:

o1 - the first object to be evaluated

o2 - the second object to be evaluated

NPE

public static void NPE(Object o1,
                       Object o2,
                       Object o3)

Throws out NullPointerException if o1 or o2 or o3 is null.

Parameters:

o1 - the first object to be evaluated

o2 - the second object to be evaluated

o3 - the third object to be evaluated

NPE

public static void NPE(Object o1,
                       Object o2,
                       Object o3,
                       Object... objects)

Throw out NullPointerException if any one of the passed objects is null.

Parameters:

o1 - the first object to be evaluated

o2 - the second object to be evaluated

o3 - the third object to be evaluated

objects - other object instances to be evaluated

NPE

public static void NPE(boolean tester)

Throws out a NullPointerException when tester evaluated to true.

Parameters:

tester - the condition to be evaluated

unexpected

public static UnexpectedException unexpected(String msg,
                                             Object... args)

Throws out a UnexpectedException with message specified.

Parameters:

msg - the message format pattern.

args - the message format arguments

unexpected

public static UnexpectedException unexpected(Throwable cause)

Throws out a UnexpectedException with cause specified.

Parameters:

cause - the cause of the unexpected exception.

unexpected

public static UnexpectedException unexpected(Throwable cause,
                                             String msg,
                                             Object... args)

Throws out a UnexpectedException with message and cause specified.

Parameters:

cause - the cause of the unexpected exception.

msg - the error message format pattern.

args - the error message format arguments.

unexpectedIf

public static void unexpectedIf(boolean tester,
                                String msg,
                                Object... args)

Throws out a UnexpectedException with message and cause specified when tester is evaluated to true.

Parameters:

tester - when true then throw out the exception.

msg - the error message format pattern.

args - the error message format arguments.

unexpectedIf

public static void unexpectedIf(boolean tester)

unexpectedIfNot

public static void unexpectedIfNot(boolean tester,
                                   String msg,
                                   Object... args)

Throws out a UnexpectedException with message and cause specified when tester is not evaluated to true.

Parameters:

tester - when false then throw out the exception.

msg - the error message format pattern.

args - the error message format arguments.

unexpectedIfNot

public static void unexpectedIfNot(boolean tester)

ioException

public static UnexpectedIOException ioException(IOException cause)

Wrap the IOException into UnexpectedIOException and throw it out.

Parameters:

cause - the IOException.

ioException

public static UnexpectedIOException ioException(String msg,
                                                Object... args)

Throws out an UnexpectedIOException with error message specified.

Parameters:

msg - the error message format pattern

args - the error message format arguments

encodingException

public static UnexpectedEncodingException encodingException(UnsupportedEncodingException cause)

Wrap the UnsupportedEncodingException into an UnexpectedEncodingException and throw it out.

Parameters:

cause - the UnsupportedEncodingException.

invalidConfiguration

public static ConfigurationException invalidConfiguration(String message,
                                                          Object... args)

Throws out a ConfigurationException with message specified.

Parameters:

message - the error message format pattern.

args - the error message format arguments.

invalidConfiguration

public static ConfigurationException invalidConfiguration(Throwable cause,
                                                          String message,
                                                          Object... args)

Throws out a ConfigurationException with cause and message specified.

Parameters:

cause - the cause of the configuration error.

message - the error message format pattern.

args - the error message format arguments.

invalidConfigurationIf

public static void invalidConfigurationIf(boolean tester,
                                          String msg,
                                          Object... args)

Throws out a ConfigurationException with message specified if tester evaluated to true.

Parameters:

tester - when true then throw out the exception

msg - the error message format pattern.

args - the error message format arguments.

invalidConfigurationIfNot

public static void invalidConfigurationIfNot(boolean tester,
                                             String msg,
                                             Object... args)

Throws out a ConfigurationException with message specified if tester evaluated to false.

Parameters:

tester - when false then throw out the exception

msg - the error message format pattern.

args - the error message format arguments.

tbd

public static ToBeImplemented tbd()

Throws out a ToBeImplemented with message to be implemented.

tbd

public static ToBeImplemented tbd(String feature)

Throws out a ToBeImplemented with feature specified.

The error message will be "${feature} to be implemented"

Parameters:

feature - the feature name

invalidArg

public static InvalidArgException invalidArg()

Throws out an InvalidArgException.

invalidArgIf

public static void invalidArgIf(boolean tester)

Throws out an InvalidArgException when tester is true.

Parameters:

tester - when true then throws out the exception

invalidArgIfNot

public static void invalidArgIfNot(boolean tester)

Throws out an InvalidArgException when tester is false.

Parameters:

tester - when false then throws out the exception

invalidArg

public static InvalidArgException invalidArg(String msg,
                                             Object... args)

Throws out an InvalidArgException with error message specified.

Parameters:

msg - the error message format pattern.

args - the error message format arguments.

invalidArgIf

public static void invalidArgIf(boolean tester,
                                String msg,
                                Object... args)

Throws out an InvalidArgException with error message specified when tester is true.

Parameters:

tester - when true then throws out the exception.

msg - the error message format pattern.

args - the error message format arguments.

invalidArgIfNot

public static void invalidArgIfNot(boolean tester,
                                   String msg,
                                   Object... args)

Throws out an InvalidArgException with error message specified when tester is false.

Parameters:

tester - when false then throws out the exception.

msg - the error message format pattern.

args - the error message format arguments.

invalidRange

public static InvalidRangeException invalidRange()

Throws out an InvalidRangeException.

invalidRangeIf

public static void invalidRangeIf(boolean tester)

Throws out an InvalidRangeException when tester is true.

Parameters:

tester - when true then throw out the exception.

invalidRangeIfNot

public static void invalidRangeIfNot(boolean tester)

Throws out an InvalidRangeException when tester is false.

Parameters:

tester - when false then throw out the exception.

invalidRange

public static InvalidRangeException invalidRange(String msg,
                                                 Object... args)

Throws out an InvalidRangeException with error message specified.

Parameters:

msg - the error message format pattern.

args - the error message format arguments.

invalidRangeIf

public static void invalidRangeIf(boolean tester,
                                  String msg,
                                  Object... args)

Throws out an InvalidRangeException with error message specified when tester is true.

Parameters:

tester - when true then throw out the exception

msg - the error message format pattern.

args - the error message format arguments.

invalidRangeIfNot

public static void invalidRangeIfNot(boolean tester,
                                     String msg,
                                     Object... args)

Throws out an InvalidRangeException with error message specified when tester is false.

Parameters:

tester - when false then throw out the exception

msg - the error message format pattern.

args - the error message format arguments.

npeIf

public static void npeIf(boolean tester)

Throws out an NullPointerException when tester is true.

Parameters:

tester - when true then throw out the exception.

npeIfNot

public static void npeIfNot(boolean tester)

Throws out an NullPointerException when tester is false.

Parameters:

tester - when false then throw out the exception.

unsupport

public static UnsupportedException unsupport()

Throws out an UnsupportedException.

unsupport

public static UnsupportedException unsupport(String msg,
                                             Object... args)

Throws out an UnsupportedException with error message specified.

Parameters:

msg - the error message format pattern.

args - the error message format arguments.

unsupportedIf

public static void unsupportedIf(boolean tester)

Throws out an UnsupportedException if tester is true.

Parameters:

tester - when true then throw out the exception.

unsupportedIfNot

public static void unsupportedIfNot(boolean tester)

Throws out an UnsupportedException if tester is false.

Parameters:

tester - when false then throw out the exception.

unsupportedIf

public static void unsupportedIf(boolean tester,
                                 String msg)

Throws out an UnsupportedException with error message specified if tester is true.

Parameters:

tester - when true then throw out the exception.

msg - the error message.

unsupportedIfNot

public static void unsupportedIfNot(boolean tester,
                                    String msg)

Throws out an UnsupportedException with error message specified if tester is false.

Parameters:

tester - when false then throw out the exception.

msg - the error message.

unsupportedIf

public static void unsupportedIf(boolean tester,
                                 String msg,
                                 Object... args)

Throws out an UnsupportedException with error message specified if tester is true.

Parameters:

tester - when true then throw out the exception.

msg - the error message format pattern.

args - the error message format arguments.

unsupportedIfNot

public static void unsupportedIfNot(boolean tester,
                                    String msg,
                                    Object... args)

Throws out an UnsupportedException with error message specified if tester is false.

Parameters:

tester - when false then throw out the exception.

msg - the error message format pattern.

args - the error message format arguments.

illegalArgumentIf

public static void illegalArgumentIf(boolean tester)

Throws out an IllegalArgumentException if tester is true.

Parameters:

tester - when true then throw out the exception.

illegalArgumentIfNot

public static void illegalArgumentIfNot(boolean tester)

Throws out an IllegalArgumentException if tester is false.

Parameters:

tester - when false then throw out the exception.

illegalArgumentIf

public static void illegalArgumentIf(boolean tester,
                                     String msg)

Throws out an IllegalArgumentException if tester is false.

Parameters:

tester - when false then throw out the exception.

illegalArgumentIfNot

public static void illegalArgumentIfNot(boolean tester,
                                        String msg)

Throws out an IllegalArgumentException if tester is true.

Parameters:

tester - when true then throw out the exception.

msg - the error message.

illegalArgumentIf

public static void illegalArgumentIf(boolean tester,
                                     String msg,
                                     Object... args)

Throws out an IllegalArgumentException with error message specified if tester is true.

Parameters:

tester - when true then throw out the exception.

msg - the error message format pattern.

args - the error message format arguments.

illegalArgumentIfNot

public static void illegalArgumentIfNot(boolean tester,
                                        String msg,
                                        Object... args)

Throws out an IllegalArgumentException with error message specified if tester is false.

Parameters:

tester - when false then throw out the exception.

msg - the error message format pattern.

args - the error message format arguments.

illegalStateIf

public static void illegalStateIf(boolean tester)

Throws out an IllegalStateException if tester is true.

Parameters:

tester - when true then throw out the exception.

illegalStateIfNot

public static void illegalStateIfNot(boolean tester)

Throws out an IllegalStateException if tester is false.

Parameters:

tester - when false then throw out the exception.

illegalStateIf

public static void illegalStateIf(boolean tester,
                                  String msg)

Throws out an IllegalStateException with error message specified if tester is true.

Parameters:

tester - when true then throw out the exception.

msg - the error message.

illegalStateIfNot

public static void illegalStateIfNot(boolean tester,
                                     String msg)

Throws out an IllegalStateException with error message specified if tester is false.

Parameters:

tester - when false then throw out the exception.

msg - the error message.

illegalStateIf

public static void illegalStateIf(boolean tester,
                                  String msg,
                                  Object... args)

Throws out an IllegalStateException with error message specified if tester is true.

Parameters:

tester - when true then throw out the exception.

msg - the error message format pattern.

args - the error message format arguments.

illegalStateIfNot

public static void illegalStateIfNot(boolean tester,
                                     String msg,
                                     Object... args)

Throws out an IllegalStateException with error message specified if tester is false.

Parameters:

tester - when false then throw out the exception.

msg - the error message format pattern.

args - the error message format arguments.

asRuntimeException

public static RuntimeException asRuntimeException(Exception e)

Convert an Exception to RuntimeException

Parameters:

e - the Exception instance

Returns:

a RuntimeException instance

stackTrace

public static String stackTrace(Throwable t)

Returns the error stack trace of a Throwable specified as a String.

Parameters:

t - the throwable.

Returns:

the stack trace of t the throwable as string.