git.gag.com Git - debian/freetts/blob - javadoc/com/sun/speech/freetts/OutputQueue.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:29 CET 2009 -->\r
   6 <TITLE>\r
   7 OutputQueue (FreeTTS 1.2)\r
   8 </TITLE>\r
   9 \r
  10 <META NAME="keywords" CONTENT="com.sun.speech.freetts.OutputQueue 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="OutputQueue (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/freetts/ItemContents.html" title="class in com.sun.speech.freetts"><B>PREV CLASS</B></A>&nbsp;\r
  53 &nbsp;<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>  &nbsp;\r
  56 &nbsp;<A HREF="OutputQueue.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;FIELD&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;FIELD&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.freetts</FONT>\r
  85 <BR>\r
  86 Class OutputQueue</H2>\r
  87 <PRE>\r
  88 java.lang.Object\r
  89   <IMG SRC="../../../../resources/inherit.gif" ALT="extended by"><B>com.sun.speech.freetts.OutputQueue</B>\r
  90 </PRE>\r
  91 <HR>\r
  92 <DL>\r
  93 <DT>public class <B>OutputQueue</B><DT>extends java.lang.Object</DL>\r
  94 \r
  95 <P>\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
  99  pend method.\r
 100 <P>\r
 101 \r
 102 <P>\r
 103 <HR>\r
 104 \r
 105 <P>\r
 106 <!-- ======== NESTED CLASS SUMMARY ======== -->\r
 107 \r
 108 \r
 109 <!-- =========== FIELD SUMMARY =========== -->\r
 110 \r
 111 \r
 112 <!-- ======== CONSTRUCTOR SUMMARY ======== -->\r
 113 \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
 119 </TR>\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
 122 \r
 123 <BR>\r
 124 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a queue with the default size.</TD>\r
 125 </TR>\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&nbsp;size)</CODE>\r
 128 \r
 129 <BR>\r
 130 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates an OutputQueue with the given size.</TD>\r
 131 </TR>\r
 132 </TABLE>\r
 133 &nbsp;\r
 134 <!-- ========== METHOD SUMMARY =========== -->\r
 135 \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
 141 </TR>\r
 142 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 143 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 144 <CODE>&nbsp;void</CODE></FONT></TD>\r
 145 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/OutputQueue.html#close()">close</A></B>()</CODE>\r
 146 \r
 147 <BR>\r
 148 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Closes the queue.</TD>\r
 149 </TR>\r
 150 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 151 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 152 <CODE>&nbsp;boolean</CODE></FONT></TD>\r
 153 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/OutputQueue.html#isClosed()">isClosed</A></B>()</CODE>\r
 154 \r
 155 <BR>\r
 156 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Determines if the queue is closed.</TD>\r
 157 </TR>\r
 158 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 159 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 160 <CODE>&nbsp;<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
 162 \r
 163 <BR>\r
 164 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Blocks until there is an utterance in the queue.</TD>\r
 165 </TR>\r
 166 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 167 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 168 <CODE>&nbsp;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>&nbsp;utterance)</CODE>\r
 170 \r
 171 <BR>\r
 172 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Posts the given utterance to the queue. </TD>\r
 173 </TR>\r
 174 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 175 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 176 <CODE>&nbsp;void</CODE></FONT></TD>\r
 177 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/OutputQueue.html#removeAll()">removeAll</A></B>()</CODE>\r
 178 \r
 179 <BR>\r
 180 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Removes all items from this OutputQueue.</TD>\r
 181 </TR>\r
 182 </TABLE>\r
 183 &nbsp;<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
 187 </TR>\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
 190 </TR>\r
 191 </TABLE>\r
 192 &nbsp;\r
 193 <P>\r
 194 \r
 195 <!-- ============ FIELD DETAIL =========== -->\r
 196 \r
 197 \r
 198 <!-- ========= CONSTRUCTOR DETAIL ======== -->\r
 199 \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
 205 </TR>\r
 206 </TABLE>\r
 207 \r
 208 <A NAME="OutputQueue(int)"><!-- --></A><H3>\r
 209 OutputQueue</H3>\r
 210 <PRE>\r
 211 public <B>OutputQueue</B>(int&nbsp;size)</PRE>\r
 212 <DL>\r
 213 <DD>Creates an OutputQueue with the given size.\r
 214 <P>\r
 215 <DT><B>Parameters:</B><DD><CODE>size</CODE> - the size of the queue</DL>\r
 216 <HR>\r
 217 \r
 218 <A NAME="OutputQueue()"><!-- --></A><H3>\r
 219 OutputQueue</H3>\r
 220 <PRE>\r
 221 public <B>OutputQueue</B>()</PRE>\r
 222 <DL>\r
 223 <DD>Creates a queue with the default size.\r
 224 <P>\r
 225 </DL>\r
 226 \r
 227 <!-- ============ METHOD DETAIL ========== -->\r
 228 \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
 234 </TR>\r
 235 </TABLE>\r
 236 \r
 237 <A NAME="post(com.sun.speech.freetts.Utterance)"><!-- --></A><H3>\r
 238 post</H3>\r
 239 <PRE>\r
 240 public void <B>post</B>(<A HREF="../../../../com/sun/speech/freetts/Utterance.html" title="class in com.sun.speech.freetts">Utterance</A>&nbsp;utterance)</PRE>\r
 241 <DL>\r
 242 <DD>Posts the given utterance to the queue. This call will block if
 243  the queue is full.\r
 244 <P>\r
 245 <DD><DL>\r
 246 <DT><B>Parameters:</B><DD><CODE>utterance</CODE> - the utterance to post
 247 <DT><B>Throws:</B>
 248 <DD><CODE>java.lang.IllegalStateException</CODE> - if the queue is closed</DL>\r
 249 </DD>\r
 250 </DL>\r
 251 <HR>\r
 252 \r
 253 <A NAME="close()"><!-- --></A><H3>\r
 254 close</H3>\r
 255 <PRE>\r
 256 public void <B>close</B>()</PRE>\r
 257 <DL>\r
 258 <DD>Closes the queue.\r
 259 <P>\r
 260 <DD><DL>\r
 261 </DL>\r
 262 </DD>\r
 263 </DL>\r
 264 <HR>\r
 265 \r
 266 <A NAME="isClosed()"><!-- --></A><H3>\r
 267 isClosed</H3>\r
 268 <PRE>\r
 269 public boolean <B>isClosed</B>()</PRE>\r
 270 <DL>\r
 271 <DD>Determines if the queue is closed.\r
 272 <P>\r
 273 <DD><DL>\r
 274
 275 <DT><B>Returns:</B><DD>true the queue is closed; otherwise false</DL>\r
 276 </DD>\r
 277 </DL>\r
 278 <HR>\r
 279 \r
 280 <A NAME="pend()"><!-- --></A><H3>\r
 281 pend</H3>\r
 282 <PRE>\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
 284 <DL>\r
 285 <DD>Blocks until there is an utterance in the queue.\r
 286 <P>\r
 287 <DD><DL>\r
 288
 289 <DT><B>Returns:</B><DD>the next utterance. On a close or interrupt, a null is
 290  returned.</DL>\r
 291 </DD>\r
 292 </DL>\r
 293 <HR>\r
 294 \r
 295 <A NAME="removeAll()"><!-- --></A><H3>\r
 296 removeAll</H3>\r
 297 <PRE>\r
 298 public void <B>removeAll</B>()</PRE>\r
 299 <DL>\r
 300 <DD>Removes all items from this OutputQueue.\r
 301 <P>\r
 302 <DD><DL>\r
 303 </DL>\r
 304 </DD>\r
 305 </DL>\r
 306 <!-- ========= END OF CLASS DATA ========= -->\r
 307 <HR>\r
 308 \r
 309
 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
 314 <TR>\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>&nbsp;</TD>\r
 320   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
 321   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
 322   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
 323   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
 324   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
 325   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
 326   </TR>\r
 327 </TABLE>\r
 328 </TD>\r
 329 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
 330 </EM>\r
 331 </TD>\r
 332 </TR>\r
 333 \r
 334 <TR>\r
 335 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 336 &nbsp;<A HREF="../../../../com/sun/speech/freetts/ItemContents.html" title="class in com.sun.speech.freetts"><B>PREV CLASS</B></A>&nbsp;\r
 337 &nbsp;<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>  &nbsp;\r
 340 &nbsp;<A HREF="OutputQueue.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
 341 &nbsp;<SCRIPT type="text/javascript">\r
 342   <!--\r
 343   if(window==top) {\r
 344     document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
 345   }\r
 346   //-->\r
 347 </SCRIPT>\r
 348 <NOSCRIPT>\r
 349   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>\r
 350 </NOSCRIPT>
 351 \r
 352 </FONT></TD>\r
 353 </TR>\r
 354 <TR>\r
 355 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 356   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
 357 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 358 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
 359 </TR>\r
 360 </TABLE>\r
 361 <A NAME="skip-navbar_bottom"></A>
 362 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
 363 \r
 364 <HR>\r
 365 \r
 366 </BODY>\r
 367 </HTML>\r