com.twofortyfouram.locale.sdk.host.model

Enum PluginErrorExecute

java.lang.Object

java.lang.Enum<PluginErrorExecute>

com.twofortyfouram.locale.sdk.host.model.PluginErrorExecute

All Implemented Interfaces:

IPluginError, Serializable, Comparable<PluginErrorExecute>

@ThreadSafe
public enum PluginErrorExecute
extends Enum<PluginErrorExecute>
implements IPluginError

Possible errors that may occur during the execute phase of interacting with plug-ins.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONDITION_RESULT_CODE_BAD

Method Summary

Modifier and Type	Method and Description
String	getDeveloperExplanation()
boolean	isFatal()
static PluginErrorExecute	valueOf(String name) Returns the enum constant of this type with the specified name.
static PluginErrorExecute[]	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

CONDITION_RESULT_CODE_BAD

public static final PluginErrorExecute CONDITION_RESULT_CODE_BAD

Method Detail

values

public static PluginErrorExecute[] 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 (PluginErrorExecute c : PluginErrorExecute.values())
    System.out.println(c);

Returns:

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

valueOf

public static PluginErrorExecute valueOf(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:

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

NullPointerException - if the argument is null

getDeveloperExplanation

public String getDeveloperExplanation()

Specified by:

getDeveloperExplanation in interface IPluginError

Returns:

A non-localized error message with an explanation of the error. This is intended to display to plug-in developers via a log message.

isFatal

public boolean isFatal()

Specified by:

isFatal in interface IPluginError

Returns:

True if the error is fatal. If false, the error is non-fatal and should be considered to be a warning.