Package com.spinyowl.legui.exception

Enum Class LeguiExceptionTemplate

java.lang.Object

java.lang.Enum<LeguiExceptionTemplate>

com.spinyowl.legui.exception.LeguiExceptionTemplate

All Implemented Interfaces:

Serializable, Comparable<LeguiExceptionTemplate>, Constable

public enum LeguiExceptionTemplate
extends Enum<LeguiExceptionTemplate>

Exception message templates. Used to build exception with predefined message.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FAILED_TO_LOAD_FONT	Used by Font.
FAILED_TO_LOAD_IMAGE	Used by StbBackedLoadableImage.
UNHANDLED_EXCEPTION	Unhandled exception.

Method Summary

Modifier and Type	Method	Description
LeguiException	create(String... args)	Used to create LeguiException with specified message and provided variables.
LeguiException	create(Throwable e, String... args)	Used to create LeguiException with specified message, Throwable cause and provided variables.
String	message(String... args)	Error message constructor.
static LeguiExceptionTemplate	valueOf(String name)	Returns the enum constant of this class with the specified name.
static LeguiExceptionTemplate[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

UNHANDLED_EXCEPTION

public static final LeguiExceptionTemplate UNHANDLED_EXCEPTION

Unhandled exception.

FAILED_TO_LOAD_FONT

public static final LeguiExceptionTemplate FAILED_TO_LOAD_FONT

Used by Font.

FAILED_TO_LOAD_IMAGE

public static final LeguiExceptionTemplate FAILED_TO_LOAD_IMAGE

Used by StbBackedLoadableImage.

Method Details

values

public static LeguiExceptionTemplate[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static LeguiExceptionTemplate valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

message

public String message(String... args)

Error message constructor.

Parameters:

args - error message variables.

Returns:

constructed message.

create

public LeguiException create(String... args)

Used to create LeguiException with specified message and provided variables.

Parameters:

args - error message variables.

Returns:

exception constructed with message template.

create

public LeguiException create(Throwable e,
 String... args)

Used to create LeguiException with specified message, Throwable cause and provided variables.

Parameters:

args - error message variables.

e - throwable instance.

Returns:

exception constructed with message template.