source: release-kits/lirk3/resources/gs3-release-maker/ant/docs/manual/api/org/apache/tools/ant/types/EnumeratedAttribute.html@ 14982

Last change on this file since 14982 was 14982, checked in by oranfry, 16 years ago

initial import of LiRK3
File size: 26.8 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!--NewPage-->
3<HTML>
4<HEAD>
5<!-- Generated by javadoc (build 1.4.2_13) on Mon Oct 01 14:33:32 NZST 2007 -->
6<TITLE>
7EnumeratedAttribute (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.types.EnumeratedAttribute class">
11
12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
13
14<SCRIPT type="text/javascript">
15function windowTitle()
16{
17 parent.document.title="EnumeratedAttribute (Apache Ant API)";
18}
19</SCRIPT>
20
21</HEAD>
22
23<BODY BGCOLOR="white" onload="windowTitle();">
24
25
26<!-- ========= START OF TOP NAVBAR ======= -->
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="">
30<TR>
31<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
32<A NAME="navbar_top_firstrow"><!-- --></A>
33<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
34 <TR ALIGN="center" VALIGN="top">
35 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
36 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
37 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
39 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
42 </TR>
43</TABLE>
44</TD>
45<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
46</EM>
47</TD>
48</TR>
49
50<TR>
51<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
52&nbsp;<A HREF="../../../../../org/apache/tools/ant/types/DTDLocation.html" title="class in org.apache.tools.ant.types"><B>PREV CLASS</B></A>&nbsp;
53&nbsp;<A HREF="../../../../../org/apache/tools/ant/types/Environment.html" title="class in org.apache.tools.ant.types"><B>NEXT CLASS</B></A></FONT></TD>
54<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
55 <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
56&nbsp;<A HREF="EnumeratedAttribute.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
57&nbsp;<SCRIPT type="text/javascript">
58 <!--
59 if(window==top) {
60 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
61 }
62 //-->
63</SCRIPT>
64<NOSCRIPT>
65 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
66</NOSCRIPT>
67
68</FONT></TD>
69</TR>
70<TR>
71<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
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>
73<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
74DETAIL:&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>
75</TR>
76</TABLE>
77<A NAME="skip-navbar_top"></A>
78<!-- ========= END OF TOP NAVBAR ========= -->
79
80<HR>
81<!-- ======== START OF CLASS DATA ======== -->
82<H2>
83<FONT SIZE="-1">
84org.apache.tools.ant.types</FONT>
85<BR>
86Class EnumeratedAttribute</H2>
87<PRE>
88java.lang.Object
89 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.types.EnumeratedAttribute</B>
90</PRE>
91<DL>
92<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../org/apache/tools/ant/taskdefs/optional/junit/AggregateTransformer.Format.html" title="class in org.apache.tools.ant.taskdefs.optional.junit">AggregateTransformer.Format</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/Available.FileDir.html" title="class in org.apache.tools.ant.taskdefs">Available.FileDir</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/optional/sitraka/Coverage.Finalsnapshot.html" title="class in org.apache.tools.ant.taskdefs.optional.sitraka">Coverage.Finalsnapshot</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/optional/sitraka/Coverage.Javavm.html" title="class in org.apache.tools.ant.taskdefs.optional.sitraka">Coverage.Javavm</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/optional/sitraka/Coverage.Recordfromstart.html" title="class in org.apache.tools.ant.taskdefs.optional.sitraka">Coverage.Recordfromstart</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/optional/sitraka/CovReport.ReportFormat.html" title="class in org.apache.tools.ant.taskdefs.optional.sitraka">CovReport.ReportFormat</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/optional/sitraka/CovReport.ReportType.html" title="class in org.apache.tools.ant.taskdefs.optional.sitraka">CovReport.ReportType</A>, <A HREF="../../../../../org/apache/tools/ant/types/selectors/DateSelector.TimeComparisons.html" title="class in org.apache.tools.ant.types.selectors">DateSelector.TimeComparisons</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/Definer.Format.html" title="class in org.apache.tools.ant.taskdefs">Definer.Format</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/Definer.OnError.html" title="class in org.apache.tools.ant.taskdefs">Definer.OnError</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/optional/dotnet/DotnetCompile.TargetTypes.html" title="class in org.apache.tools.ant.taskdefs.optional.dotnet">DotnetCompile.TargetTypes</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/Echo.EchoLevel.html" title="class in org.apache.tools.ant.taskdefs">Echo.EchoLevel</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/optional/EchoProperties.FormatAttribute.html" title="class in org.apache.tools.ant.taskdefs.optional">EchoProperties.FormatAttribute</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/optional/ejb/EjbJar.CMPVersion.html" title="class in org.apache.tools.ant.taskdefs.optional.ejb">EjbJar.CMPVersion</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/optional/ejb/EjbJar.NamingScheme.html" title="class in org.apache.tools.ant.taskdefs.optional.ejb">EjbJar.NamingScheme</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/email/EmailTask.Encoding.html" title="class in org.apache.tools.ant.taskdefs.email">EmailTask.Encoding</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/ExecuteOn.FileDirBoth.html" title="class in org.apache.tools.ant.taskdefs">ExecuteOn.FileDirBoth</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/FixCRLF.AddAsisRemove.html" title="class in org.apache.tools.ant.taskdefs">FixCRLF.AddAsisRemove</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/FixCRLF.CrLf.html" title="class in org.apache.tools.ant.taskdefs">FixCRLF.CrLf</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/optional/junit/FormatterElement.TypeAttribute.html" title="class in org.apache.tools.ant.taskdefs.optional.junit">FormatterElement.TypeAttribute</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.Action.html" title="class in org.apache.tools.ant.taskdefs.optional.net">FTP.Action</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/optional/dotnet/Ilasm.TargetTypes.html" title="class in org.apache.tools.ant.taskdefs.optional.dotnet">Ilasm.TargetTypes</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/optional/dotnet/Ildasm.EncodingTypes.html" title="class in org.apache.tools.ant.taskdefs.optional.dotnet">Ildasm.EncodingTypes</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/optional/dotnet/Ildasm.VisibilityOptions.html" title="class in org.apache.tools.ant.taskdefs.optional.dotnet">Ildasm.VisibilityOptions</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/Jar.FilesetManifestConfig.html" title="class in org.apache.tools.ant.taskdefs">Jar.FilesetManifestConfig</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.AccessType.html" title="class in org.apache.tools.ant.taskdefs">Javadoc.AccessType</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/optional/jdepend/JDependTask.FormatAttribute.html" title="class in org.apache.tools.ant.taskdefs.optional.jdepend">JDependTask.FormatAttribute</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/optional/junit/JUnitTask.ForkMode.html" title="class in org.apache.tools.ant.taskdefs.optional.junit">JUnitTask.ForkMode</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/optional/junit/JUnitTask.SummaryAttribute.html" title="class in org.apache.tools.ant.taskdefs.optional.junit">JUnitTask.SummaryAttribute</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/Length.FileMode.html" title="class in org.apache.tools.ant.taskdefs">Length.FileMode</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/Length.When.html" title="class in org.apache.tools.ant.taskdefs">Length.When</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/ManifestTask.Mode.html" title="class in org.apache.tools.ant.taskdefs">ManifestTask.Mode</A>, <A HREF="../../../../../org/apache/tools/ant/types/Mapper.MapperType.html" title="class in org.apache.tools.ant.types">Mapper.MapperType</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/optional/metamata/MMetrics.GranularityAttribute.html" title="class in org.apache.tools.ant.taskdefs.optional.metamata">MMetrics.GranularityAttribute</A>, <A HREF="../../../../../org/apache/tools/ant/types/selectors/modifiedselector/ModifiedSelector.AlgorithmName.html" title="class in org.apache.tools.ant.types.selectors.modifiedselector">ModifiedSelector.AlgorithmName</A>, <A HREF="../../../../../org/apache/tools/ant/types/selectors/modifiedselector/ModifiedSelector.CacheName.html" title="class in org.apache.tools.ant.types.selectors.modifiedselector">ModifiedSelector.CacheName</A>, <A HREF="../../../../../org/apache/tools/ant/types/selectors/modifiedselector/ModifiedSelector.ComparatorName.html" title="class in org.apache.tools.ant.types.selectors.modifiedselector">ModifiedSelector.ComparatorName</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/optional/vss/MSVSS.CurrentModUpdated.html" title="class in org.apache.tools.ant.taskdefs.optional.vss">MSVSS.CurrentModUpdated</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/optional/vss/MSVSS.WritableFiles.html" title="class in org.apache.tools.ant.taskdefs.optional.vss">MSVSS.WritableFiles</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/optional/vss/MSVSSHISTORY.BriefCodediffNofile.html" title="class in org.apache.tools.ant.taskdefs.optional.vss">MSVSSHISTORY.BriefCodediffNofile</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/optional/NetRexxC.TraceAttr.html" title="class in org.apache.tools.ant.taskdefs.optional">NetRexxC.TraceAttr</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/optional/NetRexxC.VerboseAttr.html" title="class in org.apache.tools.ant.taskdefs.optional">NetRexxC.VerboseAttr</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/PathConvert.TargetOs.html" title="class in org.apache.tools.ant.taskdefs">PathConvert.TargetOs</A>, <A HREF="../../../../../org/apache/tools/ant/types/selectors/PresentSelector.FilePresence.html" title="class in org.apache.tools.ant.types.selectors">PresentSelector.FilePresence</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/optional/PropertyFile.Entry.Operation.html" title="class in org.apache.tools.ant.taskdefs.optional">PropertyFile.Entry.Operation</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/optional/PropertyFile.Entry.Type.html" title="class in org.apache.tools.ant.taskdefs.optional">PropertyFile.Entry.Type</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/optional/PropertyFile.Unit.html" title="class in org.apache.tools.ant.taskdefs.optional">PropertyFile.Unit</A>, <A HREF="../../../../../org/apache/tools/ant/types/PropertySet.BuiltinPropertySetName.html" title="class in org.apache.tools.ant.types">PropertySet.BuiltinPropertySetName</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/Recorder.ActionChoices.html" title="class in org.apache.tools.ant.taskdefs">Recorder.ActionChoices</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/Recorder.VerbosityLevelChoices.html" title="class in org.apache.tools.ant.taskdefs">Recorder.VerbosityLevelChoices</A>, <A HREF="../../../../../org/apache/tools/ant/types/optional/image/Scale.ProportionsAttribute.html" title="class in org.apache.tools.ant.types.optional.image">Scale.ProportionsAttribute</A>, <A HREF="../../../../../org/apache/tools/ant/types/selectors/SizeSelector.ByteUnits.html" title="class in org.apache.tools.ant.types.selectors">SizeSelector.ByteUnits</A>, <A HREF="../../../../../org/apache/tools/ant/types/selectors/SizeSelector.SizeComparisons.html" title="class in org.apache.tools.ant.types.selectors">SizeSelector.SizeComparisons</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/SQLExec.DelimiterType.html" title="class in org.apache.tools.ant.taskdefs">SQLExec.DelimiterType</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/SQLExec.OnError.html" title="class in org.apache.tools.ant.taskdefs">SQLExec.OnError</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/Tar.TarCompressionMethod.html" title="class in org.apache.tools.ant.taskdefs">Tar.TarCompressionMethod</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/Tar.TarLongFileMode.html" title="class in org.apache.tools.ant.taskdefs">Tar.TarLongFileMode</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/Tstamp.Unit.html" title="class in org.apache.tools.ant.taskdefs">Tstamp.Unit</A>, <A HREF="../../../../../org/apache/tools/ant/types/selectors/TypeSelector.FileType.html" title="class in org.apache.tools.ant.types.selectors">TypeSelector.FileType</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/Untar.UntarCompressionMethod.html" title="class in org.apache.tools.ant.taskdefs">Untar.UntarCompressionMethod</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/WaitFor.Unit.html" title="class in org.apache.tools.ant.taskdefs">WaitFor.Unit</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/optional/ejb/WebsphereDeploymentTool.DBVendor.html" title="class in org.apache.tools.ant.taskdefs.optional.ejb">WebsphereDeploymentTool.DBVendor</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/Zip.Duplicate.html" title="class in org.apache.tools.ant.taskdefs">Zip.Duplicate</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/Zip.WhenEmpty.html" title="class in org.apache.tools.ant.taskdefs">Zip.WhenEmpty</A></DD>
93</DL>
94<HR>
95<DL>
96<DT>public abstract class <B>EnumeratedAttribute</B><DT>extends java.lang.Object</DL>
97
98<P>
99Helper class for attributes that can only take one of a fixed list
100 of values.
101
102 <p>See <A HREF="../../../../../org/apache/tools/ant/taskdefs/FixCRLF.html" title="class in org.apache.tools.ant.taskdefs"><CODE>FixCRLF</CODE></A> for an
103 example.
104<P>
105
106<P>
107<HR>
108
109<P>
110<!-- ======== NESTED CLASS SUMMARY ======== -->
111
112
113<!-- =========== FIELD SUMMARY =========== -->
114
115<A NAME="field_summary"><!-- --></A>
116<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
117<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
118<TD COLSPAN=2><FONT SIZE="+2">
119<B>Field Summary</B></FONT></TD>
120</TR>
121<TR BGCOLOR="white" CLASS="TableRowColor">
122<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
123<CODE>protected &nbsp;java.lang.String</CODE></FONT></TD>
124<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/EnumeratedAttribute.html#value">value</A></B></CODE>
125
126<BR>
127&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The selected value in this enumeration.</TD>
128</TR>
129</TABLE>
130&nbsp;
131<!-- ======== CONSTRUCTOR SUMMARY ======== -->
132
133<A NAME="constructor_summary"><!-- --></A>
134<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
135<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
136<TD COLSPAN=2><FONT SIZE="+2">
137<B>Constructor Summary</B></FONT></TD>
138</TR>
139<TR BGCOLOR="white" CLASS="TableRowColor">
140<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
141<CODE>protected </CODE></FONT></TD>
142<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/EnumeratedAttribute.html#EnumeratedAttribute()">EnumeratedAttribute</A></B>()</CODE>
143
144<BR>
145&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;bean constructor</TD>
146</TR>
147</TABLE>
148&nbsp;
149<!-- ========== METHOD SUMMARY =========== -->
150
151<A NAME="method_summary"><!-- --></A>
152<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
153<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
154<TD COLSPAN=2><FONT SIZE="+2">
155<B>Method Summary</B></FONT></TD>
156</TR>
157<TR BGCOLOR="white" CLASS="TableRowColor">
158<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
159<CODE>&nbsp;boolean</CODE></FONT></TD>
160<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/EnumeratedAttribute.html#containsValue(java.lang.String)">containsValue</A></B>(java.lang.String&nbsp;value)</CODE>
161
162<BR>
163&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Is this value included in the enumeration?</TD>
164</TR>
165<TR BGCOLOR="white" CLASS="TableRowColor">
166<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
167<CODE>&nbsp;int</CODE></FONT></TD>
168<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/EnumeratedAttribute.html#getIndex()">getIndex</A></B>()</CODE>
169
170<BR>
171&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
172</TR>
173<TR BGCOLOR="white" CLASS="TableRowColor">
174<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
175<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
176<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/EnumeratedAttribute.html#getValue()">getValue</A></B>()</CODE>
177
178<BR>
179&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
180</TR>
181<TR BGCOLOR="white" CLASS="TableRowColor">
182<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
183<CODE>abstract &nbsp;java.lang.String[]</CODE></FONT></TD>
184<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/EnumeratedAttribute.html#getValues()">getValues</A></B>()</CODE>
185
186<BR>
187&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This is the only method a subclass needs to implement.</TD>
188</TR>
189<TR BGCOLOR="white" CLASS="TableRowColor">
190<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
191<CODE>&nbsp;int</CODE></FONT></TD>
192<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/EnumeratedAttribute.html#indexOfValue(java.lang.String)">indexOfValue</A></B>(java.lang.String&nbsp;value)</CODE>
193
194<BR>
195&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;get the index of a value in this enumeration.</TD>
196</TR>
197<TR BGCOLOR="white" CLASS="TableRowColor">
198<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
199<CODE>&nbsp;void</CODE></FONT></TD>
200<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/EnumeratedAttribute.html#setValue(java.lang.String)">setValue</A></B>(java.lang.String&nbsp;value)</CODE>
201
202<BR>
203&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Invoked by <A HREF="../../../../../org/apache/tools/ant/IntrospectionHelper.html" title="class in org.apache.tools.ant"><CODE>IntrospectionHelper</CODE></A>.</TD>
204</TR>
205<TR BGCOLOR="white" CLASS="TableRowColor">
206<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
207<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
208<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/EnumeratedAttribute.html#toString()">toString</A></B>()</CODE>
209
210<BR>
211&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Convert the value to its string form.</TD>
212</TR>
213</TABLE>
214&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
215<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
216<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
217<TD><B>Methods inherited from class java.lang.Object</B></TD>
218</TR>
219<TR BGCOLOR="white" CLASS="TableRowColor">
220<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
221</TR>
222</TABLE>
223&nbsp;
224<P>
225
226<!-- ============ FIELD DETAIL =========== -->
227
228<A NAME="field_detail"><!-- --></A>
229<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
230<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
231<TD COLSPAN=1><FONT SIZE="+2">
232<B>Field Detail</B></FONT></TD>
233</TR>
234</TABLE>
235
236<A NAME="value"><!-- --></A><H3>
237value</H3>
238<PRE>
239protected java.lang.String <B>value</B></PRE>
240<DL>
241<DD>The selected value in this enumeration.
242<P>
243<DL>
244</DL>
245</DL>
246
247<!-- ========= CONSTRUCTOR DETAIL ======== -->
248
249<A NAME="constructor_detail"><!-- --></A>
250<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
251<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
252<TD COLSPAN=1><FONT SIZE="+2">
253<B>Constructor Detail</B></FONT></TD>
254</TR>
255</TABLE>
256
257<A NAME="EnumeratedAttribute()"><!-- --></A><H3>
258EnumeratedAttribute</H3>
259<PRE>
260protected <B>EnumeratedAttribute</B>()</PRE>
261<DL>
262<DD>bean constructor
263<P>
264</DL>
265
266<!-- ============ METHOD DETAIL ========== -->
267
268<A NAME="method_detail"><!-- --></A>
269<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
270<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
271<TD COLSPAN=1><FONT SIZE="+2">
272<B>Method Detail</B></FONT></TD>
273</TR>
274</TABLE>
275
276<A NAME="getValues()"><!-- --></A><H3>
277getValues</H3>
278<PRE>
279public abstract java.lang.String[] <B>getValues</B>()</PRE>
280<DL>
281<DD>This is the only method a subclass needs to implement.
282<P>
283<DD><DL>
284
285<DT><B>Returns:</B><DD>an array holding all possible values of the enumeration.
286 The order of elements must be fixed so that <tt>indexOfValue(String)</tt>
287 always return the same index for the same value.</DL>
288</DD>
289</DL>
290<HR>
291
292<A NAME="setValue(java.lang.String)"><!-- --></A><H3>
293setValue</H3>
294<PRE>
295public final void <B>setValue</B>(java.lang.String&nbsp;value)
296 throws <A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
297<DL>
298<DD>Invoked by <A HREF="../../../../../org/apache/tools/ant/IntrospectionHelper.html" title="class in org.apache.tools.ant"><CODE>IntrospectionHelper</CODE></A>.
299<P>
300<DD><DL>
301
302<DT><B>Throws:</B>
303<DD><CODE><A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE></DL>
304</DD>
305</DL>
306<HR>
307
308<A NAME="containsValue(java.lang.String)"><!-- --></A><H3>
309containsValue</H3>
310<PRE>
311public final boolean <B>containsValue</B>(java.lang.String&nbsp;value)</PRE>
312<DL>
313<DD>Is this value included in the enumeration?
314<P>
315<DD><DL>
316</DL>
317</DD>
318</DL>
319<HR>
320
321<A NAME="indexOfValue(java.lang.String)"><!-- --></A><H3>
322indexOfValue</H3>
323<PRE>
324public final int <B>indexOfValue</B>(java.lang.String&nbsp;value)</PRE>
325<DL>
326<DD>get the index of a value in this enumeration.
327<P>
328<DD><DL>
329<DT><B>Parameters:</B><DD><CODE>value</CODE> - the string value to look for.
330<DT><B>Returns:</B><DD>the index of the value in the array of strings
331 or -1 if it cannot be found.<DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/tools/ant/types/EnumeratedAttribute.html#getValues()"><CODE>getValues()</CODE></A></DL>
332</DD>
333</DL>
334<HR>
335
336<A NAME="getValue()"><!-- --></A><H3>
337getValue</H3>
338<PRE>
339public final java.lang.String <B>getValue</B>()</PRE>
340<DL>
341<DD><DL>
342
343<DT><B>Returns:</B><DD>the selected value.</DL>
344</DD>
345</DL>
346<HR>
347
348<A NAME="getIndex()"><!-- --></A><H3>
349getIndex</H3>
350<PRE>
351public final int <B>getIndex</B>()</PRE>
352<DL>
353<DD><DL>
354
355<DT><B>Returns:</B><DD>the index of the selected value in the array.<DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/tools/ant/types/EnumeratedAttribute.html#getValues()"><CODE>getValues()</CODE></A></DL>
356</DD>
357</DL>
358<HR>
359
360<A NAME="toString()"><!-- --></A><H3>
361toString</H3>
362<PRE>
363public java.lang.String <B>toString</B>()</PRE>
364<DL>
365<DD>Convert the value to its string form.
366<P>
367<DD><DL>
368
369<DT><B>Returns:</B><DD>the string form of the value.</DL>
370</DD>
371</DL>
372<!-- ========= END OF CLASS DATA ========= -->
373<HR>
374
375
376<!-- ======= START OF BOTTOM NAVBAR ====== -->
377<A NAME="navbar_bottom"><!-- --></A>
378<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
379<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
380<TR>
381<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
382<A NAME="navbar_bottom_firstrow"><!-- --></A>
383<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
384 <TR ALIGN="center" VALIGN="top">
385 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
386 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
387 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
388 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
389 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
390 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
391 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
392 </TR>
393</TABLE>
394</TD>
395<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
396</EM>
397</TD>
398</TR>
399
400<TR>
401<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
402&nbsp;<A HREF="../../../../../org/apache/tools/ant/types/DTDLocation.html" title="class in org.apache.tools.ant.types"><B>PREV CLASS</B></A>&nbsp;
403&nbsp;<A HREF="../../../../../org/apache/tools/ant/types/Environment.html" title="class in org.apache.tools.ant.types"><B>NEXT CLASS</B></A></FONT></TD>
404<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
405 <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
406&nbsp;<A HREF="EnumeratedAttribute.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
407&nbsp;<SCRIPT type="text/javascript">
408 <!--
409 if(window==top) {
410 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
411 }
412 //-->
413</SCRIPT>
414<NOSCRIPT>
415 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
416</NOSCRIPT>
417
418</FONT></TD>
419</TR>
420<TR>
421<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
422 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>
423<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
424DETAIL:&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>
425</TR>
426</TABLE>
427<A NAME="skip-navbar_bottom"></A>
428<!-- ======== END OF BOTTOM NAVBAR ======= -->
429
430<HR>
431Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
432</BODY>
433</HTML>
Note: See TracBrowser for help on using the repository browser.