org.jvoicexml.interpreter.scope

Enum Scope

java.lang.Object

java.lang.Enum<Scope>

org.jvoicexml.interpreter.scope.Scope

All Implemented Interfaces:

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

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

Scope.

Since:

0.3

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANONYMOUS Each <block>, <filled>, and <catch> element defines a new anonymous scope.
APPLICATION Scope that are children of the application root document's <vxml> element.
DIALOG Each dialog (<form> or <menu>) has a dialog scope that exists while the user is visiting that dialog, and which is visible to the elements of that dialog.
DOCUMENT Scope that is declared within document's <vxml> element.
SESSION Scope for a user's session.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName() Retrieve the scope's name.
static Scope	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Scope[]	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

SESSION

public static final Scope SESSION

Scope for a user's session.

APPLICATION

public static final Scope APPLICATION

Scope that are children of the application root document's <vxml> element. It is entered when the application root document is loaded. It exists while the application root document is loaded, is visible to the root document and any other loaded application leaf document.

DOCUMENT

public static final Scope DOCUMENT

Scope that is declared within document's <vxml> element. It is initialized when the document is loaded. It exists while the document is loaded. It is visible only within that document, unless the document is an application root, in which case it is visible by leaf documents through the application scope only.

DIALOG

public static final Scope DIALOG

Each dialog (<form> or <menu>) has a dialog scope that exists while the user is visiting that dialog, and which is visible to the elements of that dialog.

ANONYMOUS

public static final Scope ANONYMOUS

Each <block>, <filled>, and <catch> element defines a new anonymous scope.

Method Detail

values

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

Returns:

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

valueOf

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

getName

public java.lang.String getName()

Retrieve the scope's name.

Returns:

Name of this scope.