KickJava   Java API By Example, From Geeks To Geeks.

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


1 /*
2  * $Header: /home/cvs/jakarta-commons-sandbox/cli/src/java/org/apache/commons/cli/PatternOptionBuilder.java,v 1.2 2002/06/06 22:49:36 bayard Exp $
3  * $Revision: 1.2 $
4  * $Date: 2002/06/06 22:49:36 $
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 acknowlegement:
27  * "This product includes software developed by the
28  * Apache Software Foundation (http://www.apache.org/)."
29  * Alternately, this acknowlegement may appear in the software itself,
30  * if and wherever such third-party acknowlegements 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 Group.
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
62 package org.apache.commons.cli;
63
64 /**
65  * Allows Options to be created from a single String.
66  *
67  *
68  * @author Henri Yandell (bayard @ generationjava.com)
69  * @version $Revision: 1.2 $
70  */
71 public class PatternOptionBuilder {
72
73     /// TODO: These need to break out to OptionType and also to be pluggable.
74
75     /** String class */
76     public static final Class JavaDoc STRING_VALUE = java.lang.String JavaDoc.class;
77     /** Object class */
78     public static final Class JavaDoc OBJECT_VALUE = java.lang.Object JavaDoc.class;
79     /** Number class */
80     public static final Class JavaDoc NUMBER_VALUE = java.lang.Number JavaDoc.class;
81     /** Date class */
82     public static final Class JavaDoc DATE_VALUE = java.util.Date JavaDoc.class;
83     /** Class class */
84     public static final Class JavaDoc CLASS_VALUE = java.lang.Class JavaDoc.class;
85
86 /// can we do this one??
87 // is meant to check that the file exists, else it errors.
88 // ie) it's for reading not writing.
89 /** FileInputStream class */
90     public static final Class JavaDoc EXISTING_FILE_VALUE = java.io.FileInputStream JavaDoc.class;
91     /** File class */
92     public static final Class JavaDoc FILE_VALUE = java.io.File JavaDoc.class;
93     /** File array class */
94     public static final Class JavaDoc FILES_VALUE = java.io.File JavaDoc[].class;
95     /** URL class */
96     public static final Class JavaDoc URL_VALUE = java.net.URL JavaDoc.class;
97
98     /**
99      * <p>Retrieve the class that <code>ch</code> represents.</p>
100      *
101      * @param ch the specified character
102      * @return The class that <code>ch</code> represents
103      */
104     public static Object JavaDoc getValueClass(char ch) {
105         if (ch == '@') {
106             return PatternOptionBuilder.OBJECT_VALUE;
107         } else if (ch == ':') {
108             return PatternOptionBuilder.STRING_VALUE;
109         } else if (ch == '%') {
110             return PatternOptionBuilder.NUMBER_VALUE;
111         } else if (ch == '+') {
112             return PatternOptionBuilder.CLASS_VALUE;
113         } else if (ch == '#') {
114             return PatternOptionBuilder.DATE_VALUE;
115         } else if (ch == '<') {
116             return PatternOptionBuilder.EXISTING_FILE_VALUE;
117         } else if (ch == '>') {
118             return PatternOptionBuilder.FILE_VALUE;
119         } else if (ch == '*') {
120             return PatternOptionBuilder.FILES_VALUE;
121         } else if (ch == '/') {
122             return PatternOptionBuilder.URL_VALUE;
123         }
124         return null;
125     }
126  
127     /**
128      * <p>Returns whether <code>ch</code> is a value code, i.e.
129      * whether it represents a class in a pattern.</p>
130      *
131      * @param ch the specified character
132      * @return true if <code>ch</code> is a value code, otherwise false.
133      */
134     public static boolean isValueCode(char ch) {
135         if( (ch != '@') &&
136             (ch != ':') &&
137             (ch != '%') &&
138             (ch != '+') &&
139             (ch != '#') &&
140             (ch != '<') &&
141             (ch != '>') &&
142             (ch != '*') &&
143             (ch != '/')
144           )
145         {
146             return false;
147         }
148         return true;
149     }
150  
151     /**
152      * <p>Returns the {@link Options} instance represented by
153      * <code>pattern</code>.</p>
154      *
155      * @param pattern the pattern string
156      * @return The {@link Options} instance
157      */
158     public static Options parsePattern(String JavaDoc pattern) {
159         int sz = pattern.length();
160
161         char opt = ' ';
162         char ch = ' ';
163         boolean required = false;
164         Object JavaDoc type = null;
165
166         Options options = new Options();
167         
168         for(int i=0; i<sz; i++) {
169             ch = pattern.charAt(i);
170
171             // a value code comes after an option and specifies
172 // details about it
173 if(!isValueCode(ch)) {
174                 if(opt != ' ') {
175                     // we have a previous one to deal with
176 options.addOption( OptionBuilder.hasArg( type != null )
177                                                     .isRequired( required )
178                                                     .withType( type )
179                                                     .create( opt ) );
180                     required = false;
181                     type = null;
182                     opt = ' ';
183                 }
184                 opt = ch;
185             } else
186             if(ch == '!') {
187                 required = true;
188             } else {
189                 type = getValueClass(ch);
190             }
191         }
192
193         if(opt != ' ') {
194             // we have a final one to deal with
195 options.addOption( OptionBuilder.hasArg( type != null )
196                                             .isRequired( required )
197                                             .withType( type )
198                                             .create( opt ) );
199         }
200
201         return options;
202     }
203
204 }
205
Popular Tags