| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>CLArgsParser (Apache Axis)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="CLArgsParser (Apache Axis)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/CLArgsParser.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/axis/utils/ByteArrayOutputStream.html" title="class in org.apache.axis.utils"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/axis/utils/ClasspathUtils.html" title="class in org.apache.axis.utils"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/axis/utils/CLArgsParser.html" target="_top">Frames</a></li> |
| <li><a href="CLArgsParser.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor_detail">Constr</a> | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.axis.utils</div> |
| <h2 title="Class CLArgsParser" class="title">Class CLArgsParser</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.axis.utils.CLArgsParser</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public final class <span class="strong">CLArgsParser</span> |
| extends <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> |
| <div class="block">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.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>4.0</dd> |
| <dt><span class="strong">Author:</span></dt> |
| <dd><a href="mailto:peter@apache.org">Peter Donald</a></dd></dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><strong><a href="../../../../org/apache/axis/utils/CLArgsParser.html#CLArgsParser(java.lang.String[],%20org.apache.axis.utils.CLOptionDescriptor[])">CLArgsParser</a></strong>(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args, |
| <a href="../../../../org/apache/axis/utils/CLOptionDescriptor.html" title="class in org.apache.axis.utils">CLOptionDescriptor</a>[] optionDescriptors)</code> |
| <div class="block">Create a parser that deals with options and parses certain args.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><strong><a href="../../../../org/apache/axis/utils/CLArgsParser.html#CLArgsParser(java.lang.String[],%20org.apache.axis.utils.CLOptionDescriptor[],%20org.apache.axis.utils.ParserControl)">CLArgsParser</a></strong>(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] 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> |
| <div class="block">Create a parser that can deal with options and parses certain args.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/axis/utils/CLOption.html" title="class in org.apache.axis.utils">CLOption</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/axis/utils/CLArgsParser.html#getArgumentById(int)">getArgumentById</a></strong>(int id)</code> |
| <div class="block">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.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/axis/utils/CLOption.html" title="class in org.apache.axis.utils">CLOption</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/axis/utils/CLArgsParser.html#getArgumentByName(java.lang.String)">getArgumentByName</a></strong>(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> |
| <div class="block">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.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/axis/utils/CLArgsParser.html#getArguments()">getArguments</a></strong>()</code> |
| <div class="block">Retrieve a list of options that were parsed from command list.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/axis/utils/CLArgsParser.html#getErrorString()">getErrorString</a></strong>()</code> |
| <div class="block">Retrieve an error message that occured during parsing if one existed.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/axis/utils/CLArgsParser.html#getUnparsedArgs()">getUnparsedArgs</a></strong>()</code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="CLArgsParser(java.lang.String[], org.apache.axis.utils.CLOptionDescriptor[], org.apache.axis.utils.ParserControl)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CLArgsParser</h4> |
| <pre>public CLArgsParser(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] 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> |
| <div class="block">Create a parser that can deal with options and parses certain args.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>args</code> - the args, typically that passed to the |
| <code>public static void main(String[] args)</code> method.</dd><dd><code>optionDescriptors</code> - the option descriptors</dd></dl> |
| </li> |
| </ul> |
| <a name="CLArgsParser(java.lang.String[], org.apache.axis.utils.CLOptionDescriptor[])"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>CLArgsParser</h4> |
| <pre>public CLArgsParser(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args, |
| <a href="../../../../org/apache/axis/utils/CLOptionDescriptor.html" title="class in org.apache.axis.utils">CLOptionDescriptor</a>[] optionDescriptors)</pre> |
| <div class="block">Create a parser that deals with options and parses certain args.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>args</code> - the args</dd><dd><code>optionDescriptors</code> - the option descriptors</dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getUnparsedArgs()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUnparsedArgs</h4> |
| <pre>public final <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] getUnparsedArgs()</pre> |
| </li> |
| </ul> |
| <a name="getArguments()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getArguments</h4> |
| <pre>public final <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a> getArguments()</pre> |
| <div class="block">Retrieve a list of options that were parsed from command list.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the list of options</dd></dl> |
| </li> |
| </ul> |
| <a name="getArgumentById(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getArgumentById</h4> |
| <pre>public final <a href="../../../../org/apache/axis/utils/CLOption.html" title="class in org.apache.axis.utils">CLOption</a> getArgumentById(int id)</pre> |
| <div class="block">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.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>id</code> - the command line option id</dd> |
| <dt><span class="strong">Returns:</span></dt><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.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/axis/utils/CLOption.html" title="class in org.apache.axis.utils"><code>CLOption</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="getArgumentByName(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getArgumentByName</h4> |
| <pre>public final <a href="../../../../org/apache/axis/utils/CLOption.html" title="class in org.apache.axis.utils">CLOption</a> getArgumentByName(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre> |
| <div class="block">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.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the command line option name</dd> |
| <dt><span class="strong">Returns:</span></dt><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.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/axis/utils/CLOption.html" title="class in org.apache.axis.utils"><code>CLOption</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="getErrorString()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getErrorString</h4> |
| <pre>public final <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getErrorString()</pre> |
| <div class="block">Retrieve an error message that occured during parsing if one existed.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the error string</dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/CLArgsParser.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/axis/utils/ByteArrayOutputStream.html" title="class in org.apache.axis.utils"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/axis/utils/ClasspathUtils.html" title="class in org.apache.axis.utils"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/axis/utils/CLArgsParser.html" target="_top">Frames</a></li> |
| <li><a href="CLArgsParser.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor_detail">Constr</a> | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p> |
| </body> |
| </html> |
