KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > avalon > excalibur > cli > CLUtil


1 /*
2
3  ============================================================================
4                    The Apache Software License, Version 1.1
5  ============================================================================
6
7  Copyright (C) 1999-2003 The Apache Software Foundation. All rights reserved.
8
9  Redistribution and use in source and binary forms, with or without modifica-
10  tion, are permitted provided that the following conditions are met:
11
12  1. Redistributions of source code must retain the above copyright notice,
13     this list of conditions and the following disclaimer.
14
15  2. Redistributions in binary form must reproduce the above copyright notice,
16     this list of conditions and the following disclaimer in the documentation
17     and/or other materials provided with the distribution.
18
19  3. The end-user documentation included with the redistribution, if any, must
20     include the following acknowledgment: "This product includes software
21     developed by the Apache Software Foundation (http://www.apache.org/)."
22     Alternately, this acknowledgment may appear in the software itself, if
23     and wherever such third-party acknowledgments normally appear.
24
25  4. The names "Jakarta", "Avalon", "Excalibur" and "Apache Software Foundation"
26     must not be used to endorse or promote products derived from this software
27     without prior written permission. For written permission, please contact
28     apache@apache.org.
29
30  5. Products derived from this software may not be called "Apache", nor may
31     "Apache" appear in their name, without prior written permission of the
32     Apache Software Foundation.
33
34  THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
35  INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
36  FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
37  APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
38  INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLU-
39  DING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
40  OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
41  ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
42  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
43  THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
44
45  This software consists of voluntary contributions made by many individuals
46  on behalf of the Apache Software Foundation. For more information on the
47  Apache Software Foundation, please see <http://www.apache.org/>.
48
49 */

50 package org.apache.avalon.excalibur.cli;
51
52 /**
53  * CLUtil offers basic utility operations for use both internal and external to package.
54  *
55  * @author <a HREF="mailto:peter at apache.org">Peter Donald</a>
56  * @version $Revision: 1.5 $ $Date: 2003/04/11 10:25:52 $
57  * @since 4.0
58  * @see CLOptionDescriptor
59  * @deprecated Toolkit deprecated and replaced by http://spice.sourceforge.net/cli/
60  */

61 public final class CLUtil
62 {
63     private static final int MAX_DESCRIPTION_COLUMN_LENGTH = 60;
64
65     /**
66      * Format options into StringBuffer and return. This is typically used to
67      * print "Usage" text in response to a "--help" or invalid option.
68      *
69      * @param options the option descriptors
70      * @return the formatted description/help for options
71      */

72     public static final StringBuffer JavaDoc describeOptions( final CLOptionDescriptor[] options )
73     {
74         final String JavaDoc lSep = System.getProperty( "line.separator" );
75         final StringBuffer JavaDoc sb = new StringBuffer JavaDoc();
76
77         for( int i = 0; i < options.length; i++ )
78         {
79             final char ch = (char)options[ i ].getId();
80             final String JavaDoc name = options[ i ].getName();
81             String JavaDoc description = options[ i ].getDescription();
82             int flags = options[ i ].getFlags();
83             boolean argumentRequired =
84                 ( ( flags & CLOptionDescriptor.ARGUMENT_REQUIRED ) ==
85                 CLOptionDescriptor.ARGUMENT_REQUIRED );
86             boolean twoArgumentsRequired =
87                 ( ( flags & CLOptionDescriptor.ARGUMENTS_REQUIRED_2 ) ==
88                 CLOptionDescriptor.ARGUMENTS_REQUIRED_2 );
89             boolean needComma = false;
90             if( twoArgumentsRequired )
91             {
92                 argumentRequired = true;
93             }
94
95             sb.append( '\t' );
96
97             if( Character.isLetter( ch ) )
98             {
99                 sb.append( "-" );
100                 sb.append( ch );
101                 needComma = true;
102             }
103
104             if( null != name )
105             {
106                 if( needComma )
107                 {
108                     sb.append( ", " );
109                 }
110
111                 sb.append( "--" );
112                 sb.append( name );
113             }
114
115             if( argumentRequired )
116             {
117                 sb.append( " <argument>" );
118             }
119             if( twoArgumentsRequired )
120             {
121                 sb.append( "=<value>" );
122             }
123             sb.append( lSep );
124
125             if( null != description )
126             {
127                 while( description.length() > MAX_DESCRIPTION_COLUMN_LENGTH )
128                 {
129                     final String JavaDoc descriptionPart =
130                         description.substring( 0, MAX_DESCRIPTION_COLUMN_LENGTH );
131                     description =
132                         description.substring( MAX_DESCRIPTION_COLUMN_LENGTH );
133                     sb.append( "\t\t" );
134                     sb.append( descriptionPart );
135                     sb.append( lSep );
136                 }
137
138                 sb.append( "\t\t" );
139                 sb.append( description );
140                 sb.append( lSep );
141             }
142         }
143         return sb;
144     }
145
146     /**
147      * Private Constructor so that no instance can ever be created.
148      *
149      */

150     private CLUtil()
151     {
152     }
153 }
154
Popular Tags