org.jvoicexml.xml.srgs

Enum ModeType

java.lang.Object

java.lang.Enum<ModeType>

org.jvoicexml.xml.srgs.ModeType

All Implemented Interfaces:

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

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

The mode of a grammar indicates the type of input that the user agent should be detecting.

Since:

0.6

Enum Constant Summary

Enum Constants

Enum Constant and Description
DTMF DTMF input.
EXTERNAL External input.
VOICE Voice input.

Method Summary

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

VOICE

public static final ModeType VOICE

Voice input.

DTMF

public static final ModeType DTMF

DTMF input.

EXTERNAL

public static final ModeType EXTERNAL

External input.

Method Detail

values

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

Returns:

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

valueOf

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

getMode

public java.lang.String getMode()

Retrieves the name of this barge-in type.

Returns:

Name of this type.