pl.wavesoftware.eid.exceptions

Class Eid

java.lang.Object

pl.wavesoftware.eid.exceptions.Eid

All Implemented Interfaces:

Serializable

public class Eid
extends Object
implements Serializable

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.

Exception identifier for all Eid Runtime Exceptions.

Author:

Krzysztof Suszyński

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Eid.UniqIdGenerator It is used to generate unique ID for each EID object.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_FORMAT
static String	DEFAULT_MESSAGE_FORMAT
static String	DEFAULT_REF_FORMAT
static Eid.UniqIdGenerator	DEFAULT_UNIQ_ID_GENERATOR

Constructor Summary

Constructors

Constructor and Description
Eid(String id) Constructor
Eid(String id, String ref) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
String	getId() Getter for constant Exception ID
static String	getMessageFormat() Gets actually set message format
String	getRef() Get custom ref passed to Exception ID
String	getUniq() Gets unique generated string for this instance of Eid
String	makeLogMessage(String logMessageFormat, Object... parameters) Makes a log message from this EID object This method is for convenience of usage of EID in logging.
static String	setFormat(String format) Sets the actual format that will be used in toString() method.
static String	setMessageFormat(String format) Sets a format that will be used for all Eid exceptions when printing a detail message.
static String	setRefFormat(String refFormat) Sets the actual format that will be used in toString() method
static Eid.UniqIdGenerator	setUniqIdGenerator(Eid.UniqIdGenerator uniqIdGenerator) Sets the actual unique ID generator that will be used to generate IDs for all Eid objects.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_FORMAT

public static final String DEFAULT_FORMAT

See Also:

Constant Field Values

DEFAULT_REF_FORMAT

public static final String DEFAULT_REF_FORMAT

See Also:

Constant Field Values

DEFAULT_MESSAGE_FORMAT

public static final String DEFAULT_MESSAGE_FORMAT

See Also:

Constant Field Values

DEFAULT_UNIQ_ID_GENERATOR

public static final Eid.UniqIdGenerator DEFAULT_UNIQ_ID_GENERATOR

Constructor Detail

Eid

public Eid(String id,
   @Nullable
   String ref)

Constructor

Parameters:

id - the exception id, must be unique developer inserted string, from date

ref - an optional reference

Eid

public Eid(String id)

Constructor

Parameters:

id - the exception id, must be unique developer inserted string, from date

Method Detail

setMessageFormat

public static String setMessageFormat(String format)

Sets a format that will be used for all Eid exceptions when printing a detail message.

Format must be non-null and contain two format specifiers "%s"

Parameters:

format - a format that will be used, must be non-null and contain two format specifiers "%s"

Returns:

previously used format

Throws:

IllegalArgumentException - if given format hasn't got two format specifiers "%s", or if given format was null

getMessageFormat

public static String getMessageFormat()

Gets actually set message format

Returns:

actually set message format

setUniqIdGenerator

public static Eid.UniqIdGenerator setUniqIdGenerator(Eid.UniqIdGenerator uniqIdGenerator)

Sets the actual unique ID generator that will be used to generate IDs for all Eid objects. It will return previously used generator.

Parameters:

uniqIdGenerator - new instance of unique ID generator

Returns:

a previously used unique ID generator

Throws:

IllegalArgumentException - if given generator was null

setFormat

public static String setFormat(String format)

Sets the actual format that will be used in toString() method. It will return previously used format.

Parameters:

format - a format compliant with String.format(String, Object...) with 2 object arguments

Returns:

a previously used format

Throws:

IllegalArgumentException - if given format hasn't got two format specifiers "%s", or if given format was null

setRefFormat

public static String setRefFormat(String refFormat)

Sets the actual format that will be used in toString() method

Parameters:

refFormat - a format compliant with String.format(String, Object...) with 3 object arguments

Returns:

a previously used format

Throws:

IllegalArgumentException - if given format hasn't got tree format specifiers "%s", or if given format was null

makeLogMessage

public String makeLogMessage(@Nonnull
                    String logMessageFormat,
                    @Nonnull
                    Object... parameters)

Makes a log message from this EID object

This method is for convenience of usage of EID in logging. You can use it like this:

 log.debug(new Eid("20151025:202129").makeLogMessage("A request: %s", request));
 

Parameters:

logMessageFormat - a log message format as accepted by String.format(String, Object...)

parameters - a parameters for logMessageFormat to by passed to String.format(String, Object...)

Returns:

a formatted message

toString

public String toString()

Overrides:

toString in class Object

getId

public String getId()

Getter for constant Exception ID

Returns:

ID of exception

getRef

public String getRef()

Get custom ref passed to Exception ID

Returns:

ID of exception

getUniq

public String getUniq()

Gets unique generated string for this instance of Eid

Returns:

a unique string