org.jvoicexml.event.plain
Class CancelEvent

java.lang.Object
  java.lang.Throwable
      org.jvoicexml.event.JVoiceXMLEvent
          org.jvoicexml.event.PlainEvent
              org.jvoicexml.event.plain.CancelEvent

All Implemented Interfaces:

Serializable

public class CancelEvent
extends PlainEvent

The user has requested to cancel playing of the current prompt.

Version:

$Revision: 198 $

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

Author:

Dirk Schnelle

See Also:

Serialized Form

Field Summary

static String

EVENT_TYPE The detail message.

Constructor Summary

CancelEvent()
Constructs a new event with the event type as its detail message.

CancelEvent(String message)
Constructs a new event with the specified detail message. the given detail message is expanded to the form <EVENT_TYPE>>: <message>.

CancelEvent(String message, Throwable cause)
Constructs a new event with the specified detail message and cause.

CancelEvent(Throwable cause)
Constructs a new event with the specified cause and a detail message of (cause==null ?

Method Summary

String

getEventType() Get the event type of this event.

Methods inherited from class org.jvoicexml.event.JVoiceXMLEvent

getMessage

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Field Detail

EVENT_TYPE

public static final String EVENT_TYPE

The detail message.

See Also:

Constant Field Values

Constructor Detail

CancelEvent

public CancelEvent()

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

See Also:

getEventType()

CancelEvent

public CancelEvent(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()

CancelEvent

public CancelEvent(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()

CancelEvent

public CancelEvent(String message,
                   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 final String getEventType()

Get the event type of this event.

Specified by:

getEventType in class JVoiceXMLEvent

Returns:

Event type.