javax.speech.spi
Interface EngineListFactory

public interface EngineListFactory

Provides a list of EngineMode objects that define the available operating modes of a speech Engine.

This interface is part of the Service Provider Interface (SPI). Application developers do not need to use this interface. EngineListFactory is used internally by the EngineManager and speech Engine implementations.

Each speech Engine implementation registers an EngineListFactory object with the EngineManager class as described in the Engine Registration section. When requested by the EngineManager class, each registered EngineListFactory object provides a list of EngineMode objects that describe each available operating mode of the speech Engine implementation.

The EngineMode objects returned by EngineListFactory in its EngineList must implement the EngineFactory interface and be a sub-class of EngineMode (not EngineMode directly). The EngineManager class calls the createEngine method of each EngineFactory interface when it is requested to create an Engine. See EngineFactory for more detail.

The speech Engine implementation must perform the same security checks on access to speech Engines as the EngineManager class.

See Also:

Engine, EngineManager, registerEngineListFactory, EngineFactory, createEngine, EngineMode

Method Summary

EngineList

createEngineList(EngineMode required) Creates an EngineList containing an EngineMode for each mode of operation of a speech Engine that matches a set of required features.

Method Detail

createEngineList

EngineList createEngineList(EngineMode required)

Creates an EngineList containing an EngineMode for each mode of operation of a speech Engine that matches a set of required features. Each object in the list must be a sub-class of EngineMode and must implement the EngineFactory interface.

Returns null if no Engines are available or if none meet the specified requirements.

If required is null, all available Engines are returned.

The returned EngineList indicates the list of modes available at the time of the call (the list may change over time). An implementation can create the list at the time of the call or it may be pre-stored.

Parameters:

required - a required set of features

Returns:

the EngineList with matching EngineMode features

See Also:

EngineFactory, EngineMode, RecognizerMode, SynthesizerMode