org.jvoicexml.event.error

Class UnsupportedElementError

java.lang.Object

java.lang.Throwable

org.jvoicexml.event.JVoiceXMLEvent

org.jvoicexml.event.ErrorEvent

org.jvoicexml.event.error.UnsupportedElementError

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

UnsupportedBuiltinError, UnsupportedFormatError, UnsupportedLanguageError, UnsupportedObjectnameError

public class UnsupportedElementError
extends ErrorEvent

The platform does not support the given element, where element is a VoiceXML element defined in this specification. For instance, if a platform does not implement <transfer>, it must throw error.unsupported.transfer. This allows an author to use event handling to adapt to different platform capabilities.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
UnsupportedElementError(java.lang.String unsupported) Constructs a new event with the event type as its detail message.
UnsupportedElementError(java.lang.String unsupported, java.lang.String message) Constructs a new event with the specified detail message. the given detail message is expanded to the form <EVENT_TYPE>: <message>.
UnsupportedElementError(java.lang.String unsupported, java.lang.String message, java.lang.Throwable cause) Constructs a new event with the specified detail message and cause.
UnsupportedElementError(java.lang.String unsupported, java.lang.Throwable cause) Constructs a new event with the specified cause and a detail message of (cause==null ?

Method Summary

Modifier and Type	Method and Description
java.lang.String	getElement() Retrieve the name of the unsupported element.
java.lang.String	getEventType() Constructs an event type with the event type as specification.

Methods inherited from class org.jvoicexml.event.JVoiceXMLEvent

getMessage, isType

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

UnsupportedElementError

public UnsupportedElementError(java.lang.String unsupported)

Constructs a new event with the event type as its detail message. The cause is not initialized.

The unsupported element is used to construct the event type.

Parameters:

unsupported - The name of the unsupported element.

See Also:

getEventType()

UnsupportedElementError

public UnsupportedElementError(java.lang.String unsupported,
                               java.lang.String message)

Constructs a new event with the specified detail message. the given detail message is expanded to the form <EVENT_TYPE>: <message>. The cause is not initialized.

The unsupported element is used to construct the event type.

Parameters:

unsupported - The name of the unsupported element.

message - The detail message.

See Also:

getEventType()

UnsupportedElementError

public UnsupportedElementError(java.lang.String unsupported,
                               java.lang.Throwable cause)

Constructs a new event with the specified cause and a detail message of (cause==null ? getEventType() : cause.toString()) (which typically contains the class and detail message of cause).

The unsupported element is used to construct the event type.

Parameters:

unsupported - The name of the unsupported element.

cause - The cause.

See Also:

getEventType()

UnsupportedElementError

public UnsupportedElementError(java.lang.String unsupported,
                               java.lang.String message,
                               java.lang.Throwable cause)

Constructs a new event with the specified detail message and cause.

The unsupported element is used to construct the event type.

Parameters:

unsupported - The name of the unsupported element.

message - The detail message.

cause - The cause.

Method Detail

getElement

public final java.lang.String getElement()

Retrieve the name of the unsupported element.

Returns:

name of the unsupported element.

getEventType

public final java.lang.String getEventType()

Constructs an event type with the event type as specification. The event type has the following form

<EVENT_TYPE>.<element>

Specified by:

getEventType in class JVoiceXMLEvent

Returns:

Event type.

See Also:

EVENT_TYPE, {@inheritDoc}