Overview | Package | Class | Tree | Index | Help
PREV CLASS | NEXT CLASS	FRAMES | NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

Class javax.speech.EngineErrorEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--javax.speech.SpeechEvent
              |
              +--javax.speech.EngineEvent
                    |
                    +--javax.speech.EngineErrorEvent

public class EngineErrorEvent

extends EngineEvent

EngineErrorEvent is an asynchronous notification of an internal error in the engine which prevents normal behavior of that engine. The event encapsulates a Throwable object that provides details about the error.

See Also:

engineError, Serialized Form

Field Summary

static int	ENGINE_ERROR Identifier for event issued when engine error occurs.
Throwable	problem Throwable object (Exception or Error) that describes the detected engine problem.

Fields inherited from class javax.speech.EngineEvent

ENGINE_ALLOCATED, ENGINE_ALLOCATING_RESOURCES, ENGINE_DEALLOCATED, ENGINE_DEALLOCATING_RESOURCES, ENGINE_PAUSED, ENGINE_RESUMED, newEngineState, oldEngineState

Fields inherited from class javax.speech.SpeechEvent

id

Fields inherited from class java.util.EventObject

source

Constructor Summary

EngineErrorEvent(Engine source, int id, Throwable throwable, long oldEngineState, long newEngineState)
Constructs an EngineErrorEvent with an event identifier, throwable, old engine state and new engine state.

Method Summary

Throwable	getEngineError() Return the Throwable object (Exception or Error) that describes the engine problem.
String	paramString() Returns a parameter string identifying this event.

Methods inherited from class javax.speech.EngineEvent

getNewEngineState, getOldEngineState, paramString

Methods inherited from class javax.speech.SpeechEvent

getId, paramString, toString

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Field Detail

ENGINE_ERROR

public static final int ENGINE_ERROR

Identifier for event issued when engine error occurs.

See Also:

engineError

problem

protected Throwable problem

Throwable object (Exception or Error) that describes the detected engine problem.

See Also:

getEngineError

Constructor Detail

EngineErrorEvent

public EngineErrorEvent(Engine source,
                        int id,
                        Throwable throwable,
                        long oldEngineState,
                        long newEngineState)

Constructs an EngineErrorEvent with an event identifier, throwable, old engine state and new engine state. The old and new states are zero if the engine states are unknown or undefined.

Parameters:

source - the object that issued the event

id - the identifier for the event type

throwable - description of the detected error

oldEngineState - engine state prior to this event

newEngineState - engine state following this event

See Also:

getEngineState

Method Detail

getEngineError

public Throwable getEngineError()

Return the Throwable object (Exception or Error) that describes the engine problem.

paramString

public String paramString()

Returns a parameter string identifying this event. This method is useful for event-logging and for debugging.

Returns:

a string identifying the event

Overrides:

paramString in class EngineEvent