org.jvoicexml.event.plain

Class HelpEvent

java.lang.Object

java.lang.Throwable

org.jvoicexml.event.JVoiceXMLEvent

org.jvoicexml.event.PlainEvent

org.jvoicexml.event.plain.HelpEvent

All Implemented Interfaces:

java.io.Serializable

public class HelpEvent
extends PlainEvent

The user has asked for help.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EVENT_TYPE The detail message.

Constructor Summary

Constructors

Constructor and Description
HelpEvent() Constructs a new event with the event type as its detail message.
HelpEvent(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>.
HelpEvent(java.lang.String message, java.lang.Throwable cause) Constructs a new event with the specified detail message and cause.
HelpEvent(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	getEventType() Get the event type of this event.

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

Field Detail

EVENT_TYPE

public static final java.lang.String EVENT_TYPE

The detail message.

See Also:

Constant Field Values

Constructor Detail

HelpEvent

public HelpEvent()

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

See Also:

getEventType()

HelpEvent

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

HelpEvent

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

HelpEvent

public HelpEvent(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 final java.lang.String getEventType()

Get the event type of this event.

Specified by:

getEventType in class JVoiceXMLEvent

Returns:

Event type.