commons-cli/xdocs/manual/validators.xml at 36631728c900896bbdb3a7db8a2461983e6c046f · 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
65
66
67
68
69
70
71
72
73
74
<?xml version="1.0"?>
<!--
 Copyright 2004 The Apache Software Foundation

 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at

     http://www.apache.org/licenses/LICENSE-2.0

 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
-->
<document>

  <properties>
    <author email="commons-dev@jakarta.apache.org">commons-dev</author>
    <title>CLI2 - Validators</title>
  </properties>

  <body>
    <section name="Validators">
      <p>
        CLI2 provides a mechanism to validate argument values.  The <code>Validator</code>
        interface must be implemented to create an argument validator.  This interface has
        a single method <code>validate(java.util.List values) throws InvalidArgumentException</code>.
      </p>
      <p>
        CLI2 has some standard validators included.  They validate the following:
      </p>
      <ul>
        <li>Java class</li>
        <li>date</li>
        <li>enumeration</li>
        <li>file path</li>
        <li>number</li>
        <li>URL</li>
      </ul>

      <img src="../images/validators.jpg"/>

      <subsection name="ClassValidator">
        <p>
          The <code>ClassValidator</code> can validate a value using three criteria:
        </p>
        <ol>
          <li>the value adheres to the Java Language Specification rules</li>
          <li>the class specified by the name is loadable</li>
          <li>the class specified by the name can be instantiated</li>
        </ol>
        <source>// 1.
ClassValidator validator = new ClassValidator();
// 2.
validator.setLoadable(true);
// 3.
validator.setLoadable(true);</source>
      </subsection>
      <subsection name="DateValidator">
      </subsection>
      <subsection name="EnumValidator">
      </subsection>
      <subsection name="FileValidator">
      </subsection>
      <subsection name="NumberValidator">
      </subsection>
      <subsection name="UrlValidator">
      </subsection>

    </section>
  </body>
</document>