OptionSpec.java

/*
 * The Unified Mapping Platform (JUMP) is an extensible, interactive GUI 
 * for visualizing and manipulating spatial features with geometry and attributes.
 *
 * Copyright (C) 2003 Vivid Solutions
 * 
 * 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 2
 * 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, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 * 
 * For more information, contact:
 *
 * Vivid Solutions
 * Suite #1A
 * 2328 Government Street
 * Victoria BC  V8T 5G5
 * Canada
 *
 * (250)385-6040
 * www.vividsolutions.com
 */

package com.vividsolutions.jump.util.commandline;

import java.util.Iterator;
import java.util.Vector;


/**
 * Specifes the syntax for a single option on a command line.
 *
 * ToDo: <br>
 * <pre>
 * - add syntax pattern parsing
 *      Syntax patterns are similar to Java type signatures
 *  F - float
 *  I - int
 *  L - long
 *  S - string
 *  B - boolean
 *  + - one or more
 * eg:  "FIS+" takes a double, int, and one or more Strings
 * </pre>
 */
public class OptionSpec {
    public final static int NARGS_ZERO_OR_MORE = -1;
    public final static int NARGS_ONE_OR_MORE = -2;
    public final static int NARGS_ZERO_OR_ONE = -3;
    public final static String OPTION_FREE_ARGS = "**FREE_ARGS**"; // option name for free args
    String name;
    int nAllowedArgs = 0; // number of arguments allowed
    String syntaxPattern;
    String argDoc = ""; // arg syntax description
    String doc = ""; // option description
    Vector options = new Vector();

    public OptionSpec(String optName) {
        name = optName;
        nAllowedArgs = 0;
    }

    public OptionSpec(String optName, int nAllowed) {
        this(optName);

        // check for invalid input
        if (nAllowedArgs >= NARGS_ZERO_OR_ONE) {
            nAllowedArgs = nAllowed;
        }
    }

    public OptionSpec(String optName, String _syntaxPattern) {
        this(optName);
        syntaxPattern = _syntaxPattern;
    }

    public void setDoc(String _argDoc, String docLine) {
        argDoc = _argDoc;
        doc = docLine;
    }

    public String getArgDesc() {
        return argDoc;
    }

    public String getDocDesc() {
        return doc;
    }

    public int getNumOptions() {
        return options.size();
    }

    public Option getOption(int i) {
        if (options.size() > 0) {
            return (Option) options.elementAt(i);
        }

        return null;
    }

    public Iterator getOptions() {
        return options.iterator();
    }

    public boolean hasOption() {
        return options.size() > 0;
    }

    void addOption(Option opt) {
        options.addElement(opt);
    }

    String getName() {
        return name;
    }

    int getAllowedArgs() {
        return nAllowedArgs;
    }

    Option parse(String[] args) throws ParseException {
        checkNumArgs(args);

        return new Option(this, args);
    }

    void checkNumArgs(String[] args) throws ParseException {
        if (nAllowedArgs == NARGS_ZERO_OR_MORE) {
            // args must be ok
        } else if (nAllowedArgs == NARGS_ONE_OR_MORE) {
            if (args.length <= 0) {
                throw new ParseException("option " + name +
                    ": expected one or more args, found " + args.length);
            }
        } else if (nAllowedArgs == NARGS_ZERO_OR_ONE) {
            if (args.length > 1) {
                throw new ParseException("option " + name +
                    ": expected zero or one arg, found " + args.length);
            }
        } else if (args.length != nAllowedArgs) {
            throw new ParseException("option " + name + ": expected " +
                nAllowedArgs + " args, found " + args.length);
        }
    }
}