001: /*
002: * The Unified Mapping Platform (JUMP) is an extensible, interactive GUI
003: * for visualizing and manipulating spatial features with geometry and attributes.
004: *
005: * Copyright (C) 2003 Vivid Solutions
006: *
007: * This program is free software; you can redistribute it and/or
008: * modify it under the terms of the GNU General Public License
009: * as published by the Free Software Foundation; either version 2
010: * of the License, or (at your option) any later version.
011: *
012: * This program is distributed in the hope that it will be useful,
013: * but WITHOUT ANY WARRANTY; without even the implied warranty of
014: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
015: * GNU General Public License for more details.
016: *
017: * You should have received a copy of the GNU General Public License
018: * along with this program; if not, write to the Free Software
019: * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
020: *
021: * For more information, contact:
022: *
023: * Vivid Solutions
024: * Suite #1A
025: * 2328 Government Street
026: * Victoria BC V8T 5G5
027: * Canada
028: *
029: * (250)385-6040
030: * www.vividsolutions.com
031: */
032:
033: package com.vividsolutions.jump.util.commandline;
034:
035: import java.util.Iterator;
036: import java.util.Vector;
037:
038: /**
039: * Specifes the syntax for a single option on a command line.
040: *
041: * ToDo: <br>
042: * <pre>
043: * - add syntax pattern parsing
044: * Syntax patterns are similar to Java type signatures
045: * F - float
046: * I - int
047: * L - long
048: * S - string
049: * B - boolean
050: * + - one or more
051: * eg: "FIS+" takes a double, int, and one or more Strings
052: * </pre>
053: */
054: public class OptionSpec {
055: public final static int NARGS_ZERO_OR_MORE = -1;
056: public final static int NARGS_ONE_OR_MORE = -2;
057: public final static int NARGS_ZERO_OR_ONE = -3;
058: public final static String OPTION_FREE_ARGS = "**FREE_ARGS**"; // option name for free args
059: String name;
060: int nAllowedArgs = 0; // number of arguments allowed
061: String syntaxPattern;
062: String argDoc = ""; // arg syntax description
063: String doc = ""; // option description
064: Vector options = new Vector();
065:
066: public OptionSpec(String optName) {
067: name = optName;
068: nAllowedArgs = 0;
069: }
070:
071: public OptionSpec(String optName, int nAllowed) {
072: this (optName);
073:
074: // check for invalid input
075: if (nAllowedArgs >= NARGS_ZERO_OR_ONE) {
076: nAllowedArgs = nAllowed;
077: }
078: }
079:
080: public OptionSpec(String optName, String _syntaxPattern) {
081: this (optName);
082: syntaxPattern = _syntaxPattern;
083: }
084:
085: public void setDoc(String _argDoc, String docLine) {
086: argDoc = _argDoc;
087: doc = docLine;
088: }
089:
090: public String getArgDesc() {
091: return argDoc;
092: }
093:
094: public String getDocDesc() {
095: return doc;
096: }
097:
098: public int getNumOptions() {
099: return options.size();
100: }
101:
102: public Option getOption(int i) {
103: if (options.size() > 0) {
104: return (Option) options.elementAt(i);
105: }
106:
107: return null;
108: }
109:
110: public Iterator getOptions() {
111: return options.iterator();
112: }
113:
114: public boolean hasOption() {
115: return options.size() > 0;
116: }
117:
118: void addOption(Option opt) {
119: options.addElement(opt);
120: }
121:
122: String getName() {
123: return name;
124: }
125:
126: int getAllowedArgs() {
127: return nAllowedArgs;
128: }
129:
130: Option parse(String[] args) throws ParseException {
131: checkNumArgs(args);
132:
133: return new Option(this , args);
134: }
135:
136: void checkNumArgs(String[] args) throws ParseException {
137: if (nAllowedArgs == NARGS_ZERO_OR_MORE) {
138: // args must be ok
139: } else if (nAllowedArgs == NARGS_ONE_OR_MORE) {
140: if (args.length <= 0) {
141: throw new ParseException("option " + name
142: + ": expected one or more args, found "
143: + args.length);
144: }
145: } else if (nAllowedArgs == NARGS_ZERO_OR_ONE) {
146: if (args.length > 1) {
147: throw new ParseException("option " + name
148: + ": expected zero or one arg, found "
149: + args.length);
150: }
151: } else if (args.length != nAllowedArgs) {
152: throw new ParseException("option " + name + ": expected "
153: + nAllowedArgs + " args, found " + args.length);
154: }
155: }
156: }
|