com.ail.party
Enum PersonalRelationship

java.lang.Object
  java.lang.Enum<PersonalRelationship>
      com.ail.party.PersonalRelationship

All Implemented Interfaces:

TypeEnum, java.io.Serializable, java.lang.Comparable<PersonalRelationship>

public enum PersonalRelationship
extends java.lang.Enum<PersonalRelationship>
implements TypeEnum

Type safe enumeration representing constant values for PersonalRelationship.

Version:

$Revision: 1.6 $

Enum Constant Summary

COLLEGE
College

FRIEND
Friend

NONE
None

RELATIVE
Relative

SELF
Self

SPOUSE
Spouse

UNDEFINED
Undefined

Method Summary

static PersonalRelationship	forName(java.lang.String name) This method is similar to the valueOf() method offered by Java's Enum type, but in this case it will match either the Enum's name or the longName.
java.lang.String	getLongName() Returns the same value as longName().
java.lang.String	getName() Returns the same value as name().
int	getOrdinal() Return this Enum's ordinal id.
java.lang.String	longName() The long name for an enum.
static PersonalRelationship	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static PersonalRelationship[]	values() Returns an array containing the constants of this enum type, in the order they're declared.
java.lang.String	valuesAsCsv()

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.ail.core.TypeEnum

name

Enum Constant Detail

UNDEFINED

public static final PersonalRelationship UNDEFINED

Undefined

SELF

public static final PersonalRelationship SELF

Self

SPOUSE

public static final PersonalRelationship SPOUSE

Spouse

RELATIVE

public static final PersonalRelationship RELATIVE

Relative

FRIEND

public static final PersonalRelationship FRIEND

Friend

COLLEGE

public static final PersonalRelationship COLLEGE

College

NONE

public static final PersonalRelationship NONE

None

Method Detail

values

public static final PersonalRelationship[] values()

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:

for(PersonalRelationship c : PersonalRelationship.values())
        System.out.println(c);

Returns:

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

valueOf

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

valuesAsCsv

public java.lang.String valuesAsCsv()

longName

public java.lang.String longName()

Description copied from interface: TypeEnum

The long name for an enum. Unlike the name property on Java's Enum type, this need not be a valid Java identifier.

Specified by:

longName in interface TypeEnum

Returns:

The Enum's long name.

forName

public static PersonalRelationship forName(java.lang.String name)

This method is similar to the valueOf() method offered by Java's Enum type, but in this case it will match either the Enum's name or the longName.

Parameters:

name - The name to lookup

Returns:

The matching Enum, or IllegalArgumentException if there isn't a match.

getName

public java.lang.String getName()

Description copied from interface: TypeEnum

Returns the same value as name(). This method only exists to make TypeEnum more Bean compatible so things like jxpath can make use of it.

Specified by:

getName in interface TypeEnum

Returns:

Enum's name

getLongName

public java.lang.String getLongName()

Description copied from interface: TypeEnum

Returns the same value as longName(). This method only exists to make TypeEnum more Bean compatible so things like jxpath can make use of it.

Specified by:

getLongName in interface TypeEnum

Returns:

Enum's long name

getOrdinal

public int getOrdinal()

Description copied from interface: TypeEnum

Return this Enum's ordinal id. This method only exists to make TypeEnum more Bean compatible so things like jxpath can make use of it.

Specified by:

getOrdinal in interface TypeEnum

Returns:

Enum's ordinal.