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:29 CET 2009 -->
\r
7 OutputQueue (FreeTTS 1.2)
\r
10 <META NAME="keywords" CONTENT="com.sun.speech.freetts.OutputQueue 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="OutputQueue (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/freetts/ItemContents.html" title="class in com.sun.speech.freetts"><B>PREV CLASS</B></A>
\r
53 <A HREF="../../../../com/sun/speech/freetts/PartOfSpeechImpl.html" title="class in com.sun.speech.freetts"><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="OutputQueue.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 | FIELD | <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: FIELD | <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.freetts</FONT>
\r
86 Class OutputQueue</H2>
\r
89 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by"><B>com.sun.speech.freetts.OutputQueue</B>
\r
93 <DT>public class <B>OutputQueue</B><DT>extends java.lang.Object</DL>
\r
96 Manages a process queue for utterances. Utterances that are
97 queued to a processor can be written via the post method.
98 A processing thread can wait for an utterance to arrive via the
106 <!-- ======== NESTED CLASS SUMMARY ======== -->
\r
109 <!-- =========== FIELD SUMMARY =========== -->
\r
112 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
\r
114 <A NAME="constructor_summary"><!-- --></A>
115 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
116 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
117 <TD COLSPAN=2><FONT SIZE="+2">
\r
118 <B>Constructor Summary</B></FONT></TD>
\r
120 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
121 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/OutputQueue.html#OutputQueue()">OutputQueue</A></B>()</CODE>
\r
124 Creates a queue with the default size.</TD>
\r
126 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
127 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/OutputQueue.html#OutputQueue(int)">OutputQueue</A></B>(int size)</CODE>
\r
130 Creates an OutputQueue with the given size.</TD>
\r
134 <!-- ========== METHOD SUMMARY =========== -->
\r
136 <A NAME="method_summary"><!-- --></A>
137 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
138 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
139 <TD COLSPAN=2><FONT SIZE="+2">
\r
140 <B>Method Summary</B></FONT></TD>
\r
142 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
143 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
144 <CODE> void</CODE></FONT></TD>
\r
145 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/OutputQueue.html#close()">close</A></B>()</CODE>
\r
148 Closes the queue.</TD>
\r
150 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
151 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
152 <CODE> boolean</CODE></FONT></TD>
\r
153 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/OutputQueue.html#isClosed()">isClosed</A></B>()</CODE>
\r
156 Determines if the queue is closed.</TD>
\r
158 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
159 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
160 <CODE> <A HREF="../../../../com/sun/speech/freetts/Utterance.html" title="class in com.sun.speech.freetts">Utterance</A></CODE></FONT></TD>
\r
161 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/OutputQueue.html#pend()">pend</A></B>()</CODE>
\r
164 Blocks until there is an utterance in the queue.</TD>
\r
166 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
167 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
168 <CODE> void</CODE></FONT></TD>
\r
169 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/OutputQueue.html#post(com.sun.speech.freetts.Utterance)">post</A></B>(<A HREF="../../../../com/sun/speech/freetts/Utterance.html" title="class in com.sun.speech.freetts">Utterance</A> utterance)</CODE>
\r
172 Posts the given utterance to the queue. </TD>
\r
174 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
175 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
176 <CODE> void</CODE></FONT></TD>
\r
177 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/OutputQueue.html#removeAll()">removeAll</A></B>()</CODE>
\r
180 Removes all items from this OutputQueue.</TD>
\r
183 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
184 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
185 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
\r
186 <TD><B>Methods inherited from class java.lang.Object</B></TD>
\r
188 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
189 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
\r
195 <!-- ============ FIELD DETAIL =========== -->
\r
198 <!-- ========= CONSTRUCTOR DETAIL ======== -->
\r
200 <A NAME="constructor_detail"><!-- --></A>
201 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
202 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
203 <TD COLSPAN=1><FONT SIZE="+2">
\r
204 <B>Constructor Detail</B></FONT></TD>
\r
208 <A NAME="OutputQueue(int)"><!-- --></A><H3>
\r
211 public <B>OutputQueue</B>(int size)</PRE>
\r
213 <DD>Creates an OutputQueue with the given size.
\r
215 <DT><B>Parameters:</B><DD><CODE>size</CODE> - the size of the queue</DL>
\r
218 <A NAME="OutputQueue()"><!-- --></A><H3>
\r
221 public <B>OutputQueue</B>()</PRE>
\r
223 <DD>Creates a queue with the default size.
\r
227 <!-- ============ METHOD DETAIL ========== -->
\r
229 <A NAME="method_detail"><!-- --></A>
230 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
231 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
232 <TD COLSPAN=1><FONT SIZE="+2">
\r
233 <B>Method Detail</B></FONT></TD>
\r
237 <A NAME="post(com.sun.speech.freetts.Utterance)"><!-- --></A><H3>
\r
240 public void <B>post</B>(<A HREF="../../../../com/sun/speech/freetts/Utterance.html" title="class in com.sun.speech.freetts">Utterance</A> utterance)</PRE>
\r
242 <DD>Posts the given utterance to the queue. This call will block if
246 <DT><B>Parameters:</B><DD><CODE>utterance</CODE> - the utterance to post
248 <DD><CODE>java.lang.IllegalStateException</CODE> - if the queue is closed</DL>
\r
253 <A NAME="close()"><!-- --></A><H3>
\r
256 public void <B>close</B>()</PRE>
\r
258 <DD>Closes the queue.
\r
266 <A NAME="isClosed()"><!-- --></A><H3>
\r
269 public boolean <B>isClosed</B>()</PRE>
\r
271 <DD>Determines if the queue is closed.
\r
275 <DT><B>Returns:</B><DD>true the queue is closed; otherwise false</DL>
\r
280 <A NAME="pend()"><!-- --></A><H3>
\r
283 public <A HREF="../../../../com/sun/speech/freetts/Utterance.html" title="class in com.sun.speech.freetts">Utterance</A> <B>pend</B>()</PRE>
\r
285 <DD>Blocks until there is an utterance in the queue.
\r
289 <DT><B>Returns:</B><DD>the next utterance. On a close or interrupt, a null is
295 <A NAME="removeAll()"><!-- --></A><H3>
\r
298 public void <B>removeAll</B>()</PRE>
\r
300 <DD>Removes all items from this OutputQueue.
\r
306 <!-- ========= END OF CLASS DATA ========= -->
\r
310 <!-- ======= START OF BOTTOM NAVBAR ====== -->
\r
311 <A NAME="navbar_bottom"><!-- --></A>
312 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
313 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
\r
315 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
\r
316 <A NAME="navbar_bottom_firstrow"><!-- --></A>
317 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
\r
318 <TR ALIGN="center" VALIGN="top">
\r
319 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
\r
320 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
321 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
322 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
323 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
324 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
325 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
329 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
335 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
336 <A HREF="../../../../com/sun/speech/freetts/ItemContents.html" title="class in com.sun.speech.freetts"><B>PREV CLASS</B></A>
\r
337 <A HREF="../../../../com/sun/speech/freetts/PartOfSpeechImpl.html" title="class in com.sun.speech.freetts"><B>NEXT CLASS</B></A></FONT></TD>
\r
338 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
339 <A HREF="../../../../index.html" target="_top"><B>FRAMES</B></A>
\r
340 <A HREF="OutputQueue.html" target="_top"><B>NO FRAMES</B></A>
\r
341 <SCRIPT type="text/javascript">
\r
344 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
349 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
\r
355 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
356 SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
357 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
358 DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
361 <A NAME="skip-navbar_bottom"></A>
362 <!-- ======== END OF BOTTOM NAVBAR ======= -->
\r