Package io.guise.framework.model

Enum Notification.Option

java.lang.Object

java.lang.Enum<Notification.Option>

io.guise.framework.model.Notification.Option

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Notification.Option>

Enclosing class:

Notification

public static enum Notification.Option
extends java.lang.Enum<Notification.Option>

The options which can be expected as responses for this notification. The option ordinals represent the order in which they should be presented. Some options such as ABORT, STOP, and CANCEL, are fatal, indicating that the user has actively expressed that an action be stopped permanently.

Enum Constant Summary

Enum Constants

Enum Constant	Description
ABORT
CANCEL
FAIL
NO
NO_ALL
OK
REMOVE
RETRY
STOP
YES
YES_ALL

Method Summary

Modifier and Type	Method	Description
java.net.URI	getGlyph()
java.lang.String	getLabel()
boolean	isFatal()
static Notification.Option	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static Notification.Option[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

OK

public static final Notification.Option OK

YES

public static final Notification.Option YES

YES_ALL

public static final Notification.Option YES_ALL

NO

public static final Notification.Option NO

NO_ALL

public static final Notification.Option NO_ALL

ABORT

public static final Notification.Option ABORT

RETRY

public static final Notification.Option RETRY

FAIL

public static final Notification.Option FAIL

STOP

public static final Notification.Option STOP

REMOVE

public static final Notification.Option REMOVE

CANCEL

public static final Notification.Option CANCEL

Method Detail

values

public static Notification.Option[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Notification.Option c : Notification.Option.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Notification.Option valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

isFatal

public boolean isFatal()

Returns:

Whether this option is considered fatal.

getLabel

public java.lang.String getLabel()

Returns:

The resource reference for the option label.

getGlyph

public java.net.URI getGlyph()

Returns:

The resource reference for the option glyph.