org.jvoicexml.xml.vxml
Class Error

java.lang.Object
  org.jvoicexml.xml.XmlNode
      org.jvoicexml.xml.vxml.VoiceXmlNode
          org.jvoicexml.xml.vxml.AbstractCatchElement
              org.jvoicexml.xml.vxml.Error

All Implemented Interfaces:

XmlWritable, Node

public final class Error
extends AbstractCatchElement

Catch an error event.

The <error> element is short for <catch event="error"> and catches all events of type error:

<error>An error has occurred -- please call again later.
<exit/>
</error>

Version:

$Revision: 1.7 $

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

Author:

Steve Doyle, Dirk Schnelle

See Also:

Catch

Field Summary

private static Set<String>	CHILD_TAGS Valid child tags for this node.
private static TokenList	EVENTS List with all events, caught by this catch element.
static String	TAG_NAME Name of the tag.

Fields inherited from class org.jvoicexml.xml.vxml.AbstractCatchElement

ATTRIBUTE_COND, ATTRIBUTE_COUNT

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

Error()
Construct a new error object without a node.

Error(Node node)
Construct a new error 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?
TokenList	getEventList() Retrieve a list with all events, caught by this catch element.
String	getTagName() Get the name of the tag for the derived node.
VoiceXmlNode	newInstance(Node n) Create a new instance for the given node.

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

getCond, getCount, setCond, setCount

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, getAttributeNames, 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

CHILD_TAGS

private static final Set<String> CHILD_TAGS

Valid child tags for this node.

EVENTS

private static final TokenList EVENTS

List with all events, caught by this catch element.

Constructor Detail

Error

public Error()

Construct a new error object without a node.

This is necessary for the node factory.

See Also:

VoiceXmlNodeFactory

Error

Error(Node node)

Construct a new error 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.

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.

getEventList

public TokenList getEventList()

Retrieve a list with all events, caught by this catch element.

Specified by:

getEventList in class AbstractCatchElement

Returns:

List with all events, caught by this catch element.