[14982] | 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:17 NZST 2007 -->
|
---|
| 6 | <TITLE>
|
---|
| 7 | PropertyFileInputHandler (Apache Ant API)
|
---|
| 8 | </TITLE>
|
---|
| 9 |
|
---|
| 10 | <META NAME="keywords" CONTENT="org.apache.tools.ant.input.PropertyFileInputHandler class">
|
---|
| 11 |
|
---|
| 12 | <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
|
---|
| 13 |
|
---|
| 14 | <SCRIPT type="text/javascript">
|
---|
| 15 | function windowTitle()
|
---|
| 16 | {
|
---|
| 17 | parent.document.title="PropertyFileInputHandler (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> </TD>
|
---|
| 36 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
---|
| 37 | <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
---|
| 38 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
---|
| 39 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
---|
| 40 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
---|
| 41 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </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 | <A HREF="../../../../../org/apache/tools/ant/input/MultipleChoiceInputRequest.html" title="class in org.apache.tools.ant.input"><B>PREV CLASS</B></A>
|
---|
| 53 | NEXT CLASS</FONT></TD>
|
---|
| 54 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
---|
| 55 | <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>
|
---|
| 56 | <A HREF="PropertyFileInputHandler.html" target="_top"><B>NO FRAMES</B></A>
|
---|
| 57 | <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: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
---|
| 73 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
---|
| 74 | DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <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">
|
---|
| 84 | org.apache.tools.ant.input</FONT>
|
---|
| 85 | <BR>
|
---|
| 86 | Class PropertyFileInputHandler</H2>
|
---|
| 87 | <PRE>
|
---|
| 88 | java.lang.Object
|
---|
| 89 | <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.input.PropertyFileInputHandler</B>
|
---|
| 90 | </PRE>
|
---|
| 91 | <DL>
|
---|
| 92 | <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../org/apache/tools/ant/input/InputHandler.html" title="interface in org.apache.tools.ant.input">InputHandler</A></DD>
|
---|
| 93 | </DL>
|
---|
| 94 | <HR>
|
---|
| 95 | <DL>
|
---|
| 96 | <DT>public class <B>PropertyFileInputHandler</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../../org/apache/tools/ant/input/InputHandler.html" title="interface in org.apache.tools.ant.input">InputHandler</A></DL>
|
---|
| 97 |
|
---|
| 98 | <P>
|
---|
| 99 | Reads input from a property file, the file name is read from the
|
---|
| 100 | system property ant.input.properties, the prompt is the key for input.
|
---|
| 101 | <P>
|
---|
| 102 |
|
---|
| 103 | <P>
|
---|
| 104 | <DL>
|
---|
| 105 | <DT><B>Since:</B></DT>
|
---|
| 106 | <DD>Ant 1.5</DD>
|
---|
| 107 | </DL>
|
---|
| 108 | <HR>
|
---|
| 109 |
|
---|
| 110 | <P>
|
---|
| 111 | <!-- ======== NESTED CLASS SUMMARY ======== -->
|
---|
| 112 |
|
---|
| 113 |
|
---|
| 114 | <!-- =========== FIELD SUMMARY =========== -->
|
---|
| 115 |
|
---|
| 116 | <A NAME="field_summary"><!-- --></A>
|
---|
| 117 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
| 118 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
---|
| 119 | <TD COLSPAN=2><FONT SIZE="+2">
|
---|
| 120 | <B>Field Summary</B></FONT></TD>
|
---|
| 121 | </TR>
|
---|
| 122 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
| 123 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
| 124 | <CODE>static java.lang.String</CODE></FONT></TD>
|
---|
| 125 | <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/input/PropertyFileInputHandler.html#FILE_NAME_KEY">FILE_NAME_KEY</A></B></CODE>
|
---|
| 126 |
|
---|
| 127 | <BR>
|
---|
| 128 | Name of the system property we expect to hold the file name.</TD>
|
---|
| 129 | </TR>
|
---|
| 130 | </TABLE>
|
---|
| 131 |
|
---|
| 132 | <!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
---|
| 133 |
|
---|
| 134 | <A NAME="constructor_summary"><!-- --></A>
|
---|
| 135 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
| 136 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
---|
| 137 | <TD COLSPAN=2><FONT SIZE="+2">
|
---|
| 138 | <B>Constructor Summary</B></FONT></TD>
|
---|
| 139 | </TR>
|
---|
| 140 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
| 141 | <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/input/PropertyFileInputHandler.html#PropertyFileInputHandler()">PropertyFileInputHandler</A></B>()</CODE>
|
---|
| 142 |
|
---|
| 143 | <BR>
|
---|
| 144 | Empty no-arg constructor.</TD>
|
---|
| 145 | </TR>
|
---|
| 146 | </TABLE>
|
---|
| 147 |
|
---|
| 148 | <!-- ========== METHOD SUMMARY =========== -->
|
---|
| 149 |
|
---|
| 150 | <A NAME="method_summary"><!-- --></A>
|
---|
| 151 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
| 152 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
---|
| 153 | <TD COLSPAN=2><FONT SIZE="+2">
|
---|
| 154 | <B>Method Summary</B></FONT></TD>
|
---|
| 155 | </TR>
|
---|
| 156 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
| 157 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
| 158 | <CODE> void</CODE></FONT></TD>
|
---|
| 159 | <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/input/PropertyFileInputHandler.html#handleInput(org.apache.tools.ant.input.InputRequest)">handleInput</A></B>(<A HREF="../../../../../org/apache/tools/ant/input/InputRequest.html" title="class in org.apache.tools.ant.input">InputRequest</A> request)</CODE>
|
---|
| 160 |
|
---|
| 161 | <BR>
|
---|
| 162 | Picks up the input from a property, using the prompt as the
|
---|
| 163 | name of the property.</TD>
|
---|
| 164 | </TR>
|
---|
| 165 | </TABLE>
|
---|
| 166 | <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
|
---|
| 167 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
| 168 | <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
---|
| 169 | <TD><B>Methods inherited from class java.lang.Object</B></TD>
|
---|
| 170 | </TR>
|
---|
| 171 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
| 172 | <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
|
---|
| 173 | </TR>
|
---|
| 174 | </TABLE>
|
---|
| 175 |
|
---|
| 176 | <P>
|
---|
| 177 |
|
---|
| 178 | <!-- ============ FIELD DETAIL =========== -->
|
---|
| 179 |
|
---|
| 180 | <A NAME="field_detail"><!-- --></A>
|
---|
| 181 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
| 182 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
---|
| 183 | <TD COLSPAN=1><FONT SIZE="+2">
|
---|
| 184 | <B>Field Detail</B></FONT></TD>
|
---|
| 185 | </TR>
|
---|
| 186 | </TABLE>
|
---|
| 187 |
|
---|
| 188 | <A NAME="FILE_NAME_KEY"><!-- --></A><H3>
|
---|
| 189 | FILE_NAME_KEY</H3>
|
---|
| 190 | <PRE>
|
---|
| 191 | public static final java.lang.String <B>FILE_NAME_KEY</B></PRE>
|
---|
| 192 | <DL>
|
---|
| 193 | <DD>Name of the system property we expect to hold the file name.
|
---|
| 194 | <P>
|
---|
| 195 | <DL>
|
---|
| 196 | <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.tools.ant.input.PropertyFileInputHandler.FILE_NAME_KEY">Constant Field Values</A></DL>
|
---|
| 197 | </DL>
|
---|
| 198 |
|
---|
| 199 | <!-- ========= CONSTRUCTOR DETAIL ======== -->
|
---|
| 200 |
|
---|
| 201 | <A NAME="constructor_detail"><!-- --></A>
|
---|
| 202 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
| 203 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
---|
| 204 | <TD COLSPAN=1><FONT SIZE="+2">
|
---|
| 205 | <B>Constructor Detail</B></FONT></TD>
|
---|
| 206 | </TR>
|
---|
| 207 | </TABLE>
|
---|
| 208 |
|
---|
| 209 | <A NAME="PropertyFileInputHandler()"><!-- --></A><H3>
|
---|
| 210 | PropertyFileInputHandler</H3>
|
---|
| 211 | <PRE>
|
---|
| 212 | public <B>PropertyFileInputHandler</B>()</PRE>
|
---|
| 213 | <DL>
|
---|
| 214 | <DD>Empty no-arg constructor.
|
---|
| 215 | <P>
|
---|
| 216 | </DL>
|
---|
| 217 |
|
---|
| 218 | <!-- ============ METHOD DETAIL ========== -->
|
---|
| 219 |
|
---|
| 220 | <A NAME="method_detail"><!-- --></A>
|
---|
| 221 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
| 222 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
---|
| 223 | <TD COLSPAN=1><FONT SIZE="+2">
|
---|
| 224 | <B>Method Detail</B></FONT></TD>
|
---|
| 225 | </TR>
|
---|
| 226 | </TABLE>
|
---|
| 227 |
|
---|
| 228 | <A NAME="handleInput(org.apache.tools.ant.input.InputRequest)"><!-- --></A><H3>
|
---|
| 229 | handleInput</H3>
|
---|
| 230 | <PRE>
|
---|
| 231 | public void <B>handleInput</B>(<A HREF="../../../../../org/apache/tools/ant/input/InputRequest.html" title="class in org.apache.tools.ant.input">InputRequest</A> request)
|
---|
| 232 | throws <A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
|
---|
| 233 | <DL>
|
---|
| 234 | <DD>Picks up the input from a property, using the prompt as the
|
---|
| 235 | name of the property.
|
---|
| 236 | <P>
|
---|
| 237 | <DD><DL>
|
---|
| 238 | <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/tools/ant/input/InputHandler.html#handleInput(org.apache.tools.ant.input.InputRequest)">handleInput</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/tools/ant/input/InputHandler.html" title="interface in org.apache.tools.ant.input">InputHandler</A></CODE></DL>
|
---|
| 239 | </DD>
|
---|
| 240 | <DD><DL>
|
---|
| 241 | <DT><B>Parameters:</B><DD><CODE>request</CODE> - the request to be processed
|
---|
| 242 | <DT><B>Throws:</B>
|
---|
| 243 | <DD><CODE><A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if no property of that name can be found.</DL>
|
---|
| 244 | </DD>
|
---|
| 245 | </DL>
|
---|
| 246 | <!-- ========= END OF CLASS DATA ========= -->
|
---|
| 247 | <HR>
|
---|
| 248 |
|
---|
| 249 |
|
---|
| 250 | <!-- ======= START OF BOTTOM NAVBAR ====== -->
|
---|
| 251 | <A NAME="navbar_bottom"><!-- --></A>
|
---|
| 252 | <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
|
---|
| 253 | <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
---|
| 254 | <TR>
|
---|
| 255 | <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
---|
| 256 | <A NAME="navbar_bottom_firstrow"><!-- --></A>
|
---|
| 257 | <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
---|
| 258 | <TR ALIGN="center" VALIGN="top">
|
---|
| 259 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
---|
| 260 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
---|
| 261 | <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
---|
| 262 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
---|
| 263 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
---|
| 264 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
---|
| 265 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
---|
| 266 | </TR>
|
---|
| 267 | </TABLE>
|
---|
| 268 | </TD>
|
---|
| 269 | <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
---|
| 270 | </EM>
|
---|
| 271 | </TD>
|
---|
| 272 | </TR>
|
---|
| 273 |
|
---|
| 274 | <TR>
|
---|
| 275 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
---|
| 276 | <A HREF="../../../../../org/apache/tools/ant/input/MultipleChoiceInputRequest.html" title="class in org.apache.tools.ant.input"><B>PREV CLASS</B></A>
|
---|
| 277 | NEXT CLASS</FONT></TD>
|
---|
| 278 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
---|
| 279 | <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>
|
---|
| 280 | <A HREF="PropertyFileInputHandler.html" target="_top"><B>NO FRAMES</B></A>
|
---|
| 281 | <SCRIPT type="text/javascript">
|
---|
| 282 | <!--
|
---|
| 283 | if(window==top) {
|
---|
| 284 | document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
---|
| 285 | }
|
---|
| 286 | //-->
|
---|
| 287 | </SCRIPT>
|
---|
| 288 | <NOSCRIPT>
|
---|
| 289 | <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
---|
| 290 | </NOSCRIPT>
|
---|
| 291 |
|
---|
| 292 | </FONT></TD>
|
---|
| 293 | </TR>
|
---|
| 294 | <TR>
|
---|
| 295 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
---|
| 296 | SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
---|
| 297 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
---|
| 298 | DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
---|
| 299 | </TR>
|
---|
| 300 | </TABLE>
|
---|
| 301 | <A NAME="skip-navbar_bottom"></A>
|
---|
| 302 | <!-- ======== END OF BOTTOM NAVBAR ======= -->
|
---|
| 303 |
|
---|
| 304 | <HR>
|
---|
| 305 | Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
|
---|
| 306 | </BODY>
|
---|
| 307 | </HTML>
|
---|