1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
\r
5 <!-- Generated by javadoc (build 1.4.2_16) on Mon Mar 09 18:20:28 CET 2009 -->
\r
7 BaseEngine (FreeTTS 1.2)
\r
10 <META NAME="keywords" CONTENT="com.sun.speech.engine.BaseEngine class">
\r
12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
\r
14 <SCRIPT type="text/javascript">
\r
15 function windowTitle()
\r
17 parent.document.title="BaseEngine (FreeTTS 1.2)";
\r
23 <BODY BGCOLOR="white" onload="windowTitle();">
\r
26 <!-- ========= START OF TOP NAVBAR ======= -->
\r
27 <A NAME="navbar_top"><!-- --></A>
28 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
29 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
\r
31 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
\r
32 <A NAME="navbar_top_firstrow"><!-- --></A>
33 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
\r
34 <TR ALIGN="center" VALIGN="top">
\r
35 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
\r
36 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
37 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
39 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
45 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
51 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
52 <A HREF="../../../../com/sun/speech/engine/BaseAudioManager.html" title="class in com.sun.speech.engine"><B>PREV CLASS</B></A>
\r
53 <A HREF="../../../../com/sun/speech/engine/BaseEngineProperties.html" title="class in com.sun.speech.engine"><B>NEXT CLASS</B></A></FONT></TD>
\r
54 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
55 <A HREF="../../../../index.html" target="_top"><B>FRAMES</B></A>
\r
56 <A HREF="BaseEngine.html" target="_top"><B>NO FRAMES</B></A>
\r
57 <SCRIPT type="text/javascript">
\r
60 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
65 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
\r
71 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
72 SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
73 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
74 DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
77 <A NAME="skip-navbar_top"></A>
78 <!-- ========= END OF TOP NAVBAR ========= -->
\r
81 <!-- ======== START OF CLASS DATA ======== -->
\r
84 com.sun.speech.engine</FONT>
\r
86 Class BaseEngine</H2>
\r
89 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by"><B>com.sun.speech.engine.BaseEngine</B>
\r
92 <DT><B>All Implemented Interfaces:</B> <DD>javax.speech.Engine, <A HREF="../../../../com/sun/speech/engine/SpeechEventDispatcher.html" title="interface in com.sun.speech.engine">SpeechEventDispatcher</A></DD>
\r
95 <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.html" title="class in com.sun.speech.engine.synthesis">BaseSynthesizer</A></DD>
\r
99 <DT>public abstract class <B>BaseEngine</B><DT>extends java.lang.Object<DT>implements javax.speech.Engine, <A HREF="../../../../com/sun/speech/engine/SpeechEventDispatcher.html" title="interface in com.sun.speech.engine">SpeechEventDispatcher</A></DL>
\r
102 Supports the JSAPI 1.0 <code>Engine</code> interface.
103 Actual JSAPI implementations might want to extend or modify this
111 <!-- ======== NESTED CLASS SUMMARY ======== -->
\r
114 <!-- =========== FIELD SUMMARY =========== -->
\r
116 <A NAME="field_summary"><!-- --></A>
117 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
118 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
119 <TD COLSPAN=2><FONT SIZE="+2">
\r
120 <B>Field Summary</B></FONT></TD>
\r
122 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
123 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
124 <CODE>protected javax.speech.AudioManager</CODE></FONT></TD>
\r
125 <TD><CODE><B><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#audioManager">audioManager</A></B></CODE>
\r
128 The <code>AudioManager</code> for this <code>Engine</code>.</TD>
\r
130 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
131 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
132 <CODE>protected static long</CODE></FONT></TD>
\r
133 <TD><CODE><B><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#CLEAR_ALL_STATE">CLEAR_ALL_STATE</A></B></CODE>
\r
136 Utility state for clearing the <code>engineState</code>.</TD>
\r
138 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
139 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
140 <CODE>protected java.util.Collection</CODE></FONT></TD>
\r
141 <TD><CODE><B><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#engineListeners">engineListeners</A></B></CODE>
\r
144 List of <code>EngineListeners</code> registered for
145 <code>EngineEvents</code> on this <code>Engine</code>.</TD>
\r
147 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
148 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
149 <CODE>protected javax.speech.EngineModeDesc</CODE></FONT></TD>
\r
150 <TD><CODE><B><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#engineModeDesc">engineModeDesc</A></B></CODE>
\r
153 The <code>EngineModeDesc</code> for this <code>Engine</code>.</TD>
\r
155 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
156 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
157 <CODE>protected javax.speech.EngineProperties</CODE></FONT></TD>
\r
158 <TD><CODE><B><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#engineProperties">engineProperties</A></B></CODE>
\r
161 The <code>EngineProperties</code> for this <code>Engine</code>.</TD>
\r
163 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
164 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
165 <CODE>protected long</CODE></FONT></TD>
\r
166 <TD><CODE><B><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#engineState">engineState</A></B></CODE>
\r
169 A bitmask holding the current state of this <code>Engine</code>.</TD>
\r
171 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
172 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
173 <CODE>protected java.lang.Object</CODE></FONT></TD>
\r
174 <TD><CODE><B><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#engineStateLock">engineStateLock</A></B></CODE>
\r
177 An <code>Object</code> used for synchronizing access to
178 <code>engineState</code>.</TD>
\r
181 <A NAME="fields_inherited_from_class_javax.speech.Engine"><!-- --></A>
182 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
183 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
\r
184 <TD><B>Fields inherited from interface javax.speech.Engine</B></TD>
\r
186 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
187 <TD><CODE>ALLOCATED, ALLOCATING_RESOURCES, DEALLOCATED, DEALLOCATING_RESOURCES, PAUSED, RESUMED</CODE></TD>
\r
191 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
\r
193 <A NAME="constructor_summary"><!-- --></A>
194 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
195 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
196 <TD COLSPAN=2><FONT SIZE="+2">
\r
197 <B>Constructor Summary</B></FONT></TD>
\r
199 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
200 <TD><CODE><B><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#BaseEngine()">BaseEngine</A></B>()</CODE>
\r
203 Creates a new <code>Engine</code> in the
204 <code>DEALLOCATED</code> state.</TD>
\r
206 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
207 <TD><CODE><B><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#BaseEngine(javax.speech.EngineModeDesc)">BaseEngine</A></B>(javax.speech.EngineModeDesc desc)</CODE>
\r
210 Creates a new <code>Engine</code> in the
211 <code>DEALLOCATED</code> state.</TD>
\r
215 <!-- ========== METHOD SUMMARY =========== -->
\r
217 <A NAME="method_summary"><!-- --></A>
218 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
219 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
220 <TD COLSPAN=2><FONT SIZE="+2">
\r
221 <B>Method Summary</B></FONT></TD>
\r
223 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
224 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
225 <CODE> void</CODE></FONT></TD>
\r
226 <TD><CODE><B><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#addEngineListener(javax.speech.EngineListener)">addEngineListener</A></B>(javax.speech.EngineListener listener)</CODE>
\r
229 Requests notification of <code>EngineEvents</code> from this
230 <code>Engine</code>.</TD>
\r
232 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
233 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
234 <CODE> void</CODE></FONT></TD>
\r
235 <TD><CODE><B><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#allocate()">allocate</A></B>()</CODE>
\r
238 Allocates the resources required for this <code>Engine</code> and
239 puts it into the <code>ALLOCATED</code> state. </TD>
\r
241 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
242 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
243 <CODE>protected void</CODE></FONT></TD>
\r
244 <TD><CODE><B><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#checkEngineState(long)">checkEngineState</A></B>(long state)</CODE>
\r
247 Convenience method that throws an <code>EngineStateError</code>
248 if any of the bits in the passed state are set in the
249 <code>state</code>.</TD>
\r
251 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
252 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
253 <CODE>protected abstract <A HREF="../../../../com/sun/speech/engine/BaseEngineProperties.html" title="class in com.sun.speech.engine">BaseEngineProperties</A></CODE></FONT></TD>
\r
254 <TD><CODE><B><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#createEngineProperties()">createEngineProperties</A></B>()</CODE>
\r
257 Factory constructor for EngineProperties object.</TD>
\r
259 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
260 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
261 <CODE> void</CODE></FONT></TD>
\r
262 <TD><CODE><B><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#deallocate()">deallocate</A></B>()</CODE>
\r
265 Frees the resources of this <code>Engine</code> that were
266 acquired during allocation and during operation and return this
267 <code>Engine</code> to the <code>DEALLOCATED</code>. </TD>
\r
269 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
270 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
271 <CODE> void</CODE></FONT></TD>
\r
272 <TD><CODE><B><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#dispatchSpeechEvent(javax.speech.SpeechEvent)">dispatchSpeechEvent</A></B>(javax.speech.SpeechEvent event)</CODE>
\r
275 Dispatches a <code>SpeechEvent</code>.
278 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
279 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
280 <CODE> void</CODE></FONT></TD>
\r
281 <TD><CODE><B><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#fireEngineAllocated(javax.speech.EngineEvent)">fireEngineAllocated</A></B>(javax.speech.EngineEvent event)</CODE>
\r
284 Utility function that sends an <code>ENGINE_ALLOCATED</code>
285 event to all <code>EngineListeners</code> registered with this
286 <code>Engine</code>. </TD>
\r
288 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
289 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
290 <CODE> void</CODE></FONT></TD>
\r
291 <TD><CODE><B><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#fireEngineAllocatingResources(javax.speech.EngineEvent)">fireEngineAllocatingResources</A></B>(javax.speech.EngineEvent event)</CODE>
\r
294 Utility function that sends an
295 <code>ENGINE_ALLOCATING_RESOURCES</code> event to all
296 <code>EngineListeners</code> registered with this
297 <code>Engine</code>. </TD>
\r
299 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
300 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
301 <CODE> void</CODE></FONT></TD>
\r
302 <TD><CODE><B><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#fireEngineDeallocated(javax.speech.EngineEvent)">fireEngineDeallocated</A></B>(javax.speech.EngineEvent event)</CODE>
\r
305 Utility function that sends an
306 <code>ENGINE_DEALLOCATED</code> event to all
307 <code>EngineListeners</code> registered with this
308 <code>Engine</code>. </TD>
\r
310 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
311 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
312 <CODE> void</CODE></FONT></TD>
\r
313 <TD><CODE><B><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#fireEngineDeallocatingResources(javax.speech.EngineEvent)">fireEngineDeallocatingResources</A></B>(javax.speech.EngineEvent event)</CODE>
\r
316 Utility function that sends a
317 <code>ENGINE_DEALLOCATING_RESOURCES</code> event to all
318 <code>EngineListeners</code> registered with this
319 <code>Engine</code>. </TD>
\r
321 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
322 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
323 <CODE> void</CODE></FONT></TD>
\r
324 <TD><CODE><B><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#fireEnginePaused(javax.speech.EngineEvent)">fireEnginePaused</A></B>(javax.speech.EngineEvent event)</CODE>
\r
327 Utility function that sends an <code>ENGINE_PAUSED</code> event
329 <code>EngineListeners</code> registered with this
330 <code>Engine</code>. </TD>
\r
332 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
333 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
334 <CODE> void</CODE></FONT></TD>
\r
335 <TD><CODE><B><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#fireEngineResumed(javax.speech.EngineEvent)">fireEngineResumed</A></B>(javax.speech.EngineEvent event)</CODE>
\r
338 Utility function that sends an <code>ENGINE_RESUMED</code> event
340 <code>EngineListeners</code> registered with this
341 <code>Engine</code>. </TD>
\r
343 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
344 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
345 <CODE> javax.speech.AudioManager</CODE></FONT></TD>
\r
346 <TD><CODE><B><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#getAudioManager()">getAudioManager</A></B>()</CODE>
\r
349 Returns an object that provides management of the audio input
350 or output of this <code>Engine</code>.</TD>
\r
352 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
353 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
354 <CODE> javax.speech.EngineModeDesc</CODE></FONT></TD>
\r
355 <TD><CODE><B><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#getEngineModeDesc()">getEngineModeDesc</A></B>()</CODE>
\r
358 Gets the current operating properties and mode of
359 this <code>Engine</code>.</TD>
\r
361 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
362 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
363 <CODE> javax.speech.EngineProperties</CODE></FONT></TD>
\r
364 <TD><CODE><B><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#getEngineProperties()">getEngineProperties</A></B>()</CODE>
\r
367 Gets the <code>EngineProperties</code> of this <code>Engine</code>.
370 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
371 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
372 <CODE> long</CODE></FONT></TD>
\r
373 <TD><CODE><B><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#getEngineState()">getEngineState</A></B>()</CODE>
\r
376 Returns a or'ed set of flags indicating the current state of
377 this <code>Engine</code>.
381 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
382 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
383 <CODE> javax.speech.VocabManager</CODE></FONT></TD>
\r
384 <TD><CODE><B><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#getVocabManager()">getVocabManager</A></B>()</CODE>
\r
387 Returns an object that provides management of the vocabulary for
388 this <code>Engine</code>. </TD>
\r
390 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
391 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
392 <CODE>protected abstract void</CODE></FONT></TD>
\r
393 <TD><CODE><B><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#handleAllocate()">handleAllocate</A></B>()</CODE>
\r
396 Called from the <code>allocate</code> method. </TD>
\r
398 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
399 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
400 <CODE>protected abstract void</CODE></FONT></TD>
\r
401 <TD><CODE><B><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#handleDeallocate()">handleDeallocate</A></B>()</CODE>
\r
404 Called from the <code>deallocate</code> method. </TD>
\r
406 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
407 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
408 <CODE>protected abstract void</CODE></FONT></TD>
\r
409 <TD><CODE><B><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#handlePause()">handlePause</A></B>()</CODE>
\r
412 Called from the <code>pause</code> method. </TD>
\r
414 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
415 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
416 <CODE>protected abstract void</CODE></FONT></TD>
\r
417 <TD><CODE><B><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#handleResume()">handleResume</A></B>()</CODE>
\r
420 Called from the <code>resume</code> method. </TD>
\r
422 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
423 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
424 <CODE> void</CODE></FONT></TD>
\r
425 <TD><CODE><B><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#pause()">pause</A></B>()</CODE>
\r
428 Pauses the audio stream for this <code>Engine</code> and put
429 this <code>Engine</code> into the <code>PAUSED</code> state.</TD>
\r
431 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
432 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
433 <CODE>protected void</CODE></FONT></TD>
\r
434 <TD><CODE><B><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#postEngineAllocated(long, long)">postEngineAllocated</A></B>(long oldState,
435 long newState)</CODE>
\r
438 Utility function that generates an
439 <code>ENGINE_ALLOCATED</code> event and posts it
440 to the event queue. </TD>
\r
442 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
443 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
444 <CODE>protected void</CODE></FONT></TD>
\r
445 <TD><CODE><B><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#postEngineAllocatingResources(long, long)">postEngineAllocatingResources</A></B>(long oldState,
446 long newState)</CODE>
\r
449 Utility function that generates an
450 <code>ENGINE_ALLOCATING_RESOURCES</code> event and
451 posts it to the event queue. </TD>
\r
453 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
454 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
455 <CODE>protected void</CODE></FONT></TD>
\r
456 <TD><CODE><B><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#postEngineDeallocated(long, long)">postEngineDeallocated</A></B>(long oldState,
457 long newState)</CODE>
\r
460 Utility function that generates an
461 <code>ENGINE_DEALLOCATED</code> event and posts it
462 to the event queue. </TD>
\r
464 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
465 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
466 <CODE>protected void</CODE></FONT></TD>
\r
467 <TD><CODE><B><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#postEngineDeallocatingResources(long, long)">postEngineDeallocatingResources</A></B>(long oldState,
468 long newState)</CODE>
\r
471 Utility function that generates
472 <code>ENGINE_DEALLOCATING_RESOURCES</code> event and
473 posts it to the event queue. </TD>
\r
475 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
476 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
477 <CODE>protected void</CODE></FONT></TD>
\r
478 <TD><CODE><B><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#postEnginePaused(long, long)">postEnginePaused</A></B>(long oldState,
479 long newState)</CODE>
\r
482 Utility function that generates an
483 <code>ENGINE_PAUSED</code> event and posts it
484 to the event queue. </TD>
\r
486 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
487 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
488 <CODE>protected void</CODE></FONT></TD>
\r
489 <TD><CODE><B><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#postEngineResumed(long, long)">postEngineResumed</A></B>(long oldState,
490 long newState)</CODE>
\r
493 Utility function that generates an <code>ENGINE_RESUMED</code>
494 event and posts it to the event queue. </TD>
\r
496 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
497 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
498 <CODE> void</CODE></FONT></TD>
\r
499 <TD><CODE><B><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#removeEngineListener(javax.speech.EngineListener)">removeEngineListener</A></B>(javax.speech.EngineListener listener)</CODE>
\r
502 Removes an <code>EngineListener</code> from the list of
503 <code>EngineListeners</code>.</TD>
\r
505 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
506 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
507 <CODE> void</CODE></FONT></TD>
\r
508 <TD><CODE><B><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#resume()">resume</A></B>()</CODE>
\r
511 Resumes the audio stream for this <code>Engine</code> and put
512 this <code>Engine</code> into the <code>RESUMED</code> state.</TD>
\r
514 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
515 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
516 <CODE>protected void</CODE></FONT></TD>
\r
517 <TD><CODE><B><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#setEngineModeDesc(javax.speech.EngineModeDesc)">setEngineModeDesc</A></B>(javax.speech.EngineModeDesc desc)</CODE>
\r
520 Sets the current operating properties and mode of
521 this <code>Engine</code>.</TD>
\r
523 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
524 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
525 <CODE>protected long[]</CODE></FONT></TD>
\r
526 <TD><CODE><B><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#setEngineState(long, long)">setEngineState</A></B>(long clear,
527 long set)</CODE>
\r
530 Updates this <code>Engine</code> state by clearing defined bits,
531 then setting other specified bits.</TD>
\r
533 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
534 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
535 <CODE>protected java.lang.String</CODE></FONT></TD>
\r
536 <TD><CODE><B><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#stateToString(long)">stateToString</A></B>(long state)</CODE>
\r
539 Returns a <code>String</code> of the names of all the
540 <code>Engine</code> states in the given <code>Engine</code>
543 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
544 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
545 <CODE> boolean</CODE></FONT></TD>
\r
546 <TD><CODE><B><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#testEngineState(long)">testEngineState</A></B>(long state)</CODE>
\r
549 Returns <code>true</code> if this state of this
550 <code>Engine</code> matches the specified state.
554 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
555 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
556 <CODE> java.lang.String</CODE></FONT></TD>
\r
557 <TD><CODE><B><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#toString()">toString</A></B>()</CODE>
\r
560 Returns the engine name and mode for debug purposes.</TD>
\r
562 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
563 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
564 <CODE> void</CODE></FONT></TD>
\r
565 <TD><CODE><B><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#waitEngineState(long)">waitEngineState</A></B>(long state)</CODE>
\r
568 Blocks the calling thread until this <code>Engine</code>
569 is in a specified state.
574 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
575 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
576 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
\r
577 <TD><B>Methods inherited from class java.lang.Object</B></TD>
\r
579 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
580 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
\r
586 <!-- ============ FIELD DETAIL =========== -->
\r
588 <A NAME="field_detail"><!-- --></A>
589 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
590 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
591 <TD COLSPAN=1><FONT SIZE="+2">
\r
592 <B>Field Detail</B></FONT></TD>
\r
596 <A NAME="engineState"><!-- --></A><H3>
\r
599 protected long <B>engineState</B></PRE>
\r
601 <DD>A bitmask holding the current state of this <code>Engine</code>.
\r
608 <A NAME="engineStateLock"><!-- --></A><H3>
\r
609 engineStateLock</H3>
\r
611 protected java.lang.Object <B>engineStateLock</B></PRE>
\r
613 <DD>An <code>Object</code> used for synchronizing access to
614 <code>engineState</code>.
\r
617 <DT><B>See Also:</B><DD><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#engineState"><CODE>engineState</CODE></A></DL>
\r
621 <A NAME="engineListeners"><!-- --></A><H3>
\r
622 engineListeners</H3>
\r
624 protected java.util.Collection <B>engineListeners</B></PRE>
\r
626 <DD>List of <code>EngineListeners</code> registered for
627 <code>EngineEvents</code> on this <code>Engine</code>.
\r
634 <A NAME="audioManager"><!-- --></A><H3>
\r
637 protected javax.speech.AudioManager <B>audioManager</B></PRE>
\r
639 <DD>The <code>AudioManager</code> for this <code>Engine</code>.
\r
646 <A NAME="engineModeDesc"><!-- --></A><H3>
\r
647 engineModeDesc</H3>
\r
649 protected javax.speech.EngineModeDesc <B>engineModeDesc</B></PRE>
\r
651 <DD>The <code>EngineModeDesc</code> for this <code>Engine</code>.
\r
658 <A NAME="engineProperties"><!-- --></A><H3>
\r
659 engineProperties</H3>
\r
661 protected javax.speech.EngineProperties <B>engineProperties</B></PRE>
\r
663 <DD>The <code>EngineProperties</code> for this <code>Engine</code>.
\r
670 <A NAME="CLEAR_ALL_STATE"><!-- --></A><H3>
\r
671 CLEAR_ALL_STATE</H3>
\r
673 protected static final long <B>CLEAR_ALL_STATE</B></PRE>
\r
675 <DD>Utility state for clearing the <code>engineState</code>.
\r
678 <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#com.sun.speech.engine.BaseEngine.CLEAR_ALL_STATE">Constant Field Values</A></DL>
\r
681 <!-- ========= CONSTRUCTOR DETAIL ======== -->
\r
683 <A NAME="constructor_detail"><!-- --></A>
684 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
685 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
686 <TD COLSPAN=1><FONT SIZE="+2">
\r
687 <B>Constructor Detail</B></FONT></TD>
\r
691 <A NAME="BaseEngine()"><!-- --></A><H3>
\r
694 public <B>BaseEngine</B>()</PRE>
\r
696 <DD>Creates a new <code>Engine</code> in the
697 <code>DEALLOCATED</code> state.
\r
702 <A NAME="BaseEngine(javax.speech.EngineModeDesc)"><!-- --></A><H3>
\r
705 public <B>BaseEngine</B>(javax.speech.EngineModeDesc desc)</PRE>
\r
707 <DD>Creates a new <code>Engine</code> in the
708 <code>DEALLOCATED</code> state.
\r
710 <DT><B>Parameters:</B><DD><CODE>desc</CODE> - the operating mode of this <code>Engine</code></DL>
\r
712 <!-- ============ METHOD DETAIL ========== -->
\r
714 <A NAME="method_detail"><!-- --></A>
715 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
716 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
717 <TD COLSPAN=1><FONT SIZE="+2">
\r
718 <B>Method Detail</B></FONT></TD>
\r
722 <A NAME="getEngineState()"><!-- --></A><H3>
\r
723 getEngineState</H3>
\r
725 public long <B>getEngineState</B>()</PRE>
\r
727 <DD>Returns a or'ed set of flags indicating the current state of
728 this <code>Engine</code>.
730 <p>An <code>EngineEvent</code> is issued each time this
731 <code>Engine</code> changes state.
733 <p>The <code>getEngineState</code> method can be called successfully
734 in any <code>Engine</code> state.
\r
737 <DT><B>Specified by:</B><DD><CODE>getEngineState</CODE> in interface <CODE>javax.speech.Engine</CODE></DL>
\r
741 <DT><B>Returns:</B><DD>the current state of this <code>Engine</code><DT><B>See Also:</B><DD><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#getEngineState()"><CODE>getEngineState()</CODE></A>,
742 <A HREF="../../../../com/sun/speech/engine/BaseEngine.html#waitEngineState(long)"><CODE>waitEngineState(long)</CODE></A></DL>
\r
747 <A NAME="waitEngineState(long)"><!-- --></A><H3>
\r
748 waitEngineState</H3>
\r
750 public void <B>waitEngineState</B>(long state)
751 throws java.lang.InterruptedException,
752 java.lang.IllegalArgumentException</PRE>
\r
754 <DD>Blocks the calling thread until this <code>Engine</code>
755 is in a specified state.
757 <p>All state bits specified in the <code>state</code> parameter
758 must be set in order for the method to return, as defined
759 for the <code>testEngineState</code> method. If the <code>state</code>
760 parameter defines an unreachable state
761 (e.g. <code>PAUSED | RESUMED</code>) an exception is thrown.
763 <p>The <code>waitEngineState</code> method can be called successfully
764 in any <code>Engine</code> state.
\r
767 <DT><B>Specified by:</B><DD><CODE>waitEngineState</CODE> in interface <CODE>javax.speech.Engine</CODE></DL>
\r
770 <DT><B>Parameters:</B><DD><CODE>state</CODE> - a bitmask of the state to wait for
772 <DD><CODE>java.lang.InterruptedException</CODE> - if another thread has interrupted this thread.
773 <DD><CODE>java.lang.IllegalArgumentException</CODE> - if the specified state is unreachable<DT><B>See Also:</B><DD><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#testEngineState(long)"><CODE>testEngineState(long)</CODE></A>,
774 <A HREF="../../../../com/sun/speech/engine/BaseEngine.html#getEngineState()"><CODE>getEngineState()</CODE></A></DL>
\r
779 <A NAME="testEngineState(long)"><!-- --></A><H3>
\r
780 testEngineState</H3>
\r
782 public boolean <B>testEngineState</B>(long state)
783 throws java.lang.IllegalArgumentException</PRE>
\r
785 <DD>Returns <code>true</code> if this state of this
786 <code>Engine</code> matches the specified state.
788 <p>The test performed is not an exact match to the current
789 state. Only the specified states are tested. For
790 example the following returns true only if the
791 <code>Synthesizer</code> queue is empty, irrespective
792 of the pause/resume and allocation states.
795 if (synth.testEngineState(Synthesizer.QUEUE_EMPTY)) ...
798 <p>The <code>testEngineState</code> method is equivalent to:
801 if ((engine.getEngineState() & state) == state)
804 <p>The <code>testEngineState</code> method can be called
805 successfully in any <code>Engine</code> state.
\r
808 <DT><B>Specified by:</B><DD><CODE>testEngineState</CODE> in interface <CODE>javax.speech.Engine</CODE></DL>
\r
811 <DT><B>Parameters:</B><DD><CODE>state</CODE> - a bitmask of the states to test for
812 <DT><B>Returns:</B><DD><code>true</code> if this <code>Engine</code> matches
813 <code>state</code>; otherwise <code>false</code>
815 <DD><CODE>java.lang.IllegalArgumentException</CODE> - if the specified state is unreachable</DL>
\r
820 <A NAME="setEngineState(long, long)"><!-- --></A><H3>
\r
821 setEngineState</H3>
\r
823 protected long[] <B>setEngineState</B>(long clear,
824 long set)</PRE>
\r
826 <DD>Updates this <code>Engine</code> state by clearing defined bits,
827 then setting other specified bits.
\r
834 <DT><B>Returns:</B><DD>a length-2 array with old and new state values.</DL>
\r
839 <A NAME="allocate()"><!-- --></A><H3>
\r
842 public void <B>allocate</B>()
843 throws javax.speech.EngineException,
844 javax.speech.EngineStateError</PRE>
\r
846 <DD>Allocates the resources required for this <code>Engine</code> and
847 puts it into the <code>ALLOCATED</code> state. When this method
848 returns successfully the <code>ALLOCATED</code> bit of this
849 <code>Engine</code> state is set, and the
850 <code>testEngineState(Engine.ALLOCATED)</code> method returns
853 <p>During the processing of the method, this <code>Engine</code> is
854 temporarily in the <code>ALLOCATING_RESOURCES</code> state.
\r
857 <DT><B>Specified by:</B><DD><CODE>allocate</CODE> in interface <CODE>javax.speech.Engine</CODE></DL>
\r
862 <DD><CODE>javax.speech.EngineException</CODE> - if this <code>Engine</code> cannot be allocated
863 <DD><CODE>javax.speech.EngineStateError</CODE> - if this <code>Engine</code> is in the
864 <code>DEALLOCATING_RESOURCES</code> state<DT><B>See Also:</B><DD><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#deallocate()"><CODE>deallocate()</CODE></A></DL>
\r
869 <A NAME="handleAllocate()"><!-- --></A><H3>
\r
870 handleAllocate</H3>
\r
872 protected abstract void <B>handleAllocate</B>()
873 throws javax.speech.EngineException</PRE>
\r
875 <DD>Called from the <code>allocate</code> method. Override this in
884 <DD><CODE>javax.speech.EngineException</CODE> - if problems are encountered<DT><B>See Also:</B><DD><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#allocate()"><CODE>allocate()</CODE></A></DL>
\r
889 <A NAME="deallocate()"><!-- --></A><H3>
\r
892 public void <B>deallocate</B>()
893 throws javax.speech.EngineException,
894 javax.speech.EngineStateError</PRE>
\r
896 <DD>Frees the resources of this <code>Engine</code> that were
897 acquired during allocation and during operation and return this
898 <code>Engine</code> to the <code>DEALLOCATED</code>. When this
899 method returns the <code>DEALLOCATED</code> bit of this
900 <code>Engine</code> state is set so the
901 <code>testEngineState(Engine.DEALLOCATED)</code> method returns
904 <p>During the processing of the method, this
905 <code>Engine</code> is temporarily in the
906 <code>DEALLOCATING_RESOURCES</code> state.
908 <p>A deallocated engine can be re-started with a subsequent
909 call to <code>allocate</code>.
\r
912 <DT><B>Specified by:</B><DD><CODE>deallocate</CODE> in interface <CODE>javax.speech.Engine</CODE></DL>
\r
917 <DD><CODE>javax.speech.EngineException</CODE> - if this <code>Engine</code> cannot be
919 <DD><CODE>javax.speech.EngineStateError</CODE> - if this <code>Engine</code> is in the
920 <code>ALLOCATING_RESOURCES</code> state<DT><B>See Also:</B><DD><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#allocate()"><CODE>allocate()</CODE></A></DL>
\r
925 <A NAME="handleDeallocate()"><!-- --></A><H3>
\r
926 handleDeallocate</H3>
\r
928 protected abstract void <B>handleDeallocate</B>()
929 throws javax.speech.EngineException</PRE>
\r
931 <DD>Called from the <code>deallocate</code> method. Override this in
940 <DD><CODE>javax.speech.EngineException</CODE> - if this <code>Engine</code> cannot be
946 <A NAME="pause()"><!-- --></A><H3>
\r
949 public void <B>pause</B>()
950 throws javax.speech.EngineStateError</PRE>
\r
952 <DD>Pauses the audio stream for this <code>Engine</code> and put
953 this <code>Engine</code> into the <code>PAUSED</code> state.
\r
956 <DT><B>Specified by:</B><DD><CODE>pause</CODE> in interface <CODE>javax.speech.Engine</CODE></DL>
\r
961 <DD><CODE>javax.speech.EngineStateError</CODE> - if this <code>Engine</code> is in the
962 <code>DEALLOCATING_RESOURCES</code> or
963 <code>DEALLOCATED</code> state.</DL>
\r
968 <A NAME="handlePause()"><!-- --></A><H3>
\r
971 protected abstract void <B>handlePause</B>()</PRE>
\r
973 <DD>Called from the <code>pause</code> method. Override this in subclasses.
\r
984 <A NAME="resume()"><!-- --></A><H3>
\r
987 public void <B>resume</B>()
988 throws javax.speech.AudioException,
989 javax.speech.EngineStateError</PRE>
\r
991 <DD>Resumes the audio stream for this <code>Engine</code> and put
992 this <code>Engine</code> into the <code>RESUMED</code> state.
\r
995 <DT><B>Specified by:</B><DD><CODE>resume</CODE> in interface <CODE>javax.speech.Engine</CODE></DL>
\r
1000 <DD><CODE>javax.speech.AudioException</CODE> - if unable to gain access to the audio channel
1001 <DD><CODE>javax.speech.EngineStateError</CODE> - if this <code>Engine</code> is in the
1002 <code>DEALLOCATING_RESOURCES</code> or
1003 <code>DEALLOCATED</code> state</DL>
\r
1008 <A NAME="handleResume()"><!-- --></A><H3>
\r
1011 protected abstract void <B>handleResume</B>()</PRE>
\r
1013 <DD>Called from the <code>resume</code> method. Override in subclasses.
\r
1024 <A NAME="getAudioManager()"><!-- --></A><H3>
\r
1025 getAudioManager</H3>
\r
1027 public javax.speech.AudioManager <B>getAudioManager</B>()</PRE>
\r
1029 <DD>Returns an object that provides management of the audio input
1030 or output of this <code>Engine</code>.
\r
1033 <DT><B>Specified by:</B><DD><CODE>getAudioManager</CODE> in interface <CODE>javax.speech.Engine</CODE></DL>
\r
1037 <DT><B>Returns:</B><DD>the audio manader for this <code>Engine</code></DL>
\r
1042 <A NAME="getVocabManager()"><!-- --></A><H3>
\r
1043 getVocabManager</H3>
\r
1045 public javax.speech.VocabManager <B>getVocabManager</B>()
1046 throws javax.speech.EngineStateError</PRE>
\r
1048 <DD>Returns an object that provides management of the vocabulary for
1049 this <code>Engine</code>. Returns <code>null</code> if this
1050 <code>Engine</code> does not support vocabulary management.
\r
1053 <DT><B>Specified by:</B><DD><CODE>getVocabManager</CODE> in interface <CODE>javax.speech.Engine</CODE></DL>
\r
1057 <DT><B>Returns:</B><DD>the vocabulary manager of this <code>Engine</code>
1059 <DD><CODE>javax.speech.EngineStateError</CODE> - if this <code>Engine</code> in the
1060 <code>DEALLOCATING_RESOURCES</code> or
1061 <code>DEALLOCATED</code> state</DL>
\r
1066 <A NAME="getEngineProperties()"><!-- --></A><H3>
\r
1067 getEngineProperties</H3>
\r
1069 public javax.speech.EngineProperties <B>getEngineProperties</B>()</PRE>
\r
1071 <DD>Gets the <code>EngineProperties</code> of this <code>Engine</code>.
1072 Must be set in subclasses.
\r
1075 <DT><B>Specified by:</B><DD><CODE>getEngineProperties</CODE> in interface <CODE>javax.speech.Engine</CODE></DL>
\r
1079 <DT><B>Returns:</B><DD>the <code>EngineProperties</code> of this <code>Engine</code>.</DL>
\r
1084 <A NAME="getEngineModeDesc()"><!-- --></A><H3>
\r
1085 getEngineModeDesc</H3>
\r
1087 public javax.speech.EngineModeDesc <B>getEngineModeDesc</B>()
1088 throws java.lang.SecurityException</PRE>
\r
1090 <DD>Gets the current operating properties and mode of
1091 this <code>Engine</code>.
\r
1094 <DT><B>Specified by:</B><DD><CODE>getEngineModeDesc</CODE> in interface <CODE>javax.speech.Engine</CODE></DL>
\r
1098 <DT><B>Returns:</B><DD>the operating mode of this <code>Engine</code>
1100 <DD><CODE>java.lang.SecurityException</CODE></DL>
\r
1105 <A NAME="setEngineModeDesc(javax.speech.EngineModeDesc)"><!-- --></A><H3>
\r
1106 setEngineModeDesc</H3>
\r
1108 protected void <B>setEngineModeDesc</B>(javax.speech.EngineModeDesc desc)</PRE>
\r
1110 <DD>Sets the current operating properties and mode of
1111 this <code>Engine</code>.
\r
1117 <DT><B>Parameters:</B><DD><CODE>desc</CODE> - the new operating mode of this <code>Engine</code></DL>
\r
1122 <A NAME="addEngineListener(javax.speech.EngineListener)"><!-- --></A><H3>
\r
1123 addEngineListener</H3>
\r
1125 public void <B>addEngineListener</B>(javax.speech.EngineListener listener)</PRE>
\r
1127 <DD>Requests notification of <code>EngineEvents</code> from this
1128 <code>Engine</code>.
\r
1131 <DT><B>Specified by:</B><DD><CODE>addEngineListener</CODE> in interface <CODE>javax.speech.Engine</CODE></DL>
\r
1134 <DT><B>Parameters:</B><DD><CODE>listener</CODE> - the listener to add.</DL>
\r
1139 <A NAME="removeEngineListener(javax.speech.EngineListener)"><!-- --></A><H3>
\r
1140 removeEngineListener</H3>
\r
1142 public void <B>removeEngineListener</B>(javax.speech.EngineListener listener)</PRE>
\r
1144 <DD>Removes an <code>EngineListener</code> from the list of
1145 <code>EngineListeners</code>.
\r
1148 <DT><B>Specified by:</B><DD><CODE>removeEngineListener</CODE> in interface <CODE>javax.speech.Engine</CODE></DL>
\r
1151 <DT><B>Parameters:</B><DD><CODE>listener</CODE> - the listener to remove.</DL>
\r
1156 <A NAME="postEngineAllocated(long, long)"><!-- --></A><H3>
\r
1157 postEngineAllocated</H3>
\r
1159 protected void <B>postEngineAllocated</B>(long oldState,
1160 long newState)</PRE>
\r
1162 <DD>Utility function that generates an
1163 <code>ENGINE_ALLOCATED</code> event and posts it
1164 to the event queue. Eventually
1165 <code>fireEngineAllocated</code> will be called
1166 by the <code>dispatchSpeechEvent</code> as a result of this
1173 <DT><B>Parameters:</B><DD><CODE>oldState</CODE> - the old state of this <code>Engine</code><DD><CODE>newState</CODE> - the new state of this <code>Engine</code><DT><B>See Also:</B><DD><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#fireEngineAllocated(javax.speech.EngineEvent)"><CODE>fireEngineAllocated(javax.speech.EngineEvent)</CODE></A>,
1174 <A HREF="../../../../com/sun/speech/engine/BaseEngine.html#dispatchSpeechEvent(javax.speech.SpeechEvent)"><CODE>dispatchSpeechEvent(javax.speech.SpeechEvent)</CODE></A></DL>
\r
1179 <A NAME="fireEngineAllocated(javax.speech.EngineEvent)"><!-- --></A><H3>
\r
1180 fireEngineAllocated</H3>
\r
1182 public void <B>fireEngineAllocated</B>(javax.speech.EngineEvent event)</PRE>
\r
1184 <DD>Utility function that sends an <code>ENGINE_ALLOCATED</code>
1185 event to all <code>EngineListeners</code> registered with this
1186 <code>Engine</code>. Called by <code>dispatchSpeechEvent</code>.
\r
1192 <DT><B>Parameters:</B><DD><CODE>event</CODE> - the <code>ENGINE_ALLOCATED</code> event<DT><B>See Also:</B><DD><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#postEngineAllocated(long, long)"><CODE>postEngineAllocated(long, long)</CODE></A>,
1193 <A HREF="../../../../com/sun/speech/engine/BaseEngine.html#dispatchSpeechEvent(javax.speech.SpeechEvent)"><CODE>dispatchSpeechEvent(javax.speech.SpeechEvent)</CODE></A></DL>
\r
1198 <A NAME="postEngineAllocatingResources(long, long)"><!-- --></A><H3>
\r
1199 postEngineAllocatingResources</H3>
\r
1201 protected void <B>postEngineAllocatingResources</B>(long oldState,
1202 long newState)</PRE>
\r
1204 <DD>Utility function that generates an
1205 <code>ENGINE_ALLOCATING_RESOURCES</code> event and
1206 posts it to the event queue. Eventually
1207 <code>fireEngineAllocatingResources</code>
1208 will be called by <code>dispatchSpeechEvent</code> as a
1209 result of this action.
\r
1215 <DT><B>Parameters:</B><DD><CODE>oldState</CODE> - the old state of this <code>Engine</code><DD><CODE>newState</CODE> - the new state of this <code>Engine</code><DT><B>See Also:</B><DD><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#fireEngineAllocatingResources(javax.speech.EngineEvent)"><CODE>fireEngineAllocatingResources(javax.speech.EngineEvent)</CODE></A>,
1216 <A HREF="../../../../com/sun/speech/engine/BaseEngine.html#dispatchSpeechEvent(javax.speech.SpeechEvent)"><CODE>dispatchSpeechEvent(javax.speech.SpeechEvent)</CODE></A></DL>
\r
1221 <A NAME="fireEngineAllocatingResources(javax.speech.EngineEvent)"><!-- --></A><H3>
\r
1222 fireEngineAllocatingResources</H3>
\r
1224 public void <B>fireEngineAllocatingResources</B>(javax.speech.EngineEvent event)</PRE>
\r
1226 <DD>Utility function that sends an
1227 <code>ENGINE_ALLOCATING_RESOURCES</code> event to all
1228 <code>EngineListeners</code> registered with this
1229 <code>Engine</code>. Called by <code>dispatchSpeechEvent</code>.
\r
1235 <DT><B>Parameters:</B><DD><CODE>event</CODE> - the <code>ENGINE_ALLOCATING_RESOURCES</code> event<DT><B>See Also:</B><DD><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#postEngineAllocatingResources(long, long)"><CODE>postEngineAllocatingResources(long, long)</CODE></A>,
1236 <A HREF="../../../../com/sun/speech/engine/BaseEngine.html#dispatchSpeechEvent(javax.speech.SpeechEvent)"><CODE>dispatchSpeechEvent(javax.speech.SpeechEvent)</CODE></A></DL>
\r
1241 <A NAME="postEngineDeallocated(long, long)"><!-- --></A><H3>
\r
1242 postEngineDeallocated</H3>
\r
1244 protected void <B>postEngineDeallocated</B>(long oldState,
1245 long newState)</PRE>
\r
1247 <DD>Utility function that generates an
1248 <code>ENGINE_DEALLOCATED</code> event and posts it
1249 to the event queue. Eventually
1250 <code>fireEngineDeallocated</code> will be called
1251 by <code>dispatchSpeechEvent</code> as a result of this action.
\r
1257 <DT><B>Parameters:</B><DD><CODE>oldState</CODE> - the old state of this <code>Engine</code><DD><CODE>newState</CODE> - the new state of this <code>Engine</code><DT><B>See Also:</B><DD><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#fireEngineDeallocated(javax.speech.EngineEvent)"><CODE>fireEngineDeallocated(javax.speech.EngineEvent)</CODE></A>,
1258 <A HREF="../../../../com/sun/speech/engine/BaseEngine.html#dispatchSpeechEvent(javax.speech.SpeechEvent)"><CODE>dispatchSpeechEvent(javax.speech.SpeechEvent)</CODE></A></DL>
\r
1263 <A NAME="fireEngineDeallocated(javax.speech.EngineEvent)"><!-- --></A><H3>
\r
1264 fireEngineDeallocated</H3>
\r
1266 public void <B>fireEngineDeallocated</B>(javax.speech.EngineEvent event)</PRE>
\r
1268 <DD>Utility function that sends an
1269 <code>ENGINE_DEALLOCATED</code> event to all
1270 <code>EngineListeners</code> registered with this
1271 <code>Engine</code>. Called by <code>dispatchSpeechEvent</code>.
\r
1277 <DT><B>Parameters:</B><DD><CODE>event</CODE> - the <code>ENGINE_DEALLOCATED</code> event<DT><B>See Also:</B><DD><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#postEngineDeallocated(long, long)"><CODE>postEngineDeallocated(long, long)</CODE></A>,
1278 <A HREF="../../../../com/sun/speech/engine/BaseEngine.html#dispatchSpeechEvent(javax.speech.SpeechEvent)"><CODE>dispatchSpeechEvent(javax.speech.SpeechEvent)</CODE></A></DL>
\r
1283 <A NAME="postEngineDeallocatingResources(long, long)"><!-- --></A><H3>
\r
1284 postEngineDeallocatingResources</H3>
\r
1286 protected void <B>postEngineDeallocatingResources</B>(long oldState,
1287 long newState)</PRE>
\r
1289 <DD>Utility function that generates
1290 <code>ENGINE_DEALLOCATING_RESOURCES</code> event and
1291 posts it to the event queue. Eventually
1292 <code>fireEngineAllocatingResources</code> will be called
1293 by <code>dispatchSpeechEvent</code> as a result of this action.
\r
1299 <DT><B>Parameters:</B><DD><CODE>oldState</CODE> - the old state of this <code>Engine</code><DD><CODE>newState</CODE> - the new state of this <code>Engine</code><DT><B>See Also:</B><DD><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#fireEngineDeallocatingResources(javax.speech.EngineEvent)"><CODE>fireEngineDeallocatingResources(javax.speech.EngineEvent)</CODE></A>,
1300 <A HREF="../../../../com/sun/speech/engine/BaseEngine.html#dispatchSpeechEvent(javax.speech.SpeechEvent)"><CODE>dispatchSpeechEvent(javax.speech.SpeechEvent)</CODE></A></DL>
\r
1305 <A NAME="fireEngineDeallocatingResources(javax.speech.EngineEvent)"><!-- --></A><H3>
\r
1306 fireEngineDeallocatingResources</H3>
\r
1308 public void <B>fireEngineDeallocatingResources</B>(javax.speech.EngineEvent event)</PRE>
\r
1310 <DD>Utility function that sends a
1311 <code>ENGINE_DEALLOCATING_RESOURCES</code> event to all
1312 <code>EngineListeners</code> registered with this
1313 <code>Engine</code>. Called by <code>dispatchSpeechEvent</code>.
\r
1319 <DT><B>Parameters:</B><DD><CODE>event</CODE> - the <code>ENGINE_DEALLOCATING_RESOURCES</code> event<DT><B>See Also:</B><DD><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#postEngineDeallocatingResources(long, long)"><CODE>postEngineDeallocatingResources(long, long)</CODE></A>,
1320 <A HREF="../../../../com/sun/speech/engine/BaseEngine.html#dispatchSpeechEvent(javax.speech.SpeechEvent)"><CODE>dispatchSpeechEvent(javax.speech.SpeechEvent)</CODE></A></DL>
\r
1325 <A NAME="postEnginePaused(long, long)"><!-- --></A><H3>
\r
1326 postEnginePaused</H3>
\r
1328 protected void <B>postEnginePaused</B>(long oldState,
1329 long newState)</PRE>
\r
1331 <DD>Utility function that generates an
1332 <code>ENGINE_PAUSED</code> event and posts it
1333 to the event queue. Eventually
1334 <code>fireEnginePaused</code> will be called
1335 by <code>dispatchSpeechEvent</code> as a result of this action.
\r
1341 <DT><B>Parameters:</B><DD><CODE>oldState</CODE> - the old state of this <code>Engine</code><DD><CODE>newState</CODE> - the new state of this <code>Engine</code><DT><B>See Also:</B><DD><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#fireEnginePaused(javax.speech.EngineEvent)"><CODE>fireEnginePaused(javax.speech.EngineEvent)</CODE></A>,
1342 <A HREF="../../../../com/sun/speech/engine/BaseEngine.html#dispatchSpeechEvent(javax.speech.SpeechEvent)"><CODE>dispatchSpeechEvent(javax.speech.SpeechEvent)</CODE></A></DL>
\r
1347 <A NAME="fireEnginePaused(javax.speech.EngineEvent)"><!-- --></A><H3>
\r
1348 fireEnginePaused</H3>
\r
1350 public void <B>fireEnginePaused</B>(javax.speech.EngineEvent event)</PRE>
\r
1352 <DD>Utility function that sends an <code>ENGINE_PAUSED</code> event
1354 <code>EngineListeners</code> registered with this
1355 <code>Engine</code>. Called by <code>dispatchSpeechEvent</code>.
\r
1361 <DT><B>Parameters:</B><DD><CODE>event</CODE> - the <code>ENGINE_PAUSED</code> event<DT><B>See Also:</B><DD><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#postEnginePaused(long, long)"><CODE>postEnginePaused(long, long)</CODE></A>,
1362 <A HREF="../../../../com/sun/speech/engine/BaseEngine.html#dispatchSpeechEvent(javax.speech.SpeechEvent)"><CODE>dispatchSpeechEvent(javax.speech.SpeechEvent)</CODE></A></DL>
\r
1367 <A NAME="postEngineResumed(long, long)"><!-- --></A><H3>
\r
1368 postEngineResumed</H3>
\r
1370 protected void <B>postEngineResumed</B>(long oldState,
1371 long newState)</PRE>
\r
1373 <DD>Utility function that generates an <code>ENGINE_RESUMED</code>
1374 event and posts it to the event queue. Eventually
1375 <code>fireEngineResumed</code> will be called
1376 by <code>dispatchSpeechEvent</code> as a result of this action.
\r
1382 <DT><B>Parameters:</B><DD><CODE>oldState</CODE> - the old state of this <code>Engine</code><DD><CODE>newState</CODE> - the new state of this <code>Engine</code><DT><B>See Also:</B><DD><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#fireEngineResumed(javax.speech.EngineEvent)"><CODE>fireEngineResumed(javax.speech.EngineEvent)</CODE></A>,
1383 <A HREF="../../../../com/sun/speech/engine/BaseEngine.html#dispatchSpeechEvent(javax.speech.SpeechEvent)"><CODE>dispatchSpeechEvent(javax.speech.SpeechEvent)</CODE></A></DL>
\r
1388 <A NAME="fireEngineResumed(javax.speech.EngineEvent)"><!-- --></A><H3>
\r
1389 fireEngineResumed</H3>
\r
1391 public void <B>fireEngineResumed</B>(javax.speech.EngineEvent event)</PRE>
\r
1393 <DD>Utility function that sends an <code>ENGINE_RESUMED</code> event
1395 <code>EngineListeners</code> registered with this
1396 <code>Engine</code>. Called by <code>dispatchSpeechEvent</code>.
\r
1402 <DT><B>Parameters:</B><DD><CODE>event</CODE> - the <code>ENGINE_RESUMED</code> event<DT><B>See Also:</B><DD><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#postEngineResumed(long, long)"><CODE>postEngineResumed(long, long)</CODE></A>,
1403 <A HREF="../../../../com/sun/speech/engine/BaseEngine.html#dispatchSpeechEvent(javax.speech.SpeechEvent)"><CODE>dispatchSpeechEvent(javax.speech.SpeechEvent)</CODE></A></DL>
\r
1408 <A NAME="createEngineProperties()"><!-- --></A><H3>
\r
1409 createEngineProperties</H3>
\r
1411 protected abstract <A HREF="../../../../com/sun/speech/engine/BaseEngineProperties.html" title="class in com.sun.speech.engine">BaseEngineProperties</A> <B>createEngineProperties</B>()</PRE>
\r
1413 <DD>Factory constructor for EngineProperties object.
\r
1420 <DT><B>Returns:</B><DD>a <code>BaseEngineProperties</code> object specific to
1426 <A NAME="checkEngineState(long)"><!-- --></A><H3>
\r
1427 checkEngineState</H3>
\r
1429 protected void <B>checkEngineState</B>(long state)
1430 throws javax.speech.EngineStateError</PRE>
\r
1432 <DD>Convenience method that throws an <code>EngineStateError</code>
1433 if any of the bits in the passed state are set in the
1434 <code>state</code>.
\r
1440 <DT><B>Parameters:</B><DD><CODE>state</CODE> - the <code>Engine</code> state to check
1442 <DD><CODE>javax.speech.EngineStateError</CODE> - if any of the bits in the passed state
1443 are set in the <code>state</code></DL>
\r
1448 <A NAME="stateToString(long)"><!-- --></A><H3>
\r
1449 stateToString</H3>
\r
1451 protected java.lang.String <B>stateToString</B>(long state)</PRE>
\r
1453 <DD>Returns a <code>String</code> of the names of all the
1454 <code>Engine</code> states in the given <code>Engine</code>
1461 <DT><B>Parameters:</B><DD><CODE>state</CODE> - the bitmask of states
1462 <DT><B>Returns:</B><DD>a <code>String</code> containing the names of all the
1463 states set in <code>state</code></DL>
\r
1468 <A NAME="dispatchSpeechEvent(javax.speech.SpeechEvent)"><!-- --></A><H3>
\r
1469 dispatchSpeechEvent</H3>
\r
1471 public void <B>dispatchSpeechEvent</B>(javax.speech.SpeechEvent event)</PRE>
\r
1473 <DD>Dispatches a <code>SpeechEvent</code>.
1474 The dispatcher should notify all <code>EngineListeners</code>
1475 from this method. The <code>SpeechEvent</code> was added
1476 via the various post methods of this class.
\r
1479 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/sun/speech/engine/SpeechEventDispatcher.html#dispatchSpeechEvent(javax.speech.SpeechEvent)">dispatchSpeechEvent</A></CODE> in interface <CODE><A HREF="../../../../com/sun/speech/engine/SpeechEventDispatcher.html" title="interface in com.sun.speech.engine">SpeechEventDispatcher</A></CODE></DL>
\r
1482 <DT><B>Parameters:</B><DD><CODE>event</CODE> - the <code>SpeechEvent</code> to dispatch<DT><B>See Also:</B><DD><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#postEngineAllocatingResources(long, long)"><CODE>postEngineAllocatingResources(long, long)</CODE></A>,
1483 <A HREF="../../../../com/sun/speech/engine/BaseEngine.html#postEngineAllocated(long, long)"><CODE>postEngineAllocated(long, long)</CODE></A>,
1484 <A HREF="../../../../com/sun/speech/engine/BaseEngine.html#postEngineDeallocatingResources(long, long)"><CODE>postEngineDeallocatingResources(long, long)</CODE></A>,
1485 <A HREF="../../../../com/sun/speech/engine/BaseEngine.html#postEngineDeallocated(long, long)"><CODE>postEngineDeallocated(long, long)</CODE></A>,
1486 <A HREF="../../../../com/sun/speech/engine/BaseEngine.html#postEnginePaused(long, long)"><CODE>postEnginePaused(long, long)</CODE></A>,
1487 <A HREF="../../../../com/sun/speech/engine/BaseEngine.html#postEngineResumed(long, long)"><CODE>postEngineResumed(long, long)</CODE></A></DL>
\r
1492 <A NAME="toString()"><!-- --></A><H3>
\r
1495 public java.lang.String <B>toString</B>()</PRE>
\r
1497 <DD>Returns the engine name and mode for debug purposes.
\r
1504 <DT><B>Returns:</B><DD>the engine name and mode.</DL>
\r
1507 <!-- ========= END OF CLASS DATA ========= -->
\r
1511 <!-- ======= START OF BOTTOM NAVBAR ====== -->
\r
1512 <A NAME="navbar_bottom"><!-- --></A>
1513 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
1514 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
\r
1516 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
\r
1517 <A NAME="navbar_bottom_firstrow"><!-- --></A>
1518 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
\r
1519 <TR ALIGN="center" VALIGN="top">
\r
1520 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
\r
1521 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
1522 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
1523 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
1524 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
1525 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
1526 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
1530 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
1536 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
1537 <A HREF="../../../../com/sun/speech/engine/BaseAudioManager.html" title="class in com.sun.speech.engine"><B>PREV CLASS</B></A>
\r
1538 <A HREF="../../../../com/sun/speech/engine/BaseEngineProperties.html" title="class in com.sun.speech.engine"><B>NEXT CLASS</B></A></FONT></TD>
\r
1539 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
1540 <A HREF="../../../../index.html" target="_top"><B>FRAMES</B></A>
\r
1541 <A HREF="BaseEngine.html" target="_top"><B>NO FRAMES</B></A>
\r
1542 <SCRIPT type="text/javascript">
\r
1545 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
1550 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
\r
1556 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
1557 SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
1558 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
1559 DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
1562 <A NAME="skip-navbar_bottom"></A>
1563 <!-- ======== END OF BOTTOM NAVBAR ======= -->
\r