org.jvoicexml.xml.vxml

Enum BargeInType

java.lang.Object

java.lang.Enum<BargeInType>

org.jvoicexml.xml.vxml.BargeInType

All Implemented Interfaces:

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

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

When bargein is enabled, the bargeintype attribute can be used to suggest the type of bargein the platform will perform in response to voice or DTMF input.

Since:

0.5

Enum Constant Summary

Enum Constants

Enum Constant and Description
HOTWORD The prompt will not be stopped until a complete match of an active grammar is detected.
SPEECH The prompt will be stopped as soon as speech or DTMF input is detected.

Method Summary

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

SPEECH

public static final BargeInType SPEECH

The prompt will be stopped as soon as speech or DTMF input is detected. The prompt is stopped irrespective of whether or not the input matches a grammar and irrespective of which grammars are active.

HOTWORD

public static final BargeInType HOTWORD

The prompt will not be stopped until a complete match of an active grammar is detected. Input that does not match a grammar is ignored (note that this even applies during the timeout period); as a consequence, a nomatch event will never be generated in the case of hotword bargein.

Method Detail

values

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

Returns:

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

valueOf

public static BargeInType 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 barge-in type.

Returns:

Name of this type.