org.jvoicexml.event

Class JVoiceXMLEvent

java.lang.Object

java.lang.Throwable

org.jvoicexml.event.JVoiceXMLEvent

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

ErrorEvent, GenericVoiceXmlEvent, PlainEvent, RecordingStartedEvent, RecordingStoppedEvent, SpokenInputEvent, SynthesizedOutputEvent

public abstract class JVoiceXMLEvent
extends java.lang.Throwable

Base class for all events.

The platform throws events when the user does not respond, doesn't respond in a way that the application understands, requests help, etc. The interpreter throws events if it finds a semantic error in a VoiceXML document, or when it encounters a <throw> element. Events are identified by character strings.

Events are subdivided into plain events (things that happen normally), and error events (abnormal occurrences).

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
JVoiceXMLEvent() Constructs a new event with the event type as its detail message.
JVoiceXMLEvent(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>.
JVoiceXMLEvent(java.lang.String message, java.lang.Throwable cause) Constructs a new event with the specified detail message and cause.
JVoiceXMLEvent(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
abstract java.lang.String	getEventType() Get the event type of this event.
java.lang.String	getMessage() Preceed the type to the original message.
boolean	isType(java.lang.String otherType) Checks if the type of this event matches the given type.

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

JVoiceXMLEvent

public JVoiceXMLEvent()

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

See Also:

getEventType()

JVoiceXMLEvent

public JVoiceXMLEvent(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.

Parameters:

message - The detail message.

See Also:

getEventType()

JVoiceXMLEvent

public JVoiceXMLEvent(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).

Parameters:

cause - The cause.

See Also:

getEventType()

JVoiceXMLEvent

public JVoiceXMLEvent(java.lang.String message,
                      java.lang.Throwable cause)

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

Parameters:

message - The detail message.

cause - The cause.

Method Detail

getEventType

public abstract java.lang.String getEventType()

Get the event type of this event.

Returns:

Event type.

isType

public final boolean isType(java.lang.String otherType)

Checks if the type of this event matches the given type.

Parameters:

otherType - the type to check for

Returns:

true if the type is the same

Since:

0.7.7

getMessage

public final java.lang.String getMessage()

Preceed the type to the original message. The returned String evaluates to type: message.

Overrides:

getMessage in class java.lang.Throwable