KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > commons > cli > OptionValidator


1 /*
2  * $Header: /cvsroot/cvsgrab/cvsgrab/src/java/org/apache/commons/cli/OptionValidator.java,v 1.1 2005/06/16 18:11:11 ludovicc Exp $
3  * $Revision: 1.1 $
4  * $Date: 2005/06/16 18:11:11 $
5  *
6  * ====================================================================
7  *
8  * The Apache Software License, Version 1.1
9  *
10  * Copyright (c) 1999-2001 The Apache Software Foundation. All rights
11  * reserved.
12  *
13  * Redistribution and use in source and binary forms, with or without
14  * modification, are permitted provided that the following conditions
15  * are met:
16  *
17  * 1. Redistributions of source code must retain the above copyright
18  * notice, this list of conditions and the following disclaimer.
19  *
20  * 2. Redistributions in binary form must reproduce the above copyright
21  * notice, this list of conditions and the following disclaimer in
22  * the documentation and/or other materials provided with the
23  * distribution.
24  *
25  * 3. The end-user documentation included with the redistribution, if
26  * any, must include the following acknowledgement:
27  * "This product includes software developed by the
28  * Apache Software Foundation (http://www.apache.org/)."
29  * Alternately, this acknowledgement may appear in the software itself,
30  * if and wherever such third-party acknowledgements normally appear.
31  *
32  * 4. The names "The Jakarta Project", "Commons", and "Apache Software
33  * Foundation" must not be used to endorse or promote products derived
34  * from this software without prior written permission. For written
35  * permission, please contact apache@apache.org.
36  *
37  * 5. Products derived from this software may not be called "Apache"
38  * nor may "Apache" appear in their names without prior written
39  * permission of the Apache Software Foundation.
40  *
41  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
42  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
43  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
44  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
45  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
46  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
47  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
48  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
49  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
50  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
51  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
52  * SUCH DAMAGE.
53  * ====================================================================
54  *
55  * This software consists of voluntary contributions made by many
56  * individuals on behalf of the Apache Software Foundation. For more
57  * information on the Apache Software Foundation, please see
58  * <http://www.apache.org/>.
59  *
60  */
61 package org.apache.commons.cli;
62
63 /**
64  * Validates an Option string.
65  *
66  * @author John Keyes ( john at integralsource.com )
67  */
68 public class OptionValidator {
69
70     /**
71      * <p>Validates whether <code>opt</code> is a permissable Option
72      * shortOpt. The rules that specify if the <code>opt</code>
73      * is valid are:</p>
74      * <ul>
75      * <li><code>opt</code> is not NULL</li>
76      * <li>a single character <code>opt</code> that is either
77      * ' '(special case), '?', '@' or a letter</li>
78      * <li>a multi character <code>opt</code> that only contains
79      * letters.</li>
80      * </ul>
81      *
82      * @param opt The option string to validate
83      * @throws IllegalArgumentException if the Option is not valid.
84      */
85     static void validateOption(String JavaDoc opt)
86                         throws IllegalArgumentException JavaDoc
87     {
88         // check that opt is not NULL
89 if (opt == null)
90         {
91             return;
92         }
93
94         // handle the single character opt
95 else if (opt.length() == 1)
96         {
97             char ch = opt.charAt(0);
98
99             if (!isValidOpt(ch))
100             {
101                 throw new IllegalArgumentException JavaDoc("illegal option value '" + ch
102                                                    + "'");
103             }
104         }
105
106         // handle the multi character opt
107 else
108         {
109             char[] chars = opt.toCharArray();
110
111             for (int i = 0; i < chars.length; i++)
112             {
113                 if (!isValidChar(chars[i]))
114                 {
115                     throw new IllegalArgumentException JavaDoc(
116                             "opt contains illegal character value '" + chars[i]
117                             + "'");
118                 }
119             }
120         }
121     }
122
123     /**
124      * <p>Returns whether the specified character is a valid Option.</p>
125      *
126      * @param c the option to validate
127      * @return true if <code>c</code> is a letter, ' ', '?' or '@',
128      * otherwise false.
129      */
130     private static boolean isValidOpt(char c)
131     {
132         return (isValidChar(c) || (c == ' ') || (c == '?') || c == '@');
133     }
134
135     /**
136      * <p>Returns whether the specified character is a valid character.</p>
137      *
138      * @param c the character to validate
139      * @return true if <code>c</code> is a letter.
140      */
141     private static boolean isValidChar(char c)
142     {
143         return Character.isJavaIdentifierPart(c);
144     }
145 }
Popular Tags