com.screenscraper.annotations

Enum Behavior

java.lang.Object

java.lang.Enum<Behavior>

com.screenscraper.annotations.Behavior

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Behavior>

public enum Behavior
extends java.lang.Enum<Behavior>

Types of behaviors to add automatically if the method is called from an incorrect version

Enum Constant Summary

Enum Constants

Enum Constant and Description
DO_NOTHING Doesn't even generate a log message.
LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE Indicates that null should be returned if the method is called from an incorrect version.
LOG_ERROR_ONLY Behavior to indicate the method handles enforcing the constraint, but a log message should be written
THROW_EXCEPTION Indicates that an exception should be thrown if the method is called from an incorrect version

Method Summary

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

DO_NOTHING

public static final Behavior DO_NOTHING

Doesn't even generate a log message.

LOG_ERROR_ONLY

public static final Behavior LOG_ERROR_ONLY

Behavior to indicate the method handles enforcing the constraint, but a log message should be written

THROW_EXCEPTION

public static final Behavior THROW_EXCEPTION

Indicates that an exception should be thrown if the method is called from an incorrect version

LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE

public static final Behavior LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE

Indicates that null should be returned if the method is called from an incorrect version. For primitive return types, -1 is returned for numbers, 0 for character and byte types, and false for boolean values.

Method Detail

values

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

Returns:

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

valueOf

public static Behavior 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