org.jvoicexml.xml.ssml

Enum GenderType

java.lang.Object

java.lang.Enum<GenderType>

org.jvoicexml.xml.ssml.GenderType

All Implemented Interfaces:

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

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

Gender of a Voice.

Since:

0.6

Enum Constant Summary

Enum Constants

Enum Constant and Description
FEMALE Female voice.
MALE Male voice.
NEUTRAL Neutral voice that is neither male or female (for example, artificial voices, robotic voices).

Method Summary

Modifier and Type	Method and Description
java.lang.String	getType() Retrieves the name of this gender type.
static GenderType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static GenderType[]	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

MALE

public static final GenderType MALE

Male voice.

FEMALE

public static final GenderType FEMALE

Female voice.

NEUTRAL

public static final GenderType NEUTRAL

Neutral voice that is neither male or female (for example, artificial voices, robotic voices).

Method Detail

values

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

Returns:

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

valueOf

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

getType

public java.lang.String getType()

Retrieves the name of this gender type.

Returns:

Name of this type.