com.fsc.cicerone.model

Enum Sex

java.lang.Object

java.lang.Enum<Sex>

com.fsc.cicerone.model.Sex

All Implemented Interfaces:

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

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

The sexes available in Cicerone.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FEMALE The Female sex.
MALE The Male sex.
OTHER A fallback for every non-binary sex.

Method Summary

Modifier and Type	Method and Description
int	getAvatarResource() Get the image resource associated with the sex.
static Sex	getValue(java.lang.String s) Get a sex from a string.
java.lang.String	toString() Convert a Sex to String.
static Sex	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Sex[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

MALE

public static final Sex MALE

The Male sex.

FEMALE

public static final Sex FEMALE

The Female sex.

OTHER

public static final Sex OTHER

A fallback for every non-binary sex.

Method Detail

values

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

Returns:

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

valueOf

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

getValue

@Nullable
public static Sex getValue(java.lang.String s)

Get a sex from a string.

Parameters:

s - The string.

Returns:

The Sex value associated with the string (case insensitive). The accepted values are mapped in the following way:

String	Sex value
"male"	MALE
"female"	FEMALE
"other"	OTHER

Every other string value will be converted to null.

toString

@NonNull
public java.lang.String toString()

Convert a Sex to String.

Overrides:

toString in class java.lang.Enum<Sex>

Returns:

The String associated to the Sex value (lower case). If the Sex value is null, the function returns null.

getAvatarResource

public int getAvatarResource()

Get the image resource associated with the sex.

Returns:

An integer representing the resource.