/lib/JSAP/doc/javadoc/com/martiansoftware/jsap/ant/ParameterConfiguration.html

https://bitbucket.org/arkban/somersault · HTML · 451 lines · 374 code · 52 blank · 25 comment · 0 complexity · 081270634af2bba9556054fa66015dd5 MD5 · raw file 

    

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
    2. 

  2. <!--NewPage-->
    3. 

  3. <HTML>
    4. 

  4. <HEAD>
    5. 

  5. <!-- Generated by javadoc (build 1.4.2_08) on Thu Aug 03 20:30:44 EDT 2006 -->
    6. 

  6. <TITLE>
    7. 

  7. ParameterConfiguration (JSAP: the Java Simple Argument Parser)
    8. 

  8. </TITLE>
    9. 

  9. 

  10. <META NAME="keywords" CONTENT="com.martiansoftware.jsap.ant.ParameterConfiguration class">
    11. 

  11. 

  12. <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
    13. 

  13. 

  14. <SCRIPT type="text/javascript">
    15. 

  15. function windowTitle()
    16. 

  16. {
    17. 

  17.     parent.document.title="ParameterConfiguration (JSAP: the Java Simple Argument Parser)";
    18. 

  18. }
    19. 

  19. </SCRIPT>
    20. 

  20. 

  21. </HEAD>
    22. 

  22. 

  23. <BODY BGCOLOR="white" onload="windowTitle();">
    24. 

  24. 

  25. 

  26. <!-- ========= START OF TOP NAVBAR ======= -->
    27. 

  27. <A NAME="navbar_top"><!-- --></A>
    28. 

  28. <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
    29. 

  29. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
    30. 

  30. <TR>
    31. 

  31. <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
    32. 

  32. <A NAME="navbar_top_firstrow"><!-- --></A>
    33. 

  33. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
    34. 

  34.   <TR ALIGN="center" VALIGN="top">
    35. 

  35.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
    36. 

  36.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
    37. 

  37.   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
    38. 

  38.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
    39. 

  39.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
    40. 

  40.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
    41. 

  41.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
    42. 

  42.   </TR>
    43. 

  43. </TABLE>
    44. 

  44. </TD>
    45. 

  45. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
    46. 

  46. </EM>
    47. 

  47. </TD>
    48. 

  48. </TR>
    49. 

  49. 

  50. <TR>
    51. 

  51. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    52. 

  52. &nbsp;<A HREF="../../../../com/martiansoftware/jsap/ant/OptionConfiguration.html" title="class in com.martiansoftware.jsap.ant"><B>PREV CLASS</B></A>&nbsp;
    53. 

  53. &nbsp;<A HREF="../../../../com/martiansoftware/jsap/ant/ParserProperty.html" title="class in com.martiansoftware.jsap.ant"><B>NEXT CLASS</B></A></FONT></TD>
    54. 

  54. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    55. 

  55.   <A HREF="../../../../index.html" target="_top"><B>FRAMES</B></A>  &nbsp;
    56. 

  56. &nbsp;<A HREF="ParameterConfiguration.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
    57. 

  57. &nbsp;<SCRIPT type="text/javascript">
    58. 

  58.   <!--
    59. 

  59.   if(window==top) {
    60. 

  60.     document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
    61. 

  61.   }
    62. 

  62.   //-->
    63. 

  63. </SCRIPT>
    64. 

  64. <NOSCRIPT>
    65. 

  65.   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
    66. 

  66. </NOSCRIPT>
    67. 

  67. 

  68. </FONT></TD>
    69. 

  69. </TR>
    70. 

  70. <TR>
    71. 

  71. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
    72. 

  72.   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
    73. 

  73. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
    74. 

  74. DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
    75. 

  75. </TR>
    76. 

  76. </TABLE>
    77. 

  77. <A NAME="skip-navbar_top"></A>
    78. 

  78. <!-- ========= END OF TOP NAVBAR ========= -->
    79. 

  79. 

  80. <HR>
    81. 

  81. <!-- ======== START OF CLASS DATA ======== -->
    82. 

  82. <H2>
    83. 

  83. <FONT SIZE="-1">
    84. 

  84. com.martiansoftware.jsap.ant</FONT>
    85. 

  85. <BR>
    86. 

  86. Class ParameterConfiguration</H2>
    87. 

  87. <PRE>
    88. 

  88. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html" title="class or interface in java.lang">java.lang.Object</A>
    89. 

  89.   <IMG SRC="../../../../resources/inherit.gif" ALT="extended by"><B>com.martiansoftware.jsap.ant.ParameterConfiguration</B>
    90. 

  90. </PRE>
    91. 

  91. <DL>
    92. 

  92. <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../com/martiansoftware/jsap/ant/OptionConfiguration.html" title="class in com.martiansoftware.jsap.ant">OptionConfiguration</A>, <A HREF="../../../../com/martiansoftware/jsap/ant/SwitchConfiguration.html" title="class in com.martiansoftware.jsap.ant">SwitchConfiguration</A></DD>
    93. 

  93. </DL>
    94. 

  94. <HR>
    95. 

  95. <DL>
    96. 

  96. <DT>public abstract class <B>ParameterConfiguration</B><DT>extends <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></DL>
    97. 

  97. 

  98. <P>
    99. 

  99. Stores/provides configuration data common to switches, flaggedoptions, and
    100. 

  100.  unflaggedoptions
    101. 

  101.  nested inside a jsap ant task.
    102. 

  102.  For detailed information on using the jsap task, see the documentation for
    103. 

  103.  JSAPAntTask.
    104. 

  104. <P>
    105. 

  105. 

  106. <P>
    107. 

  107. <DL>
    108. 

  108. <DT><B>Author:</B></DT>
    109. 

  109.   <DD><a href="http://www.martiansoftware.com/contact.html">Marty Lamb</a></DD>
    110. 

  110. <DT><B>See Also:</B><DD><A HREF="../../../../com/martiansoftware/jsap/ant/JSAPAntTask.html" title="class in com.martiansoftware.jsap.ant"><CODE>JSAPAntTask</CODE></A></DL>
    111. 

  111. <HR>
    112. 

  112. 

  113. <P>
    114. 

  114. <!-- ======== NESTED CLASS SUMMARY ======== -->
    115. 

  115. 

  116. 

  117. <!-- =========== FIELD SUMMARY =========== -->
    118. 

  118. 

  119. 

  120. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
    121. 

  121. 

  122. <A NAME="constructor_summary"><!-- --></A>
    123. 

  123. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    124. 

  124. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    125. 

  125. <TD COLSPAN=2><FONT SIZE="+2">
    126. 

  126. <B>Constructor Summary</B></FONT></TD>
    127. 

  127. </TR>
    128. 

  128. <TR BGCOLOR="white" CLASS="TableRowColor">
    129. 

  129. <TD><CODE><B><A HREF="../../../../com/martiansoftware/jsap/ant/ParameterConfiguration.html#ParameterConfiguration()">ParameterConfiguration</A></B>()</CODE>
    130. 

  130. 

  131. <BR>
    132. 

  132. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a new ParameterConfiguration.</TD>
    133. 

  133. </TR>
    134. 

  134. </TABLE>
    135. 

  135. &nbsp;
    136. 

  136. <!-- ========== METHOD SUMMARY =========== -->
    137. 

  137. 

  138. <A NAME="method_summary"><!-- --></A>
    139. 

  139. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    140. 

  140. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    141. 

  141. <TD COLSPAN=2><FONT SIZE="+2">
    142. 

  142. <B>Method Summary</B></FONT></TD>
    143. 

  143. </TR>
    144. 

  144. <TR BGCOLOR="white" CLASS="TableRowColor">
    145. 

  145. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    146. 

  146. <CODE>&nbsp;void</CODE></FONT></TD>
    147. 

  147. <TD><CODE><B><A HREF="../../../../com/martiansoftware/jsap/ant/ParameterConfiguration.html#addConfiguredDefault(com.martiansoftware.jsap.ant.DefaultValue)">addConfiguredDefault</A></B>(<A HREF="../../../../com/martiansoftware/jsap/ant/DefaultValue.html" title="class in com.martiansoftware.jsap.ant">DefaultValue</A>&nbsp;defaultValue)</CODE>
    148. 

  148. 

  149. <BR>
    150. 

  150. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds a configured default value to the current list of default values
    151. 

  151.  for this parameter.</TD>
    152. 

  152. </TR>
    153. 

  153. <TR BGCOLOR="white" CLASS="TableRowColor">
    154. 

  154. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    155. 

  155. <CODE>abstract &nbsp;void</CODE></FONT></TD>
    156. 

  156. <TD><CODE><B><A HREF="../../../../com/martiansoftware/jsap/ant/ParameterConfiguration.html#createMethod(java.lang.String, java.io.PrintStream)">createMethod</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;methodName,
    157. 

  157.              <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/PrintStream.html" title="class or interface in java.io">PrintStream</A>&nbsp;out)</CODE>
    158. 

  158. 

  159. <BR>
    160. 

  160. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates source code for a java method that creates a parameter matching
    161. 

  161.  this object's configuration.</TD>
    162. 

  162. </TR>
    163. 

  163. <TR BGCOLOR="white" CLASS="TableRowColor">
    164. 

  164. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    165. 

  165. <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>[]</CODE></FONT></TD>
    166. 

  166. <TD><CODE><B><A HREF="../../../../com/martiansoftware/jsap/ant/ParameterConfiguration.html#getDefaults()">getDefaults</A></B>()</CODE>
    167. 

  167. 

  168. <BR>
    169. 

  169. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an array of this parameter's default values, or a zero-length
    170. 

  170.  array if none exist.</TD>
    171. 

  171. </TR>
    172. 

  172. <TR BGCOLOR="white" CLASS="TableRowColor">
    173. 

  173. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    174. 

  174. <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD>
    175. 

  175. <TD><CODE><B><A HREF="../../../../com/martiansoftware/jsap/ant/ParameterConfiguration.html#getId()">getId</A></B>()</CODE>
    176. 

  176. 

  177. <BR>
    178. 

  178. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the unique ID for this parameter.</TD>
    179. 

  179. </TR>
    180. 

  180. <TR BGCOLOR="white" CLASS="TableRowColor">
    181. 

  181. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    182. 

  182. <CODE>abstract &nbsp;<A HREF="../../../../com/martiansoftware/jsap/Parameter.html" title="class in com.martiansoftware.jsap">Parameter</A></CODE></FONT></TD>
    183. 

  183. <TD><CODE><B><A HREF="../../../../com/martiansoftware/jsap/ant/ParameterConfiguration.html#getParameter()">getParameter</A></B>()</CODE>
    184. 

  184. 

  185. <BR>
    186. 

  186. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an Parameter (String, FlaggedOption, or UnflaggedOption)
    187. 

  187.  configured according
    188. 

  188.  to the settings contained within this object.</TD>
    189. 

  189. </TR>
    190. 

  190. <TR BGCOLOR="white" CLASS="TableRowColor">
    191. 

  191. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    192. 

  192. <CODE>&nbsp;boolean</CODE></FONT></TD>
    193. 

  193. <TD><CODE><B><A HREF="../../../../com/martiansoftware/jsap/ant/ParameterConfiguration.html#hasProperties()">hasProperties</A></B>()</CODE>
    194. 

  194. 

  195. <BR>
    196. 

  196. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a boolean indicating whether this parameter has any properties
    197. 

  197.  associated with its
    198. 

  198.  StringParser.</TD>
    199. 

  199. </TR>
    200. 

  200. <TR BGCOLOR="white" CLASS="TableRowColor">
    201. 

  201. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    202. 

  202. <CODE>&nbsp;void</CODE></FONT></TD>
    203. 

  203. <TD><CODE><B><A HREF="../../../../com/martiansoftware/jsap/ant/ParameterConfiguration.html#setDefault(java.lang.String)">setDefault</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;defaultValue)</CODE>
    204. 

  204. 

  205. <BR>
    206. 

  206. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds a default value to the current list of default values for this
    207. 

  207.  parameter.</TD>
    208. 

  208. </TR>
    209. 

  209. <TR BGCOLOR="white" CLASS="TableRowColor">
    210. 

  210. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    211. 

  211. <CODE>&nbsp;void</CODE></FONT></TD>
    212. 

  212. <TD><CODE><B><A HREF="../../../../com/martiansoftware/jsap/ant/ParameterConfiguration.html#setId(java.lang.String)">setId</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;id)</CODE>
    213. 

  213. 

  214. <BR>
    215. 

  215. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the unique ID for this parameter.</TD>
    216. 

  216. </TR>
    217. 

  217. </TABLE>
    218. 

  218. &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
    219. 

  219. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    220. 

  220. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
    221. 

  221. <TD><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></B></TD>
    222. 

  222. </TR>
    223. 

  223. <TR BGCOLOR="white" CLASS="TableRowColor">
    224. 

  224. <TD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
    225. 

  225. </TR>
    226. 

  226. </TABLE>
    227. 

  227. &nbsp;
    228. 

  228. <P>
    229. 

  229. 

  230. <!-- ============ FIELD DETAIL =========== -->
    231. 

  231. 

  232. 

  233. <!-- ========= CONSTRUCTOR DETAIL ======== -->
    234. 

  234. 

  235. <A NAME="constructor_detail"><!-- --></A>
    236. 

  236. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    237. 

  237. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    238. 

  238. <TD COLSPAN=1><FONT SIZE="+2">
    239. 

  239. <B>Constructor Detail</B></FONT></TD>
    240. 

  240. </TR>
    241. 

  241. </TABLE>
    242. 

  242. 

  243. <A NAME="ParameterConfiguration()"><!-- --></A><H3>
    244. 

  244. ParameterConfiguration</H3>
    245. 

  245. <PRE>
    246. 

  246. public <B>ParameterConfiguration</B>()</PRE>
    247. 

  247. <DL>
    248. 

  248. <DD>Creates a new ParameterConfiguration.
    249. 

  249. <P>
    250. 

  250. </DL>
    251. 

  251. 

  252. <!-- ============ METHOD DETAIL ========== -->
    253. 

  253. 

  254. <A NAME="method_detail"><!-- --></A>
    255. 

  255. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    256. 

  256. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    257. 

  257. <TD COLSPAN=1><FONT SIZE="+2">
    258. 

  258. <B>Method Detail</B></FONT></TD>
    259. 

  259. </TR>
    260. 

  260. </TABLE>
    261. 

  261. 

  262. <A NAME="getParameter()"><!-- --></A><H3>
    263. 

  263. getParameter</H3>
    264. 

  264. <PRE>
    265. 

  265. public abstract <A HREF="../../../../com/martiansoftware/jsap/Parameter.html" title="class in com.martiansoftware.jsap">Parameter</A> <B>getParameter</B>()</PRE>
    266. 

  266. <DL>
    267. 

  267. <DD>Returns an Parameter (String, FlaggedOption, or UnflaggedOption)
    268. 

  268.  configured according
    269. 

  269.  to the settings contained within this object.
    270. 

  270. <P>
    271. 

  271. <DD><DL>
    272. 

  272. 

  273. <DT><B>Returns:</B><DD>an Parameter (String, FlaggedOption, or UnflaggedOption)
    274. 

  274.  configured according
    275. 

  275.  to the settings contained within this object.</DL>
    276. 

  276. </DD>
    277. 

  277. </DL>
    278. 

  278. <HR>
    279. 

  279. 

  280. <A NAME="setId(java.lang.String)"><!-- --></A><H3>
    281. 

  281. setId</H3>
    282. 

  282. <PRE>
    283. 

  283. public void <B>setId</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;id)</PRE>
    284. 

  284. <DL>
    285. 

  285. <DD>Sets the unique ID for this parameter.
    286. 

  286. <P>
    287. 

  287. <DD><DL>
    288. 

  288. <DT><B>Parameters:</B><DD><CODE>id</CODE> - ths unique ID for this parameter.</DL>
    289. 

  289. </DD>
    290. 

  290. </DL>
    291. 

  291. <HR>
    292. 

  292. 

  293. <A NAME="getId()"><!-- --></A><H3>
    294. 

  294. getId</H3>
    295. 

  295. <PRE>
    296. 

  296. public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getId</B>()</PRE>
    297. 

  297. <DL>
    298. 

  298. <DD>Returns the unique ID for this parameter.
    299. 

  299. <P>
    300. 

  300. <DD><DL>
    301. 

  301. 

  302. <DT><B>Returns:</B><DD>the unique ID for this parameter.</DL>
    303. 

  303. </DD>
    304. 

  304. </DL>
    305. 

  305. <HR>
    306. 

  306. 

  307. <A NAME="setDefault(java.lang.String)"><!-- --></A><H3>
    308. 

  308. setDefault</H3>
    309. 

  309. <PRE>
    310. 

  310. public void <B>setDefault</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;defaultValue)</PRE>
    311. 

  311. <DL>
    312. 

  312. <DD>Adds a default value to the current list of default values for this
    313. 

  313.  parameter.
    314. 

  314. <P>
    315. 

  315. <DD><DL>
    316. 

  316. <DT><B>Parameters:</B><DD><CODE>defaultValue</CODE> - the default value to add to the current list of
    317. 

  317.  default values for this parameter.</DL>
    318. 

  318. </DD>
    319. 

  319. </DL>
    320. 

  320. <HR>
    321. 

  321. 

  322. <A NAME="addConfiguredDefault(com.martiansoftware.jsap.ant.DefaultValue)"><!-- --></A><H3>
    323. 

  323. addConfiguredDefault</H3>
    324. 

  324. <PRE>
    325. 

  325. public void <B>addConfiguredDefault</B>(<A HREF="../../../../com/martiansoftware/jsap/ant/DefaultValue.html" title="class in com.martiansoftware.jsap.ant">DefaultValue</A>&nbsp;defaultValue)</PRE>
    326. 

  326. <DL>
    327. 

  327. <DD>Adds a configured default value to the current list of default values
    328. 

  328.  for this parameter.
    329. 

  329. <P>
    330. 

  330. <DD><DL>
    331. 

  331. <DT><B>Parameters:</B><DD><CODE>defaultValue</CODE> - the configured default value to add to the current
    332. 

  332.  list of default
    333. 

  333.  values for this parameter.</DL>
    334. 

  334. </DD>
    335. 

  335. </DL>
    336. 

  336. <HR>
    337. 

  337. 

  338. <A NAME="getDefaults()"><!-- --></A><H3>
    339. 

  339. getDefaults</H3>
    340. 

  340. <PRE>
    341. 

  341. public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>[] <B>getDefaults</B>()</PRE>
    342. 

  342. <DL>
    343. 

  343. <DD>Returns an array of this parameter's default values, or a zero-length
    344. 

  344.  array if none exist.
    345. 

  345. <P>
    346. 

  346. <DD><DL>
    347. 

  347. 

  348. <DT><B>Returns:</B><DD>an array of this parameter's default values, or a zero-length
    349. 

  349.  array if none exist.</DL>
    350. 

  350. </DD>
    351. 

  351. </DL>
    352. 

  352. <HR>
    353. 

  353. 

  354. <A NAME="hasProperties()"><!-- --></A><H3>
    355. 

  355. hasProperties</H3>
    356. 

  356. <PRE>
    357. 

  357. public boolean <B>hasProperties</B>()</PRE>
    358. 

  358. <DL>
    359. 

  359. <DD>Returns a boolean indicating whether this parameter has any properties
    360. 

  360.  associated with its
    361. 

  361.  StringParser.  This method always returns false; it may be overridden by
    362. 

  362.  subclasses.
    363. 

  363. <P>
    364. 

  364. <DD><DL>
    365. 

  365. 

  366. <DT><B>Returns:</B><DD>a boolean indicating whether this parameter has any properties
    367. 

  367.  associated with its
    368. 

  368.  StringParser.</DL>
    369. 

  369. </DD>
    370. 

  370. </DL>
    371. 

  371. <HR>
    372. 

  372. 

  373. <A NAME="createMethod(java.lang.String, java.io.PrintStream)"><!-- --></A><H3>
    374. 

  374. createMethod</H3>
    375. 

  375. <PRE>
    376. 

  376. public abstract void <B>createMethod</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;methodName,
    377. 

  377.                                   <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/PrintStream.html" title="class or interface in java.io">PrintStream</A>&nbsp;out)
    378. 

  378.                            throws <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></PRE>
    379. 

  379. <DL>
    380. 

  380. <DD>Creates source code for a java method that creates a parameter matching
    381. 

  381.  this object's configuration.
    382. 

  382. <P>
    383. 

  383. <DD><DL>
    384. 

  384. <DT><B>Parameters:</B><DD><CODE>methodName</CODE> - the name of the java method to generate.<DD><CODE>out</CODE> - the PrintStream to which the generated source code should be
    385. 

  385.  written.
    386. 

  386. <DT><B>Throws:</B>
    387. 

  387. <DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></CODE> - if any are thrown by PrintStream.</DL>
    388. 

  388. </DD>
    389. 

  389. </DL>
    390. 

  390. <!-- ========= END OF CLASS DATA ========= -->
    391. 

  391. <HR>
    392. 

  392. 

  393. 

  394. <!-- ======= START OF BOTTOM NAVBAR ====== -->
    395. 

  395. <A NAME="navbar_bottom"><!-- --></A>
    396. 

  396. <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
    397. 

  397. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
    398. 

  398. <TR>
    399. 

  399. <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
    400. 

  400. <A NAME="navbar_bottom_firstrow"><!-- --></A>
    401. 

  401. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
    402. 

  402.   <TR ALIGN="center" VALIGN="top">
    403. 

  403.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
    404. 

  404.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
    405. 

  405.   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
    406. 

  406.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
    407. 

  407.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
    408. 

  408.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
    409. 

  409.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
    410. 

  410.   </TR>
    411. 

  411. </TABLE>
    412. 

  412. </TD>
    413. 

  413. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
    414. 

  414. </EM>
    415. 

  415. </TD>
    416. 

  416. </TR>
    417. 

  417. 

  418. <TR>
    419. 

  419. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    420. 

  420. &nbsp;<A HREF="../../../../com/martiansoftware/jsap/ant/OptionConfiguration.html" title="class in com.martiansoftware.jsap.ant"><B>PREV CLASS</B></A>&nbsp;
    421. 

  421. &nbsp;<A HREF="../../../../com/martiansoftware/jsap/ant/ParserProperty.html" title="class in com.martiansoftware.jsap.ant"><B>NEXT CLASS</B></A></FONT></TD>
    422. 

  422. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    423. 

  423.   <A HREF="../../../../index.html" target="_top"><B>FRAMES</B></A>  &nbsp;
    424. 

  424. &nbsp;<A HREF="ParameterConfiguration.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
    425. 

  425. &nbsp;<SCRIPT type="text/javascript">
    426. 

  426.   <!--
    427. 

  427.   if(window==top) {
    428. 

  428.     document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
    429. 

  429.   }
    430. 

  430.   //-->
    431. 

  431. </SCRIPT>
    432. 

  432. <NOSCRIPT>
    433. 

  433.   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
    434. 

  434. </NOSCRIPT>
    435. 

  435. 

  436. </FONT></TD>
    437. 

  437. </TR>
    438. 

  438. <TR>
    439. 

  439. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
    440. 

  440.   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
    441. 

  441. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
    442. 

  442. DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
    443. 

  443. </TR>
    444. 

  444. </TABLE>
    445. 

  445. <A NAME="skip-navbar_bottom"></A>
    446. 

  446. <!-- ======== END OF BOTTOM NAVBAR ======= -->
    447. 

  447. 

  448. <HR>
    449. 

  449. Copyright &copy; 2002-2006, Martian Software, Inc..  All Rights Reserved.<br>For the latest version and documentation, please visit <a href='http://www.martiansoftware.com/jsap'>http://www.martiansoftware.com/jsap</a>
    450. 

  450. </BODY>
    451. 

  451. </HTML>
    452.