KickJava   Java API By Example, From Geeks To Geeks.

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


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 import java.util.Arrays JavaDoc;
53
54 /**
55  * Basic class describing an instance of option.
56  *
57  * @author <a HREF="mailto:peter at apache.org">Peter Donald</a>
58  * @author <a HREF="mailto:leo.sutic at inspireinfrastructure.com">Leo Sutic</a>
59  * @version $Revision: 1.6 $ $Date: 2003/04/11 10:25:52 $
60  * @since 4.0
61  * @deprecated Toolkit deprecated and replaced by http://spice.sourceforge.net/cli/
62  */
63 public final class CLOption
64 {
65     /**
66      * Value of {@link #getId} when the option is a text argument.
67      */
68     public static final int TEXT_ARGUMENT = 0;
69
70     /**
71      * Default descriptor. Required, since code assumes that getDescriptor will never return null.
72      */
73     private static final CLOptionDescriptor TEXT_ARGUMENT_DESCRIPTOR =
74         new CLOptionDescriptor( null, CLOptionDescriptor.ARGUMENT_OPTIONAL, TEXT_ARGUMENT, null );
75
76     private String JavaDoc[] m_arguments;
77     private CLOptionDescriptor m_descriptor = TEXT_ARGUMENT_DESCRIPTOR;
78
79     /**
80      * Retrieve argument to option if it takes arguments.
81      *
82      * @return the (first) argument
83      */
84     public final String JavaDoc getArgument()
85     {
86         return getArgument( 0 );
87     }
88
89     /**
90      * Retrieve indexed argument to option if it takes arguments.
91      *
92      * @param index The argument index, from 0 to
93      * {@link #getArgumentCount()}-1.
94      * @return the argument
95      */
96     public final String JavaDoc getArgument( final int index )
97     {
98         if( null == m_arguments || index < 0 || index >= m_arguments.length )
99         {
100             return null;
101         }
102         else
103         {
104             return m_arguments[ index ];
105         }
106     }
107
108     /**
109      * Retrieve id of option.
110      *
111      * The id is eqivalent to character code if it can be a single letter option.
112      *
113      * @return the id
114      * @deprecated use <code>getDescriptor().getId()</code> instead
115      */
116     public final int getId()
117     {
118         return m_descriptor == null ? TEXT_ARGUMENT : m_descriptor.getId();
119     }
120
121     public final CLOptionDescriptor getDescriptor()
122     {
123         return m_descriptor;
124     }
125
126     /**
127      * Constructor taking an descriptor
128      *
129      * @param descriptor the descriptor iff null, will default to a "text argument" descriptor.
130      */
131     public CLOption( final CLOptionDescriptor descriptor )
132     {
133         if( descriptor != null )
134         {
135             m_descriptor = descriptor;
136         }
137     }
138
139     /**
140      * Constructor taking argument for option.
141      *
142      * @param argument the argument
143      */
144     public CLOption( final String JavaDoc argument )
145     {
146         this( (CLOptionDescriptor)null );
147         addArgument( argument );
148     }
149
150     /**
151      * Mutator of Argument property.
152      *
153      * @param argument the argument
154      */
155     public final void addArgument( final String JavaDoc argument )
156     {
157         if( null == m_arguments )
158         {
159             m_arguments = new String JavaDoc[]{argument};
160         }
161         else
162         {
163             final String JavaDoc[] arguments = new String JavaDoc[ m_arguments.length + 1 ];
164             System.arraycopy( m_arguments, 0, arguments, 0, m_arguments.length );
165             arguments[ m_arguments.length ] = argument;
166             m_arguments = arguments;
167         }
168     }
169
170     /**
171      * Get number of arguments.
172      *
173      * @return the number of arguments
174      */
175     public final int getArgumentCount()
176     {
177         if( null == m_arguments )
178         {
179             return 0;
180         }
181         else
182         {
183             return m_arguments.length;
184         }
185     }
186
187     /**
188      * Convert to String.
189      *
190      * @return the string value
191      */
192     public final String JavaDoc toString()
193     {
194         final StringBuffer JavaDoc sb = new StringBuffer JavaDoc();
195         sb.append( "[Option " );
196         sb.append( (char)m_descriptor.getId() );
197
198         if( null != m_arguments )
199         {
200             sb.append( ", " );
201             sb.append( Arrays.asList( m_arguments ) );
202         }
203
204         sb.append( " ]" );
205
206         return sb.toString();
207     }
208 }
209
Popular Tags