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

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

initial import of LiRK3
File size: 30.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>
7DataType (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.types.DataType 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="DataType (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/CommandlineJava.SysProperties.html" title="class in org.apache.tools.ant.types"><B>PREV CLASS</B></A>&nbsp;
53&nbsp;<A HREF="../../../../../org/apache/tools/ant/types/Description.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="DataType.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 DataType</H2>
87<PRE>
88java.lang.Object
89 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">org.apache.tools.ant.ProjectComponent</A>
90 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.types.DataType</B>
91</PRE>
92<DL>
93<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../org/apache/tools/ant/types/AbstractFileSet.html" title="class in org.apache.tools.ant.types">AbstractFileSet</A>, <A HREF="../../../../../org/apache/tools/ant/types/selectors/AbstractSelectorContainer.html" title="class in org.apache.tools.ant.types.selectors">AbstractSelectorContainer</A>, <A HREF="../../../../../org/apache/tools/ant/types/AntFilterReader.html" title="class in org.apache.tools.ant.types">AntFilterReader</A>, <A HREF="../../../../../org/apache/tools/ant/types/Assertions.html" title="class in org.apache.tools.ant.types">Assertions</A>, <A HREF="../../../../../org/apache/tools/ant/types/selectors/BaseSelector.html" title="class in org.apache.tools.ant.types.selectors">BaseSelector</A>, <A HREF="../../../../../org/apache/tools/ant/types/Description.html" title="class in org.apache.tools.ant.types">Description</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/optional/extension/ExtensionAdapter.html" title="class in org.apache.tools.ant.taskdefs.optional.extension">ExtensionAdapter</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/optional/extension/ExtensionSet.html" title="class in org.apache.tools.ant.taskdefs.optional.extension">ExtensionSet</A>, <A HREF="../../../../../org/apache/tools/ant/types/FileList.html" title="class in org.apache.tools.ant.types">FileList</A>, <A HREF="../../../../../org/apache/tools/ant/types/FilterChain.html" title="class in org.apache.tools.ant.types">FilterChain</A>, <A HREF="../../../../../org/apache/tools/ant/types/FilterSet.html" title="class in org.apache.tools.ant.types">FilterSet</A>, <A HREF="../../../../../org/apache/tools/ant/types/optional/image/ImageOperation.html" title="class in org.apache.tools.ant.types.optional.image">ImageOperation</A>, <A HREF="../../../../../org/apache/tools/ant/types/Mapper.html" title="class in org.apache.tools.ant.types">Mapper</A>, <A HREF="../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</A>, <A HREF="../../../../../org/apache/tools/ant/types/PatternSet.html" title="class in org.apache.tools.ant.types">PatternSet</A>, <A HREF="../../../../../org/apache/tools/ant/types/PropertySet.html" title="class in org.apache.tools.ant.types">PropertySet</A>, <A HREF="../../../../../org/apache/tools/ant/types/RedirectorElement.html" title="class in org.apache.tools.ant.types">RedirectorElement</A>, <A HREF="../../../../../org/apache/tools/ant/types/RegularExpression.html" title="class in org.apache.tools.ant.types">RegularExpression</A>, <A HREF="../../../../../org/apache/tools/ant/types/Substitution.html" title="class in org.apache.tools.ant.types">Substitution</A>, <A HREF="../../../../../org/apache/tools/ant/types/XMLCatalog.html" title="class in org.apache.tools.ant.types">XMLCatalog</A></DD>
94</DL>
95<HR>
96<DL>
97<DT>public abstract class <B>DataType</B><DT>extends <A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">ProjectComponent</A></DL>
98
99<P>
100Base class for those classes that can appear inside the build file
101 as stand alone data types.
102
103 <p>This class handles the common description attribute and provides
104 a default implementation for reference handling and checking for
105 circular references that is appropriate for types that can not be
106 nested inside elements of the same type (i.e. &lt;patternset&gt;
107 but not &lt;path&gt;).</p>
108<P>
109
110<P>
111<HR>
112
113<P>
114<!-- ======== NESTED CLASS SUMMARY ======== -->
115
116
117<!-- =========== FIELD SUMMARY =========== -->
118
119<A NAME="field_summary"><!-- --></A>
120<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
121<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
122<TD COLSPAN=2><FONT SIZE="+2">
123<B>Field Summary</B></FONT></TD>
124</TR>
125<TR BGCOLOR="white" CLASS="TableRowColor">
126<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
127<CODE>protected &nbsp;boolean</CODE></FONT></TD>
128<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/DataType.html#checked">checked</A></B></CODE>
129
130<BR>
131&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>The user should not be directly referencing
132 variable. Please use <A HREF="../../../../../org/apache/tools/ant/types/DataType.html#setChecked(boolean)"><CODE>setChecked(boolean)</CODE></A> or
133 <A HREF="../../../../../org/apache/tools/ant/types/DataType.html#isChecked()"><CODE>isChecked()</CODE></A> instead.</I></TD>
134</TR>
135<TR BGCOLOR="white" CLASS="TableRowColor">
136<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
137<CODE>protected &nbsp;java.lang.String</CODE></FONT></TD>
138<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/DataType.html#description">description</A></B></CODE>
139
140<BR>
141&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>The user should not be directly referencing
142 variable. Please use <A HREF="../../../../../org/apache/tools/ant/types/DataType.html#setDescription(java.lang.String)"><CODE>setDescription(java.lang.String)</CODE></A> or
143 <A HREF="../../../../../org/apache/tools/ant/types/DataType.html#getDescription()"><CODE>getDescription()</CODE></A> instead.</I></TD>
144</TR>
145<TR BGCOLOR="white" CLASS="TableRowColor">
146<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
147<CODE>protected &nbsp;<A HREF="../../../../../org/apache/tools/ant/types/Reference.html" title="class in org.apache.tools.ant.types">Reference</A></CODE></FONT></TD>
148<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/DataType.html#ref">ref</A></B></CODE>
149
150<BR>
151&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>The user should not be directly referencing
152 variable. Please use <A HREF="../../../../../org/apache/tools/ant/types/DataType.html#getRefid()"><CODE>getRefid()</CODE></A> instead.</I></TD>
153</TR>
154</TABLE>
155&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
156<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
157<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
158<TD><B>Fields inherited from class org.apache.tools.ant.<A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">ProjectComponent</A></B></TD>
159</TR>
160<TR BGCOLOR="white" CLASS="TableRowColor">
161<TD><CODE><A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html#project">project</A></CODE></TD>
162</TR>
163</TABLE>
164&nbsp;
165<!-- ======== CONSTRUCTOR SUMMARY ======== -->
166
167<A NAME="constructor_summary"><!-- --></A>
168<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
169<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
170<TD COLSPAN=2><FONT SIZE="+2">
171<B>Constructor Summary</B></FONT></TD>
172</TR>
173<TR BGCOLOR="white" CLASS="TableRowColor">
174<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/DataType.html#DataType()">DataType</A></B>()</CODE>
175
176<BR>
177&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
178</TR>
179</TABLE>
180&nbsp;
181<!-- ========== METHOD SUMMARY =========== -->
182
183<A NAME="method_summary"><!-- --></A>
184<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
185<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
186<TD COLSPAN=2><FONT SIZE="+2">
187<B>Method Summary</B></FONT></TD>
188</TR>
189<TR BGCOLOR="white" CLASS="TableRowColor">
190<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
191<CODE>protected &nbsp;void</CODE></FONT></TD>
192<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/DataType.html#checkAttributesAllowed()">checkAttributesAllowed</A></B>()</CODE>
193
194<BR>
195&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;check that it is ok to set attributes, i.e that no reference is defined</TD>
196</TR>
197<TR BGCOLOR="white" CLASS="TableRowColor">
198<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
199<CODE>protected &nbsp;void</CODE></FONT></TD>
200<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/DataType.html#checkChildrenAllowed()">checkChildrenAllowed</A></B>()</CODE>
201
202<BR>
203&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;check that it is ok to add children, i.e that no reference is defined</TD>
204</TR>
205<TR BGCOLOR="white" CLASS="TableRowColor">
206<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
207<CODE>protected &nbsp;<A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE></FONT></TD>
208<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/DataType.html#circularReference()">circularReference</A></B>()</CODE>
209
210<BR>
211&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates an exception that indicates the user has generated a
212 loop of data types referencing each other.</TD>
213</TR>
214<TR BGCOLOR="white" CLASS="TableRowColor">
215<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
216<CODE>protected &nbsp;void</CODE></FONT></TD>
217<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/DataType.html#dieOnCircularReference(java.util.Stack, org.apache.tools.ant.Project)">dieOnCircularReference</A></B>(java.util.Stack&nbsp;stack,
218 <A HREF="../../../../../org/apache/tools/ant/Project.html" title="class in org.apache.tools.ant">Project</A>&nbsp;project)</CODE>
219
220<BR>
221&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Check to see whether any DataType we hold references to is
222 included in the Stack (which holds all DataType instances that
223 directly or indirectly reference this instance, including this
224 instance itself).</TD>
225</TR>
226<TR BGCOLOR="white" CLASS="TableRowColor">
227<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
228<CODE>protected &nbsp;java.lang.Object</CODE></FONT></TD>
229<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/DataType.html#getCheckedRef(java.lang.Class, java.lang.String)">getCheckedRef</A></B>(java.lang.Class&nbsp;requiredClass,
230 java.lang.String&nbsp;dataTypeName)</CODE>
231
232<BR>
233&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Performs the check for circular references and returns the
234 referenced object.</TD>
235</TR>
236<TR BGCOLOR="white" CLASS="TableRowColor">
237<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
238<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
239<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/DataType.html#getDescription()">getDescription</A></B>()</CODE>
240
241<BR>
242&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the description for the current data type.</TD>
243</TR>
244<TR BGCOLOR="white" CLASS="TableRowColor">
245<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
246<CODE>protected &nbsp;<A HREF="../../../../../org/apache/tools/ant/types/Reference.html" title="class in org.apache.tools.ant.types">Reference</A></CODE></FONT></TD>
247<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/DataType.html#getRefid()">getRefid</A></B>()</CODE>
248
249<BR>
250&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;get the reference set on this object</TD>
251</TR>
252<TR BGCOLOR="white" CLASS="TableRowColor">
253<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
254<CODE>protected &nbsp;boolean</CODE></FONT></TD>
255<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/DataType.html#isChecked()">isChecked</A></B>()</CODE>
256
257<BR>
258&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
259</TR>
260<TR BGCOLOR="white" CLASS="TableRowColor">
261<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
262<CODE>&nbsp;boolean</CODE></FONT></TD>
263<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/DataType.html#isReference()">isReference</A></B>()</CODE>
264
265<BR>
266&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Has the refid attribute of this element been set?</TD>
267</TR>
268<TR BGCOLOR="white" CLASS="TableRowColor">
269<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
270<CODE>protected &nbsp;<A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE></FONT></TD>
271<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/DataType.html#noChildrenAllowed()">noChildrenAllowed</A></B>()</CODE>
272
273<BR>
274&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates an exception that indicates that this XML element must
275 not have child elements if the refid attribute is set.</TD>
276</TR>
277<TR BGCOLOR="white" CLASS="TableRowColor">
278<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
279<CODE>protected &nbsp;void</CODE></FONT></TD>
280<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/DataType.html#setChecked(boolean)">setChecked</A></B>(boolean&nbsp;checked)</CODE>
281
282<BR>
283&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
284</TR>
285<TR BGCOLOR="white" CLASS="TableRowColor">
286<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
287<CODE>&nbsp;void</CODE></FONT></TD>
288<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/DataType.html#setDescription(java.lang.String)">setDescription</A></B>(java.lang.String&nbsp;desc)</CODE>
289
290<BR>
291&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets a description of the current data type.</TD>
292</TR>
293<TR BGCOLOR="white" CLASS="TableRowColor">
294<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
295<CODE>&nbsp;void</CODE></FONT></TD>
296<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/DataType.html#setRefid(org.apache.tools.ant.types.Reference)">setRefid</A></B>(<A HREF="../../../../../org/apache/tools/ant/types/Reference.html" title="class in org.apache.tools.ant.types">Reference</A>&nbsp;ref)</CODE>
297
298<BR>
299&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the value of the refid attribute.</TD>
300</TR>
301<TR BGCOLOR="white" CLASS="TableRowColor">
302<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
303<CODE>protected &nbsp;<A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE></FONT></TD>
304<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/DataType.html#tooManyAttributes()">tooManyAttributes</A></B>()</CODE>
305
306<BR>
307&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates an exception that indicates that refid has to be the
308 only attribute if it is set.</TD>
309</TR>
310</TABLE>
311&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
312<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
313<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
314<TD><B>Methods inherited from class org.apache.tools.ant.<A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">ProjectComponent</A></B></TD>
315</TR>
316<TR BGCOLOR="white" CLASS="TableRowColor">
317<TD><CODE><A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html#getProject()">getProject</A>, <A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html#log(java.lang.String)">log</A>, <A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html#log(java.lang.String, int)">log</A>, <A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html#setProject(org.apache.tools.ant.Project)">setProject</A></CODE></TD>
318</TR>
319</TABLE>
320&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
321<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
322<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
323<TD><B>Methods inherited from class java.lang.Object</B></TD>
324</TR>
325<TR BGCOLOR="white" CLASS="TableRowColor">
326<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
327</TR>
328</TABLE>
329&nbsp;
330<P>
331
332<!-- ============ FIELD DETAIL =========== -->
333
334<A NAME="field_detail"><!-- --></A>
335<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
336<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
337<TD COLSPAN=1><FONT SIZE="+2">
338<B>Field Detail</B></FONT></TD>
339</TR>
340</TABLE>
341
342<A NAME="description"><!-- --></A><H3>
343description</H3>
344<PRE>
345protected java.lang.String <B>description</B></PRE>
346<DL>
347<DD><B>Deprecated.</B>&nbsp;<I>The user should not be directly referencing
348 variable. Please use <A HREF="../../../../../org/apache/tools/ant/types/DataType.html#setDescription(java.lang.String)"><CODE>setDescription(java.lang.String)</CODE></A> or
349 <A HREF="../../../../../org/apache/tools/ant/types/DataType.html#getDescription()"><CODE>getDescription()</CODE></A> instead.</I>
350<P>
351<DD>The description the user has set.
352<P>
353<DL>
354</DL>
355</DL>
356<HR>
357
358<A NAME="ref"><!-- --></A><H3>
359ref</H3>
360<PRE>
361protected <A HREF="../../../../../org/apache/tools/ant/types/Reference.html" title="class in org.apache.tools.ant.types">Reference</A> <B>ref</B></PRE>
362<DL>
363<DD><B>Deprecated.</B>&nbsp;<I>The user should not be directly referencing
364 variable. Please use <A HREF="../../../../../org/apache/tools/ant/types/DataType.html#getRefid()"><CODE>getRefid()</CODE></A> instead.</I>
365<P>
366<DD>Value to the refid attribute.
367<P>
368<DL>
369</DL>
370</DL>
371<HR>
372
373<A NAME="checked"><!-- --></A><H3>
374checked</H3>
375<PRE>
376protected boolean <B>checked</B></PRE>
377<DL>
378<DD><B>Deprecated.</B>&nbsp;<I>The user should not be directly referencing
379 variable. Please use <A HREF="../../../../../org/apache/tools/ant/types/DataType.html#setChecked(boolean)"><CODE>setChecked(boolean)</CODE></A> or
380 <A HREF="../../../../../org/apache/tools/ant/types/DataType.html#isChecked()"><CODE>isChecked()</CODE></A> instead.</I>
381<P>
382<DD>Are we sure we don't hold circular references?
383
384 <p>Subclasses are responsible for setting this value to false
385 if we'd need to investigate this condition (usually because a
386 child element has been added that is a subclass of
387 DataType).</p>
388<P>
389<DL>
390</DL>
391</DL>
392
393<!-- ========= CONSTRUCTOR DETAIL ======== -->
394
395<A NAME="constructor_detail"><!-- --></A>
396<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
397<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
398<TD COLSPAN=1><FONT SIZE="+2">
399<B>Constructor Detail</B></FONT></TD>
400</TR>
401</TABLE>
402
403<A NAME="DataType()"><!-- --></A><H3>
404DataType</H3>
405<PRE>
406public <B>DataType</B>()</PRE>
407<DL>
408</DL>
409
410<!-- ============ METHOD DETAIL ========== -->
411
412<A NAME="method_detail"><!-- --></A>
413<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
414<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
415<TD COLSPAN=1><FONT SIZE="+2">
416<B>Method Detail</B></FONT></TD>
417</TR>
418</TABLE>
419
420<A NAME="setDescription(java.lang.String)"><!-- --></A><H3>
421setDescription</H3>
422<PRE>
423public void <B>setDescription</B>(java.lang.String&nbsp;desc)</PRE>
424<DL>
425<DD>Sets a description of the current data type. It will be useful
426 in commenting what we are doing.
427<P>
428<DD><DL>
429</DL>
430</DD>
431</DL>
432<HR>
433
434<A NAME="getDescription()"><!-- --></A><H3>
435getDescription</H3>
436<PRE>
437public java.lang.String <B>getDescription</B>()</PRE>
438<DL>
439<DD>Return the description for the current data type.
440<P>
441<DD><DL>
442</DL>
443</DD>
444</DL>
445<HR>
446
447<A NAME="isReference()"><!-- --></A><H3>
448isReference</H3>
449<PRE>
450public boolean <B>isReference</B>()</PRE>
451<DL>
452<DD>Has the refid attribute of this element been set?
453<P>
454<DD><DL>
455</DL>
456</DD>
457</DL>
458<HR>
459
460<A NAME="setRefid(org.apache.tools.ant.types.Reference)"><!-- --></A><H3>
461setRefid</H3>
462<PRE>
463public void <B>setRefid</B>(<A HREF="../../../../../org/apache/tools/ant/types/Reference.html" title="class in org.apache.tools.ant.types">Reference</A>&nbsp;ref)</PRE>
464<DL>
465<DD>Set the value of the refid attribute.
466
467 <p>Subclasses may need to check whether any other attributes
468 have been set as well or child elements have been created and
469 thus override this method. if they do the must call
470 <code>super.setRefid</code>.</p>
471<P>
472<DD><DL>
473</DL>
474</DD>
475</DL>
476<HR>
477
478<A NAME="dieOnCircularReference(java.util.Stack, org.apache.tools.ant.Project)"><!-- --></A><H3>
479dieOnCircularReference</H3>
480<PRE>
481protected void <B>dieOnCircularReference</B>(java.util.Stack&nbsp;stack,
482 <A HREF="../../../../../org/apache/tools/ant/Project.html" title="class in org.apache.tools.ant">Project</A>&nbsp;project)
483 throws <A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
484<DL>
485<DD>Check to see whether any DataType we hold references to is
486 included in the Stack (which holds all DataType instances that
487 directly or indirectly reference this instance, including this
488 instance itself).
489
490 <p>If one is included, throw a BuildException created by <A HREF="../../../../../org/apache/tools/ant/types/DataType.html#circularReference()"><CODE>circularReference</CODE></A>.</p>
491
492 <p>This implementation is appropriate only for a DataType that
493 cannot hold other DataTypes as children.</p>
494
495 <p>The general contract of this method is that it shouldn't do
496 anything if <A HREF="../../../../../org/apache/tools/ant/types/DataType.html#checked"><CODE><code>checked</code></CODE></A> is true and
497 set it to true on exit.</p>
498<P>
499<DD><DL>
500
501<DT><B>Throws:</B>
502<DD><CODE><A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE></DL>
503</DD>
504</DL>
505<HR>
506
507<A NAME="getCheckedRef(java.lang.Class, java.lang.String)"><!-- --></A><H3>
508getCheckedRef</H3>
509<PRE>
510protected java.lang.Object <B>getCheckedRef</B>(java.lang.Class&nbsp;requiredClass,
511 java.lang.String&nbsp;dataTypeName)</PRE>
512<DL>
513<DD>Performs the check for circular references and returns the
514 referenced object.
515<P>
516<DD><DL>
517</DL>
518</DD>
519</DL>
520<HR>
521
522<A NAME="tooManyAttributes()"><!-- --></A><H3>
523tooManyAttributes</H3>
524<PRE>
525protected <A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A> <B>tooManyAttributes</B>()</PRE>
526<DL>
527<DD>Creates an exception that indicates that refid has to be the
528 only attribute if it is set.
529<P>
530<DD><DL>
531</DL>
532</DD>
533</DL>
534<HR>
535
536<A NAME="noChildrenAllowed()"><!-- --></A><H3>
537noChildrenAllowed</H3>
538<PRE>
539protected <A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A> <B>noChildrenAllowed</B>()</PRE>
540<DL>
541<DD>Creates an exception that indicates that this XML element must
542 not have child elements if the refid attribute is set.
543<P>
544<DD><DL>
545</DL>
546</DD>
547</DL>
548<HR>
549
550<A NAME="circularReference()"><!-- --></A><H3>
551circularReference</H3>
552<PRE>
553protected <A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A> <B>circularReference</B>()</PRE>
554<DL>
555<DD>Creates an exception that indicates the user has generated a
556 loop of data types referencing each other.
557<P>
558<DD><DL>
559</DL>
560</DD>
561</DL>
562<HR>
563
564<A NAME="isChecked()"><!-- --></A><H3>
565isChecked</H3>
566<PRE>
567protected boolean <B>isChecked</B>()</PRE>
568<DL>
569<DD><DL>
570</DL>
571</DD>
572</DL>
573<HR>
574
575<A NAME="setChecked(boolean)"><!-- --></A><H3>
576setChecked</H3>
577<PRE>
578protected void <B>setChecked</B>(boolean&nbsp;checked)</PRE>
579<DL>
580<DD><DL>
581</DL>
582</DD>
583</DL>
584<HR>
585
586<A NAME="getRefid()"><!-- --></A><H3>
587getRefid</H3>
588<PRE>
589protected <A HREF="../../../../../org/apache/tools/ant/types/Reference.html" title="class in org.apache.tools.ant.types">Reference</A> <B>getRefid</B>()</PRE>
590<DL>
591<DD>get the reference set on this object
592<P>
593<DD><DL>
594
595<DT><B>Returns:</B><DD>the reference or null</DL>
596</DD>
597</DL>
598<HR>
599
600<A NAME="checkAttributesAllowed()"><!-- --></A><H3>
601checkAttributesAllowed</H3>
602<PRE>
603protected void <B>checkAttributesAllowed</B>()</PRE>
604<DL>
605<DD>check that it is ok to set attributes, i.e that no reference is defined
606<P>
607<DD><DL>
608
609<DT><B>Throws:</B>
610<DD><CODE><A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if not allowed<DT><B>Since:</B></DT>
611 <DD>Ant 1.6</DD>
612</DL>
613</DD>
614</DL>
615<HR>
616
617<A NAME="checkChildrenAllowed()"><!-- --></A><H3>
618checkChildrenAllowed</H3>
619<PRE>
620protected void <B>checkChildrenAllowed</B>()</PRE>
621<DL>
622<DD>check that it is ok to add children, i.e that no reference is defined
623<P>
624<DD><DL>
625
626<DT><B>Throws:</B>
627<DD><CODE><A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if not allowed<DT><B>Since:</B></DT>
628 <DD>Ant 1.6</DD>
629</DL>
630</DD>
631</DL>
632<!-- ========= END OF CLASS DATA ========= -->
633<HR>
634
635
636<!-- ======= START OF BOTTOM NAVBAR ====== -->
637<A NAME="navbar_bottom"><!-- --></A>
638<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
639<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
640<TR>
641<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
642<A NAME="navbar_bottom_firstrow"><!-- --></A>
643<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
644 <TR ALIGN="center" VALIGN="top">
645 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
646 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
647 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
648 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
649 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
650 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
651 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
652 </TR>
653</TABLE>
654</TD>
655<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
656</EM>
657</TD>
658</TR>
659
660<TR>
661<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
662&nbsp;<A HREF="../../../../../org/apache/tools/ant/types/CommandlineJava.SysProperties.html" title="class in org.apache.tools.ant.types"><B>PREV CLASS</B></A>&nbsp;
663&nbsp;<A HREF="../../../../../org/apache/tools/ant/types/Description.html" title="class in org.apache.tools.ant.types"><B>NEXT CLASS</B></A></FONT></TD>
664<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
665 <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
666&nbsp;<A HREF="DataType.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
667&nbsp;<SCRIPT type="text/javascript">
668 <!--
669 if(window==top) {
670 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
671 }
672 //-->
673</SCRIPT>
674<NOSCRIPT>
675 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
676</NOSCRIPT>
677
678</FONT></TD>
679</TR>
680<TR>
681<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
682 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>
683<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
684DETAIL:&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>
685</TR>
686</TABLE>
687<A NAME="skip-navbar_bottom"></A>
688<!-- ======== END OF BOTTOM NAVBAR ======= -->
689
690<HR>
691Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
692</BODY>
693</HTML>
Note: See TracBrowser for help on using the repository browser.