net.mitnet.tools.pdf.book.common.cli.CommandLineHelper.java Source code

Introduction

Here is the source code for net.mitnet.tools.pdf.book.common.cli.CommandLineHelper.java

Source

/*
Copyright (C) 2010-2011  Tim Telcik <telcik@gmail.com>
    
This program 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 3 of the License, or
(at your option) any later version.
    
This program 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, see <http://www.gnu.org/licenses/>.
*/

package net.mitnet.tools.pdf.book.common.cli;

import java.io.File;
import java.util.Arrays;
import java.util.List;

import org.apache.commons.cli.CommandLine;
import org.apache.commons.cli.Option;

/**
 * Command Line Helper.
 * 
 * This class provides a simple decorator for the Command Line class.
 *  
 * @author Tim Telcik <telcik@gmail.com>
 * 
 * @see CommandLine
 */
public class CommandLineHelper {

    private CommandLine commandLine = null;

    public CommandLineHelper(CommandLine commandLine) {
        this.commandLine = commandLine;
    }

    /**
     * Returns the Option value.
     */
    public String getOptionValue(Option option) {
        return commandLine.getOptionValue(option.getOpt());
    }

    /**
     * Returns true if an option has been set.
     */
    public boolean hasOption(Option option) {
        return commandLine.hasOption(option.getOpt());
    }

    /**
     * Returns the Option value as a File.
     */
    public File getOptionValueAsFile(Option option) {
        return getOptionValueAsFile(option.getOpt());
    }

    /**
     * Returns the Option value as a File.
     */
    public File getOptionValueAsFile(String opt) {
        String fileName = this.commandLine.getOptionValue(opt);
        File file = new File(fileName);
        return file;
    }

    /**
     * Returns the Option value as an int.
     */
    public int getOptionValueAsInt(Option option) {
        return getOptionValueAsInt(option.getOpt());
    }

    /**
     * Returns the Option value as an int.
     */
    public int getOptionValueAsInt(String opt) {
        String intString = commandLine.getOptionValue(opt);
        int resultInt = Integer.parseInt(intString);
        return resultInt;
    }

    /**
     * Returns the Option value as an Integer.
     */
    public Integer getOptionValueAsInteger(Option option) {
        return getOptionValueAsInteger(option.getOpt());
    }

    /**
     * Returns the Option value as an Integer.
     */
    public Integer getOptionValueAsInteger(String opt) {
        String integerString = commandLine.getOptionValue(opt);
        int resultInteger = Integer.valueOf(integerString);
        return resultInteger;
    }

    /**
     * Returns the Options as a List.
     * 
     * NOTE: The Options are stored in CommandLine as a List, 
     *       but only exposed by an Iterator or Option[] array. 
     * 
     * @return Options List 
     */
    public List<Option> getOptionsAsList() {
        Option[] options = commandLine.getOptions();
        List<Option> optionsList = Arrays.asList(options);
        return optionsList;
    }

}