• Home
• com.github.strator-dev.greenpepper
• greenpepper-remote-agent
• 4.2.4
• source code
• CommandLine.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.greenpepper.util.cli.CommandLine Maven / Gradle / Ivy

/*
 * Copyright (c) 2006 Pyxis Technologies inc.
 *
 * This is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA,
 * or see the FSF site: http://www.fsf.org.
 */

package com.greenpepper.util.cli;

import java.io.File;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Locale;
import java.util.Map;

/**
 * 
CommandLine class.
 *
 * @author oaouattara
 * @version $Id: $Id
 */
public class CommandLine
{
    private static final Map converters = new HashMap();

    static
    {
        registerConverter( String.class, new StringConverter() );
        registerConverter( Integer.class, new IntegerConverter() );
        registerConverter( int.class, new IntegerConverter() );
        registerConverter( Locale.class, new LocaleConverter() );
        registerConverter( File.class, new FileConverter() );
        registerConverter( Class.class, new ClassConverter() );
    }

    /**
     * 
registerConverter.
     *
     * @param type a {@link java.lang.Class} object.
     * @param converter a {@link com.greenpepper.util.cli.Converter} object.
     */
    public static void registerConverter( Class type, Converter converter )
    {
        converters.put( type, converter );
    }

    /**
     * 
converterFor.
     *
     * @param type a {@link java.lang.Class} object.
     * @return a {@link com.greenpepper.util.cli.Converter} object.
     */
    public static Converter converterFor( Class type )
    {
        if (!converters.containsKey( type ))
            throw new IllegalArgumentException( "Don't know type: " + type );

        return converters.get( type );
    }

    private final List arguments;
    private final List options;

    private CommandLineParser parser = new PosixParser();
    private String banner = "";

    /**
     * 
Constructor for CommandLine.
     */
    public CommandLine()
    {
        arguments = new ArrayList();
        options = new ArrayList();
    }

    /**
     * 
Setter for the field banner.
     *
     * @param banner a {@link java.lang.String} object.
     */
    public void setBanner( String banner )
    {
        this.banner = banner;
    }

    /**
     * 
setMode.
     *
     * @param parser a {@link com.greenpepper.util.cli.CommandLineParser} object.
     */
    public void setMode( CommandLineParser parser )
    {
        this.parser = parser;
    }

    /**
     * 
buildOption.
     *
     * @param name a {@link java.lang.String} object.
     * @param options a {@link java.lang.String} object.
     * @return a {@link com.greenpepper.util.cli.OptionBuilder} object.
     */
    public OptionBuilder buildOption( String name, String... options )
    {
        OptionBuilder option = OptionBuilder.create( name );
        parser.build( option, options );
        return option;
    }

    /**
     * 
defineOption.
     *
     * @param option a {@link com.greenpepper.util.cli.OptionBuilder} object.
     */
    public void defineOption( OptionBuilder option )
    {
        define( option.make() );
    }

    /**
     * 
define.
     *
     * @param option a {@link com.greenpepper.util.cli.Option} object.
     */
    public void define( Option option )
    {
        options.add( option );
    }

    /**
     * 
parse.
     *
     * @param args a {@link java.lang.String} object.
     * @return an array of {@link java.lang.String} objects.
     * @throws com.greenpepper.util.cli.ParseException if any.
     */
    public String[] parse( String... args ) throws ParseException
    {
        parser.parse( this, args );
        callStubs();
        return getArguments();
    }

    /**
     * 
addArgument.
     *
     * @param arg a {@link java.lang.String} object.
     */
    public void addArgument( String arg )
    {
        arguments.add( arg );
    }

    /**
     * 
getArgumentCount.
     *
     * @return a int.
     */
    public int getArgumentCount()
    {
        return arguments.size();
    }

    /**
     * 
Getter for the field arguments.
     *
     * @return an array of {@link java.lang.String} objects.
     */
    public String[] getArguments()
    {
        return arguments.toArray( new String[arguments.size()] );
    }

    /**
     * 
getArgument.
     *
     * @param index a int.
     * @return a {@link java.lang.String} object.
     */
    public String getArgument( int index )
    {
        if (index >= arguments.size()) return null;
        return arguments.get( index );
    }

    /**
     * 
hasOptionValue.
     *
     * @param name a {@link java.lang.String} object.
     * @return a boolean.
     */
    public boolean hasOptionValue( String name )
    {
        return getOptionValues().containsKey( name );
    }

    /**
     * 
getOptionValues.
     *
     * @return a {@link java.util.Map} object.
     */
    public Map getOptionValues()
    {
        Map opts = new HashMap();
        for (Option opt : options)
        {
            if (opt.wasGiven()) opts.put( opt.getName(), opt.getValue() );
        }

        return opts;
    }

    /**
     * 
getOptionValue.
     *
     * @param name a {@link java.lang.String} object.
     * @return a {@link java.lang.Object} object.
     */
    public Object getOptionValue( String name )
    {
        if (!hasOptionValue( name )) throw new IllegalArgumentException( "Don't know option: " + name );
        return getOptionValues().get( name );
    }

    /**
     * 
usage.
     *
     * @return a {@link java.lang.String} object.
     */
    public String usage()
    {
        StringBuilder sb = new StringBuilder( "Usage: " ).append( banner );
        if (options.isEmpty()) return sb.toString();

        sb.append( "\n\n" ).append( "Options:" );
        for (Option option : options)
        {
            sb.append( "\n" ).append( option );
        }

        return sb.toString();
    }

    /**
     * 
getOptionWithShortForm.
     *
     * @param shortForm a {@link java.lang.String} object.
     * @return a {@link com.greenpepper.util.cli.Option} object.
     * @throws com.greenpepper.util.cli.InvalidOptionException if any.
     */
    public Option getOptionWithShortForm( String shortForm ) throws InvalidOptionException
    {
        for (Option option : options)
        {
            if (shortForm.equals( option.getShortForm() )) return option;
        }

        throw new InvalidOptionException( shortForm );
    }

    /**
     * 
getOptionWithLongForm.
     *
     * @param longForm a {@link java.lang.String} object.
     * @return a {@link com.greenpepper.util.cli.Option} object.
     * @throws com.greenpepper.util.cli.InvalidOptionException if any.
     */
    public Option getOptionWithLongForm( String longForm ) throws InvalidOptionException
    {
        for (Option option : options)
        {
            if (longForm.equals( option.getLongForm() )) return option;
        }

        throw new InvalidOptionException( longForm );
    }

    private void callStubs()
    {
        for (Option option : options)
        {
            if (option.wasGiven()) option.call();
        }
    }
}