org.jvoicexml.interpreter

Enum InterpreterState

java.lang.Object

java.lang.Enum<InterpreterState>

org.jvoicexml.interpreter.InterpreterState

All Implemented Interfaces:

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

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

A VoiceXML interpreter is at all times in one of two states:

1. waiting for input in an input item (such as <field>, <record>, or <transfer>), or
2. transitioning between input items in response to an input (including spoken utterances, dtmf key presses, and input-related events such as a noinput or nomatch event) received while in the waiting state. While in the transitioning state no speech input is collected, accepted or interpreted. Consequently root and document level speech grammars (such as defined in <link>s) may not be active at all times. However, DTMF input (including timing information) should be collected and buffered in the transition state. Similarly, asynchronously generated events not related directly to execution of the transition should also be buffered until the waiting state (e.g. connection.disconnect.hangup).

Since:

0.6

Enum Constant Summary

Enum Constants

Enum Constant and Description
TRANSITIONING The interpreter is transitioning between input items in response to an input (including spoken utterances, dtmf key presses, and input-related events such as a noinput or nomatch event) received while in the waiting state.
WAITING The interpreter is waiting for input in an input item (such as <field>, <record>, or <transfer>).

Method Summary

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

WAITING

public static final InterpreterState WAITING

The interpreter is waiting for input in an input item (such as <field>, <record>, or <transfer>).

TRANSITIONING

public static final InterpreterState TRANSITIONING

The interpreter is transitioning between input items in response to an input (including spoken utterances, dtmf key presses, and input-related events such as a noinput or nomatch event) received while in the waiting state. While in the transitioning state no speech input is collected, accepted or interpreted. Consequently root and document level speech grammars (such as defined in <link>s) may not be active at all times. However, DTMF input (including timing information) should be collected and buffered in the transition state. Similarly, asynchronously generated events not related directly to execution of the transition should also be buffered until the waiting state (e.g. connection.disconnect.hangup).

Method Detail

values

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

Returns:

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

valueOf

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

getStateName

public java.lang.String getStateName()

Retrieves the name of this state.

Returns:

Name of this state.