* args4j style format prior to invoking args4j for parsing.
*/
public class CmdLineParser {
- public interface Factory {
- CmdLineParser create(Object bean);
- }
-
- private final MyParser parser;
-
- @SuppressWarnings("rawtypes")
- private Map<String, OptionHandler> options;
-
- /**
- * Creates a new command line owner that parses arguments/options and set them
- * into the given object.
- *
- * @param bean instance of a class annotated by
- * {@link org.kohsuke.args4j.Option} and
- * {@link org.kohsuke.args4j.Argument}. this object will receive
- * values.
- *
- * @throws IllegalAnnotationError if the option bean class is using args4j
- * annotations incorrectly.
- */
- public CmdLineParser(Object bean)
- throws IllegalAnnotationError {
- this.parser = new MyParser(bean);
- }
-
- public void addArgument(Setter<?> setter, Argument a) {
- parser.addArgument(setter, a);
- }
-
- public void addOption(Setter<?> setter, Option o) {
- parser.addOption(setter, o);
- }
-
- public void printSingleLineUsage(Writer w, ResourceBundle rb) {
- parser.printSingleLineUsage(w, rb);
- }
-
- public void printUsage(Writer out, ResourceBundle rb) {
- parser.printUsage(out, rb);
- }
-
- public void printDetailedUsage(String name, StringWriter out) {
- out.write(name);
- printSingleLineUsage(out, null);
- out.write('\n');
- out.write('\n');
- printUsage(out, null);
- out.write('\n');
- }
-
- public void printQueryStringUsage(String name, StringWriter out) {
- out.write(name);
-
- char next = '?';
- List<NamedOptionDef> booleans = new ArrayList<NamedOptionDef>();
- for (@SuppressWarnings("rawtypes") OptionHandler handler : parser.options) {
- if (handler.option instanceof NamedOptionDef) {
- NamedOptionDef n = (NamedOptionDef) handler.option;
-
- if (handler instanceof BooleanOptionHandler) {
- booleans.add(n);
- continue;
- }
-
- if (!n.required()) {
- out.write('[');
- }
- out.write(next);
- next = '&';
- if (n.name().startsWith("--")) {
- out.write(n.name().substring(2));
- } else if (n.name().startsWith("-")) {
- out.write(n.name().substring(1));
- } else {
- out.write(n.name());
- }
- out.write('=');
-
- out.write(metaVar(handler, n));
- if (!n.required()) {
- out.write(']');
- }
- if (n.isMultiValued()) {
- out.write('*');
- }
- }
- }
- for (NamedOptionDef n : booleans) {
- if (!n.required()) {
- out.write('[');
- }
- out.write(next);
- next = '&';
- if (n.name().startsWith("--")) {
- out.write(n.name().substring(2));
- } else if (n.name().startsWith("-")) {
- out.write(n.name().substring(1));
- } else {
- out.write(n.name());
- }
- if (!n.required()) {
- out.write(']');
- }
- }
- }
-
- private static String metaVar(OptionHandler<?> handler, NamedOptionDef n) {
- String var = n.metaVar();
- if (Strings.isNullOrEmpty(var)) {
- var = handler.getDefaultMetaVariable();
- if (handler instanceof EnumOptionHandler) {
- var = var.substring(1, var.length() - 1).replace(" ", "");
- }
- }
- return var;
- }
-
- public boolean wasHelpRequestedByOption() {
- return parser.help.value;
- }
-
- public void parseArgument(final String... args) throws CmdLineException {
- List<String> tmp = Lists.newArrayListWithCapacity(args.length);
- for (int argi = 0; argi < args.length; argi++) {
- final String str = args[argi];
- if (str.equals("--")) {
- while (argi < args.length)
- tmp.add(args[argi++]);
- break;
- }
-
- if (str.startsWith("--")) {
- final int eq = str.indexOf('=');
- if (eq > 0) {
- tmp.add(str.substring(0, eq));
- tmp.add(str.substring(eq + 1));
- continue;
- }
- }
-
- tmp.add(str);
- }
- parser.parseArgument(tmp.toArray(new String[tmp.size()]));
- }
-
- public void parseOptionMap(Map<String, String[]> parameters)
- throws CmdLineException {
- Multimap<String, String> map = LinkedHashMultimap.create();
- for (Map.Entry<String, String[]> ent : parameters.entrySet()) {
- for (String val : ent.getValue()) {
- map.put(ent.getKey(), val);
- }
- }
- parseOptionMap(map);
- }
-
- public void parseOptionMap(Multimap<String, String> params)
- throws CmdLineException {
- List<String> tmp = Lists.newArrayListWithCapacity(2 * params.size());
- for (final String key : params.keySet()) {
- String name = makeOption(key);
-
- if (isBoolean(name)) {
- boolean on = false;
- for (String value : params.get(key)) {
- on = toBoolean(key, value);
- }
- if (on) {
- tmp.add(name);
- }
- } else {
- for (String value : params.get(key)) {
- tmp.add(name);
- tmp.add(value);
- }
- }
- }
- parser.parseArgument(tmp.toArray(new String[tmp.size()]));
- }
-
- public boolean isBoolean(String name) {
- return findHandler(makeOption(name)) instanceof BooleanOptionHandler;
- }
-
- private String makeOption(String name) {
- if (!name.startsWith("-")) {
- if (name.length() == 1) {
- name = "-" + name;
- } else {
- name = "--" + name;
- }
- }
- return name;
- }
-
- @SuppressWarnings("rawtypes")
- private OptionHandler findHandler(String name) {
- if (options == null) {
- options = index(parser.options);
- }
- return options.get(name);
- }
-
- @SuppressWarnings("rawtypes")
- private static Map<String, OptionHandler> index(List<OptionHandler> in) {
- Map<String, OptionHandler> m = Maps.newHashMap();
- for (OptionHandler handler : in) {
- if (handler.option instanceof NamedOptionDef) {
- NamedOptionDef def = (NamedOptionDef) handler.option;
- if (!def.isArgument()) {
- m.put(def.name(), handler);
- for (String alias : def.aliases()) {
- m.put(alias, handler);
- }
- }
- }
- }
- return m;
- }
-
- private boolean toBoolean(String name, String value) throws CmdLineException {
- if ("true".equals(value) || "t".equals(value)
- || "yes".equals(value) || "y".equals(value)
- || "on".equals(value)
- || "1".equals(value)
- || value == null || "".equals(value)) {
- return true;
- }
-
- if ("false".equals(value) || "f".equals(value)
- || "no".equals(value) || "n".equals(value)
- || "off".equals(value)
- || "0".equals(value)) {
- return false;
- }
-
- throw new CmdLineException(parser, String.format(
- "invalid boolean \"%s=%s\"", name, value));
- }
-
- private class MyParser extends org.kohsuke.args4j.CmdLineParser {
- @SuppressWarnings("rawtypes")
- private List<OptionHandler> options;
- private HelpOption help;
-
- MyParser(final Object bean) {
- super(bean);
- ensureOptionsInitialized();
- }
-
- @SuppressWarnings({"unchecked", "rawtypes"})
- @Override
- protected OptionHandler createOptionHandler(final OptionDef option,
- final Setter setter) {
- if (isHandlerSpecified(option) || isEnum(setter) || isPrimitive(setter)) {
- return add(super.createOptionHandler(option, setter));
- }
-
-// OptionHandlerFactory<?> factory = handlers.get(setter.getType());
-// if (factory != null) {
-// return factory.create(this, option, setter);
-// }
- return add(super.createOptionHandler(option, setter));
- }
-
- @SuppressWarnings("rawtypes")
- private OptionHandler add(OptionHandler handler) {
- ensureOptionsInitialized();
- options.add(handler);
- return handler;
- }
-
- private void ensureOptionsInitialized() {
- if (options == null) {
- help = new HelpOption();
- options = Lists.newArrayList();
- addOption(help, help);
- }
- }
-
- private boolean isHandlerSpecified(final OptionDef option) {
- return option.handler() != OptionHandler.class;
- }
-
- private <T> boolean isEnum(Setter<T> setter) {
- return Enum.class.isAssignableFrom(setter.getType());
- }
-
- private <T> boolean isPrimitive(Setter<T> setter) {
- return setter.getType().isPrimitive();
- }
- }
-
- private static class HelpOption implements Option, Setter<Boolean> {
- private boolean value;
-
- @Override
- public String name() {
- return "--help";
- }
-
- @Override
- public String[] aliases() {
- return new String[] {"-h"};
- }
-
- @Override
- public String[] depends() {
- return new String[] {};
- }
-
- @Override
- public boolean hidden() {
- return false;
- }
-
- @Override
- public String usage() {
- return "display this help text";
- }
-
- @Override
- public void addValue(Boolean val) {
- value = val;
- }
-
- @Override
- public Class<? extends OptionHandler<Boolean>> handler() {
- return BooleanOptionHandler.class;
- }
-
- @Override
- public String metaVar() {
- return "";
- }
-
- @Override
- public boolean required() {
- return false;
- }
-
- @Override
- public Class<? extends Annotation> annotationType() {
- return Option.class;
- }
-
- @Override
- public FieldSetter asFieldSetter() {
- throw new UnsupportedOperationException();
- }
-
- @Override
- public AnnotatedElement asAnnotatedElement() {
- throw new UnsupportedOperationException();
- }
-
- @Override
- public Class<Boolean> getType() {
- return Boolean.class;
- }
-
- @Override
- public boolean isMultiValued() {
- return false;
- }
- }
+ public interface Factory {
+ CmdLineParser create(Object bean);
+ }
+
+ private final MyParser parser;
+
+ @SuppressWarnings("rawtypes")
+ private Map<String, OptionHandler> options;
+
+ /**
+ * Creates a new command line owner that parses arguments/options and set
+ * them into the given object.
+ *
+ * @param bean
+ * instance of a class annotated by
+ * {@link org.kohsuke.args4j.Option} and
+ * {@link org.kohsuke.args4j.Argument}. this object will receive
+ * values.
+ *
+ * @throws IllegalAnnotationError
+ * if the option bean class is using args4j annotations
+ * incorrectly.
+ */
+ public CmdLineParser(Object bean) throws IllegalAnnotationError {
+ this.parser = new MyParser(bean);
+ }
+
+ public void addArgument(Setter<?> setter, Argument a) {
+ parser.addArgument(setter, a);
+ }
+
+ public void addOption(Setter<?> setter, Option o) {
+ parser.addOption(setter, o);
+ }
+
+ public void printSingleLineUsage(Writer w, ResourceBundle rb) {
+ parser.printSingleLineUsage(w, rb);
+ }
+
+ public void printUsage(Writer out, ResourceBundle rb) {
+ parser.printUsage(out, rb);
+ }
+
+ public void printDetailedUsage(String name, StringWriter out) {
+ out.write(name);
+ printSingleLineUsage(out, null);
+ out.write('\n');
+ out.write('\n');
+ printUsage(out, null);
+ out.write('\n');
+ }
+
+ public void printQueryStringUsage(String name, StringWriter out) {
+ out.write(name);
+
+ char next = '?';
+ List<NamedOptionDef> booleans = new ArrayList<NamedOptionDef>();
+ for (@SuppressWarnings("rawtypes")
+ OptionHandler handler : parser.options) {
+ if (handler.option instanceof NamedOptionDef) {
+ NamedOptionDef n = (NamedOptionDef) handler.option;
+
+ if (handler instanceof BooleanOptionHandler) {
+ booleans.add(n);
+ continue;
+ }
+
+ if (!n.required()) {
+ out.write('[');
+ }
+ out.write(next);
+ next = '&';
+ if (n.name().startsWith("--")) {
+ out.write(n.name().substring(2));
+ } else if (n.name().startsWith("-")) {
+ out.write(n.name().substring(1));
+ } else {
+ out.write(n.name());
+ }
+ out.write('=');
+
+ out.write(metaVar(handler, n));
+ if (!n.required()) {
+ out.write(']');
+ }
+ if (n.isMultiValued()) {
+ out.write('*');
+ }
+ }
+ }
+ for (NamedOptionDef n : booleans) {
+ if (!n.required()) {
+ out.write('[');
+ }
+ out.write(next);
+ next = '&';
+ if (n.name().startsWith("--")) {
+ out.write(n.name().substring(2));
+ } else if (n.name().startsWith("-")) {
+ out.write(n.name().substring(1));
+ } else {
+ out.write(n.name());
+ }
+ if (!n.required()) {
+ out.write(']');
+ }
+ }
+ }
+
+ private static String metaVar(OptionHandler<?> handler, NamedOptionDef n) {
+ String var = n.metaVar();
+ if (Strings.isNullOrEmpty(var)) {
+ var = handler.getDefaultMetaVariable();
+ if (handler instanceof EnumOptionHandler) {
+ var = var.substring(1, var.length() - 1).replace(" ", "");
+ }
+ }
+ return var;
+ }
+
+ public boolean wasHelpRequestedByOption() {
+ return parser.help.value;
+ }
+
+ public void parseArgument(final String... args) throws CmdLineException {
+ List<String> tmp = Lists.newArrayListWithCapacity(args.length);
+ for (int argi = 0; argi < args.length; argi++) {
+ final String str = args[argi];
+ if (str.equals("--")) {
+ while (argi < args.length)
+ tmp.add(args[argi++]);
+ break;
+ }
+
+ if (str.startsWith("--")) {
+ final int eq = str.indexOf('=');
+ if (eq > 0) {
+ tmp.add(str.substring(0, eq));
+ tmp.add(str.substring(eq + 1));
+ continue;
+ }
+ }
+
+ tmp.add(str);
+ }
+ parser.parseArgument(tmp.toArray(new String[tmp.size()]));
+ }
+
+ public void parseOptionMap(Map<String, String[]> parameters) throws CmdLineException {
+ Multimap<String, String> map = LinkedHashMultimap.create();
+ for (Map.Entry<String, String[]> ent : parameters.entrySet()) {
+ for (String val : ent.getValue()) {
+ map.put(ent.getKey(), val);
+ }
+ }
+ parseOptionMap(map);
+ }
+
+ public void parseOptionMap(Multimap<String, String> params) throws CmdLineException {
+ List<String> tmp = Lists.newArrayListWithCapacity(2 * params.size());
+ for (final String key : params.keySet()) {
+ String name = makeOption(key);
+
+ if (isBoolean(name)) {
+ boolean on = false;
+ for (String value : params.get(key)) {
+ on = toBoolean(key, value);
+ }
+ if (on) {
+ tmp.add(name);
+ }
+ } else {
+ for (String value : params.get(key)) {
+ tmp.add(name);
+ tmp.add(value);
+ }
+ }
+ }
+ parser.parseArgument(tmp.toArray(new String[tmp.size()]));
+ }
+
+ public boolean isBoolean(String name) {
+ return findHandler(makeOption(name)) instanceof BooleanOptionHandler;
+ }
+
+ private String makeOption(String name) {
+ if (!name.startsWith("-")) {
+ if (name.length() == 1) {
+ name = "-" + name;
+ } else {
+ name = "--" + name;
+ }
+ }
+ return name;
+ }
+
+ @SuppressWarnings("rawtypes")
+ private OptionHandler findHandler(String name) {
+ if (options == null) {
+ options = index(parser.options);
+ }
+ return options.get(name);
+ }
+
+ @SuppressWarnings("rawtypes")
+ private static Map<String, OptionHandler> index(List<OptionHandler> in) {
+ Map<String, OptionHandler> m = Maps.newHashMap();
+ for (OptionHandler handler : in) {
+ if (handler.option instanceof NamedOptionDef) {
+ NamedOptionDef def = (NamedOptionDef) handler.option;
+ if (!def.isArgument()) {
+ m.put(def.name(), handler);
+ for (String alias : def.aliases()) {
+ m.put(alias, handler);
+ }
+ }
+ }
+ }
+ return m;
+ }
+
+ private boolean toBoolean(String name, String value) throws CmdLineException {
+ if ("true".equals(value) || "t".equals(value) || "yes".equals(value) || "y".equals(value) || "on".equals(value)
+ || "1".equals(value) || value == null || "".equals(value)) {
+ return true;
+ }
+
+ if ("false".equals(value) || "f".equals(value) || "no".equals(value) || "n".equals(value)
+ || "off".equals(value) || "0".equals(value)) {
+ return false;
+ }
+
+ throw new CmdLineException(parser, String.format("invalid boolean \"%s=%s\"", name, value));
+ }
+
+ private class MyParser extends org.kohsuke.args4j.CmdLineParser {
+ @SuppressWarnings("rawtypes")
+ private List<OptionHandler> options;
+ private HelpOption help;
+
+ MyParser(final Object bean) {
+ super(bean);
+ ensureOptionsInitialized();
+ }
+
+ @SuppressWarnings({ "unchecked", "rawtypes" })
+ @Override
+ protected OptionHandler createOptionHandler(final OptionDef option, final Setter setter) {
+ if (isHandlerSpecified(option) || isEnum(setter) || isPrimitive(setter)) {
+ return add(super.createOptionHandler(option, setter));
+ }
+
+ // OptionHandlerFactory<?> factory = handlers.get(setter.getType());
+ // if (factory != null) {
+ // return factory.create(this, option, setter);
+ // }
+ return add(super.createOptionHandler(option, setter));
+ }
+
+ @SuppressWarnings("rawtypes")
+ private OptionHandler add(OptionHandler handler) {
+ ensureOptionsInitialized();
+ options.add(handler);
+ return handler;
+ }
+
+ private void ensureOptionsInitialized() {
+ if (options == null) {
+ help = new HelpOption();
+ options = Lists.newArrayList();
+ addOption(help, help);
+ }
+ }
+
+ private boolean isHandlerSpecified(final OptionDef option) {
+ return option.handler() != OptionHandler.class;
+ }
+
+ private <T> boolean isEnum(Setter<T> setter) {
+ return Enum.class.isAssignableFrom(setter.getType());
+ }
+
+ private <T> boolean isPrimitive(Setter<T> setter) {
+ return setter.getType().isPrimitive();
+ }
+ }
+
+ private static class HelpOption implements Option, Setter<Boolean> {
+ private boolean value;
+
+ @Override
+ public String name() {
+ return "--help";
+ }
+
+ @Override
+ public String[] aliases() {
+ return new String[] { "-h" };
+ }
+
+ @Override
+ public String[] depends() {
+ return new String[] {};
+ }
+
+ @Override
+ public boolean hidden() {
+ return false;
+ }
+
+ @Override
+ public String usage() {
+ return "display this help text";
+ }
+
+ @Override
+ public void addValue(Boolean val) {
+ value = val;
+ }
+
+ @Override
+ public Class<? extends OptionHandler<Boolean>> handler() {
+ return BooleanOptionHandler.class;
+ }
+
+ @Override
+ public String metaVar() {
+ return "";
+ }
+
+ @Override
+ public boolean required() {
+ return false;
+ }
+
+ @Override
+ public Class<? extends Annotation> annotationType() {
+ return Option.class;
+ }
+
+ @Override
+ public FieldSetter asFieldSetter() {
+ throw new UnsupportedOperationException();
+ }
+
+ @Override
+ public AnnotatedElement asAnnotatedElement() {
+ throw new UnsupportedOperationException();
+ }
+
+ @Override
+ public Class<Boolean> getType() {
+ return Boolean.class;
+ }
+
+ @Override
+ public boolean isMultiValued() {
+ return false;
+ }
+ }
}