pl.wavesoftware.eid.exceptions

Class EidRuntimeException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

pl.wavesoftware.eid.exceptions.EidRuntimeException

All Implemented Interfaces:

Serializable, EidContainer

Direct Known Subclasses:

EidIllegalArgumentException, EidIllegalStateException, EidIndexOutOfBoundsException, EidNullPointerException

public class EidRuntimeException
extends RuntimeException
implements EidContainer

This class shouldn't be used in any public API or library. It is designed to be used for in-house development of end user applications which will report Bugs in standardized error pages or post them to issue tracker.

This exception class is baseline of all Eid runtime exception classes. It is designed to ease of use and provide strict ID for given Exception usage. This approach speed up development of large application and helps support teams to by giving the both static and random ID for each possible unpredicted bug.

This is best to use with tools and plugins like EidGenerator for Netbeans IDE

Caution! There is no constructor with just a string, for reason that this forces users to add Eid in all places that earlier uses RuntimeException.

For convenience use EidPreconditions

Author:

Krzysztof Suszyński

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
EidRuntimeException(Eid id) Constructs a new runtime exception with the specified Eid object
EidRuntimeException(Eid id, String messageFormat, Object... parameters) Constructs a new runtime exception with specified Eid object and custom message The detail message is computed as: String.format(Eid.getMessageFormat(), id.toString(), String.format(messageFormat, parameters))
EidRuntimeException(Eid id, Throwable cause) Constructs a new runtime exception with the specified Eid object and cause The detail message is computed as String.format(Eid.getMessageFormat(), id.toString(), message(cause))
EidRuntimeException(String eid, String ref) Constructs a new runtime exception with the specified exception Id and ref code.
EidRuntimeException(String eid, String ref, Throwable cause) Constructs a new runtime exception with the specified a exception Id, ref code and cause.
EidRuntimeException(String eid, Throwable cause) Constructs a new runtime exception with the specified cause, a exception Id and detail message of eid.toString() + " => " + (cause==null ?

Method Summary

Methods

Modifier and Type	Method and Description
Eid	getEid() Retrieves a Eid object
Class<? extends RuntimeException>	getStandardJdkClass() Returns a standard JDK class that this ones is base on.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

EidRuntimeException

public EidRuntimeException(String eid,
                   String ref)

Constructs a new runtime exception with the specified exception Id and ref code. The cause is not initialized, and may subsequently be initialized by a call to Throwable.initCause(java.lang.Throwable).

Parameters:

eid - exception ID

ref - the ref code for Eid

EidRuntimeException

public EidRuntimeException(String eid,
                   Throwable cause)

Constructs a new runtime exception with the specified cause, a exception Id and detail message of eid.toString() + " => " + (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause). This constructor is useful for runtime exceptions that are little more than wrappers for other throwable.

Parameters:

eid - exception ID

cause - the cause (which is saved for later retrieval by the Throwable.getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)

EidRuntimeException

public EidRuntimeException(String eid,
                   String ref,
                   Throwable cause)

Constructs a new runtime exception with the specified a exception Id, ref code and cause.

Parameters:

eid - exception ID

ref - the ref code for Eid

cause - the cause (which is saved for later retrieval by the Throwable.getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)

EidRuntimeException

public EidRuntimeException(Eid id)

Constructs a new runtime exception with the specified Eid object

Parameters:

id - exception ID

EidRuntimeException

public EidRuntimeException(Eid id,
                   Throwable cause)

Constructs a new runtime exception with the specified Eid object and cause

The detail message is computed as String.format(Eid.getMessageFormat(), id.toString(), message(cause))

Parameters:

id - exception ID

cause - the cause (which is saved for later retrieval by the Throwable.getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)

EidRuntimeException

public EidRuntimeException(Eid id,
                   String messageFormat,
                   Object... parameters)

Constructs a new runtime exception with specified Eid object and custom message

The detail message is computed as:

String.format(Eid.getMessageFormat(), id.toString(), String.format(messageFormat, parameters))

Parameters:

id - exception ID

messageFormat - message format in form of String.format(String, Object...)

parameters - parameters in form of String.format(String, Object...)

Method Detail

getEid

public Eid getEid()

Description copied from interface: EidContainer

Retrieves a Eid object

Specified by:

getEid in interface EidContainer

Returns:

Eid object

getStandardJdkClass

public Class<? extends RuntimeException> getStandardJdkClass()

Returns a standard JDK class that this ones is base on. It doesn't mean this class extends that class.

Returns:

a standard JDK class of exception, in this case RuntimeException class.