upstream version 1.2.2
[debian/freetts] / javadoc / com / sun / speech / freetts / Gender.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 Gender (FreeTTS 1.2)\r
8 </TITLE>\r
9 \r
10 <META NAME="keywords" CONTENT="com.sun.speech.freetts.Gender 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="Gender (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/FreeTTSTime.html" title="class in com.sun.speech.freetts"><B>PREV CLASS</B></A>&nbsp;\r
53 &nbsp;<A HREF="../../../../com/sun/speech/freetts/InputMode.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="Gender.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;CONSTR&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;CONSTR&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 Gender</H2>\r
87 <PRE>\r
88 java.lang.Object\r
89   <IMG SRC="../../../../resources/inherit.gif" ALT="extended by"><B>com.sun.speech.freetts.Gender</B>\r
90 </PRE>\r
91 <DL>\r
92 <DT><B>All Implemented Interfaces:</B> <DD>java.lang.Comparable</DD>\r
93 </DL>\r
94 <HR>\r
95 <DL>\r
96 <DT>public class <B>Gender</B><DT>extends java.lang.Object<DT>implements java.lang.Comparable</DL>\r
97 \r
98 <P>\r
99 Provides an enumeration of Gender, following the JSAPI style.
100  (http://java.sun.com/products/java-media/speech/forDevelopers/jsapi-doc/)
101
102  These are intended for use to define properties about FreeTTS
103  voices.\r
104 <P>\r
105 \r
106 <P>\r
107 <DL>\r
108 <DT><B>See Also:</B><DD><A HREF="../../../../com/sun/speech/freetts/Voice.html" title="class in com.sun.speech.freetts"><CODE>Voice</CODE></A></DL>\r
109 <HR>\r
110 \r
111 <P>\r
112 <!-- ======== NESTED CLASS SUMMARY ======== -->\r
113 \r
114 \r
115 <!-- =========== FIELD SUMMARY =========== -->\r
116 \r
117 <A NAME="field_summary"><!-- --></A>
118 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
119 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
120 <TD COLSPAN=2><FONT SIZE="+2">\r
121 <B>Field Summary</B></FONT></TD>\r
122 </TR>\r
123 <TR BGCOLOR="white" CLASS="TableRowColor">\r
124 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
125 <CODE>static&nbsp;<A HREF="../../../../com/sun/speech/freetts/Gender.html" title="class in com.sun.speech.freetts">Gender</A></CODE></FONT></TD>\r
126 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Gender.html#DONT_CARE">DONT_CARE</A></B></CODE>\r
127 \r
128 <BR>\r
129 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Match against all other genders.</TD>\r
130 </TR>\r
131 <TR BGCOLOR="white" CLASS="TableRowColor">\r
132 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
133 <CODE>static&nbsp;<A HREF="../../../../com/sun/speech/freetts/Gender.html" title="class in com.sun.speech.freetts">Gender</A></CODE></FONT></TD>\r
134 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Gender.html#FEMALE">FEMALE</A></B></CODE>\r
135 \r
136 <BR>\r
137 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Female.</TD>\r
138 </TR>\r
139 <TR BGCOLOR="white" CLASS="TableRowColor">\r
140 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
141 <CODE>static&nbsp;<A HREF="../../../../com/sun/speech/freetts/Gender.html" title="class in com.sun.speech.freetts">Gender</A></CODE></FONT></TD>\r
142 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Gender.html#MALE">MALE</A></B></CODE>\r
143 \r
144 <BR>\r
145 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Male.</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>static&nbsp;<A HREF="../../../../com/sun/speech/freetts/Gender.html" title="class in com.sun.speech.freetts">Gender</A></CODE></FONT></TD>\r
150 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Gender.html#NEUTRAL">NEUTRAL</A></B></CODE>\r
151 \r
152 <BR>\r
153 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Neutral such as a robot or artificial.</TD>\r
154 </TR>\r
155 </TABLE>\r
156 &nbsp;\r
157 <!-- ======== CONSTRUCTOR SUMMARY ======== -->\r
158 \r
159 \r
160 <!-- ========== METHOD SUMMARY =========== -->\r
161 \r
162 <A NAME="method_summary"><!-- --></A>
163 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
164 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
165 <TD COLSPAN=2><FONT SIZE="+2">\r
166 <B>Method Summary</B></FONT></TD>\r
167 </TR>\r
168 <TR BGCOLOR="white" CLASS="TableRowColor">\r
169 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
170 <CODE>&nbsp;int</CODE></FONT></TD>\r
171 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Gender.html#compareTo(java.lang.Object)">compareTo</A></B>(java.lang.Object&nbsp;o)</CODE>\r
172 \r
173 <BR>\r
174 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Compare two genders.  </TD>\r
175 </TR>\r
176 <TR BGCOLOR="white" CLASS="TableRowColor">\r
177 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
178 <CODE>&nbsp;java.lang.String</CODE></FONT></TD>\r
179 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Gender.html#toString()">toString</A></B>()</CODE>\r
180 \r
181 <BR>\r
182 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Generates a human readable name describing the gender.</TD>\r
183 </TR>\r
184 </TABLE>\r
185 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
186 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
187 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
188 <TD><B>Methods inherited from class java.lang.Object</B></TD>\r
189 </TR>\r
190 <TR BGCOLOR="white" CLASS="TableRowColor">\r
191 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>\r
192 </TR>\r
193 </TABLE>\r
194 &nbsp;\r
195 <P>\r
196 \r
197 <!-- ============ FIELD DETAIL =========== -->\r
198 \r
199 <A NAME="field_detail"><!-- --></A>
200 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
201 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
202 <TD COLSPAN=1><FONT SIZE="+2">\r
203 <B>Field Detail</B></FONT></TD>\r
204 </TR>\r
205 </TABLE>\r
206 \r
207 <A NAME="MALE"><!-- --></A><H3>\r
208 MALE</H3>\r
209 <PRE>\r
210 public static final <A HREF="../../../../com/sun/speech/freetts/Gender.html" title="class in com.sun.speech.freetts">Gender</A> <B>MALE</B></PRE>\r
211 <DL>\r
212 <DD>Male.\r
213 <P>\r
214 <DL>\r
215 </DL>\r
216 </DL>\r
217 <HR>\r
218 \r
219 <A NAME="FEMALE"><!-- --></A><H3>\r
220 FEMALE</H3>\r
221 <PRE>\r
222 public static final <A HREF="../../../../com/sun/speech/freetts/Gender.html" title="class in com.sun.speech.freetts">Gender</A> <B>FEMALE</B></PRE>\r
223 <DL>\r
224 <DD>Female.\r
225 <P>\r
226 <DL>\r
227 </DL>\r
228 </DL>\r
229 <HR>\r
230 \r
231 <A NAME="NEUTRAL"><!-- --></A><H3>\r
232 NEUTRAL</H3>\r
233 <PRE>\r
234 public static final <A HREF="../../../../com/sun/speech/freetts/Gender.html" title="class in com.sun.speech.freetts">Gender</A> <B>NEUTRAL</B></PRE>\r
235 <DL>\r
236 <DD>Neutral such as a robot or artificial.\r
237 <P>\r
238 <DL>\r
239 </DL>\r
240 </DL>\r
241 <HR>\r
242 \r
243 <A NAME="DONT_CARE"><!-- --></A><H3>\r
244 DONT_CARE</H3>\r
245 <PRE>\r
246 public static final <A HREF="../../../../com/sun/speech/freetts/Gender.html" title="class in com.sun.speech.freetts">Gender</A> <B>DONT_CARE</B></PRE>\r
247 <DL>\r
248 <DD>Match against all other genders.\r
249 <P>\r
250 <DL>\r
251 </DL>\r
252 </DL>\r
253 \r
254 <!-- ========= CONSTRUCTOR DETAIL ======== -->\r
255 \r
256 \r
257 <!-- ============ METHOD DETAIL ========== -->\r
258 \r
259 <A NAME="method_detail"><!-- --></A>
260 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
261 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
262 <TD COLSPAN=1><FONT SIZE="+2">\r
263 <B>Method Detail</B></FONT></TD>\r
264 </TR>\r
265 </TABLE>\r
266 \r
267 <A NAME="toString()"><!-- --></A><H3>\r
268 toString</H3>\r
269 <PRE>\r
270 public java.lang.String <B>toString</B>()</PRE>\r
271 <DL>\r
272 <DD>Generates a human readable name describing the gender.\r
273 <P>\r
274 <DD><DL>\r
275 </DL>\r
276 </DD>\r
277 <DD><DL>\r
278
279 <DT><B>Returns:</B><DD>the name of the gender</DL>\r
280 </DD>\r
281 </DL>\r
282 <HR>\r
283 \r
284 <A NAME="compareTo(java.lang.Object)"><!-- --></A><H3>\r
285 compareTo</H3>\r
286 <PRE>\r
287 public int <B>compareTo</B>(java.lang.Object&nbsp;o)</PRE>\r
288 <DL>\r
289 <DD>Compare two genders.  If either is DONT_CARE, then returns 0.\r
290 <P>\r
291 <DD><DL>\r
292 <DT><B>Specified by:</B><DD><CODE>compareTo</CODE> in interface <CODE>java.lang.Comparable</CODE></DL>\r
293 </DD>\r
294 <DD><DL>\r
295 </DL>\r
296 </DD>\r
297 </DL>\r
298 <!-- ========= END OF CLASS DATA ========= -->\r
299 <HR>\r
300 \r
301
302 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
303 <A NAME="navbar_bottom"><!-- --></A>
304 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
305 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
306 <TR>\r
307 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
308 <A NAME="navbar_bottom_firstrow"><!-- --></A>
309 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
310   <TR ALIGN="center" VALIGN="top">\r
311   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
312   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
313   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
314   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
315   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
316   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
317   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
318   </TR>\r
319 </TABLE>\r
320 </TD>\r
321 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
322 </EM>\r
323 </TD>\r
324 </TR>\r
325 \r
326 <TR>\r
327 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
328 &nbsp;<A HREF="../../../../com/sun/speech/freetts/FreeTTSTime.html" title="class in com.sun.speech.freetts"><B>PREV CLASS</B></A>&nbsp;\r
329 &nbsp;<A HREF="../../../../com/sun/speech/freetts/InputMode.html" title="class in com.sun.speech.freetts"><B>NEXT CLASS</B></A></FONT></TD>\r
330 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
331   <A HREF="../../../../index.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
332 &nbsp;<A HREF="Gender.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
333 &nbsp;<SCRIPT type="text/javascript">\r
334   <!--\r
335   if(window==top) {\r
336     document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
337   }\r
338   //-->\r
339 </SCRIPT>\r
340 <NOSCRIPT>\r
341   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>\r
342 </NOSCRIPT>
343 \r
344 </FONT></TD>\r
345 </TR>\r
346 <TR>\r
347 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
348   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
349 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
350 DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
351 </TR>\r
352 </TABLE>\r
353 <A NAME="skip-navbar_bottom"></A>
354 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
355 \r
356 <HR>\r
357 \r
358 </BODY>\r
359 </HTML>\r