src/java/org/apache/commons/cli/avalon/CLOption.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.
 * 
 */

package org.apache.commons.cli.avalon;
// Renamed from org.apache.avalon.excalibur.cli

import java.util.Arrays;

/**
 * Basic class describing an instance of option.
 *
 */
public final class CLOption
{
    /**
     * Value of {@link #getId} when the option is a text argument.
     */
    public static final int TEXT_ARGUMENT = 0;

    /**
     * Default descriptor. Required, since code assumes that getDescriptor will never return null.
     */
    private static final CLOptionDescriptor TEXT_ARGUMENT_DESCRIPTOR =
            new CLOptionDescriptor( null, CLOptionDescriptor.ARGUMENT_OPTIONAL, TEXT_ARGUMENT,
                    null );

    private String[] m_arguments;
    private CLOptionDescriptor m_descriptor = TEXT_ARGUMENT_DESCRIPTOR;

    /**
     * Retrieve argument to option if it takes arguments.
     *
     * @return the (first) argument
     */
    public final String getArgument()
    {
        return getArgument( 0 );
    }

    /**
     * Retrieve indexed argument to option if it takes arguments.
     *
     * @param index The argument index, from 0 to
     * {@link #getArgumentCount()}-1.
     * @return the argument
     */
    public final String getArgument( final int index )
    {
        if( null == m_arguments || index < 0 || index >= m_arguments.length )
        {
            return null;
        }
        else
        {
            return m_arguments[index];
        }
    }

    public final CLOptionDescriptor getDescriptor()
    {
        return m_descriptor;
    }

    /**
     * Constructor taking an descriptor
     *
     * @param descriptor the descriptor iff null, will default to a "text argument" descriptor.
     */
    public CLOption( final CLOptionDescriptor descriptor )
    {
        if( descriptor != null )
        {
            m_descriptor = descriptor;
        }
    }

    /**
     * Constructor taking argument for option.
     *
     * @param argument the argument
     */
    public CLOption( final String argument )
    {
        this( (CLOptionDescriptor)null );
        addArgument( argument );
    }

    /**
     * Mutator of Argument property.
     *
     * @param argument the argument
     */
    public final void addArgument( final String argument )
    {
        if( null == m_arguments )
        {
            m_arguments = new String[]{argument};
        }
        else
        {
            final String[] arguments = new String[m_arguments.length + 1];
            System.arraycopy( m_arguments, 0, arguments, 0, m_arguments.length );
            arguments[m_arguments.length] = argument;
            m_arguments = arguments;
        }
    }

    /**
     * Get number of arguments.
     *
     * @return the number of arguments
     */
    public final int getArgumentCount()
    {
        if( null == m_arguments )
        {
            return 0;
        }
        else
        {
            return m_arguments.length;
        }
    }

    /**
     * Convert to String.
     *
     * @return the string value
     */
    public final String toString()
    {
        final StringBuffer sb = new StringBuffer();
        sb.append("[");
        final char id = (char) m_descriptor.getId();
        if (id == TEXT_ARGUMENT) {
            sb.append("Text ");
        } else {
            sb.append("Option ");
            sb.append(id);            
        }

        if( null != m_arguments )
        {
            sb.append( ", " ); // $NON-NLS-1$
            sb.append( Arrays.asList( m_arguments ) );
        }

        sb.append( " ]" ); // $NON-NLS-1$

        return sb.toString();
    }

    /*
     * Convert to a shorter String for test purposes
     * 
     * @return the string value
     */
    final String toShortString() {
        final StringBuffer sb = new StringBuffer();
        final char id = (char) m_descriptor.getId();
        if (id != TEXT_ARGUMENT) {
            sb.append("-");
            sb.append(id);            
        }

        if (null != m_arguments) {
            if (id != TEXT_ARGUMENT) {
                sb.append("=");
            }
            sb.append(Arrays.asList(m_arguments));
        }
        return sb.toString();
    }
}