| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!--NewPage--> |
| <HTML> |
| <HEAD> |
| <!-- Generated by javadoc (build 1.4.2_08) on Sat Apr 22 18:56:49 PDT 2006 --> |
| <TITLE> |
| CLArgsParser (Axis API) |
| </TITLE> |
| |
| <META NAME="keywords" CONTENT="org.apache.axis.utils.CLArgsParser class"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| parent.document.title="CLArgsParser (Axis API)"; |
| } |
| </SCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| |
| |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <A NAME="navbar_top"><!-- --></A> |
| <A HREF="#skip-navbar_top" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/CLArgsParser.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../org/apache/axis/utils/ByteArrayOutputStream.html" title="class in org.apache.axis.utils"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/apache/axis/utils/ClasspathUtils.html" title="class in org.apache.axis.utils"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="CLArgsParser.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_top"></A> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| |
| <HR> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <H2> |
| <FONT SIZE="-1"> |
| org.apache.axis.utils</FONT> |
| <BR> |
| Class CLArgsParser</H2> |
| <PRE> |
| java.lang.Object |
| <IMG SRC="../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.axis.utils.CLArgsParser</B> |
| </PRE> |
| <HR> |
| <DL> |
| <DT>public final class <B>CLArgsParser</B><DT>extends java.lang.Object</DL> |
| |
| <P> |
| Parser for command line arguments. |
| |
| This parses command lines according to the standard (?) of |
| GNU utilities. |
| |
| Note: This is still used in 1.1 libraries so do not add 1.2+ dependencies. |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>Since:</B></DT> |
| <DD>4.0</DD> |
| <DT><B>Author:</B></DT> |
| <DD><a href="mailto:peter@apache.org">Peter Donald</a></DD> |
| </DL> |
| <HR> |
| |
| <P> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| |
| |
| <!-- =========== FIELD SUMMARY =========== --> |
| |
| |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| |
| <A NAME="constructor_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=2><FONT SIZE="+2"> |
| <B>Constructor Summary</B></FONT></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../org/apache/axis/utils/CLArgsParser.html#CLArgsParser(java.lang.String[], org.apache.axis.utils.CLOptionDescriptor[])">CLArgsParser</A></B>(java.lang.String[] args, |
| <A HREF="../../../../org/apache/axis/utils/CLOptionDescriptor.html" title="class in org.apache.axis.utils">CLOptionDescriptor</A>[] optionDescriptors)</CODE> |
| |
| <BR> |
| Create a parser that deals with options and parses certain args.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../org/apache/axis/utils/CLArgsParser.html#CLArgsParser(java.lang.String[], org.apache.axis.utils.CLOptionDescriptor[], org.apache.axis.utils.ParserControl)">CLArgsParser</A></B>(java.lang.String[] args, |
| <A HREF="../../../../org/apache/axis/utils/CLOptionDescriptor.html" title="class in org.apache.axis.utils">CLOptionDescriptor</A>[] optionDescriptors, |
| <A HREF="../../../../org/apache/axis/utils/ParserControl.html" title="interface in org.apache.axis.utils">ParserControl</A> control)</CODE> |
| |
| <BR> |
| Create a parser that can deal with options and parses certain args.</TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ========== METHOD SUMMARY =========== --> |
| |
| <A NAME="method_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=2><FONT SIZE="+2"> |
| <B>Method Summary</B></FONT></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/axis/utils/CLOption.html" title="class in org.apache.axis.utils">CLOption</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/axis/utils/CLArgsParser.html#getArgumentById(int)">getArgumentById</A></B>(int id)</CODE> |
| |
| <BR> |
| Retrieve the <A HREF="../../../../org/apache/axis/utils/CLOption.html" title="class in org.apache.axis.utils"><CODE>CLOption</CODE></A> with specified id, or |
| <code>null</code> if no command line option is found.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/axis/utils/CLOption.html" title="class in org.apache.axis.utils">CLOption</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/axis/utils/CLArgsParser.html#getArgumentByName(java.lang.String)">getArgumentByName</A></B>(java.lang.String name)</CODE> |
| |
| <BR> |
| Retrieve the <A HREF="../../../../org/apache/axis/utils/CLOption.html" title="class in org.apache.axis.utils"><CODE>CLOption</CODE></A> with specified name, or |
| <code>null</code> if no command line option is found.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.util.Vector</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/axis/utils/CLArgsParser.html#getArguments()">getArguments</A></B>()</CODE> |
| |
| <BR> |
| Retrieve a list of options that were parsed from command list.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/axis/utils/CLArgsParser.html#getErrorString()">getErrorString</A></B>()</CODE> |
| |
| <BR> |
| Retrieve an error message that occured during parsing if one existed.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.String[]</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/axis/utils/CLArgsParser.html#getUnparsedArgs()">getUnparsedArgs</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TD><B>Methods inherited from class java.lang.Object</B></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ FIELD DETAIL =========== --> |
| |
| |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| |
| <A NAME="constructor_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=1><FONT SIZE="+2"> |
| <B>Constructor Detail</B></FONT></TD> |
| </TR> |
| </TABLE> |
| |
| <A NAME="CLArgsParser(java.lang.String[], org.apache.axis.utils.CLOptionDescriptor[], org.apache.axis.utils.ParserControl)"><!-- --></A><H3> |
| CLArgsParser</H3> |
| <PRE> |
| public <B>CLArgsParser</B>(java.lang.String[] args, |
| <A HREF="../../../../org/apache/axis/utils/CLOptionDescriptor.html" title="class in org.apache.axis.utils">CLOptionDescriptor</A>[] optionDescriptors, |
| <A HREF="../../../../org/apache/axis/utils/ParserControl.html" title="interface in org.apache.axis.utils">ParserControl</A> control)</PRE> |
| <DL> |
| <DD>Create a parser that can deal with options and parses certain args. |
| <P> |
| <DT><B>Parameters:</B><DD><CODE>args</CODE> - the args, typically that passed to the |
| <code>public static void main(String[] args)</code> method.<DD><CODE>optionDescriptors</CODE> - the option descriptors</DL> |
| <HR> |
| |
| <A NAME="CLArgsParser(java.lang.String[], org.apache.axis.utils.CLOptionDescriptor[])"><!-- --></A><H3> |
| CLArgsParser</H3> |
| <PRE> |
| public <B>CLArgsParser</B>(java.lang.String[] args, |
| <A HREF="../../../../org/apache/axis/utils/CLOptionDescriptor.html" title="class in org.apache.axis.utils">CLOptionDescriptor</A>[] optionDescriptors)</PRE> |
| <DL> |
| <DD>Create a parser that deals with options and parses certain args. |
| <P> |
| <DT><B>Parameters:</B><DD><CODE>args</CODE> - the args<DD><CODE>optionDescriptors</CODE> - the option descriptors</DL> |
| |
| <!-- ============ METHOD DETAIL ========== --> |
| |
| <A NAME="method_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=1><FONT SIZE="+2"> |
| <B>Method Detail</B></FONT></TD> |
| </TR> |
| </TABLE> |
| |
| <A NAME="getUnparsedArgs()"><!-- --></A><H3> |
| getUnparsedArgs</H3> |
| <PRE> |
| public final java.lang.String[] <B>getUnparsedArgs</B>()</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getArguments()"><!-- --></A><H3> |
| getArguments</H3> |
| <PRE> |
| public final java.util.Vector <B>getArguments</B>()</PRE> |
| <DL> |
| <DD>Retrieve a list of options that were parsed from command list. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the list of options</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getArgumentById(int)"><!-- --></A><H3> |
| getArgumentById</H3> |
| <PRE> |
| public final <A HREF="../../../../org/apache/axis/utils/CLOption.html" title="class in org.apache.axis.utils">CLOption</A> <B>getArgumentById</B>(int id)</PRE> |
| <DL> |
| <DD>Retrieve the <A HREF="../../../../org/apache/axis/utils/CLOption.html" title="class in org.apache.axis.utils"><CODE>CLOption</CODE></A> with specified id, or |
| <code>null</code> if no command line option is found. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>id</CODE> - the command line option id |
| <DT><B>Returns:</B><DD>the <A HREF="../../../../org/apache/axis/utils/CLOption.html" title="class in org.apache.axis.utils"><CODE>CLOption</CODE></A> with the specified id, or |
| <code>null</code> if no CLOption is found.<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/axis/utils/CLOption.html" title="class in org.apache.axis.utils"><CODE>CLOption</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getArgumentByName(java.lang.String)"><!-- --></A><H3> |
| getArgumentByName</H3> |
| <PRE> |
| public final <A HREF="../../../../org/apache/axis/utils/CLOption.html" title="class in org.apache.axis.utils">CLOption</A> <B>getArgumentByName</B>(java.lang.String name)</PRE> |
| <DL> |
| <DD>Retrieve the <A HREF="../../../../org/apache/axis/utils/CLOption.html" title="class in org.apache.axis.utils"><CODE>CLOption</CODE></A> with specified name, or |
| <code>null</code> if no command line option is found. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>name</CODE> - the command line option name |
| <DT><B>Returns:</B><DD>the <A HREF="../../../../org/apache/axis/utils/CLOption.html" title="class in org.apache.axis.utils"><CODE>CLOption</CODE></A> with the specified name, or |
| <code>null</code> if no CLOption is found.<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/axis/utils/CLOption.html" title="class in org.apache.axis.utils"><CODE>CLOption</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getErrorString()"><!-- --></A><H3> |
| getErrorString</H3> |
| <PRE> |
| public final java.lang.String <B>getErrorString</B>()</PRE> |
| <DL> |
| <DD>Retrieve an error message that occured during parsing if one existed. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the error string</DL> |
| </DD> |
| </DL> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <HR> |
| |
| |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <A NAME="navbar_bottom"><!-- --></A> |
| <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/CLArgsParser.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../org/apache/axis/utils/ByteArrayOutputStream.html" title="class in org.apache.axis.utils"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/apache/axis/utils/ClasspathUtils.html" title="class in org.apache.axis.utils"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="CLArgsParser.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| Copyright © 2005 Apache Web Services Project. All Rights Reserved. |
| </BODY> |
| </HTML> |
