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
10 <META NAME="keywords" CONTENT="com.sun.speech.freetts.Token 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="Token (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/Segmenter.html" title="class in com.sun.speech.freetts"><B>PREV CLASS</B></A>
\r
53 <A HREF="../../../../com/sun/speech/freetts/Utterance.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="Token.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
89 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by"><B>com.sun.speech.freetts.Token</B>
\r
93 <DT>public class <B>Token</B><DT>extends java.lang.Object</DL>
\r
96 Contains a parsed token from a Tokenizer.
\r
103 <!-- ======== NESTED CLASS SUMMARY ======== -->
\r
106 <!-- =========== FIELD SUMMARY =========== -->
\r
109 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
\r
111 <A NAME="constructor_summary"><!-- --></A>
112 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
113 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
114 <TD COLSPAN=2><FONT SIZE="+2">
\r
115 <B>Constructor Summary</B></FONT></TD>
\r
117 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
118 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Token.html#Token()">Token</A></B>()</CODE>
\r
121 </TD>
\r
125 <!-- ========== METHOD SUMMARY =========== -->
\r
127 <A NAME="method_summary"><!-- --></A>
128 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
129 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
130 <TD COLSPAN=2><FONT SIZE="+2">
\r
131 <B>Method Summary</B></FONT></TD>
\r
133 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
134 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
135 <CODE> int</CODE></FONT></TD>
\r
136 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Token.html#getLineNumber()">getLineNumber</A></B>()</CODE>
\r
139 Returns the line of this token in the original text.</TD>
\r
141 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
142 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
143 <CODE> int</CODE></FONT></TD>
\r
144 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Token.html#getPosition()">getPosition</A></B>()</CODE>
\r
147 Returns the position of this token in the original input text.</TD>
\r
149 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
150 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
151 <CODE> java.lang.String</CODE></FONT></TD>
\r
152 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Token.html#getPostpunctuation()">getPostpunctuation</A></B>()</CODE>
\r
155 Returns the postpunctuation characters of this Token.</TD>
\r
157 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
158 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
159 <CODE> java.lang.String</CODE></FONT></TD>
\r
160 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Token.html#getPrepunctuation()">getPrepunctuation</A></B>()</CODE>
\r
163 Returns the prepunctuation characters of this Token.</TD>
\r
165 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
166 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
167 <CODE> java.lang.String</CODE></FONT></TD>
\r
168 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Token.html#getWhitespace()">getWhitespace</A></B>()</CODE>
\r
171 Returns the whitespace characters of this Token.</TD>
\r
173 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
174 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
175 <CODE> java.lang.String</CODE></FONT></TD>
\r
176 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Token.html#getWord()">getWord</A></B>()</CODE>
\r
179 Returns the string associated with this token.</TD>
\r
181 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
182 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
183 <CODE> void</CODE></FONT></TD>
\r
184 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Token.html#setLineNumber(int)">setLineNumber</A></B>(int lineNumber)</CODE>
\r
187 Set the line of this token in the original text.</TD>
\r
189 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
190 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
191 <CODE> void</CODE></FONT></TD>
\r
192 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Token.html#setPosition(int)">setPosition</A></B>(int position)</CODE>
\r
195 Sets the position of the token in the original input text.</TD>
\r
197 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
198 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
199 <CODE> void</CODE></FONT></TD>
\r
200 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Token.html#setPostpunctuation(java.lang.String)">setPostpunctuation</A></B>(java.lang.String postpunctuation)</CODE>
\r
203 Sets the postpunctuation characters of this Token.</TD>
\r
205 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
206 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
207 <CODE> void</CODE></FONT></TD>
\r
208 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Token.html#setPrepunctuation(java.lang.String)">setPrepunctuation</A></B>(java.lang.String prepunctuation)</CODE>
\r
211 Sets the prepunctuation characters of this Token.</TD>
\r
213 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
214 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
215 <CODE> void</CODE></FONT></TD>
\r
216 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Token.html#setWhitespace(java.lang.String)">setWhitespace</A></B>(java.lang.String whitespace)</CODE>
\r
219 Sets the whitespace characters of this Token.</TD>
\r
221 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
222 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
223 <CODE> void</CODE></FONT></TD>
\r
224 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Token.html#setWord(java.lang.String)">setWord</A></B>(java.lang.String word)</CODE>
\r
227 Sets the string of this Token.</TD>
\r
229 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
230 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
231 <CODE> java.lang.String</CODE></FONT></TD>
\r
232 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Token.html#toString()">toString</A></B>()</CODE>
\r
235 Converts this token to a string.</TD>
\r
238 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
239 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
240 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
\r
241 <TD><B>Methods inherited from class java.lang.Object</B></TD>
\r
243 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
244 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
\r
250 <!-- ============ FIELD DETAIL =========== -->
\r
253 <!-- ========= CONSTRUCTOR DETAIL ======== -->
\r
255 <A NAME="constructor_detail"><!-- --></A>
256 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
257 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
258 <TD COLSPAN=1><FONT SIZE="+2">
\r
259 <B>Constructor Detail</B></FONT></TD>
\r
263 <A NAME="Token()"><!-- --></A><H3>
\r
266 public <B>Token</B>()</PRE>
\r
270 <!-- ============ METHOD DETAIL ========== -->
\r
272 <A NAME="method_detail"><!-- --></A>
273 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
274 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
275 <TD COLSPAN=1><FONT SIZE="+2">
\r
276 <B>Method Detail</B></FONT></TD>
\r
280 <A NAME="getWhitespace()"><!-- --></A><H3>
\r
283 public java.lang.String <B>getWhitespace</B>()</PRE>
\r
285 <DD>Returns the whitespace characters of this Token.
\r
289 <DT><B>Returns:</B><DD>the whitespace characters of this Token;
290 null if this Token does not use whitespace characters</DL>
\r
295 <A NAME="getPrepunctuation()"><!-- --></A><H3>
\r
296 getPrepunctuation</H3>
\r
298 public java.lang.String <B>getPrepunctuation</B>()</PRE>
\r
300 <DD>Returns the prepunctuation characters of this Token.
\r
304 <DT><B>Returns:</B><DD>the prepunctuation characters of this Token;
305 null if this Token does not use prepunctuation characters</DL>
\r
310 <A NAME="getPostpunctuation()"><!-- --></A><H3>
\r
311 getPostpunctuation</H3>
\r
313 public java.lang.String <B>getPostpunctuation</B>()</PRE>
\r
315 <DD>Returns the postpunctuation characters of this Token.
\r
319 <DT><B>Returns:</B><DD>the postpunctuation characters of this Token;
320 null if this Token does not use postpunctuation characters</DL>
\r
325 <A NAME="getPosition()"><!-- --></A><H3>
\r
328 public int <B>getPosition</B>()</PRE>
\r
330 <DD>Returns the position of this token in the original input text.
\r
334 <DT><B>Returns:</B><DD>the position of this token in the original input text</DL>
\r
339 <A NAME="getLineNumber()"><!-- --></A><H3>
\r
342 public int <B>getLineNumber</B>()</PRE>
\r
344 <DD>Returns the line of this token in the original text.
\r
348 <DT><B>Returns:</B><DD>the line of this token in the original text</DL>
\r
353 <A NAME="setWhitespace(java.lang.String)"><!-- --></A><H3>
\r
356 public void <B>setWhitespace</B>(java.lang.String whitespace)</PRE>
\r
358 <DD>Sets the whitespace characters of this Token.
\r
361 <DT><B>Parameters:</B><DD><CODE>whitespace</CODE> - the whitespace character for this token</DL>
\r
366 <A NAME="setPrepunctuation(java.lang.String)"><!-- --></A><H3>
\r
367 setPrepunctuation</H3>
\r
369 public void <B>setPrepunctuation</B>(java.lang.String prepunctuation)</PRE>
\r
371 <DD>Sets the prepunctuation characters of this Token.
\r
374 <DT><B>Parameters:</B><DD><CODE>prepunctuation</CODE> - the prepunctuation characters</DL>
\r
379 <A NAME="setPostpunctuation(java.lang.String)"><!-- --></A><H3>
\r
380 setPostpunctuation</H3>
\r
382 public void <B>setPostpunctuation</B>(java.lang.String postpunctuation)</PRE>
\r
384 <DD>Sets the postpunctuation characters of this Token.
\r
387 <DT><B>Parameters:</B><DD><CODE>postpunctuation</CODE> - the postpunctuation characters</DL>
\r
392 <A NAME="setPosition(int)"><!-- --></A><H3>
\r
395 public void <B>setPosition</B>(int position)</PRE>
\r
397 <DD>Sets the position of the token in the original input text.
\r
400 <DT><B>Parameters:</B><DD><CODE>position</CODE> - the position of the input text</DL>
\r
405 <A NAME="setLineNumber(int)"><!-- --></A><H3>
\r
408 public void <B>setLineNumber</B>(int lineNumber)</PRE>
\r
410 <DD>Set the line of this token in the original text.
\r
413 <DT><B>Parameters:</B><DD><CODE>lineNumber</CODE> - the line of this token in the original text</DL>
\r
418 <A NAME="getWord()"><!-- --></A><H3>
\r
421 public java.lang.String <B>getWord</B>()</PRE>
\r
423 <DD>Returns the string associated with this token.
\r
427 <DT><B>Returns:</B><DD>the token if it exists; otherwise null</DL>
\r
432 <A NAME="setWord(java.lang.String)"><!-- --></A><H3>
\r
435 public void <B>setWord</B>(java.lang.String word)</PRE>
\r
437 <DD>Sets the string of this Token.
\r
440 <DT><B>Parameters:</B><DD><CODE>word</CODE> - the word for this token</DL>
\r
445 <A NAME="toString()"><!-- --></A><H3>
\r
448 public java.lang.String <B>toString</B>()</PRE>
\r
450 <DD>Converts this token to a string.
\r
454 <DT><B>Returns:</B><DD>the string representation of this object</DL>
\r
457 <!-- ========= END OF CLASS DATA ========= -->
\r
461 <!-- ======= START OF BOTTOM NAVBAR ====== -->
\r
462 <A NAME="navbar_bottom"><!-- --></A>
463 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
464 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
\r
466 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
\r
467 <A NAME="navbar_bottom_firstrow"><!-- --></A>
468 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
\r
469 <TR ALIGN="center" VALIGN="top">
\r
470 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
\r
471 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
472 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
473 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
474 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
475 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
476 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
480 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
486 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
487 <A HREF="../../../../com/sun/speech/freetts/Segmenter.html" title="class in com.sun.speech.freetts"><B>PREV CLASS</B></A>
\r
488 <A HREF="../../../../com/sun/speech/freetts/Utterance.html" title="class in com.sun.speech.freetts"><B>NEXT CLASS</B></A></FONT></TD>
\r
489 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
490 <A HREF="../../../../index.html" target="_top"><B>FRAMES</B></A>
\r
491 <A HREF="Token.html" target="_top"><B>NO FRAMES</B></A>
\r
492 <SCRIPT type="text/javascript">
\r
495 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
500 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
\r
506 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
507 SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
508 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
509 DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
512 <A NAME="skip-navbar_bottom"></A>
513 <!-- ======== END OF BOTTOM NAVBAR ======= -->
\r
projects / debian / freetts / blob