com.idevicesinc.sweetblue.utils

Enum State.ChangeIntent

java.lang.Object

java.lang.Enum<State.ChangeIntent>

com.idevicesinc.sweetblue.utils.State.ChangeIntent

All Implemented Interfaces:

Serializable, Comparable<State.ChangeIntent>

Enclosing interface:

State

public static enum State.ChangeIntent
extends Enum<State.ChangeIntent>

Enumerates the intention behind a state change - as comprehensively as possible, whether the application user intended for the state change to happen or not. See State.ChangeEvent.intentMask() for more discussion on user intent.

Enum Constant Summary

Enum Constants

Enum Constant and Description
INTENTIONAL The state change was intentional.
NULL Used instead of Java's built-in null wherever appropriate.
UNINTENTIONAL The state change was not intentional.

Method Summary

Modifier and Type	Method and Description
int	bits()
static State.ChangeIntent	fromDiskValue(int diskValue) Transforms toDiskValue() back to the enum.
int	toDiskValue() The integer value to write to disk.
static int	toDiskValue(State.ChangeIntent intent_nullable)
static State.ChangeIntent	valueOf(String name) Returns the enum constant of this type with the specified name.
static State.ChangeIntent[]	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

NULL

public static final State.ChangeIntent NULL

Used instead of Java's built-in null wherever appropriate.

UNINTENTIONAL

public static final State.ChangeIntent UNINTENTIONAL

The state change was not intentional.

INTENTIONAL

public static final State.ChangeIntent INTENTIONAL

The state change was intentional.

Method Detail

values

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

Returns:

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

valueOf

public static State.ChangeIntent 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

toDiskValue

public int toDiskValue()

The integer value to write to disk. Not using ordinal to avoid unintentional consequences of changing enum order by accident or something.

toDiskValue

public static int toDiskValue(State.ChangeIntent intent_nullable)

fromDiskValue

public static State.ChangeIntent fromDiskValue(int diskValue)

Transforms toDiskValue() back to the enum. Returns NULL if diskValue can't be resolved.

bits

public int bits()