com.sas.collection
Class HowChanged

com.sas.collection.HowChanged

public final class HowChanged

An Enumeration class. Use the static final variables as enumeration values: discrete named values from a set of 5 values. Note there are no public constructors, so the final static variables listed below will be the only instances of the class.

See Also:

Enum

Nested Class Summary

Nested classes/interfaces inherited from class com.sas.util.Enum

com.sas.util.Enum.Editor

Field Summary

static HowChanged	ADDED One or more items have been added.
static int	count Number of enumerations.
static HowChanged	OTHER Some other change has occurred.
static HowChanged	REMOVED One or more items have been removed.
static HowChanged	REORDERED The order has been changed due to a sort or other reordering of the items.
static HowChanged	REPLACED One or more items have been replaced.

Fields inherited from class com.sas.util.Enum

next

Method Summary

static HowChanged	get(int index) Return the enum corresponding to an index, or ordinal position.
static HowChanged	get(java.lang.String name) Return the enum corresponding to an enum name
static HowChanged	getEnum(int value) Return the enum containing a specified value
static HowChanged	getFirst() Get the first enum in the sequence.
int	getIndex() Return the ordinal position of an enum.
HowChanged	getNext() Return the next HowChanged in the sequence
com.sas.util.Enum	getNextEnum() Return the next HowChanged in the sequence
static HowChanged	read(java.io.ObjectInputStream is) Deserialization support.
void	write(java.io.ObjectOutputStream os) Serialization support. write a HowChanged to an ObjectOutputStream.

Methods inherited from class com.sas.util.Enum

get, get, getAt, getAt, getEnum, getEnums, getIndex, getValue, setValue, toString, toString

Field Detail

count

public static final int count

Number of enumerations.

See Also:

Constant Field Values

REPLACED

public static final HowChanged REPLACED

One or more items have been replaced. Like a remove + add combination.

REORDERED

public static final HowChanged REORDERED

The order has been changed due to a sort or other reordering of the items.

ADDED

public static final HowChanged ADDED

One or more items have been added.

REMOVED

public static final HowChanged REMOVED

One or more items have been removed.

OTHER

public static final HowChanged OTHER

Some other change has occurred.

Method Detail

getNext

public HowChanged getNext()

Return the next HowChanged in the sequence

Returns:

the next HowChanged in the sequence

getNextEnum

public com.sas.util.Enum getNextEnum()

Return the next HowChanged in the sequence

Specified by:

getNextEnum in class com.sas.util.Enum

Returns:

the next HowChanged in the sequence

getIndex

public int getIndex()

Return the ordinal position of an enum. The ordinal position is it's position relative to the others; this is a value from 0 to 5_1

Specified by:

getIndex in class com.sas.util.Enum

Returns:

int

get

public static HowChanged get(int index)

Return the enum corresponding to an index, or ordinal position.

Parameters:

index - The relative position [0,5_1]

Returns:

HowChanged

getEnum

public static HowChanged getEnum(int value)

Return the enum containing a specified value

Parameters:

value - A value of a HowChanged to find.

Returns:

HowChanged

get

public static HowChanged get(java.lang.String name)

Return the enum corresponding to an enum name

Parameters:

name - The enumeration name to find

Returns:

HowChanged, null if no such enumeration

write

public void write(java.io.ObjectOutputStream os)
           throws java.io.IOException

Serialization support. write a HowChanged to an ObjectOutputStream. Use this method to serialize a HowChanged held in an instance variable if you want to make the holding object Serializable. Enum objects are not Serializable because they are immutable singletons. (The benefit of enums is there is only one of each value.)

Parameters:

os - an Object Output Stream.

Throws:

java.io.IOException

read

public static HowChanged read(java.io.ObjectInputStream is)
                       throws java.io.IOException

Deserialization support. Read a HowChanged from an ObjectInputStream. Note that HowChanged objects are not serializable; this prevents creation of multiple objects with the same value and/or name. Call this from your class' private readObject method if your class is Serializable and keeps HowChanged objects; the HowChanged instance variable in your class should be transient.

Parameters:

is - the ObjectInputStream

Throws:

java.io.IOException

getFirst

public static HowChanged getFirst()

Get the first enum in the sequence.

Returns:

the next Enum, or null if this is the last in the sequence.