javax.speech.synthesis
Class SpeakableException

Object
  Throwable
      Exception
          SpeechException
              SpeakableException

public class SpeakableException
extends SpeechException

Thrown if a problem is found with an item placed on the Synthesizer output queue.

If the item represents synthesis markup, then it must conform to the Speech Synthesis Markup Language (SSML).

The exception message is a printable String. A Synthesizer may optionally provide SpeakableExceptionDetails for each syntax problem.

See Also:

Synthesizer, SpeakableExceptionDetail

Constructor Summary

SpeakableException()
Constructs a SpeakableException with no detail message.

SpeakableException(String message)
Constructs a SpeakableException with the specified detail message.

SpeakableException(String message, SpeakableExceptionDetail[] details)
Constructs a SpeakableException with the specified detail message and programmatic details of each problem.

Method Summary

SpeakableExceptionDetail[]

getDetails() Gets the list of SpeakableExceptionDetail descriptions.

Methods inherited from class Throwable

getMessage, printStackTrace, toString

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SpeakableException

public SpeakableException()

Constructs a SpeakableException with no detail message.

SpeakableException

public SpeakableException(String message)

Constructs a SpeakableException with the specified detail message.

Parameters:

message - a printable detail message

SpeakableException

public SpeakableException(String message,
                          SpeakableExceptionDetail[] details)
                   throws IllegalArgumentException

Constructs a SpeakableException with the specified detail message and programmatic details of each problem.

Parameters:

message - a printable detail message

details - a non-null array of details for problems encountered

Throws:

IllegalArgumentException - if called with an invalid parameter value

See Also:

getMessage, getDetails

Method Detail

getDetails

public SpeakableExceptionDetail[] getDetails()

Gets the list of SpeakableExceptionDetail descriptions. This provides additional details for problems encountered.

If no details are available, a zero-length array is returned.

Returns:

an array of SpeakableExceptionDetail objects