<!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 (1.8.0_131) on Thu May 25 01:29:03 JST 2017 --> <title>CommandLine.Arity (picocli 0.9.6 API)</title> <meta name="date" content="2017-05-25"> <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="CommandLine.Arity (picocli 0.9.6 API)"; } } catch(err) { } //--> var methods = {"i0":10,"i1":9,"i2":9,"i3":9,"i4":10,"i5":10,"i6":10,"i7":10,"i8":9}; var tabs = {65535:["t0","All Methods"],1:["t1","Static 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="../picocli/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="../picocli/CommandLine.html" title="class in picocli"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../picocli/CommandLine.Command.html" title="annotation in picocli"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../index.html?picocli/CommandLine.Arity.html" target="_top">Frames</a></li> <li><a href="CommandLine.Arity.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><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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">picocli</div> <h2 title="Class CommandLine.Arity" class="title">Class CommandLine.Arity</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>picocli.CommandLine.Arity</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <dl> <dt>Enclosing class:</dt> <dd><a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a></dd> </dl> <hr> <br> <pre>public static class <span class="typeNameLabel">CommandLine.Arity</span> extends java.lang.Object</pre> <div class="block">Describes the number of parameters required and accepted by an option or a positional parameter.</div> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList"> <!-- =========== FIELD SUMMARY =========== --> <ul class="blockList"> <li class="blockList"><a name="field.summary"> <!-- --> </a> <h3>Field Summary</h3> <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> <caption><span>Fields</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Field and Description</th> </tr> <tr class="altColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Arity.html#isVariable">isVariable</a></span></code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Arity.html#max">max</a></span></code> <div class="block">Maximum accepted number of parameters for an option or positional parameter.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Arity.html#min">min</a></span></code> <div class="block">Required number of parameters for an option or positional parameter.</div> </td> </tr> </table> </li> </ul> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor.summary"> <!-- --> </a> <h3>Constructor Summary</h3> <table class="memberSummary" 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><span class="memberNameLink"><a href="../picocli/CommandLine.Arity.html#Arity-int-int-boolean-boolean-java.lang.String-">Arity</a></span>(int min, int max, boolean variable, boolean unspecified, java.lang.String originalValue)</code> <div class="block">Constructs a new Arity object with the specified parameters.</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="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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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>boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Arity.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object object)</code> </td> </tr> <tr id="i1" class="rowColor"> <td class="colFirst"><code>static <a href="../picocli/CommandLine.Arity.html" title="class in picocli">CommandLine.Arity</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Arity.html#forOption-java.lang.reflect.Field-">forOption</a></span>(java.lang.reflect.Field field)</code> <div class="block">Returns a new <code>Arity</code> based on the Option annotation on the specified field, or the field type if no arity was specified.</div> </td> </tr> <tr id="i2" class="altColor"> <td class="colFirst"><code>static <a href="../picocli/CommandLine.Arity.html" title="class in picocli">CommandLine.Arity</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Arity.html#forParameters-java.lang.reflect.Field-">forParameters</a></span>(java.lang.reflect.Field field)</code> <div class="block">Returns a new <code>Arity</code> based on the Parameters annotation on the specified field, or the field type if no arity was specified.</div> </td> </tr> <tr id="i3" class="rowColor"> <td class="colFirst"><code>static <a href="../picocli/CommandLine.Arity.html" title="class in picocli">CommandLine.Arity</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Arity.html#forType-java.lang.Class-">forType</a></span>(java.lang.Class<?> type)</code> <div class="block">Returns a new <code>Arity</code> based on the specified type: booleans have arity 0, arrays or Collections have arity "0..*", and other types have arity 1.</div> </td> </tr> <tr id="i4" class="altColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Arity.html#hashCode--">hashCode</a></span>()</code> </td> </tr> <tr id="i5" class="rowColor"> <td class="colFirst"><code><a href="../picocli/CommandLine.Arity.html" title="class in picocli">CommandLine.Arity</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Arity.html#max-int-">max</a></span>(int newMax)</code> <div class="block">Returns a new Arity object with the <code>max</code> value replaced by the specified value.</div> </td> </tr> <tr id="i6" class="altColor"> <td class="colFirst"><code><a href="../picocli/CommandLine.Arity.html" title="class in picocli">CommandLine.Arity</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Arity.html#min-int-">min</a></span>(int newMin)</code> <div class="block">Returns a new Arity object with the <code>min</code> value replaced by the specified value.</div> </td> </tr> <tr id="i7" class="rowColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Arity.html#toString--">toString</a></span>()</code> </td> </tr> <tr id="i8" class="altColor"> <td class="colFirst"><code>static <a href="../picocli/CommandLine.Arity.html" title="class in picocli">CommandLine.Arity</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Arity.html#valueOf-java.lang.String-">valueOf</a></span>(java.lang.String arity)</code> <div class="block">Leniently parses the specified String as an <code>Arity</code> value and return the result.</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.Object</h3> <code>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li> </ul> </li> </ul> </li> </ul> </div> <div class="details"> <ul class="blockList"> <li class="blockList"> <!-- ============ FIELD DETAIL =========== --> <ul class="blockList"> <li class="blockList"><a name="field.detail"> <!-- --> </a> <h3>Field Detail</h3> <a name="min"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>min</h4> <pre>public final int min</pre> <div class="block">Required number of parameters for an option or positional parameter.</div> </li> </ul> <a name="max"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>max</h4> <pre>public final int max</pre> <div class="block">Maximum accepted number of parameters for an option or positional parameter.</div> </li> </ul> <a name="isVariable"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>isVariable</h4> <pre>public final boolean isVariable</pre> </li> </ul> </li> </ul> <!-- ========= CONSTRUCTOR DETAIL ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor.detail"> <!-- --> </a> <h3>Constructor Detail</h3> <a name="Arity-int-int-boolean-boolean-java.lang.String-"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>Arity</h4> <pre>public Arity(int min, int max, boolean variable, boolean unspecified, java.lang.String originalValue)</pre> <div class="block">Constructs a new Arity object with the specified parameters.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>min</code> - minimum number of required parameters</dd> <dd><code>max</code> - maximum number of allowed parameters (or Integer.MAX_VALUE if variable)</dd> <dd><code>variable</code> - <code>true</code> if any number or parameters is allowed, <code>false</code> otherwise</dd> <dd><code>unspecified</code> - <code>true</code> if no arity was specified on the option/parameter (value is based on type)</dd> <dd><code>originalValue</code> - the original value that was specified on the option or parameter</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="forOption-java.lang.reflect.Field-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>forOption</h4> <pre>public static <a href="../picocli/CommandLine.Arity.html" title="class in picocli">CommandLine.Arity</a> forOption(java.lang.reflect.Field field)</pre> <div class="block">Returns a new <code>Arity</code> based on the Option annotation on the specified field, or the field type if no arity was specified.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>field</code> - the field whose Option annotation to inspect</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>a new <code>Arity</code> based on the Option annotation on the specified field</dd> </dl> </li> </ul> <a name="forParameters-java.lang.reflect.Field-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>forParameters</h4> <pre>public static <a href="../picocli/CommandLine.Arity.html" title="class in picocli">CommandLine.Arity</a> forParameters(java.lang.reflect.Field field)</pre> <div class="block">Returns a new <code>Arity</code> based on the Parameters annotation on the specified field, or the field type if no arity was specified.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>field</code> - the field whose Parameters annotation to inspect</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>a new <code>Arity</code> based on the Parameters annotation on the specified field</dd> </dl> </li> </ul> <a name="forType-java.lang.Class-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>forType</h4> <pre>public static <a href="../picocli/CommandLine.Arity.html" title="class in picocli">CommandLine.Arity</a> forType(java.lang.Class<?> type)</pre> <div class="block">Returns a new <code>Arity</code> based on the specified type: booleans have arity 0, arrays or Collections have arity "0..*", and other types have arity 1.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>type</code> - the type whose default arity to return</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>a new <code>Arity</code> based on the specified type</dd> </dl> </li> </ul> <a name="valueOf-java.lang.String-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>valueOf</h4> <pre>public static <a href="../picocli/CommandLine.Arity.html" title="class in picocli">CommandLine.Arity</a> valueOf(java.lang.String arity)</pre> <div class="block">Leniently parses the specified String as an <code>Arity</code> value and return the result. An arity string can be a fixed integer value or a range of the form <code>MIN_VALUE + ".." + MAX_VALUE</code>. If the <code>MIN_VALUE</code> string is not numeric, the minimum is zero. If the <code>MAX_VALUE</code> is not numeric, the arity is taken to be variable and the maximum is <code>Integer.MAX_VALUE</code>.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>arity</code> - the arity string to parse</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>a new <code>Arity</code> value</dd> </dl> </li> </ul> <a name="min-int-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>min</h4> <pre>public <a href="../picocli/CommandLine.Arity.html" title="class in picocli">CommandLine.Arity</a> min(int newMin)</pre> <div class="block">Returns a new Arity object with the <code>min</code> value replaced by the specified value.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>newMin</code> - the <code>min</code> value of the returned Arity object</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>a new Arity object with the specified <code>min</code> value, all other values are kept</dd> </dl> </li> </ul> <a name="max-int-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>max</h4> <pre>public <a href="../picocli/CommandLine.Arity.html" title="class in picocli">CommandLine.Arity</a> max(int newMax)</pre> <div class="block">Returns a new Arity object with the <code>max</code> value replaced by the specified value.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>newMax</code> - the <code>max</code> value of the returned Arity object</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>a new Arity object with the specified <code>max</code> value, all other values are kept</dd> </dl> </li> </ul> <a name="equals-java.lang.Object-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>equals</h4> <pre>public boolean equals(java.lang.Object object)</pre> <dl> <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> <dd><code>equals</code> in class <code>java.lang.Object</code></dd> </dl> </li> </ul> <a name="hashCode--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>hashCode</h4> <pre>public int hashCode()</pre> <dl> <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> <dd><code>hashCode</code> in class <code>java.lang.Object</code></dd> </dl> </li> </ul> <a name="toString--"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>toString</h4> <pre>public java.lang.String toString()</pre> <dl> <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> <dd><code>toString</code> in class <code>java.lang.Object</code></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="../picocli/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="../picocli/CommandLine.html" title="class in picocli"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../picocli/CommandLine.Command.html" title="annotation in picocli"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../index.html?picocli/CommandLine.Arity.html" target="_top">Frames</a></li> <li><a href="CommandLine.Arity.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><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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 ======= --> </body> </html>