com.steelypip.powerups.alert

Class Alert

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.steelypip.powerups.alert.Alert

All Implemented Interfaces:

java.io.Serializable, java.lang.Iterable<Culprit>

Direct Known Subclasses:

JSONBuildFailedException

public class Alert
extends java.lang.RuntimeException
implements java.lang.Iterable<Culprit>

Alerts are intended to act as generic application exceptions that can be decorated with contextual key-value information. The idiom for using them is: throw new Alert( message ).culprit( key1, value1 ).culprit( key2, value2 ); As the exception propogates outward, it is appropriate for additional information to be tagged onto the exception and for it to be re-thrown.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Alert()
Alert(java.lang.String message)
Alert(java.lang.String message, java.lang.Throwable cause) This is the most general constructor, which simply invokes the super class constructor with the same arguments.
Alert(java.lang.Throwable cause)

Method Summary

Modifier and Type	Method and Description
Alert	code(@NonNull java.lang.String string)
Alert	culprit(java.lang.Iterable<Culprit> list)
Alert	culprit(@NonNull java.lang.String desc, char ch)
Alert	culprit(@NonNull java.lang.String desc, int arg)
Alert	culprit(@NonNull java.lang.String desc, java.lang.Object arg)
Culprit	get(java.lang.String key)
java.lang.String	getCodeString()
boolean	hasKey(java.lang.String k)
boolean	hasKeyValue(java.lang.String k, java.lang.Object v)
Alert	hint(@NonNull java.lang.String msg) This is a convenient method for adding a culprit with the "hint" key.
static Alert	internalError() A convenience method for building an Alert that is suitable for signalling that some part of the object state has entered a condition that the programmer intends to be impossible.
static Alert	internalError(java.lang.String msg) A convenience method for building an Alert that is suitable for signalling that some part of the object state has entered a condition that the programmer intends to be impossible.
java.util.Iterator<Culprit>	iterator() This is a service method for reporting.
Alert	note(@NonNull java.lang.String string)
void	report()
void	reportTo(java.io.PrintWriter pw)
java.lang.String	toString()
static Alert	unimplemented() A convenience method for building an Alert that is suitable to act as a placeholder for unfinished work.
static Alert	unimplemented(java.lang.String msg) A convenience method for building an Alert that is suitable to act as a placeholder for unfinished work.
static Alert	unreachable()
static Alert	unreachable(java.lang.String msg)
static Alert	unreachable(java.lang.String msg, java.lang.Throwable t) A convenience method for building an Alert that is suitable for signalling code regions that the programmer intends should never arise.
static Alert	unreachable(java.lang.Throwable t)

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

Alert

public Alert()

Alert

public Alert(java.lang.String message,
             java.lang.Throwable cause)

This is the most general constructor, which simply invokes the super class constructor with the same arguments.

Parameters:

message - the main message

cause - the originating throwable

Alert

public Alert(java.lang.String message)

Alert

public Alert(java.lang.Throwable cause)

Method Detail

iterator

public java.util.Iterator<Culprit> iterator()

This is a service method for reporting.

Specified by:

iterator in interface java.lang.Iterable<Culprit>

get

public Culprit get(java.lang.String key)

hasKeyValue

public boolean hasKeyValue(java.lang.String k,
                           java.lang.Object v)

hasKey

public boolean hasKey(java.lang.String k)

culprit

public Alert culprit(@NonNull java.lang.String desc,
                     java.lang.Object arg)

culprit

public Alert culprit(@NonNull java.lang.String desc,
                     int arg)

culprit

public Alert culprit(@NonNull java.lang.String desc,
                     char ch)

culprit

public Alert culprit(java.lang.Iterable<Culprit> list)

reportTo

public void reportTo(java.io.PrintWriter pw)

report

public void report()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Throwable

hint

public Alert hint(@NonNull java.lang.String msg)

This is a convenient method for adding a culprit with the "hint" key. This should be used where there may be a common root cause that has an easy fix e.g. "Missing semi-colon?".

Parameters:

msg - The message hinting as to the fix.

Returns:

the original object.

code

public Alert code(@NonNull java.lang.String string)

note

public Alert note(@NonNull java.lang.String string)

getCodeString

public java.lang.String getCodeString()

unreachable

public static Alert unreachable()

unreachable

public static Alert unreachable(java.lang.Throwable t)

unreachable

public static Alert unreachable(java.lang.String msg)

unreachable

public static Alert unreachable(java.lang.String msg,
                                java.lang.Throwable t)

A convenience method for building an Alert that is suitable for signalling code regions that the programmer intends should never arise. It's a useful subset of internal-error.

Parameters:

msg - The main message

t - A wrapped throwable

Returns:

the Alert

unimplemented

public static Alert unimplemented()

A convenience method for building an Alert that is suitable to act as a placeholder for unfinished work. The message defaults to "Unimplemented".

Returns:

the Alert

unimplemented

public static Alert unimplemented(java.lang.String msg)

A convenience method for building an Alert that is suitable to act as a placeholder for unfinished work.

Parameters:

msg - the main message

Returns:

the Alert

internalError

public static Alert internalError()

A convenience method for building an Alert that is suitable for signalling that some part of the object state has entered a condition that the programmer intends to be impossible. The message is "Internal error".

Returns:

the Alert

internalError

public static Alert internalError(java.lang.String msg)

A convenience method for building an Alert that is suitable for signalling that some part of the object state has entered a condition that the programmer intends to be impossible.

Parameters:

msg - the main message

Returns:

the Alert