commons-cli/xdocs/creation.xml at fbc0bd02b0d9d97ae044aebbbfbc5b13d3eacafe · apache/commons-cli · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
<?xml version="1.0"?>
<document>

  <properties>
    <author email="jbjk@mac.com">John Keyes</author>
    <title>Option</title>
  </properties>

  <body>
    <section name="Option Construction">
      <p>
        There are two ways to create an
        <a href="apidocs/org/apache/commons/cli/Option.html">Option</a>;
        with the Option constructors or with the factory methods
        defined in
        <a href="apidocs/org/apache/commons/cli/Options.html">Options</a>.
        The method signatures of both approaches are identical.
      </p>
      <p>
        The entries in the following table describe the method
        signatures of the constructors and of the factory methods
        using the names of the properties the parameters represent.
      </p>
      <table>
        <tr>
          <th>API</th>
          <th>API</th>
          <th>Parameter Order</th>
        </tr>
        <tr>
          <td><a href="apidocs/org/apache/commons/cli/Option.html#Option(java.lang.String, boolean, java.lang.String)">ctor</a></td>
          <td><a href="apidocs/org/apache/commons/cli/Options.html#addOption(java.lang.String, boolean, java.lang.String)">factory</a></td>
          <td>Opt, Arg, Description</td>
        </tr>
        <tr>
          <td><a href="apidocs/org/apache/commons/cli/Option.html#Option(java.lang.String, java.lang.String, boolean, java.lang.String)">ctor</a></td>
          <td><a href="apidocs/org/apache/commons/cli/Options.html#addOption(java.lang.String, java.lang.String, boolean, java.lang.String)">factory</a></td>
          <td>Opt, LongOpt, Arg, Description</td>
        </tr>
        <tr>
          <td><a href="apidocs/org/apache/commons/cli/Option.html#Option(java.lang.String, java.lang.String, boolean, java.lang.String, boolean)">ctor</a></td>
          <td><a href="apidocs/org/apache/commons/cli/Options.html#addOption(java.lang.String, java.lang.String, boolean, java.lang.String, boolean)">factory</a></td>
          <td>Opt, LongOpt, Arg, Description, Required</td>
        </tr>
        <tr>
          <td><a href="apidocs/org/apache/commons/cli/Option.html#Option(java.lang.String, java.lang.String, boolean, java.lang.String, boolean, boolean)">ctor</a></td>
          <td><a href="apidocs/org/apache/commons/cli/Options.html#addOption(java.lang.String, java.lang.String, boolean, java.lang.String, boolean, boolean)">factory</a></td>
          <td>Opt, LongOpt, Arg, Description, Required, MultipleArgs</td>
        </tr>
        <tr>
          <td><a href="apidocs/org/apache/commons/cli/Option.html#Option(java.lang.String, java.lang.String, boolean, java.lang.String, boolean, boolean, java.lang.Object)">ctor</a></td>
          <td><a href="apidocs/org/apache/commons/cli/Options.html#addOption(java.lang.String, java.lang.String, boolean, java.lang.String, boolean, boolean, java.lang.Object)">factory</a></td>
          <td>Opt, LongOpt, Arg, Description, Required, MultipleArgs, Type</td>
        </tr>
      </table>
      <p>
        To add an <a href="apidocs/org/apache/commons/cli/Option.html">Option</a>
        that has been created using a constructor the
        <a href="apidocs/org/apache/commons/cli/Options.html#addOption(org.apache.commons.cli.Option)">addOption</a>
        method must be used.
      </p>
    </section>
  </body>
</document>