org.jvoicexml.xml.vxml
Class Exit

java.lang.Object
  org.jvoicexml.xml.XmlNode
      org.jvoicexml.xml.vxml.VoiceXmlNode
          org.jvoicexml.xml.vxml.Exit

All Implemented Interfaces:

XmlWritable, Node

public final class Exit
extends VoiceXmlNode

Exit a session.

Returns control to the interpreter context which determines what to do next.

<exit/>

This element differs from <return> in that it terminates all loaded documents, while <return> returns from a <subdialog> invocation. If the <subdialog> caused a new document (or application) to be invoked, then <return> will cause that document to be terminated, but execution will resume after the <subdialog>.

Version:

$Revision: 1.8 $

Copyright © 2005 JVoiceXML group - http://jvoicexml.sourceforge.net/

Author:

Steve Doyle

See Also:

Return

Field Summary

static String	ATTRIBUTE_EXPR An ECMAScript expression that is evaluated as the return value (e.g. "0", "'oops!'"
static String	ATTRIBUTE_NAMELIST Variable names to be returned to interpreter context.
protected static ArrayList<String>	ATTRIBUTE_NAMES Supported attribute names for this node.
static String	TAG_NAME Name of the tag.

Fields inherited from class org.jvoicexml.xml.XmlNode

node

Fields inherited from interface org.w3c.dom.Node

ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

Constructor Summary

Exit()
Construct a new exit object without a node.

Exit(Node node)
Construct a new exit object.

Method Summary

Text	addText(String text) Create a new text within this node.
protected boolean	canContainChild(String tagName) Can the specified sub-tag be contained within this node?
Collection<String>	getAttributeNames() Returns a collection of permitted attribute names for the node.
String	getExpr() Retrieve the expr attribute.
String	getNamelist() Retrieve the namelist attribute.
TokenList	getNameListObject() Retrieve the namelist attribute as a list object.
String	getTagName() Get the name of the tag for the derived node.
VoiceXmlNode	newInstance(Node n) Create a new instance for the given node.
void	setExpr(String expr) Set the expr attribute.
void	setNamelist(String namelist) Set the namelist attribute.

Methods inherited from class org.jvoicexml.xml.vxml.VoiceXmlNode

getChildNodes, getFirstChild, getLastChild, getNextSibling, getParentNode, getPreviousSibling

Methods inherited from class org.jvoicexml.xml.XmlNode

addChild, appendChild, cloneNode, compareDocumentPosition, getAttribute, getAttributes, getBaseURI, getChildNodes, getFeature, getLocalName, getNamespaceURI, getNode, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getPrefix, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setAttribute, setNodeValue, setPrefix, setTextContent, setUserData, toString, writeChildrenXml, writeXml

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

TAG_NAME

public static final String TAG_NAME

Name of the tag.

See Also:

Constant Field Values

ATTRIBUTE_EXPR

public static final String ATTRIBUTE_EXPR

An ECMAScript expression that is evaluated as the return value (e.g. "0", "'oops!'", or "field1").

See Also:

Constant Field Values

ATTRIBUTE_NAMELIST

public static final String ATTRIBUTE_NAMELIST

Variable names to be returned to interpreter context. The default is to return no variables; this means the interpreter context will receive an empty ECMAScript object.

See Also:

Constant Field Values

ATTRIBUTE_NAMES

protected static final ArrayList<String> ATTRIBUTE_NAMES

Supported attribute names for this node.

Constructor Detail

Exit

public Exit()

Construct a new exit object without a node.

This is necessary for the node factory.

See Also:

VoiceXmlNodeFactory

Exit

Exit(Node node)

Construct a new exit object.

Parameters:

node - The encapsulated node.

Method Detail

getTagName

public String getTagName()

Get the name of the tag for the derived node.

Specified by:

getTagName in class XmlNode

Returns:

name of the tag.

newInstance

public VoiceXmlNode newInstance(Node n)

Create a new instance for the given node.

Specified by:

newInstance in class XmlNode

Parameters:

n - The node to encapsulate.

Returns:

The new instance.

getExpr

public String getExpr()

Retrieve the expr attribute.

Returns:

Value of the expr attribute.

See Also:

ATTRIBUTE_EXPR

setExpr

public void setExpr(String expr)

Set the expr attribute.

Parameters:

expr - Value of the expr attribute.

See Also:

ATTRIBUTE_EXPR

getNamelist

public String getNamelist()

Retrieve the namelist attribute.

Returns:

Value of the namelist attribute.

See Also:

ATTRIBUTE_NAMELIST

getNameListObject

public TokenList getNameListObject()

Retrieve the namelist attribute as a list object.

Returns:

Value of the namelist attribute as a list.

Since:

0.3

See Also:

getNamelist()

setNamelist

public void setNamelist(String namelist)

Set the namelist attribute.

Parameters:

namelist - Value of the namelist attribute.

See Also:

ATTRIBUTE_NAMELIST

addText

public Text addText(String text)

Create a new text within this node.

Parameters:

text - The text to be added.

Returns:

The new created text.

canContainChild

protected boolean canContainChild(String tagName)

Can the specified sub-tag be contained within this node?

Specified by:

canContainChild in class XmlNode

Parameters:

tagName - Name of child.

Returns:

True if the sub-tag is allowed on this node.

getAttributeNames

public Collection<String> getAttributeNames()

Returns a collection of permitted attribute names for the node.

Overrides:

getAttributeNames in class XmlNode

Returns:

A collection of attribute names that are allowed for the node