com.compoze.exchange
Class Gender

java.lang.Object

  |

  +--com.compoze.exchange.Gender

All Implemented Interfaces:

java.io.Serializable

public class Gender

extends java.lang.Object

implements java.io.Serializable

This class stores the values for a 'gender'. The internationalizable string values are stored in the exchange_resources.properties file (accessed through ExchangeProperties) and referenced by their key.

See Also:

Serialized Form

Field Summary

static Gender	FEMALE This value represents the 'female' gender.
static Gender	MALE This value represents the 'male' gender.
static int	STORE_VALUE_FEMALE This value represents the 'female' store value.
static int	STORE_VALUE_MALE This value represents the 'male' store value.
static int	STORE_VALUE_UNSPECIFIED This value represents the 'unspecified' store value.
static Gender	UNSPECIFIED This value represents the 'unspecified' gender.

Method Summary

boolean	equals(java.lang.Object o) Checks for equality.
static Gender	get(int sStoreValue) Gets the gender by its store value.
static java.util.List	getList() Gets the list of gender levels.
java.lang.String	getName() Gets the name of the gender using the system default locale.
java.lang.String	getName(java.util.Locale locale) Gets the name of the gender using the specified locale.
int	getStoreValue() Gets the value that's used to store the gender in the storage system.
java.lang.String	toString() Returns a string representation of the object.
java.lang.String	toString(java.util.Locale locale) Returns a string representation of the object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

STORE_VALUE_UNSPECIFIED

public static final int STORE_VALUE_UNSPECIFIED

This value represents the 'unspecified' store value.

STORE_VALUE_FEMALE

public static final int STORE_VALUE_FEMALE

This value represents the 'female' store value.

STORE_VALUE_MALE

public static final int STORE_VALUE_MALE

This value represents the 'male' store value.

UNSPECIFIED

public static final Gender UNSPECIFIED

This value represents the 'unspecified' gender.

FEMALE

public static final Gender FEMALE

This value represents the 'female' gender.

MALE

public static final Gender MALE

This value represents the 'male' gender.

Method Detail

getName

public java.lang.String getName()

Gets the name of the gender using the system default locale.

Returns:

the name

getName

public java.lang.String getName(java.util.Locale locale)

Gets the name of the gender using the specified locale.

Parameters:

locale - the locale

Returns:

the name

getStoreValue

public int getStoreValue()

Gets the value that's used to store the gender in the storage system.

Returns:

the store value

get

public static Gender get(int sStoreValue)

Gets the gender by its store value.

Parameters:

sStoreValue - the store value to get by

Returns:

the matching gender or null if not found

getList

public static java.util.List getList()

Gets the list of gender levels.

Returns:

the list of Genders objects (unmodifiable)

equals

public boolean equals(java.lang.Object o)

Checks for equality. The store value is used to determine equality, so that the language the name is represented in is not important.

Overrides:

equals in class java.lang.Object

Parameters:

o - the object to check

Returns:

true if this object has the same store value as the argument, false otherwise

toString

public java.lang.String toString()

Returns a string representation of the object.

Overrides:

toString in class java.lang.Object

Returns:

the string representation of the object

toString

public java.lang.String toString(java.util.Locale locale)

Returns a string representation of the object.

Parameters:

locale - the locale

Returns:

the string representation of the object