org.jvoicexml.xml.vxml
Class Catch

java.lang.Object
  org.jvoicexml.xml.AbstractXmlNode
      org.jvoicexml.xml.vxml.AbstractCatchElement
          org.jvoicexml.xml.vxml.Catch

All Implemented Interfaces:

VoiceXmlNode, XmlNode, XmlWritable, Node

public final class Catch
extends AbstractCatchElement

The <catch> element associates a catch with a document, dialog, or form item (except for blocks). It contains executable content.

Version:

$Revision: 197 $

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

Author:

Steve Doyle, Dirk Schnelle

See Also:

Form, VoiceXmlDocument

Field Summary

static String	ATTRIBUTE_EVENT The event or events to catch.
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.vxml.AbstractCatchElement

ATTRIBUTE_COND, ATTRIBUTE_COUNT

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

Catch()
Construct a new catch object without a node.

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.
NodeList	getChildNodes() A NodeList that contains all children of this node.
String	getEvent() Retrieve the event attribute.
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.
void	setEvent(String event) Set the event attribute.

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

getCond, getCount, setCond, setCount

Methods inherited from class org.jvoicexml.xml.AbstractXmlNode

addChild, addChild, appendChild, cloneNode, compareDocumentPosition, getAttribute, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNode, getNodeFactory, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, 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

Methods inherited from interface org.jvoicexml.xml.XmlNode

addChild, getAttribute, getChildNodes, getNode, setAttribute

Methods inherited from interface org.jvoicexml.xml.XmlWritable

writeChildrenXml, writeXml

Methods inherited from interface org.w3c.dom.Node

appendChild, cloneNode, compareDocumentPosition, getAttributes, getBaseURI, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData

Field Detail

TAG_NAME

public static final String TAG_NAME

Name of the tag.

See Also:

Constant Field Values

ATTRIBUTE_EVENT

public static final String ATTRIBUTE_EVENT

The event or events to catch. A space-separated list of events may be specified, indicating that this <catch> element catches all the events named in the list. In such a case a separate event counter is maintained for each event. If the attribute is unspecified, all events are to be caught.

See Also:

AbstractCatchElement.ATTRIBUTE_COUNT, Constant Field Values

ATTRIBUTE_NAMES

protected static final ArrayList<String> ATTRIBUTE_NAMES

Supported attribute names for this node.

Constructor Detail

Catch

public Catch()

Construct a new catch object without a node.

This is necessary for the node factory.

See Also:

VoiceXmlNodeFactory

Method Detail

getTagName

public String getTagName()

Get the name of the tag for the derived node.

Returns:

name of the tag.

newInstance

public VoiceXmlNode newInstance(Node n)

Create a new instance for the given node.

Parameters:

n - The node to encapsulate.

Returns:

The new instance.

See Also:

XmlNodeFactory

getEvent

public String getEvent()

Retrieve the event attribute.

Returns:

Value of the event attribute.

See Also:

ATTRIBUTE_EVENT

setEvent

public void setEvent(String event)

Set the event attribute.

Parameters:

event - Value of the event attribute.

See Also:

ATTRIBUTE_EVENT

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.

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 AbstractXmlNode

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.

Specified by:

getAttributeNames in interface XmlNode

Overrides:

getAttributeNames in class AbstractXmlNode

Returns:

A collection of attribute names that are allowed for the node

getChildNodes

public final NodeList getChildNodes()

A NodeList that contains all children of this node.

Specified by:

getChildNodes in interface Node

Returns:

NodeList