| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>ArgumentValues (Apache Geode 1.15.0)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="ArgumentValues (Apache Geode 1.15.0)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <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="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/geode/modules/session/installer/args/ArgumentProcessor.html" title="class in org.apache.geode.modules.session.installer.args"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../org/apache/geode/modules/session/installer/args/UnknownArgumentHandler.html" title="interface in org.apache.geode.modules.session.installer.args"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/geode/modules/session/installer/args/ArgumentValues.html" target="_top">Frames</a></li> |
| <li><a href="ArgumentValues.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>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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.geode.modules.session.installer.args</div> |
| <h2 title="Class ArgumentValues" class="title">Class ArgumentValues</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/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.geode.modules.session.installer.args.ArgumentValues</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">ArgumentValues</span> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> |
| <div class="block">Result object capturing the result of processing command line arguments.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/geode/modules/session/installer/args/ArgumentValues.html#getAllResults-org.apache.geode.modules.session.installer.args.Argument-">getAllResults</a></span>(<a href="../../../../../../../org/apache/geode/modules/session/installer/args/Argument.html" title="class in org.apache.geode.modules.session.installer.args">Argument</a> arg)</code> |
| <div class="block">Returns all results for the specified argument.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="../../../../../../../org/apache/geode/modules/session/installer/args/Argument.html" title="class in org.apache.geode.modules.session.installer.args">Argument</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/geode/modules/session/installer/args/ArgumentValues.html#getDefinedArguments--">getDefinedArguments</a></span>()</code> |
| <div class="block">Returns a list of all defined arguments.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/geode/modules/session/installer/args/ArgumentValues.html#getDefinedCount-org.apache.geode.modules.session.installer.args.Argument...-">getDefinedCount</a></span>(<a href="../../../../../../../org/apache/geode/modules/session/installer/args/Argument.html" title="class in org.apache.geode.modules.session.installer.args">Argument</a>... ofThese)</code> |
| <div class="block">Counts the number of arguments defined on the command line which are in the list provided.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/geode/modules/session/installer/args/ArgumentValues.html#getFirstResult-org.apache.geode.modules.session.installer.args.Argument-">getFirstResult</a></span>(<a href="../../../../../../../org/apache/geode/modules/session/installer/args/Argument.html" title="class in org.apache.geode.modules.session.installer.args">Argument</a> arg)</code> |
| <div class="block">Convenience method to return the first value of the first instance of the command line argument |
| values for the specified argument.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/geode/modules/session/installer/args/ArgumentValues.html#getFirstResultAsInt-org.apache.geode.modules.session.installer.args.Argument-int-">getFirstResultAsInt</a></span>(<a href="../../../../../../../org/apache/geode/modules/session/installer/args/Argument.html" title="class in org.apache.geode.modules.session.installer.args">Argument</a> arg, |
| int undefinedValue)</code> |
| <div class="block">Convenience method to return the result of getFirstResult method as an integer.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/geode/modules/session/installer/args/ArgumentValues.html#getPostArgs--">getPostArgs</a></span>()</code> |
| <div class="block">After processing the command line arguments, this method may be used to return all arguments |
| which were excluded from processing by their placement after the "<code>--</code>" |
| psuedo-argument.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/geode/modules/session/installer/args/ArgumentValues.html#isDefined-org.apache.geode.modules.session.installer.args.Argument-">isDefined</a></span>(<a href="../../../../../../../org/apache/geode/modules/session/installer/args/Argument.html" title="class in org.apache.geode.modules.session.installer.args">Argument</a> arg)</code> |
| <div class="block">Returns whetheror not the command line argument was actually provided on the command line.</div> |
| </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="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" 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"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getPostArgs--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPostArgs</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] getPostArgs()</pre> |
| <div class="block">After processing the command line arguments, this method may be used to return all arguments |
| which were excluded from processing by their placement after the "<code>--</code>" |
| psuedo-argument.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>all unprocess arguments</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDefinedArguments--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDefinedArguments</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="../../../../../../../org/apache/geode/modules/session/installer/args/Argument.html" title="class in org.apache.geode.modules.session.installer.args">Argument</a>> getDefinedArguments()</pre> |
| <div class="block">Returns a list of all defined arguments.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>set of arguments</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDefinedCount-org.apache.geode.modules.session.installer.args.Argument...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDefinedCount</h4> |
| <pre>public int getDefinedCount(<a href="../../../../../../../org/apache/geode/modules/session/installer/args/Argument.html" title="class in org.apache.geode.modules.session.installer.args">Argument</a>... ofThese)</pre> |
| <div class="block">Counts the number of arguments defined on the command line which are in the list provided.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ofThese</code> - the arguments to search for, or null to count all supplied arguments</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>count of the defined arguments</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isDefined-org.apache.geode.modules.session.installer.args.Argument-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isDefined</h4> |
| <pre>public boolean isDefined(<a href="../../../../../../../org/apache/geode/modules/session/installer/args/Argument.html" title="class in org.apache.geode.modules.session.installer.args">Argument</a> arg)</pre> |
| <div class="block">Returns whetheror not the command line argument was actually provided on the command line.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>arg</code> - argument to query</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the argument is defined by the command line, false otherwise</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAllResults-org.apache.geode.modules.session.installer.args.Argument-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAllResults</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]> getAllResults(<a href="../../../../../../../org/apache/geode/modules/session/installer/args/Argument.html" title="class in org.apache.geode.modules.session.installer.args">Argument</a> arg)</pre> |
| <div class="block">Returns all results for the specified argument. If a command line option is specified more than |
| once, this is the method to use to get all values.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>arg</code> - argument to query</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>list of all parameter lists defined for this argument</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFirstResult-org.apache.geode.modules.session.installer.args.Argument-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFirstResult</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getFirstResult(<a href="../../../../../../../org/apache/geode/modules/session/installer/args/Argument.html" title="class in org.apache.geode.modules.session.installer.args">Argument</a> arg)</pre> |
| <div class="block">Convenience method to return the first value of the first instance of the command line argument |
| values for the specified argument.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>arg</code> - argument to query</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>first parameter of the first list of parameters supplied</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFirstResultAsInt-org.apache.geode.modules.session.installer.args.Argument-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getFirstResultAsInt</h4> |
| <pre>public int getFirstResultAsInt(<a href="../../../../../../../org/apache/geode/modules/session/installer/args/Argument.html" title="class in org.apache.geode.modules.session.installer.args">Argument</a> arg, |
| int undefinedValue)</pre> |
| <div class="block">Convenience method to return the result of getFirstResult method as an integer.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>arg</code> - argument to query</dd> |
| <dd><code>undefinedValue</code> - value to return when argument is not defined or is illegally defined</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>value specified, or default value provided</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> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <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="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/geode/modules/session/installer/args/ArgumentProcessor.html" title="class in org.apache.geode.modules.session.installer.args"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../org/apache/geode/modules/session/installer/args/UnknownArgumentHandler.html" title="interface in org.apache.geode.modules.session.installer.args"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/geode/modules/session/installer/args/ArgumentValues.html" target="_top">Frames</a></li> |
| <li><a href="ArgumentValues.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>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
