org.jvoicexml.event.plain.implementation

Class MarkerReachedEvent

java.lang.Object

java.lang.Throwable

org.jvoicexml.event.JVoiceXMLEvent

org.jvoicexml.event.plain.implementation.SynthesizedOutputEvent

org.jvoicexml.event.plain.implementation.MarkerReachedEvent

All Implemented Interfaces:

java.io.Serializable

public final class MarkerReachedEvent
extends SynthesizedOutputEvent

A notification that a certain mark within an SSML document has been reached.

Since:

0.7.1

See Also:

Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
MarkerReachedEvent(SynthesizedOutput output, java.lang.String sessionId, java.lang.String name) Constructs a new event with the event type as its detail message.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getMark() Returns the name of the mark that has been reached.

Methods inherited from class org.jvoicexml.event.plain.implementation.SynthesizedOutputEvent

getEventType, getSessionId, getSource

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

DETAIL

public static final java.lang.String DETAIL

The unsupported element.

See Also:

Constant Field Values

EVENT_TYPE

public static final java.lang.String EVENT_TYPE

The detail message.

Constructor Detail

MarkerReachedEvent

public MarkerReachedEvent(SynthesizedOutput output,
                          java.lang.String sessionId,
                          java.lang.String name)

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

The DETAIL is used to construct the event type.

Parameters:

output - object that caused the event.

sessionId - the session id

name - name of the mark that has been reached.

See Also:

SynthesizedOutputEvent.getEventType()

Method Detail

getMark

public java.lang.String getMark()

Returns the name of the mark that has been reached.

Returns:

name of the mark.