upstream version 1.2.2
[debian/freetts] / javadoc / com / sun / speech / engine / BaseEngine.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">\r
2 <!--NewPage-->\r
3 <HTML>\r
4 <HEAD>\r
5 <!-- Generated by javadoc (build 1.4.2_16) on Mon Mar 09 18:20:28 CET 2009 -->\r
6 <TITLE>\r
7 BaseEngine (FreeTTS 1.2)\r
8 </TITLE>\r
9 \r
10 <META NAME="keywords" CONTENT="com.sun.speech.engine.BaseEngine class">\r
11 \r
12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">\r
13 \r
14 <SCRIPT type="text/javascript">\r
15 function windowTitle()\r
16 {\r
17     parent.document.title="BaseEngine (FreeTTS 1.2)";\r
18 }\r
19 </SCRIPT>\r
20 \r
21 </HEAD>\r
22 \r
23 <BODY BGCOLOR="white" onload="windowTitle();">\r
24 \r
25
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
30 <TR>\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>&nbsp;</TD>\r
36   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
37   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
38   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
39   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
40   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
41   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
42   </TR>\r
43 </TABLE>\r
44 </TD>\r
45 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
46 </EM>\r
47 </TD>\r
48 </TR>\r
49 \r
50 <TR>\r
51 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
52 &nbsp;<A HREF="../../../../com/sun/speech/engine/BaseAudioManager.html" title="class in com.sun.speech.engine"><B>PREV CLASS</B></A>&nbsp;\r
53 &nbsp;<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>  &nbsp;\r
56 &nbsp;<A HREF="BaseEngine.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
57 &nbsp;<SCRIPT type="text/javascript">\r
58   <!--\r
59   if(window==top) {\r
60     document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
61   }\r
62   //-->\r
63 </SCRIPT>\r
64 <NOSCRIPT>\r
65   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>\r
66 </NOSCRIPT>
67 \r
68 </FONT></TD>\r
69 </TR>\r
70 <TR>\r
71 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
72   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
73 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
74 DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
75 </TR>\r
76 </TABLE>\r
77 <A NAME="skip-navbar_top"></A>
78 <!-- ========= END OF TOP NAVBAR ========= -->\r
79 \r
80 <HR>\r
81 <!-- ======== START OF CLASS DATA ======== -->\r
82 <H2>\r
83 <FONT SIZE="-1">\r
84 com.sun.speech.engine</FONT>\r
85 <BR>\r
86 Class BaseEngine</H2>\r
87 <PRE>\r
88 java.lang.Object\r
89   <IMG SRC="../../../../resources/inherit.gif" ALT="extended by"><B>com.sun.speech.engine.BaseEngine</B>\r
90 </PRE>\r
91 <DL>\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
93 </DL>\r
94 <DL>\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
96 </DL>\r
97 <HR>\r
98 <DL>\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
100 \r
101 <P>\r
102 Supports the JSAPI 1.0 <code>Engine</code> interface.
103  Actual JSAPI implementations might want to extend or modify this
104  implementation.\r
105 <P>\r
106 \r
107 <P>\r
108 <HR>\r
109 \r
110 <P>\r
111 <!-- ======== NESTED CLASS SUMMARY ======== -->\r
112 \r
113 \r
114 <!-- =========== FIELD SUMMARY =========== -->\r
115 \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
121 </TR>\r
122 <TR BGCOLOR="white" CLASS="TableRowColor">\r
123 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
124 <CODE>protected &nbsp;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
126 \r
127 <BR>\r
128 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The <code>AudioManager</code> for this <code>Engine</code>.</TD>\r
129 </TR>\r
130 <TR BGCOLOR="white" CLASS="TableRowColor">\r
131 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
132 <CODE>protected static&nbsp;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
134 \r
135 <BR>\r
136 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Utility state for clearing the <code>engineState</code>.</TD>\r
137 </TR>\r
138 <TR BGCOLOR="white" CLASS="TableRowColor">\r
139 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
140 <CODE>protected &nbsp;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
142 \r
143 <BR>\r
144 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;List of <code>EngineListeners</code> registered for
145  <code>EngineEvents</code> on this <code>Engine</code>.</TD>\r
146 </TR>\r
147 <TR BGCOLOR="white" CLASS="TableRowColor">\r
148 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
149 <CODE>protected &nbsp;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
151 \r
152 <BR>\r
153 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The <code>EngineModeDesc</code> for this <code>Engine</code>.</TD>\r
154 </TR>\r
155 <TR BGCOLOR="white" CLASS="TableRowColor">\r
156 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
157 <CODE>protected &nbsp;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
159 \r
160 <BR>\r
161 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The <code>EngineProperties</code> for this <code>Engine</code>.</TD>\r
162 </TR>\r
163 <TR BGCOLOR="white" CLASS="TableRowColor">\r
164 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
165 <CODE>protected &nbsp;long</CODE></FONT></TD>\r
166 <TD><CODE><B><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#engineState">engineState</A></B></CODE>\r
167 \r
168 <BR>\r
169 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A bitmask holding the current state of this <code>Engine</code>.</TD>\r
170 </TR>\r
171 <TR BGCOLOR="white" CLASS="TableRowColor">\r
172 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
173 <CODE>protected &nbsp;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
175 \r
176 <BR>\r
177 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;An <code>Object</code> used for synchronizing access to
178  <code>engineState</code>.</TD>\r
179 </TR>\r
180 </TABLE>\r
181 &nbsp;<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
185 </TR>\r
186 <TR BGCOLOR="white" CLASS="TableRowColor">\r
187 <TD><CODE>ALLOCATED, ALLOCATING_RESOURCES, DEALLOCATED, DEALLOCATING_RESOURCES, PAUSED, RESUMED</CODE></TD>\r
188 </TR>\r
189 </TABLE>\r
190 &nbsp;\r
191 <!-- ======== CONSTRUCTOR SUMMARY ======== -->\r
192 \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
198 </TR>\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
201 \r
202 <BR>\r
203 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a new <code>Engine</code> in the
204  <code>DEALLOCATED</code> state.</TD>\r
205 </TR>\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&nbsp;desc)</CODE>\r
208 \r
209 <BR>\r
210 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a new <code>Engine</code> in the
211  <code>DEALLOCATED</code> state.</TD>\r
212 </TR>\r
213 </TABLE>\r
214 &nbsp;\r
215 <!-- ========== METHOD SUMMARY =========== -->\r
216 \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
222 </TR>\r
223 <TR BGCOLOR="white" CLASS="TableRowColor">\r
224 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
225 <CODE>&nbsp;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&nbsp;listener)</CODE>\r
227 \r
228 <BR>\r
229 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Requests notification of <code>EngineEvents</code> from this
230  <code>Engine</code>.</TD>\r
231 </TR>\r
232 <TR BGCOLOR="white" CLASS="TableRowColor">\r
233 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
234 <CODE>&nbsp;void</CODE></FONT></TD>\r
235 <TD><CODE><B><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#allocate()">allocate</A></B>()</CODE>\r
236 \r
237 <BR>\r
238 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Allocates the resources required for this <code>Engine</code> and
239  puts it into the <code>ALLOCATED</code> state.  </TD>\r
240 </TR>\r
241 <TR BGCOLOR="white" CLASS="TableRowColor">\r
242 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
243 <CODE>protected &nbsp;void</CODE></FONT></TD>\r
244 <TD><CODE><B><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#checkEngineState(long)">checkEngineState</A></B>(long&nbsp;state)</CODE>\r
245 \r
246 <BR>\r
247 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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
250 </TR>\r
251 <TR BGCOLOR="white" CLASS="TableRowColor">\r
252 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
253 <CODE>protected abstract &nbsp;<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
255 \r
256 <BR>\r
257 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Factory constructor for EngineProperties object.</TD>\r
258 </TR>\r
259 <TR BGCOLOR="white" CLASS="TableRowColor">\r
260 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
261 <CODE>&nbsp;void</CODE></FONT></TD>\r
262 <TD><CODE><B><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#deallocate()">deallocate</A></B>()</CODE>\r
263 \r
264 <BR>\r
265 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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
268 </TR>\r
269 <TR BGCOLOR="white" CLASS="TableRowColor">\r
270 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
271 <CODE>&nbsp;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&nbsp;event)</CODE>\r
273 \r
274 <BR>\r
275 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Dispatches a <code>SpeechEvent</code>.
276  </TD>\r
277 </TR>\r
278 <TR BGCOLOR="white" CLASS="TableRowColor">\r
279 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
280 <CODE>&nbsp;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&nbsp;event)</CODE>\r
282 \r
283 <BR>\r
284 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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
287 </TR>\r
288 <TR BGCOLOR="white" CLASS="TableRowColor">\r
289 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
290 <CODE>&nbsp;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&nbsp;event)</CODE>\r
292 \r
293 <BR>\r
294 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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
298 </TR>\r
299 <TR BGCOLOR="white" CLASS="TableRowColor">\r
300 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
301 <CODE>&nbsp;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&nbsp;event)</CODE>\r
303 \r
304 <BR>\r
305 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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
309 </TR>\r
310 <TR BGCOLOR="white" CLASS="TableRowColor">\r
311 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
312 <CODE>&nbsp;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&nbsp;event)</CODE>\r
314 \r
315 <BR>\r
316 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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
320 </TR>\r
321 <TR BGCOLOR="white" CLASS="TableRowColor">\r
322 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
323 <CODE>&nbsp;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&nbsp;event)</CODE>\r
325 \r
326 <BR>\r
327 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Utility function that sends an <code>ENGINE_PAUSED</code> event
328  to all
329  <code>EngineListeners</code> registered with this
330  <code>Engine</code>.  </TD>\r
331 </TR>\r
332 <TR BGCOLOR="white" CLASS="TableRowColor">\r
333 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
334 <CODE>&nbsp;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&nbsp;event)</CODE>\r
336 \r
337 <BR>\r
338 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Utility function that sends an <code>ENGINE_RESUMED</code> event
339  to all
340  <code>EngineListeners</code> registered with this
341  <code>Engine</code>.  </TD>\r
342 </TR>\r
343 <TR BGCOLOR="white" CLASS="TableRowColor">\r
344 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
345 <CODE>&nbsp;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
347 \r
348 <BR>\r
349 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an object that provides management of the audio input
350  or output of this <code>Engine</code>.</TD>\r
351 </TR>\r
352 <TR BGCOLOR="white" CLASS="TableRowColor">\r
353 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
354 <CODE>&nbsp;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
356 \r
357 <BR>\r
358 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the current operating properties and mode of
359  this <code>Engine</code>.</TD>\r
360 </TR>\r
361 <TR BGCOLOR="white" CLASS="TableRowColor">\r
362 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
363 <CODE>&nbsp;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
365 \r
366 <BR>\r
367 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the <code>EngineProperties</code> of this <code>Engine</code>.
368  </TD>\r
369 </TR>\r
370 <TR BGCOLOR="white" CLASS="TableRowColor">\r
371 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
372 <CODE>&nbsp;long</CODE></FONT></TD>\r
373 <TD><CODE><B><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#getEngineState()">getEngineState</A></B>()</CODE>\r
374 \r
375 <BR>\r
376 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a or'ed set of flags indicating the current state of
377  this <code>Engine</code>.
378
379  </TD>\r
380 </TR>\r
381 <TR BGCOLOR="white" CLASS="TableRowColor">\r
382 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
383 <CODE>&nbsp;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
385 \r
386 <BR>\r
387 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an object that provides management of the vocabulary for
388  this <code>Engine</code>.  </TD>\r
389 </TR>\r
390 <TR BGCOLOR="white" CLASS="TableRowColor">\r
391 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
392 <CODE>protected abstract &nbsp;void</CODE></FONT></TD>\r
393 <TD><CODE><B><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#handleAllocate()">handleAllocate</A></B>()</CODE>\r
394 \r
395 <BR>\r
396 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Called from the <code>allocate</code> method.  </TD>\r
397 </TR>\r
398 <TR BGCOLOR="white" CLASS="TableRowColor">\r
399 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
400 <CODE>protected abstract &nbsp;void</CODE></FONT></TD>\r
401 <TD><CODE><B><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#handleDeallocate()">handleDeallocate</A></B>()</CODE>\r
402 \r
403 <BR>\r
404 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Called from the <code>deallocate</code> method.  </TD>\r
405 </TR>\r
406 <TR BGCOLOR="white" CLASS="TableRowColor">\r
407 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
408 <CODE>protected abstract &nbsp;void</CODE></FONT></TD>\r
409 <TD><CODE><B><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#handlePause()">handlePause</A></B>()</CODE>\r
410 \r
411 <BR>\r
412 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Called from the <code>pause</code> method.  </TD>\r
413 </TR>\r
414 <TR BGCOLOR="white" CLASS="TableRowColor">\r
415 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
416 <CODE>protected abstract &nbsp;void</CODE></FONT></TD>\r
417 <TD><CODE><B><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#handleResume()">handleResume</A></B>()</CODE>\r
418 \r
419 <BR>\r
420 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Called from the <code>resume</code> method.  </TD>\r
421 </TR>\r
422 <TR BGCOLOR="white" CLASS="TableRowColor">\r
423 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
424 <CODE>&nbsp;void</CODE></FONT></TD>\r
425 <TD><CODE><B><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#pause()">pause</A></B>()</CODE>\r
426 \r
427 <BR>\r
428 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Pauses the audio stream for this <code>Engine</code> and put
429  this <code>Engine</code> into the <code>PAUSED</code> state.</TD>\r
430 </TR>\r
431 <TR BGCOLOR="white" CLASS="TableRowColor">\r
432 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
433 <CODE>protected &nbsp;void</CODE></FONT></TD>\r
434 <TD><CODE><B><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#postEngineAllocated(long, long)">postEngineAllocated</A></B>(long&nbsp;oldState,
435                     long&nbsp;newState)</CODE>\r
436 \r
437 <BR>\r
438 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Utility function that generates an
439  <code>ENGINE_ALLOCATED</code> event and posts it
440  to the event queue.  </TD>\r
441 </TR>\r
442 <TR BGCOLOR="white" CLASS="TableRowColor">\r
443 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
444 <CODE>protected &nbsp;void</CODE></FONT></TD>\r
445 <TD><CODE><B><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#postEngineAllocatingResources(long, long)">postEngineAllocatingResources</A></B>(long&nbsp;oldState,
446                               long&nbsp;newState)</CODE>\r
447 \r
448 <BR>\r
449 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Utility function that generates an
450  <code>ENGINE_ALLOCATING_RESOURCES</code> event and
451  posts it to the event queue.  </TD>\r
452 </TR>\r
453 <TR BGCOLOR="white" CLASS="TableRowColor">\r
454 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
455 <CODE>protected &nbsp;void</CODE></FONT></TD>\r
456 <TD><CODE><B><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#postEngineDeallocated(long, long)">postEngineDeallocated</A></B>(long&nbsp;oldState,
457                       long&nbsp;newState)</CODE>\r
458 \r
459 <BR>\r
460 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Utility function that generates an
461  <code>ENGINE_DEALLOCATED</code> event and posts it
462  to the event queue.  </TD>\r
463 </TR>\r
464 <TR BGCOLOR="white" CLASS="TableRowColor">\r
465 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
466 <CODE>protected &nbsp;void</CODE></FONT></TD>\r
467 <TD><CODE><B><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#postEngineDeallocatingResources(long, long)">postEngineDeallocatingResources</A></B>(long&nbsp;oldState,
468                                 long&nbsp;newState)</CODE>\r
469 \r
470 <BR>\r
471 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Utility function that generates
472  <code>ENGINE_DEALLOCATING_RESOURCES</code> event and
473  posts it to the event queue.  </TD>\r
474 </TR>\r
475 <TR BGCOLOR="white" CLASS="TableRowColor">\r
476 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
477 <CODE>protected &nbsp;void</CODE></FONT></TD>\r
478 <TD><CODE><B><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#postEnginePaused(long, long)">postEnginePaused</A></B>(long&nbsp;oldState,
479                  long&nbsp;newState)</CODE>\r
480 \r
481 <BR>\r
482 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Utility function that generates an
483  <code>ENGINE_PAUSED</code> event and posts it
484  to the event queue.  </TD>\r
485 </TR>\r
486 <TR BGCOLOR="white" CLASS="TableRowColor">\r
487 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
488 <CODE>protected &nbsp;void</CODE></FONT></TD>\r
489 <TD><CODE><B><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#postEngineResumed(long, long)">postEngineResumed</A></B>(long&nbsp;oldState,
490                   long&nbsp;newState)</CODE>\r
491 \r
492 <BR>\r
493 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Utility function that generates an <code>ENGINE_RESUMED</code>
494  event and posts it to the event queue.  </TD>\r
495 </TR>\r
496 <TR BGCOLOR="white" CLASS="TableRowColor">\r
497 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
498 <CODE>&nbsp;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&nbsp;listener)</CODE>\r
500 \r
501 <BR>\r
502 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Removes an <code>EngineListener</code> from the list of
503  <code>EngineListeners</code>.</TD>\r
504 </TR>\r
505 <TR BGCOLOR="white" CLASS="TableRowColor">\r
506 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
507 <CODE>&nbsp;void</CODE></FONT></TD>\r
508 <TD><CODE><B><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#resume()">resume</A></B>()</CODE>\r
509 \r
510 <BR>\r
511 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Resumes the audio stream for this <code>Engine</code> and put
512  this <code>Engine</code> into the <code>RESUMED</code> state.</TD>\r
513 </TR>\r
514 <TR BGCOLOR="white" CLASS="TableRowColor">\r
515 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
516 <CODE>protected &nbsp;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&nbsp;desc)</CODE>\r
518 \r
519 <BR>\r
520 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the current operating properties and mode of
521  this <code>Engine</code>.</TD>\r
522 </TR>\r
523 <TR BGCOLOR="white" CLASS="TableRowColor">\r
524 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
525 <CODE>protected &nbsp;long[]</CODE></FONT></TD>\r
526 <TD><CODE><B><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#setEngineState(long, long)">setEngineState</A></B>(long&nbsp;clear,
527                long&nbsp;set)</CODE>\r
528 \r
529 <BR>\r
530 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Updates this <code>Engine</code> state by clearing defined bits,
531  then setting other specified bits.</TD>\r
532 </TR>\r
533 <TR BGCOLOR="white" CLASS="TableRowColor">\r
534 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
535 <CODE>protected &nbsp;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&nbsp;state)</CODE>\r
537 \r
538 <BR>\r
539 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a <code>String</code> of the names of all the
540  <code>Engine</code> states in the given <code>Engine</code>
541  state.</TD>\r
542 </TR>\r
543 <TR BGCOLOR="white" CLASS="TableRowColor">\r
544 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
545 <CODE>&nbsp;boolean</CODE></FONT></TD>\r
546 <TD><CODE><B><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#testEngineState(long)">testEngineState</A></B>(long&nbsp;state)</CODE>\r
547 \r
548 <BR>\r
549 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns <code>true</code> if this state of this
550  <code>Engine</code> matches the specified state.
551
552  </TD>\r
553 </TR>\r
554 <TR BGCOLOR="white" CLASS="TableRowColor">\r
555 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
556 <CODE>&nbsp;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
558 \r
559 <BR>\r
560 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the engine name and mode for debug purposes.</TD>\r
561 </TR>\r
562 <TR BGCOLOR="white" CLASS="TableRowColor">\r
563 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
564 <CODE>&nbsp;void</CODE></FONT></TD>\r
565 <TD><CODE><B><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#waitEngineState(long)">waitEngineState</A></B>(long&nbsp;state)</CODE>\r
566 \r
567 <BR>\r
568 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Blocks the calling thread until this <code>Engine</code>
569  is in a specified state.
570
571  </TD>\r
572 </TR>\r
573 </TABLE>\r
574 &nbsp;<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
578 </TR>\r
579 <TR BGCOLOR="white" CLASS="TableRowColor">\r
580 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>\r
581 </TR>\r
582 </TABLE>\r
583 &nbsp;\r
584 <P>\r
585 \r
586 <!-- ============ FIELD DETAIL =========== -->\r
587 \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
593 </TR>\r
594 </TABLE>\r
595 \r
596 <A NAME="engineState"><!-- --></A><H3>\r
597 engineState</H3>\r
598 <PRE>\r
599 protected long <B>engineState</B></PRE>\r
600 <DL>\r
601 <DD>A bitmask holding the current state of this <code>Engine</code>.\r
602 <P>\r
603 <DL>\r
604 </DL>\r
605 </DL>\r
606 <HR>\r
607 \r
608 <A NAME="engineStateLock"><!-- --></A><H3>\r
609 engineStateLock</H3>\r
610 <PRE>\r
611 protected java.lang.Object <B>engineStateLock</B></PRE>\r
612 <DL>\r
613 <DD>An <code>Object</code> used for synchronizing access to
614  <code>engineState</code>.\r
615 <P>\r
616 <DL>\r
617 <DT><B>See Also:</B><DD><A HREF="../../../../com/sun/speech/engine/BaseEngine.html#engineState"><CODE>engineState</CODE></A></DL>\r
618 </DL>\r
619 <HR>\r
620 \r
621 <A NAME="engineListeners"><!-- --></A><H3>\r
622 engineListeners</H3>\r
623 <PRE>\r
624 protected java.util.Collection <B>engineListeners</B></PRE>\r
625 <DL>\r
626 <DD>List of <code>EngineListeners</code> registered for
627  <code>EngineEvents</code> on this <code>Engine</code>.\r
628 <P>\r
629 <DL>\r
630 </DL>\r
631 </DL>\r
632 <HR>\r
633 \r
634 <A NAME="audioManager"><!-- --></A><H3>\r
635 audioManager</H3>\r
636 <PRE>\r
637 protected javax.speech.AudioManager <B>audioManager</B></PRE>\r
638 <DL>\r
639 <DD>The <code>AudioManager</code> for this <code>Engine</code>.\r
640 <P>\r
641 <DL>\r
642 </DL>\r
643 </DL>\r
644 <HR>\r
645 \r
646 <A NAME="engineModeDesc"><!-- --></A><H3>\r
647 engineModeDesc</H3>\r
648 <PRE>\r
649 protected javax.speech.EngineModeDesc <B>engineModeDesc</B></PRE>\r
650 <DL>\r
651 <DD>The <code>EngineModeDesc</code> for this <code>Engine</code>.\r
652 <P>\r
653 <DL>\r
654 </DL>\r
655 </DL>\r
656 <HR>\r
657 \r
658 <A NAME="engineProperties"><!-- --></A><H3>\r
659 engineProperties</H3>\r
660 <PRE>\r
661 protected javax.speech.EngineProperties <B>engineProperties</B></PRE>\r
662 <DL>\r
663 <DD>The <code>EngineProperties</code> for this <code>Engine</code>.\r
664 <P>\r
665 <DL>\r
666 </DL>\r
667 </DL>\r
668 <HR>\r
669 \r
670 <A NAME="CLEAR_ALL_STATE"><!-- --></A><H3>\r
671 CLEAR_ALL_STATE</H3>\r
672 <PRE>\r
673 protected static final long <B>CLEAR_ALL_STATE</B></PRE>\r
674 <DL>\r
675 <DD>Utility state for clearing the <code>engineState</code>.\r
676 <P>\r
677 <DL>\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
679 </DL>\r
680 \r
681 <!-- ========= CONSTRUCTOR DETAIL ======== -->\r
682 \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
688 </TR>\r
689 </TABLE>\r
690 \r
691 <A NAME="BaseEngine()"><!-- --></A><H3>\r
692 BaseEngine</H3>\r
693 <PRE>\r
694 public <B>BaseEngine</B>()</PRE>\r
695 <DL>\r
696 <DD>Creates a new <code>Engine</code> in the
697  <code>DEALLOCATED</code> state.\r
698 <P>\r
699 </DL>\r
700 <HR>\r
701 \r
702 <A NAME="BaseEngine(javax.speech.EngineModeDesc)"><!-- --></A><H3>\r
703 BaseEngine</H3>\r
704 <PRE>\r
705 public <B>BaseEngine</B>(javax.speech.EngineModeDesc&nbsp;desc)</PRE>\r
706 <DL>\r
707 <DD>Creates a new <code>Engine</code> in the
708  <code>DEALLOCATED</code> state.\r
709 <P>\r
710 <DT><B>Parameters:</B><DD><CODE>desc</CODE> - the operating mode of this <code>Engine</code></DL>\r
711 \r
712 <!-- ============ METHOD DETAIL ========== -->\r
713 \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
719 </TR>\r
720 </TABLE>\r
721 \r
722 <A NAME="getEngineState()"><!-- --></A><H3>\r
723 getEngineState</H3>\r
724 <PRE>\r
725 public long <B>getEngineState</B>()</PRE>\r
726 <DL>\r
727 <DD>Returns a or'ed set of flags indicating the current state of
728  this <code>Engine</code>.
729
730  <p>An <code>EngineEvent</code> is issued each time this
731  <code>Engine</code> changes state.
732
733  <p>The <code>getEngineState</code> method can be called successfully
734  in any <code>Engine</code> state.\r
735 <P>\r
736 <DD><DL>\r
737 <DT><B>Specified by:</B><DD><CODE>getEngineState</CODE> in interface <CODE>javax.speech.Engine</CODE></DL>\r
738 </DD>\r
739 <DD><DL>\r
740
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
743 </DD>\r
744 </DL>\r
745 <HR>\r
746 \r
747 <A NAME="waitEngineState(long)"><!-- --></A><H3>\r
748 waitEngineState</H3>\r
749 <PRE>\r
750 public void <B>waitEngineState</B>(long&nbsp;state)
751                      throws java.lang.InterruptedException,
752                             java.lang.IllegalArgumentException</PRE>\r
753 <DL>\r
754 <DD>Blocks the calling thread until this <code>Engine</code>
755  is in a specified state.
756
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.
762
763  <p>The <code>waitEngineState</code> method can be called successfully
764  in any <code>Engine</code> state.\r
765 <P>\r
766 <DD><DL>\r
767 <DT><B>Specified by:</B><DD><CODE>waitEngineState</CODE> in interface <CODE>javax.speech.Engine</CODE></DL>\r
768 </DD>\r
769 <DD><DL>\r
770 <DT><B>Parameters:</B><DD><CODE>state</CODE> - a bitmask of the state to wait for
771 <DT><B>Throws:</B>
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
775 </DD>\r
776 </DL>\r
777 <HR>\r
778 \r
779 <A NAME="testEngineState(long)"><!-- --></A><H3>\r
780 testEngineState</H3>\r
781 <PRE>\r
782 public boolean <B>testEngineState</B>(long&nbsp;state)
783                         throws java.lang.IllegalArgumentException</PRE>\r
784 <DL>\r
785 <DD>Returns <code>true</code> if this state of this
786  <code>Engine</code> matches the specified state.
787
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.
793  
794  <PRE>
795     if (synth.testEngineState(Synthesizer.QUEUE_EMPTY)) ...
796  </PRE>
797
798  <p>The <code>testEngineState</code> method is equivalent to:
799  
800  <PRE>
801       if ((engine.getEngineState() & state) == state)
802  </PRE>
803
804  <p>The <code>testEngineState</code> method can be called 
805  successfully in any <code>Engine</code> state.\r
806 <P>\r
807 <DD><DL>\r
808 <DT><B>Specified by:</B><DD><CODE>testEngineState</CODE> in interface <CODE>javax.speech.Engine</CODE></DL>\r
809 </DD>\r
810 <DD><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>
814 <DT><B>Throws:</B>
815 <DD><CODE>java.lang.IllegalArgumentException</CODE> - if the specified state is unreachable</DL>\r
816 </DD>\r
817 </DL>\r
818 <HR>\r
819 \r
820 <A NAME="setEngineState(long, long)"><!-- --></A><H3>\r
821 setEngineState</H3>\r
822 <PRE>\r
823 protected long[] <B>setEngineState</B>(long&nbsp;clear,
824                                 long&nbsp;set)</PRE>\r
825 <DL>\r
826 <DD>Updates this <code>Engine</code> state by clearing defined bits,
827  then setting other specified bits.\r
828 <P>\r
829 <DD><DL>\r
830 </DL>\r
831 </DD>\r
832 <DD><DL>\r
833
834 <DT><B>Returns:</B><DD>a length-2 array with old and new state values.</DL>\r
835 </DD>\r
836 </DL>\r
837 <HR>\r
838 \r
839 <A NAME="allocate()"><!-- --></A><H3>\r
840 allocate</H3>\r
841 <PRE>\r
842 public void <B>allocate</B>()
843               throws javax.speech.EngineException,
844                      javax.speech.EngineStateError</PRE>\r
845 <DL>\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
851  <code>true</code>.
852
853  <p>During the processing of the method, this <code>Engine</code> is
854  temporarily in the <code>ALLOCATING_RESOURCES</code> state.\r
855 <P>\r
856 <DD><DL>\r
857 <DT><B>Specified by:</B><DD><CODE>allocate</CODE> in interface <CODE>javax.speech.Engine</CODE></DL>\r
858 </DD>\r
859 <DD><DL>\r
860
861 <DT><B>Throws:</B>
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
865 </DD>\r
866 </DL>\r
867 <HR>\r
868 \r
869 <A NAME="handleAllocate()"><!-- --></A><H3>\r
870 handleAllocate</H3>\r
871 <PRE>\r
872 protected abstract void <B>handleAllocate</B>()
873                                 throws javax.speech.EngineException</PRE>\r
874 <DL>\r
875 <DD>Called from the <code>allocate</code> method.  Override this in
876  subclasses.\r
877 <P>\r
878 <DD><DL>\r
879 </DL>\r
880 </DD>\r
881 <DD><DL>\r
882
883 <DT><B>Throws:</B>
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
885 </DD>\r
886 </DL>\r
887 <HR>\r
888 \r
889 <A NAME="deallocate()"><!-- --></A><H3>\r
890 deallocate</H3>\r
891 <PRE>\r
892 public void <B>deallocate</B>()
893                 throws javax.speech.EngineException,
894                        javax.speech.EngineStateError</PRE>\r
895 <DL>\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 
902  <code>true</code>.
903
904  <p>During the processing of the method, this
905  <code>Engine</code> is temporarily in the
906  <code>DEALLOCATING_RESOURCES</code> state.
907
908  <p>A deallocated engine can be re-started with a subsequent
909  call to <code>allocate</code>.\r
910 <P>\r
911 <DD><DL>\r
912 <DT><B>Specified by:</B><DD><CODE>deallocate</CODE> in interface <CODE>javax.speech.Engine</CODE></DL>\r
913 </DD>\r
914 <DD><DL>\r
915
916 <DT><B>Throws:</B>
917 <DD><CODE>javax.speech.EngineException</CODE> - if this <code>Engine</code> cannot be
918    deallocated
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
921 </DD>\r
922 </DL>\r
923 <HR>\r
924 \r
925 <A NAME="handleDeallocate()"><!-- --></A><H3>\r
926 handleDeallocate</H3>\r
927 <PRE>\r
928 protected abstract void <B>handleDeallocate</B>()
929                                   throws javax.speech.EngineException</PRE>\r
930 <DL>\r
931 <DD>Called from the <code>deallocate</code> method.  Override this in
932  subclasses.\r
933 <P>\r
934 <DD><DL>\r
935 </DL>\r
936 </DD>\r
937 <DD><DL>\r
938
939 <DT><B>Throws:</B>
940 <DD><CODE>javax.speech.EngineException</CODE> - if this <code>Engine</code> cannot be
941    deallocated.</DL>\r
942 </DD>\r
943 </DL>\r
944 <HR>\r
945 \r
946 <A NAME="pause()"><!-- --></A><H3>\r
947 pause</H3>\r
948 <PRE>\r
949 public void <B>pause</B>()
950            throws javax.speech.EngineStateError</PRE>\r
951 <DL>\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
954 <P>\r
955 <DD><DL>\r
956 <DT><B>Specified by:</B><DD><CODE>pause</CODE> in interface <CODE>javax.speech.Engine</CODE></DL>\r
957 </DD>\r
958 <DD><DL>\r
959
960 <DT><B>Throws:</B>
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
964 </DD>\r
965 </DL>\r
966 <HR>\r
967 \r
968 <A NAME="handlePause()"><!-- --></A><H3>\r
969 handlePause</H3>\r
970 <PRE>\r
971 protected abstract void <B>handlePause</B>()</PRE>\r
972 <DL>\r
973 <DD>Called from the <code>pause</code> method.  Override this in subclasses.\r
974 <P>\r
975 <DD><DL>\r
976 </DL>\r
977 </DD>\r
978 <DD><DL>\r
979 </DL>\r
980 </DD>\r
981 </DL>\r
982 <HR>\r
983 \r
984 <A NAME="resume()"><!-- --></A><H3>\r
985 resume</H3>\r
986 <PRE>\r
987 public void <B>resume</B>()
988             throws javax.speech.AudioException,
989                    javax.speech.EngineStateError</PRE>\r
990 <DL>\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
993 <P>\r
994 <DD><DL>\r
995 <DT><B>Specified by:</B><DD><CODE>resume</CODE> in interface <CODE>javax.speech.Engine</CODE></DL>\r
996 </DD>\r
997 <DD><DL>\r
998
999 <DT><B>Throws:</B>
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
1004 </DD>\r
1005 </DL>\r
1006 <HR>\r
1007 \r
1008 <A NAME="handleResume()"><!-- --></A><H3>\r
1009 handleResume</H3>\r
1010 <PRE>\r
1011 protected abstract void <B>handleResume</B>()</PRE>\r
1012 <DL>\r
1013 <DD>Called from the <code>resume</code> method.  Override in subclasses.\r
1014 <P>\r
1015 <DD><DL>\r
1016 </DL>\r
1017 </DD>\r
1018 <DD><DL>\r
1019 </DL>\r
1020 </DD>\r
1021 </DL>\r
1022 <HR>\r
1023 \r
1024 <A NAME="getAudioManager()"><!-- --></A><H3>\r
1025 getAudioManager</H3>\r
1026 <PRE>\r
1027 public javax.speech.AudioManager <B>getAudioManager</B>()</PRE>\r
1028 <DL>\r
1029 <DD>Returns an object that provides management of the audio input
1030  or output of this <code>Engine</code>.\r
1031 <P>\r
1032 <DD><DL>\r
1033 <DT><B>Specified by:</B><DD><CODE>getAudioManager</CODE> in interface <CODE>javax.speech.Engine</CODE></DL>\r
1034 </DD>\r
1035 <DD><DL>\r
1036
1037 <DT><B>Returns:</B><DD>the audio manader for this <code>Engine</code></DL>\r
1038 </DD>\r
1039 </DL>\r
1040 <HR>\r
1041 \r
1042 <A NAME="getVocabManager()"><!-- --></A><H3>\r
1043 getVocabManager</H3>\r
1044 <PRE>\r
1045 public javax.speech.VocabManager <B>getVocabManager</B>()
1046                                           throws javax.speech.EngineStateError</PRE>\r
1047 <DL>\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
1051 <P>\r
1052 <DD><DL>\r
1053 <DT><B>Specified by:</B><DD><CODE>getVocabManager</CODE> in interface <CODE>javax.speech.Engine</CODE></DL>\r
1054 </DD>\r
1055 <DD><DL>\r
1056
1057 <DT><B>Returns:</B><DD>the vocabulary manager of this <code>Engine</code>
1058 <DT><B>Throws:</B>
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
1062 </DD>\r
1063 </DL>\r
1064 <HR>\r
1065 \r
1066 <A NAME="getEngineProperties()"><!-- --></A><H3>\r
1067 getEngineProperties</H3>\r
1068 <PRE>\r
1069 public javax.speech.EngineProperties <B>getEngineProperties</B>()</PRE>\r
1070 <DL>\r
1071 <DD>Gets the <code>EngineProperties</code> of this <code>Engine</code>.
1072  Must be set in subclasses.\r
1073 <P>\r
1074 <DD><DL>\r
1075 <DT><B>Specified by:</B><DD><CODE>getEngineProperties</CODE> in interface <CODE>javax.speech.Engine</CODE></DL>\r
1076 </DD>\r
1077 <DD><DL>\r
1078
1079 <DT><B>Returns:</B><DD>the <code>EngineProperties</code> of this <code>Engine</code>.</DL>\r
1080 </DD>\r
1081 </DL>\r
1082 <HR>\r
1083 \r
1084 <A NAME="getEngineModeDesc()"><!-- --></A><H3>\r
1085 getEngineModeDesc</H3>\r
1086 <PRE>\r
1087 public javax.speech.EngineModeDesc <B>getEngineModeDesc</B>()
1088                                               throws java.lang.SecurityException</PRE>\r
1089 <DL>\r
1090 <DD>Gets the current operating properties and mode of
1091  this <code>Engine</code>.\r
1092 <P>\r
1093 <DD><DL>\r
1094 <DT><B>Specified by:</B><DD><CODE>getEngineModeDesc</CODE> in interface <CODE>javax.speech.Engine</CODE></DL>\r
1095 </DD>\r
1096 <DD><DL>\r
1097
1098 <DT><B>Returns:</B><DD>the operating mode of this <code>Engine</code>
1099 <DT><B>Throws:</B>
1100 <DD><CODE>java.lang.SecurityException</CODE></DL>\r
1101 </DD>\r
1102 </DL>\r
1103 <HR>\r
1104 \r
1105 <A NAME="setEngineModeDesc(javax.speech.EngineModeDesc)"><!-- --></A><H3>\r
1106 setEngineModeDesc</H3>\r
1107 <PRE>\r
1108 protected void <B>setEngineModeDesc</B>(javax.speech.EngineModeDesc&nbsp;desc)</PRE>\r
1109 <DL>\r
1110 <DD>Sets the current operating properties and mode of
1111  this <code>Engine</code>.\r
1112 <P>\r
1113 <DD><DL>\r
1114 </DL>\r
1115 </DD>\r
1116 <DD><DL>\r
1117 <DT><B>Parameters:</B><DD><CODE>desc</CODE> - the new operating mode of this <code>Engine</code></DL>\r
1118 </DD>\r
1119 </DL>\r
1120 <HR>\r
1121 \r
1122 <A NAME="addEngineListener(javax.speech.EngineListener)"><!-- --></A><H3>\r
1123 addEngineListener</H3>\r
1124 <PRE>\r
1125 public void <B>addEngineListener</B>(javax.speech.EngineListener&nbsp;listener)</PRE>\r
1126 <DL>\r
1127 <DD>Requests notification of <code>EngineEvents</code> from this
1128  <code>Engine</code>.\r
1129 <P>\r
1130 <DD><DL>\r
1131 <DT><B>Specified by:</B><DD><CODE>addEngineListener</CODE> in interface <CODE>javax.speech.Engine</CODE></DL>\r
1132 </DD>\r
1133 <DD><DL>\r
1134 <DT><B>Parameters:</B><DD><CODE>listener</CODE> - the listener to add.</DL>\r
1135 </DD>\r
1136 </DL>\r
1137 <HR>\r
1138 \r
1139 <A NAME="removeEngineListener(javax.speech.EngineListener)"><!-- --></A><H3>\r
1140 removeEngineListener</H3>\r
1141 <PRE>\r
1142 public void <B>removeEngineListener</B>(javax.speech.EngineListener&nbsp;listener)</PRE>\r
1143 <DL>\r
1144 <DD>Removes an <code>EngineListener</code> from the list of
1145  <code>EngineListeners</code>.\r
1146 <P>\r
1147 <DD><DL>\r
1148 <DT><B>Specified by:</B><DD><CODE>removeEngineListener</CODE> in interface <CODE>javax.speech.Engine</CODE></DL>\r
1149 </DD>\r
1150 <DD><DL>\r
1151 <DT><B>Parameters:</B><DD><CODE>listener</CODE> - the listener to remove.</DL>\r
1152 </DD>\r
1153 </DL>\r
1154 <HR>\r
1155 \r
1156 <A NAME="postEngineAllocated(long, long)"><!-- --></A><H3>\r
1157 postEngineAllocated</H3>\r
1158 <PRE>\r
1159 protected void <B>postEngineAllocated</B>(long&nbsp;oldState,
1160                                    long&nbsp;newState)</PRE>\r
1161 <DL>\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
1167  action.\r
1168 <P>\r
1169 <DD><DL>\r
1170 </DL>\r
1171 </DD>\r
1172 <DD><DL>\r
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
1175 </DD>\r
1176 </DL>\r
1177 <HR>\r
1178 \r
1179 <A NAME="fireEngineAllocated(javax.speech.EngineEvent)"><!-- --></A><H3>\r
1180 fireEngineAllocated</H3>\r
1181 <PRE>\r
1182 public void <B>fireEngineAllocated</B>(javax.speech.EngineEvent&nbsp;event)</PRE>\r
1183 <DL>\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
1187 <P>\r
1188 <DD><DL>\r
1189 </DL>\r
1190 </DD>\r
1191 <DD><DL>\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
1194 </DD>\r
1195 </DL>\r
1196 <HR>\r
1197 \r
1198 <A NAME="postEngineAllocatingResources(long, long)"><!-- --></A><H3>\r
1199 postEngineAllocatingResources</H3>\r
1200 <PRE>\r
1201 protected void <B>postEngineAllocatingResources</B>(long&nbsp;oldState,
1202                                              long&nbsp;newState)</PRE>\r
1203 <DL>\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
1210 <P>\r
1211 <DD><DL>\r
1212 </DL>\r
1213 </DD>\r
1214 <DD><DL>\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
1217 </DD>\r
1218 </DL>\r
1219 <HR>\r
1220 \r
1221 <A NAME="fireEngineAllocatingResources(javax.speech.EngineEvent)"><!-- --></A><H3>\r
1222 fireEngineAllocatingResources</H3>\r
1223 <PRE>\r
1224 public void <B>fireEngineAllocatingResources</B>(javax.speech.EngineEvent&nbsp;event)</PRE>\r
1225 <DL>\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
1230 <P>\r
1231 <DD><DL>\r
1232 </DL>\r
1233 </DD>\r
1234 <DD><DL>\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
1237 </DD>\r
1238 </DL>\r
1239 <HR>\r
1240 \r
1241 <A NAME="postEngineDeallocated(long, long)"><!-- --></A><H3>\r
1242 postEngineDeallocated</H3>\r
1243 <PRE>\r
1244 protected void <B>postEngineDeallocated</B>(long&nbsp;oldState,
1245                                      long&nbsp;newState)</PRE>\r
1246 <DL>\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
1252 <P>\r
1253 <DD><DL>\r
1254 </DL>\r
1255 </DD>\r
1256 <DD><DL>\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
1259 </DD>\r
1260 </DL>\r
1261 <HR>\r
1262 \r
1263 <A NAME="fireEngineDeallocated(javax.speech.EngineEvent)"><!-- --></A><H3>\r
1264 fireEngineDeallocated</H3>\r
1265 <PRE>\r
1266 public void <B>fireEngineDeallocated</B>(javax.speech.EngineEvent&nbsp;event)</PRE>\r
1267 <DL>\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
1272 <P>\r
1273 <DD><DL>\r
1274 </DL>\r
1275 </DD>\r
1276 <DD><DL>\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
1279 </DD>\r
1280 </DL>\r
1281 <HR>\r
1282 \r
1283 <A NAME="postEngineDeallocatingResources(long, long)"><!-- --></A><H3>\r
1284 postEngineDeallocatingResources</H3>\r
1285 <PRE>\r
1286 protected void <B>postEngineDeallocatingResources</B>(long&nbsp;oldState,
1287                                                long&nbsp;newState)</PRE>\r
1288 <DL>\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
1294 <P>\r
1295 <DD><DL>\r
1296 </DL>\r
1297 </DD>\r
1298 <DD><DL>\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
1301 </DD>\r
1302 </DL>\r
1303 <HR>\r
1304 \r
1305 <A NAME="fireEngineDeallocatingResources(javax.speech.EngineEvent)"><!-- --></A><H3>\r
1306 fireEngineDeallocatingResources</H3>\r
1307 <PRE>\r
1308 public void <B>fireEngineDeallocatingResources</B>(javax.speech.EngineEvent&nbsp;event)</PRE>\r
1309 <DL>\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
1314 <P>\r
1315 <DD><DL>\r
1316 </DL>\r
1317 </DD>\r
1318 <DD><DL>\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
1321 </DD>\r
1322 </DL>\r
1323 <HR>\r
1324 \r
1325 <A NAME="postEnginePaused(long, long)"><!-- --></A><H3>\r
1326 postEnginePaused</H3>\r
1327 <PRE>\r
1328 protected void <B>postEnginePaused</B>(long&nbsp;oldState,
1329                                 long&nbsp;newState)</PRE>\r
1330 <DL>\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
1336 <P>\r
1337 <DD><DL>\r
1338 </DL>\r
1339 </DD>\r
1340 <DD><DL>\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
1343 </DD>\r
1344 </DL>\r
1345 <HR>\r
1346 \r
1347 <A NAME="fireEnginePaused(javax.speech.EngineEvent)"><!-- --></A><H3>\r
1348 fireEnginePaused</H3>\r
1349 <PRE>\r
1350 public void <B>fireEnginePaused</B>(javax.speech.EngineEvent&nbsp;event)</PRE>\r
1351 <DL>\r
1352 <DD>Utility function that sends an <code>ENGINE_PAUSED</code> event
1353  to all
1354  <code>EngineListeners</code> registered with this
1355  <code>Engine</code>.  Called by <code>dispatchSpeechEvent</code>.\r
1356 <P>\r
1357 <DD><DL>\r
1358 </DL>\r
1359 </DD>\r
1360 <DD><DL>\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
1363 </DD>\r
1364 </DL>\r
1365 <HR>\r
1366 \r
1367 <A NAME="postEngineResumed(long, long)"><!-- --></A><H3>\r
1368 postEngineResumed</H3>\r
1369 <PRE>\r
1370 protected void <B>postEngineResumed</B>(long&nbsp;oldState,
1371                                  long&nbsp;newState)</PRE>\r
1372 <DL>\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
1377 <P>\r
1378 <DD><DL>\r
1379 </DL>\r
1380 </DD>\r
1381 <DD><DL>\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
1384 </DD>\r
1385 </DL>\r
1386 <HR>\r
1387 \r
1388 <A NAME="fireEngineResumed(javax.speech.EngineEvent)"><!-- --></A><H3>\r
1389 fireEngineResumed</H3>\r
1390 <PRE>\r
1391 public void <B>fireEngineResumed</B>(javax.speech.EngineEvent&nbsp;event)</PRE>\r
1392 <DL>\r
1393 <DD>Utility function that sends an <code>ENGINE_RESUMED</code> event
1394  to all
1395  <code>EngineListeners</code> registered with this
1396  <code>Engine</code>.  Called by <code>dispatchSpeechEvent</code>.\r
1397 <P>\r
1398 <DD><DL>\r
1399 </DL>\r
1400 </DD>\r
1401 <DD><DL>\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
1404 </DD>\r
1405 </DL>\r
1406 <HR>\r
1407 \r
1408 <A NAME="createEngineProperties()"><!-- --></A><H3>\r
1409 createEngineProperties</H3>\r
1410 <PRE>\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
1412 <DL>\r
1413 <DD>Factory constructor for EngineProperties object.\r
1414 <P>\r
1415 <DD><DL>\r
1416 </DL>\r
1417 </DD>\r
1418 <DD><DL>\r
1419
1420 <DT><B>Returns:</B><DD>a <code>BaseEngineProperties</code> object specific to
1421    a subclass.</DL>\r
1422 </DD>\r
1423 </DL>\r
1424 <HR>\r
1425 \r
1426 <A NAME="checkEngineState(long)"><!-- --></A><H3>\r
1427 checkEngineState</H3>\r
1428 <PRE>\r
1429 protected void <B>checkEngineState</B>(long&nbsp;state)
1430                          throws javax.speech.EngineStateError</PRE>\r
1431 <DL>\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
1435 <P>\r
1436 <DD><DL>\r
1437 </DL>\r
1438 </DD>\r
1439 <DD><DL>\r
1440 <DT><B>Parameters:</B><DD><CODE>state</CODE> - the <code>Engine</code> state to check
1441 <DT><B>Throws:</B>
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
1444 </DD>\r
1445 </DL>\r
1446 <HR>\r
1447 \r
1448 <A NAME="stateToString(long)"><!-- --></A><H3>\r
1449 stateToString</H3>\r
1450 <PRE>\r
1451 protected java.lang.String <B>stateToString</B>(long&nbsp;state)</PRE>\r
1452 <DL>\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>
1455  state.\r
1456 <P>\r
1457 <DD><DL>\r
1458 </DL>\r
1459 </DD>\r
1460 <DD><DL>\r
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
1464 </DD>\r
1465 </DL>\r
1466 <HR>\r
1467 \r
1468 <A NAME="dispatchSpeechEvent(javax.speech.SpeechEvent)"><!-- --></A><H3>\r
1469 dispatchSpeechEvent</H3>\r
1470 <PRE>\r
1471 public void <B>dispatchSpeechEvent</B>(javax.speech.SpeechEvent&nbsp;event)</PRE>\r
1472 <DL>\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
1477 <P>\r
1478 <DD><DL>\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
1480 </DD>\r
1481 <DD><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
1488 </DD>\r
1489 </DL>\r
1490 <HR>\r
1491 \r
1492 <A NAME="toString()"><!-- --></A><H3>\r
1493 toString</H3>\r
1494 <PRE>\r
1495 public java.lang.String <B>toString</B>()</PRE>\r
1496 <DL>\r
1497 <DD>Returns the engine name and mode for debug purposes.\r
1498 <P>\r
1499 <DD><DL>\r
1500 </DL>\r
1501 </DD>\r
1502 <DD><DL>\r
1503
1504 <DT><B>Returns:</B><DD>the engine name and mode.</DL>\r
1505 </DD>\r
1506 </DL>\r
1507 <!-- ========= END OF CLASS DATA ========= -->\r
1508 <HR>\r
1509 \r
1510
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
1515 <TR>\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>&nbsp;</TD>\r
1521   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
1522   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
1523   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
1524   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
1525   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
1526   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
1527   </TR>\r
1528 </TABLE>\r
1529 </TD>\r
1530 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
1531 </EM>\r
1532 </TD>\r
1533 </TR>\r
1534 \r
1535 <TR>\r
1536 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
1537 &nbsp;<A HREF="../../../../com/sun/speech/engine/BaseAudioManager.html" title="class in com.sun.speech.engine"><B>PREV CLASS</B></A>&nbsp;\r
1538 &nbsp;<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>  &nbsp;\r
1541 &nbsp;<A HREF="BaseEngine.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
1542 &nbsp;<SCRIPT type="text/javascript">\r
1543   <!--\r
1544   if(window==top) {\r
1545     document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
1546   }\r
1547   //-->\r
1548 </SCRIPT>\r
1549 <NOSCRIPT>\r
1550   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>\r
1551 </NOSCRIPT>
1552 \r
1553 </FONT></TD>\r
1554 </TR>\r
1555 <TR>\r
1556 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
1557   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
1558 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
1559 DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
1560 </TR>\r
1561 </TABLE>\r
1562 <A NAME="skip-navbar_bottom"></A>
1563 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
1564 \r
1565 <HR>\r
1566 \r
1567 </BODY>\r
1568 </HTML>\r