diff options
Diffstat (limited to 'src/main/java/com/beust')
49 files changed, 4149 insertions, 0 deletions
diff --git a/src/main/java/com/beust/jcommander/DynamicParameter.java b/src/main/java/com/beust/jcommander/DynamicParameter.java new file mode 100644 index 0000000..2159c1f --- /dev/null +++ b/src/main/java/com/beust/jcommander/DynamicParameter.java @@ -0,0 +1,50 @@ +package com.beust.jcommander; + +import static java.lang.annotation.ElementType.FIELD; + +import com.beust.jcommander.validators.NoValidator; +import com.beust.jcommander.validators.NoValueValidator; + +import java.lang.annotation.Retention; +import java.lang.annotation.Target; + +@Retention(java.lang.annotation.RetentionPolicy.RUNTIME) +@Target({ FIELD }) +public @interface DynamicParameter { + /** + * An array of allowed command line parameters (e.g. "-D", "--define", etc...). + */ + String[] names() default {}; + + /** + * Whether this option is required. + */ + boolean required() default false; + + /** + * A description of this option. + */ + String description() default ""; + + /** + * The key used to find the string in the message bundle. + */ + String descriptionKey() default ""; + + /** + * If true, this parameter won't appear in the usage(). + */ + boolean hidden() default false; + + /** + * The validation class to use. + */ + Class<? extends IParameterValidator> validateWith() default NoValidator.class; + + /** + * The character(s) used to assign the values. + */ + String assignment() default "="; + + Class<? extends IValueValidator> validateValueWith() default NoValueValidator.class; +} diff --git a/src/main/java/com/beust/jcommander/FuzzyMap.java b/src/main/java/com/beust/jcommander/FuzzyMap.java new file mode 100644 index 0000000..5f3939b --- /dev/null +++ b/src/main/java/com/beust/jcommander/FuzzyMap.java @@ -0,0 +1,61 @@ +package com.beust.jcommander; + +import com.beust.jcommander.internal.Maps; + +import java.util.Map; + +/** + * Helper class to perform fuzzy key look ups: looking up case insensitive or + * abbreviated keys. + */ +public class FuzzyMap { + interface IKey { + String getName(); + } + + public static <V> V findInMap(Map<? extends IKey, V> map, IKey name, + boolean caseSensitive, boolean allowAbbreviations) { + if (allowAbbreviations) { + return findAbbreviatedValue(map, name, caseSensitive); + } else { + if (caseSensitive) { + return map.get(name); + } else { + for (IKey c : map.keySet()) { + if (c.getName().equalsIgnoreCase(name.getName())) { + return map.get(c); + } + } + } + } + return null; + } + + private static <V> V findAbbreviatedValue(Map<? extends IKey, V> map, IKey name, + boolean caseSensitive) { + String string = name.getName(); + Map<String, V> results = Maps.newHashMap(); + for (IKey c : map.keySet()) { + String n = c.getName(); + boolean match = (caseSensitive && n.startsWith(string)) + || ((! caseSensitive) && n.toLowerCase().startsWith(string.toLowerCase())); + if (match) { + results.put(n, map.get(c)); + } + } + + V result; + if (results.size() > 1) { + throw new ParameterException("Ambiguous option: " + name + + " matches " + results.keySet()); + } else if (results.size() == 1) { + result = results.values().iterator().next(); + } else { + result = null; + } + + return result; + } + + +} diff --git a/src/main/java/com/beust/jcommander/IDefaultProvider.java b/src/main/java/com/beust/jcommander/IDefaultProvider.java new file mode 100644 index 0000000..0353928 --- /dev/null +++ b/src/main/java/com/beust/jcommander/IDefaultProvider.java @@ -0,0 +1,35 @@ +/** + * Copyright (C) 2010 the original author or authors. + * See the notice.md file distributed with this work for additional + * information regarding copyright ownership. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.beust.jcommander; + +/** + * Allows the specification of default values. + * + * @author cbeust + */ +public interface IDefaultProvider { + + /** + * @param optionName The name of the option as specified in the names() attribute + * of the @Parameter option (e.g. "-file"). + * + * @return the default value for this option. + */ + String getDefaultValueFor(String optionName); +} diff --git a/src/main/java/com/beust/jcommander/IParameterValidator.java b/src/main/java/com/beust/jcommander/IParameterValidator.java new file mode 100644 index 0000000..19fee0d --- /dev/null +++ b/src/main/java/com/beust/jcommander/IParameterValidator.java @@ -0,0 +1,38 @@ +/** + * Copyright (C) 2011 the original author or authors. + * See the notice.md file distributed with this work for additional + * information regarding copyright ownership. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.beust.jcommander; + +/** + * The class used to validate parameters. + * + * @author Cedric Beust <cedric@beust.com> + */ +public interface IParameterValidator { + + /** + * Validate the parameter. + * + * @param name The name of the parameter (e.g. "-host"). + * @param value The value of the parameter that we need to validate + * + * @throws ParameterException Thrown if the value of the parameter is invalid. + */ + void validate(String name, String value) throws ParameterException; + +} diff --git a/src/main/java/com/beust/jcommander/IParameterValidator2.java b/src/main/java/com/beust/jcommander/IParameterValidator2.java new file mode 100644 index 0000000..77e7dd3 --- /dev/null +++ b/src/main/java/com/beust/jcommander/IParameterValidator2.java @@ -0,0 +1,34 @@ +/** + * Copyright (C) 2011 the original author or authors. + * See the notice.md file distributed with this work for additional + * information regarding copyright ownership. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.beust.jcommander; + +public interface IParameterValidator2 extends IParameterValidator { + + /** + * Validate the parameter. + * + * @param name The name of the parameter (e.g. "-host"). + * @param value The value of the parameter that we need to validate + * @param pd The description of this parameter + * + * @throws ParameterException Thrown if the value of the parameter is invalid. + */ + void validate(String name, String value, ParameterDescription pd) throws ParameterException; + +} diff --git a/src/main/java/com/beust/jcommander/IStringConverter.java b/src/main/java/com/beust/jcommander/IStringConverter.java new file mode 100644 index 0000000..fb51a79 --- /dev/null +++ b/src/main/java/com/beust/jcommander/IStringConverter.java @@ -0,0 +1,39 @@ +/** + * Copyright (C) 2010 the original author or authors. + * See the notice.md file distributed with this work for additional + * information regarding copyright ownership. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.beust.jcommander; + +/** + * An interface that converts strings to any arbitrary type. + * + * If your class implements a constructor that takes a String, this + * constructor will be used to instantiate your converter and the + * parameter will receive the name of the option that's being parsed, + * which can be useful to issue a more useful error message if the + * conversion fails. + * + * You can also extend BaseConverter to make your life easier. + * + * @author cbeust + */ +public interface IStringConverter<T> { + /** + * @return an object of type <T> created from the parameter value. + */ + T convert(String value); +} diff --git a/src/main/java/com/beust/jcommander/IStringConverterFactory.java b/src/main/java/com/beust/jcommander/IStringConverterFactory.java new file mode 100644 index 0000000..0e53ca0 --- /dev/null +++ b/src/main/java/com/beust/jcommander/IStringConverterFactory.java @@ -0,0 +1,30 @@ +/** + * Copyright (C) 2010 the original author or authors. + * See the notice.md file distributed with this work for additional + * information regarding copyright ownership. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.beust.jcommander; + +/** + * A factory for IStringConverter. This interface lets you specify your + * converters in one place instead of having them repeated all over + * your argument classes. + * + * @author cbeust + */ +public interface IStringConverterFactory { + <T> Class<? extends IStringConverter<T>> getConverter(Class<T> forType); +} diff --git a/src/main/java/com/beust/jcommander/IValueValidator.java b/src/main/java/com/beust/jcommander/IValueValidator.java new file mode 100644 index 0000000..feed25d --- /dev/null +++ b/src/main/java/com/beust/jcommander/IValueValidator.java @@ -0,0 +1,14 @@ +package com.beust.jcommander; + +public interface IValueValidator<T> { + /** + * Validate the parameter. + * + * @param name The name of the parameter (e.g. "-host"). + * @param value The value of the parameter that we need to validate + * + * @throws ParameterException Thrown if the value of the parameter is invalid. + */ + void validate(String name, T value) throws ParameterException; + +} diff --git a/src/main/java/com/beust/jcommander/IVariableArity.java b/src/main/java/com/beust/jcommander/IVariableArity.java new file mode 100644 index 0000000..e8a40ba --- /dev/null +++ b/src/main/java/com/beust/jcommander/IVariableArity.java @@ -0,0 +1,16 @@ +package com.beust.jcommander; + +/** + * Must be implemented by argument classes that contain at least one + * \@Parameter with "variableArity = true". + */ +public interface IVariableArity { + + /** + * @param optionName the name of the option to process. + * @param options the entire list of options. + * + * @return how many options were processed. + */ + int processVariableArity(String optionName, String[] options); +} diff --git a/src/main/java/com/beust/jcommander/JCommander.java b/src/main/java/com/beust/jcommander/JCommander.java new file mode 100644 index 0000000..2e049a1 --- /dev/null +++ b/src/main/java/com/beust/jcommander/JCommander.java @@ -0,0 +1,1599 @@ +/** + * Copyright (C) 2010 the original author or authors. + * See the notice.md file distributed with this work for additional + * information regarding copyright ownership. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.beust.jcommander; + +import java.io.BufferedReader; +import java.io.FileReader; +import java.io.IOException; +import java.lang.reflect.Constructor; +import java.lang.reflect.InvocationTargetException; +import java.lang.reflect.Method; +import java.lang.reflect.ParameterizedType; +import java.lang.reflect.Type; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.Collections; +import java.util.Comparator; +import java.util.EnumSet; +import java.util.Iterator; +import java.util.LinkedList; +import java.util.List; +import java.util.Locale; +import java.util.Map; +import java.util.ResourceBundle; + +import com.beust.jcommander.FuzzyMap.IKey; +import com.beust.jcommander.converters.IParameterSplitter; +import com.beust.jcommander.converters.NoConverter; +import com.beust.jcommander.converters.StringConverter; +import com.beust.jcommander.internal.Console; +import com.beust.jcommander.internal.DefaultConsole; +import com.beust.jcommander.internal.DefaultConverterFactory; +import com.beust.jcommander.internal.JDK6Console; +import com.beust.jcommander.internal.Lists; +import com.beust.jcommander.internal.Maps; +import com.beust.jcommander.internal.Nullable; + +/** + * The main class for JCommander. It's responsible for parsing the object that contains + * all the annotated fields, parse the command line and assign the fields with the correct + * values and a few other helper methods, such as usage(). + * + * The object(s) you pass in the constructor are expected to have one or more + * \@Parameter annotations on them. You can pass either a single object, an array of objects + * or an instance of Iterable. In the case of an array or Iterable, JCommander will collect + * the \@Parameter annotations from all the objects passed in parameter. + * + * @author Cedric Beust <cedric@beust.com> + */ +public class JCommander { + public static final String DEBUG_PROPERTY = "jcommander.debug"; + + /** + * A map to look up parameter description per option name. + */ + private Map<IKey, ParameterDescription> m_descriptions; + + /** + * The objects that contain fields annotated with @Parameter. + */ + private List<Object> m_objects = Lists.newArrayList(); + + private boolean m_firstTimeMainParameter = true; + + /** + * This field/method will contain whatever command line parameter is not an option. + * It is expected to be a List<String>. + */ + private Parameterized m_mainParameter = null; + + /** + * The object on which we found the main parameter field. + */ + private Object m_mainParameterObject; + + /** + * The annotation found on the main parameter field. + */ + private Parameter m_mainParameterAnnotation; + + private ParameterDescription m_mainParameterDescription; + + /** + * A set of all the parameterizeds that are required. During the reflection phase, + * this field receives all the fields that are annotated with required=true + * and during the parsing phase, all the fields that are assigned a value + * are removed from it. At the end of the parsing phase, if it's not empty, + * then some required fields did not receive a value and an exception is + * thrown. + */ + private Map<Parameterized, ParameterDescription> m_requiredFields = Maps.newHashMap(); + + /** + * A map of all the parameterized fields/methods. + */ + private Map<Parameterized, ParameterDescription> m_fields = Maps.newHashMap(); + + private ResourceBundle m_bundle; + + /** + * A default provider returns default values for the parameters. + */ + private IDefaultProvider m_defaultProvider; + + /** + * List of commands and their instance. + */ + private Map<ProgramName, JCommander> m_commands = Maps.newLinkedHashMap(); + + /** + * Alias database for reverse lookup + */ + private Map<IKey, ProgramName> aliasMap = Maps.newLinkedHashMap(); + + /** + * The name of the command after the parsing has run. + */ + private String m_parsedCommand; + + /** + * The name of command or alias as it was passed to the + * command line + */ + private String m_parsedAlias; + + private ProgramName m_programName; + + private Comparator<? super ParameterDescription> m_parameterDescriptionComparator + = new Comparator<ParameterDescription>() { + @Override + public int compare(ParameterDescription p0, ParameterDescription p1) { + return p0.getLongestName().compareTo(p1.getLongestName()); + } + }; + + private int m_columnSize = 79; + + private boolean m_helpWasSpecified; + + private List<String> m_unknownArgs = Lists.newArrayList(); + private boolean m_acceptUnknownOptions = false; + private boolean m_allowParameterOverwriting = false; + + private static Console m_console; + + /** + * The factories used to look up string converters. + */ + private static LinkedList<IStringConverterFactory> CONVERTER_FACTORIES = Lists.newLinkedList(); + + static { + CONVERTER_FACTORIES.addFirst(new DefaultConverterFactory()); + }; + + /** + * Creates a new un-configured JCommander object. + */ + public JCommander() { + } + + /** + * @param object The arg object expected to contain {@link Parameter} annotations. + */ + public JCommander(Object object) { + addObject(object); + createDescriptions(); + } + + /** + * @param object The arg object expected to contain {@link Parameter} annotations. + * @param bundle The bundle to use for the descriptions. Can be null. + */ + public JCommander(Object object, @Nullable ResourceBundle bundle) { + addObject(object); + setDescriptionsBundle(bundle); + } + + /** + * @param object The arg object expected to contain {@link Parameter} annotations. + * @param bundle The bundle to use for the descriptions. Can be null. + * @param args The arguments to parse (optional). + */ + public JCommander(Object object, ResourceBundle bundle, String... args) { + addObject(object); + setDescriptionsBundle(bundle); + parse(args); + } + + /** + * @param object The arg object expected to contain {@link Parameter} annotations. + * @param args The arguments to parse (optional). + */ + public JCommander(Object object, String... args) { + addObject(object); + parse(args); + } + + public static Console getConsole() { + if (m_console == null) { + try { + Method consoleMethod = System.class.getDeclaredMethod("console", new Class<?>[0]); + Object console = consoleMethod.invoke(null, new Object[0]); + m_console = new JDK6Console(console); + } catch (Throwable t) { + m_console = new DefaultConsole(); + } + } + return m_console; + } + + /** + * Adds the provided arg object to the set of objects that this commander + * will parse arguments into. + * + * @param object The arg object expected to contain {@link Parameter} + * annotations. If <code>object</code> is an array or is {@link Iterable}, + * the child objects will be added instead. + */ + // declared final since this is invoked from constructors + public final void addObject(Object object) { + if (object instanceof Iterable) { + // Iterable + for (Object o : (Iterable<?>) object) { + m_objects.add(o); + } + } else if (object.getClass().isArray()) { + // Array + for (Object o : (Object[]) object) { + m_objects.add(o); + } + } else { + // Single object + m_objects.add(object); + } + } + + /** + * Sets the {@link ResourceBundle} to use for looking up descriptions. + * Set this to <code>null</code> to use description text directly. + */ + // declared final since this is invoked from constructors + public final void setDescriptionsBundle(ResourceBundle bundle) { + m_bundle = bundle; + } + + /** + * Parse and validate the command line parameters. + */ + public void parse(String... args) { + parse(true /* validate */, args); + } + + /** + * Parse the command line parameters without validating them. + */ + public void parseWithoutValidation(String... args) { + parse(false /* no validation */, args); + } + + private void parse(boolean validate, String... args) { + StringBuilder sb = new StringBuilder("Parsing \""); + sb.append(join(args).append("\"\n with:").append(join(m_objects.toArray()))); + p(sb.toString()); + + if (m_descriptions == null) createDescriptions(); + initializeDefaultValues(); + parseValues(expandArgs(args), validate); + if (validate) validateOptions(); + } + + private StringBuilder join(Object[] args) { + StringBuilder result = new StringBuilder(); + for (int i = 0; i < args.length; i++) { + if (i > 0) result.append(" "); + result.append(args[i]); + } + return result; + } + + private void initializeDefaultValues() { + if (m_defaultProvider != null) { + for (ParameterDescription pd : m_descriptions.values()) { + initializeDefaultValue(pd); + } + + for (Map.Entry<ProgramName, JCommander> entry : m_commands.entrySet()) { + entry.getValue().initializeDefaultValues(); + } + } + } + + /** + * Make sure that all the required parameters have received a value. + */ + private void validateOptions() { + // No validation if we found a help parameter + if (m_helpWasSpecified) { + return; + } + + if (! m_requiredFields.isEmpty()) { + StringBuilder missingFields = new StringBuilder(); + for (ParameterDescription pd : m_requiredFields.values()) { + missingFields.append(pd.getNames()).append(" "); + } + throw new ParameterException("The following " + + pluralize(m_requiredFields.size(), "option is required: ", "options are required: ") + + missingFields); + } + + if (m_mainParameterDescription != null) { + if (m_mainParameterDescription.getParameter().required() && + !m_mainParameterDescription.isAssigned()) { + throw new ParameterException("Main parameters are required (\"" + + m_mainParameterDescription.getDescription() + "\")"); + } + } + } + + private static String pluralize(int quantity, String singular, String plural) { + return quantity == 1 ? singular : plural; + } + + /** + * Expand the command line parameters to take @ parameters into account. + * When @ is encountered, the content of the file that follows is inserted + * in the command line. + * + * @param originalArgv the original command line parameters + * @return the new and enriched command line parameters + */ + private String[] expandArgs(String[] originalArgv) { + List<String> vResult1 = Lists.newArrayList(); + + // + // Expand @ + // + for (String arg : originalArgv) { + + if (arg.startsWith("@")) { + String fileName = arg.substring(1); + vResult1.addAll(readFile(fileName)); + } + else { + List<String> expanded = expandDynamicArg(arg); + vResult1.addAll(expanded); + } + } + + // Expand separators + // + List<String> vResult2 = Lists.newArrayList(); + for (int i = 0; i < vResult1.size(); i++) { + String arg = vResult1.get(i); + String[] v1 = vResult1.toArray(new String[0]); + if (isOption(v1, arg)) { + String sep = getSeparatorFor(v1, arg); + if (! " ".equals(sep)) { + String[] sp = arg.split("[" + sep + "]", 2); + for (String ssp : sp) { + vResult2.add(ssp); + } + } else { + vResult2.add(arg); + } + } else { + vResult2.add(arg); + } + } + + return vResult2.toArray(new String[vResult2.size()]); + } + + private List<String> expandDynamicArg(String arg) { + for (ParameterDescription pd : m_descriptions.values()) { + if (pd.isDynamicParameter()) { + for (String name : pd.getParameter().names()) { + if (arg.startsWith(name) && !arg.equals(name)) { + return Arrays.asList(name, arg.substring(name.length())); + } + } + } + } + + return Arrays.asList(arg); + } + + private boolean isOption(String[] args, String arg) { + String prefixes = getOptionPrefixes(args, arg); + return arg.length() > 0 && prefixes.indexOf(arg.charAt(0)) >= 0; + } + + private ParameterDescription getPrefixDescriptionFor(String arg) { + for (Map.Entry<IKey, ParameterDescription> es : m_descriptions.entrySet()) { + if (arg.startsWith(es.getKey().getName())) return es.getValue(); + } + + return null; + } + + /** + * If arg is an option, we can look it up directly, but if it's a value, + * we need to find the description for the option that precedes it. + */ + private ParameterDescription getDescriptionFor(String[] args, String arg) { + ParameterDescription result = getPrefixDescriptionFor(arg); + if (result != null) return result; + + for (String a : args) { + ParameterDescription pd = getPrefixDescriptionFor(arg); + if (pd != null) result = pd; + if (a.equals(arg)) return result; + } + + throw new ParameterException("Unknown parameter: " + arg); + } + + private String getSeparatorFor(String[] args, String arg) { + ParameterDescription pd = getDescriptionFor(args, arg); + + // Could be null if only main parameters were passed + if (pd != null) { + Parameters p = pd.getObject().getClass().getAnnotation(Parameters.class); + if (p != null) return p.separators(); + } + + return " "; + } + + private String getOptionPrefixes(String[] args, String arg) { + ParameterDescription pd = getDescriptionFor(args, arg); + + // Could be null if only main parameters were passed + if (pd != null) { + Parameters p = pd.getObject().getClass() + .getAnnotation(Parameters.class); + if (p != null) return p.optionPrefixes(); + } + String result = Parameters.DEFAULT_OPTION_PREFIXES; + + // See if any of the objects contains a @Parameters(optionPrefixes) + StringBuilder sb = new StringBuilder(); + for (Object o : m_objects) { + Parameters p = o.getClass().getAnnotation(Parameters.class); + if (p != null && !Parameters.DEFAULT_OPTION_PREFIXES.equals(p.optionPrefixes())) { + sb.append(p.optionPrefixes()); + } + } + + if (! Strings.isStringEmpty(sb.toString())) { + result = sb.toString(); + } + + return result; + } + + /** + * Reads the file specified by filename and returns the file content as a string. + * End of lines are replaced by a space. + * + * @param fileName the command line filename + * @return the file content as a string. + */ + private static List<String> readFile(String fileName) { + List<String> result = Lists.newArrayList(); + + try { + BufferedReader bufRead = new BufferedReader(new FileReader(fileName)); + + String line; + + // Read through file one line at time. Print line # and line + while ((line = bufRead.readLine()) != null) { + // Allow empty lines and # comments in these at files + if (line.length() > 0 && ! line.trim().startsWith("#")) { + result.add(line); + } + } + + bufRead.close(); + } + catch (IOException e) { + throw new ParameterException("Could not read file " + fileName + ": " + e); + } + + return result; + } + + /** + * Remove spaces at both ends and handle double quotes. + */ + private static String trim(String string) { + String result = string.trim(); + if (result.startsWith("\"") && result.endsWith("\"") && result.length() > 1) { + result = result.substring(1, result.length() - 1); + } + return result; + } + + /** + * Create the ParameterDescriptions for all the \@Parameter found. + */ + private void createDescriptions() { + m_descriptions = Maps.newHashMap(); + + for (Object object : m_objects) { + addDescription(object); + } + } + + private void addDescription(Object object) { + Class<?> cls = object.getClass(); + + List<Parameterized> parameterizeds = Parameterized.parseArg(object); + for (Parameterized parameterized : parameterizeds) { + WrappedParameter wp = parameterized.getWrappedParameter(); + if (wp != null && wp.getParameter() != null) { + Parameter annotation = wp.getParameter(); + // + // @Parameter + // + Parameter p = annotation; + if (p.names().length == 0) { + p("Found main parameter:" + parameterized); + if (m_mainParameter != null) { + throw new ParameterException("Only one @Parameter with no names attribute is" + + " allowed, found:" + m_mainParameter + " and " + parameterized); + } + m_mainParameter = parameterized; + m_mainParameterObject = object; + m_mainParameterAnnotation = p; + m_mainParameterDescription = + new ParameterDescription(object, p, parameterized, m_bundle, this); + } else { + ParameterDescription pd = + new ParameterDescription(object, p, parameterized, m_bundle, this); + for (String name : p.names()) { + if (m_descriptions.containsKey(new StringKey(name))) { + throw new ParameterException("Found the option " + name + " multiple times"); + } + p("Adding description for " + name); + m_fields.put(parameterized, pd); + m_descriptions.put(new StringKey(name), pd); + + if (p.required()) m_requiredFields.put(parameterized, pd); + } + } + } else if (parameterized.getDelegateAnnotation() != null) { + // + // @ParametersDelegate + // + Object delegateObject = parameterized.get(object); + if (delegateObject == null){ + throw new ParameterException("Delegate field '" + parameterized.getName() + + "' cannot be null."); + } + addDescription(delegateObject); + } else if (wp != null && wp.getDynamicParameter() != null) { + // + // @DynamicParameter + // + DynamicParameter dp = wp.getDynamicParameter(); + for (String name : dp.names()) { + if (m_descriptions.containsKey(name)) { + throw new ParameterException("Found the option " + name + " multiple times"); + } + p("Adding description for " + name); + ParameterDescription pd = + new ParameterDescription(object, dp, parameterized, m_bundle, this); + m_fields.put(parameterized, pd); + m_descriptions.put(new StringKey(name), pd); + + if (dp.required()) m_requiredFields.put(parameterized, pd); + } + } + } + +// while (!Object.class.equals(cls)) { +// for (Field f : cls.getDeclaredFields()) { +// p("Field:" + cls.getSimpleName() + "." + f.getName()); +// f.setAccessible(true); +// Annotation annotation = f.getAnnotation(Parameter.class); +// Annotation delegateAnnotation = f.getAnnotation(ParametersDelegate.class); +// Annotation dynamicParameter = f.getAnnotation(DynamicParameter.class); +// if (annotation != null) { +// // +// // @Parameter +// // +// Parameter p = (Parameter) annotation; +// if (p.names().length == 0) { +// p("Found main parameter:" + f); +// if (m_mainParameterField != null) { +// throw new ParameterException("Only one @Parameter with no names attribute is" +// + " allowed, found:" + m_mainParameterField + " and " + f); +// } +// m_mainParameterField = parameterized; +// m_mainParameterObject = object; +// m_mainParameterAnnotation = p; +// m_mainParameterDescription = new ParameterDescription(object, p, f, m_bundle, this); +// } else { +// for (String name : p.names()) { +// if (m_descriptions.containsKey(name)) { +// throw new ParameterException("Found the option " + name + " multiple times"); +// } +// p("Adding description for " + name); +// ParameterDescription pd = new ParameterDescription(object, p, f, m_bundle, this); +// m_fields.put(f, pd); +// m_descriptions.put(name, pd); +// +// if (p.required()) m_requiredFields.put(f, pd); +// } +// } +// } else if (delegateAnnotation != null) { +// // +// // @ParametersDelegate +// // +// try { +// Object delegateObject = f.get(object); +// if (delegateObject == null){ +// throw new ParameterException("Delegate field '" + f.getName() + "' cannot be null."); +// } +// addDescription(delegateObject); +// } catch (IllegalAccessException e) { +// } +// } else if (dynamicParameter != null) { +// // +// // @DynamicParameter +// // +// DynamicParameter dp = (DynamicParameter) dynamicParameter; +// for (String name : dp.names()) { +// if (m_descriptions.containsKey(name)) { +// throw new ParameterException("Found the option " + name + " multiple times"); +// } +// p("Adding description for " + name); +// ParameterDescription pd = new ParameterDescription(object, dp, f, m_bundle, this); +// m_fields.put(f, pd); +// m_descriptions.put(name, pd); +// +// if (dp.required()) m_requiredFields.put(f, pd); +// } +// } +// } +// // Traverse the super class until we find Object.class +// cls = cls.getSuperclass(); +// } + } + + private void initializeDefaultValue(ParameterDescription pd) { + for (String optionName : pd.getParameter().names()) { + String def = m_defaultProvider.getDefaultValueFor(optionName); + if (def != null) { + p("Initializing " + optionName + " with default value:" + def); + pd.addValue(def, true /* default */); + return; + } + } + } + + /** + * Main method that parses the values and initializes the fields accordingly. + */ + private void parseValues(String[] args, boolean validate) { + // This boolean becomes true if we encounter a command, which indicates we need + // to stop parsing (the parsing of the command will be done in a sub JCommander + // object) + boolean commandParsed = false; + int i = 0; + boolean isDashDash = false; // once we encounter --, everything goes into the main parameter + while (i < args.length && ! commandParsed) { + String arg = args[i]; + String a = trim(arg); + args[i] = a; + p("Parsing arg: " + a); + + JCommander jc = findCommandByAlias(arg); + int increment = 1; + if (! isDashDash && ! "--".equals(a) && isOption(args, a) && jc == null) { + // + // Option + // + ParameterDescription pd = findParameterDescription(a); + + if (pd != null) { + if (pd.getParameter().password()) { + // + // Password option, use the Console to retrieve the password + // + char[] password = readPassword(pd.getDescription(), pd.getParameter().echoInput()); + pd.addValue(new String(password)); + m_requiredFields.remove(pd.getParameterized()); + } else { + if (pd.getParameter().variableArity()) { + // + // Variable arity? + // + increment = processVariableArity(args, i, pd); + } else { + // + // Regular option + // + Class<?> fieldType = pd.getParameterized().getType(); + + // Boolean, set to true as soon as we see it, unless it specified + // an arity of 1, in which case we need to read the next value + if ((fieldType == boolean.class || fieldType == Boolean.class) + && pd.getParameter().arity() == -1) { + pd.addValue("true"); + m_requiredFields.remove(pd.getParameterized()); + } else { + increment = processFixedArity(args, i, pd, fieldType); + } + // If it's a help option, remember for later + if (pd.isHelp()) { + m_helpWasSpecified = true; + } + } + } + } else { + if (m_acceptUnknownOptions) { + m_unknownArgs.add(arg); + i++; + while (i < args.length && ! isOption(args, args[i])) { + m_unknownArgs.add(args[i++]); + } + increment = 0; + } else { + throw new ParameterException("Unknown option: " + arg); + } + } + } + else { + // + // Main parameter + // + if (! Strings.isStringEmpty(arg)) { + if ("--".equals(arg)) { + isDashDash = true; + a = trim(args[++i]); + } + if (m_commands.isEmpty()) { + // + // Regular (non-command) parsing + // + List mp = getMainParameter(arg); + String value = a; // If there's a non-quoted version, prefer that one + Object convertedValue = value; + + if (m_mainParameter.getGenericType() instanceof ParameterizedType) { + ParameterizedType p = (ParameterizedType) m_mainParameter.getGenericType(); + Type cls = p.getActualTypeArguments()[0]; + if (cls instanceof Class) { + convertedValue = convertValue(m_mainParameter, (Class) cls, value); + } + } + + ParameterDescription.validateParameter(m_mainParameterDescription, + m_mainParameterAnnotation.validateWith(), + "Default", value); + + m_mainParameterDescription.setAssigned(true); + mp.add(convertedValue); + } + else { + // + // Command parsing + // + if (jc == null && validate) { + throw new MissingCommandException("Expected a command, got " + arg); + } else if (jc != null){ + m_parsedCommand = jc.m_programName.m_name; + m_parsedAlias = arg; //preserve the original form + + // Found a valid command, ask it to parse the remainder of the arguments. + // Setting the boolean commandParsed to true will force the current + // loop to end. + jc.parse(subArray(args, i + 1)); + commandParsed = true; + } + } + } + } + i += increment; + } + + // Mark the parameter descriptions held in m_fields as assigned + for (ParameterDescription parameterDescription : m_descriptions.values()) { + if (parameterDescription.isAssigned()) { + m_fields.get(parameterDescription.getParameterized()).setAssigned(true); + } + } + + } + + private class DefaultVariableArity implements IVariableArity { + + @Override + public int processVariableArity(String optionName, String[] options) { + int i = 0; + while (i < options.length && !isOption(options, options[i])) { + i++; + } + return i; + } + } + private final IVariableArity DEFAULT_VARIABLE_ARITY = new DefaultVariableArity(); + + private int m_verbose = 0; + + private boolean m_caseSensitiveOptions = true; + private boolean m_allowAbbreviatedOptions = false; + + /** + * @return the number of options that were processed. + */ + private int processVariableArity(String[] args, int index, ParameterDescription pd) { + Object arg = pd.getObject(); + IVariableArity va; + if (! (arg instanceof IVariableArity)) { + va = DEFAULT_VARIABLE_ARITY; + } else { + va = (IVariableArity) arg; + } + + List<String> currentArgs = Lists.newArrayList(); + for (int j = index + 1; j < args.length; j++) { + currentArgs.add(args[j]); + } + int arity = va.processVariableArity(pd.getParameter().names()[0], + currentArgs.toArray(new String[0])); + + int result = processFixedArity(args, index, pd, List.class, arity); + return result; + } + + private int processFixedArity(String[] args, int index, ParameterDescription pd, + Class<?> fieldType) { + // Regular parameter, use the arity to tell use how many values + // we need to consume + int arity = pd.getParameter().arity(); + int n = (arity != -1 ? arity : 1); + + return processFixedArity(args, index, pd, fieldType, n); + } + + private int processFixedArity(String[] args, int originalIndex, ParameterDescription pd, + Class<?> fieldType, int arity) { + int index = originalIndex; + String arg = args[index]; + // Special case for boolean parameters of arity 0 + if (arity == 0 && + (Boolean.class.isAssignableFrom(fieldType) + || boolean.class.isAssignableFrom(fieldType))) { + pd.addValue("true"); + m_requiredFields.remove(pd.getParameterized()); + } else if (index < args.length - 1) { + int offset = "--".equals(args[index + 1]) ? 1 : 0; + + if (index + arity < args.length) { + for (int j = 1; j <= arity; j++) { + pd.addValue(trim(args[index + j + offset])); + m_requiredFields.remove(pd.getParameterized()); + } + index += arity + offset; + } else { + throw new ParameterException("Expected " + arity + " values after " + arg); + } + } else { + throw new ParameterException("Expected a value after parameter " + arg); + } + + return arity + 1; + } + + /** + * Invoke Console.readPassword through reflection to avoid depending + * on Java 6. + */ + private char[] readPassword(String description, boolean echoInput) { + getConsole().print(description + ": "); + return getConsole().readPassword(echoInput); + } + + private String[] subArray(String[] args, int index) { + int l = args.length - index; + String[] result = new String[l]; + System.arraycopy(args, index, result, 0, l); + + return result; + } + + /** + * @return the field that's meant to receive all the parameters that are not options. + * + * @param arg the arg that we're about to add (only passed here to output a meaningful + * error message). + */ + private List<?> getMainParameter(String arg) { + if (m_mainParameter == null) { + throw new ParameterException( + "Was passed main parameter '" + arg + "' but no main parameter was defined"); + } + + List<?> result = (List<?>) m_mainParameter.get(m_mainParameterObject); + if (result == null) { + result = Lists.newArrayList(); + if (! List.class.isAssignableFrom(m_mainParameter.getType())) { + throw new ParameterException("Main parameter field " + m_mainParameter + + " needs to be of type List, not " + m_mainParameter.getType()); + } + m_mainParameter.set(m_mainParameterObject, result); + } + if (m_firstTimeMainParameter) { + result.clear(); + m_firstTimeMainParameter = false; + } + return result; + } + + public String getMainParameterDescription() { + if (m_descriptions == null) createDescriptions(); + return m_mainParameterAnnotation != null ? m_mainParameterAnnotation.description() + : null; + } + +// private int longestName(Collection<?> objects) { +// int result = 0; +// for (Object o : objects) { +// int l = o.toString().length(); +// if (l > result) result = l; +// } +// +// return result; +// } + + /** + * Set the program name (used only in the usage). + */ + public void setProgramName(String name) { + setProgramName(name, new String[0]); + } + + /** + * Set the program name + * + * @param name program name + * @param aliases aliases to the program name + */ + public void setProgramName(String name, String... aliases) { + m_programName = new ProgramName(name, Arrays.asList(aliases)); + } + + /** + * Display the usage for this command. + */ + public void usage(String commandName) { + StringBuilder sb = new StringBuilder(); + usage(commandName, sb); + getConsole().println(sb.toString()); + } + + /** + * Store the help for the command in the passed string builder. + */ + public void usage(String commandName, StringBuilder out) { + usage(commandName, out, ""); + } + + /** + * Store the help for the command in the passed string builder, indenting + * every line with "indent". + */ + public void usage(String commandName, StringBuilder out, String indent) { + String description = getCommandDescription(commandName); + JCommander jc = findCommandByAlias(commandName); + if (description != null) { + out.append(indent).append(description); + out.append("\n"); + } + jc.usage(out, indent); + } + + /** + * @return the description of the command. + */ + public String getCommandDescription(String commandName) { + JCommander jc = findCommandByAlias(commandName); + if (jc == null) { + throw new ParameterException("Asking description for unknown command: " + commandName); + } + + Object arg = jc.getObjects().get(0); + Parameters p = arg.getClass().getAnnotation(Parameters.class); + ResourceBundle bundle = null; + String result = null; + if (p != null) { + result = p.commandDescription(); + String bundleName = p.resourceBundle(); + if (!"".equals(bundleName)) { + bundle = ResourceBundle.getBundle(bundleName, Locale.getDefault()); + } else { + bundle = m_bundle; + } + + if (bundle != null) { + result = getI18nString(bundle, p.commandDescriptionKey(), p.commandDescription()); + } + } + + return result; + } + + /** + * @return The internationalized version of the string if available, otherwise + * return def. + */ + private String getI18nString(ResourceBundle bundle, String key, String def) { + String s = bundle != null ? bundle.getString(key) : null; + return s != null ? s : def; + } + + /** + * Display the help on System.out. + */ + public void usage() { + StringBuilder sb = new StringBuilder(); + usage(sb); + getConsole().println(sb.toString()); + } + + /** + * Store the help in the passed string builder. + */ + public void usage(StringBuilder out) { + usage(out, ""); + } + + public void usage(StringBuilder out, String indent) { + if (m_descriptions == null) createDescriptions(); + boolean hasCommands = !m_commands.isEmpty(); + + // + // First line of the usage + // + String programName = m_programName != null ? m_programName.getDisplayName() : "<main class>"; + out.append(indent).append("Usage: " + programName + " [options]"); + if (hasCommands) out.append(indent).append(" [command] [command options]"); + if (m_mainParameterDescription != null) { + out.append(" " + m_mainParameterDescription.getDescription()); + } + out.append("\n"); + + // + // Align the descriptions at the "longestName" column + // + int longestName = 0; + List<ParameterDescription> sorted = Lists.newArrayList(); + for (ParameterDescription pd : m_fields.values()) { + if (! pd.getParameter().hidden()) { + sorted.add(pd); + // + to have an extra space between the name and the description + int length = pd.getNames().length() + 2; + if (length > longestName) { + longestName = length; + } + } + } + + // + // Sort the options + // + Collections.sort(sorted, getParameterDescriptionComparator()); + + // + // Display all the names and descriptions + // + int descriptionIndent = 6; + if (sorted.size() > 0) out.append(indent).append(" Options:\n"); + for (ParameterDescription pd : sorted) { + WrappedParameter parameter = pd.getParameter(); + out.append(indent).append(" " + + (parameter.required() ? "* " : " ") + + pd.getNames() + + "\n" + + indent + s(descriptionIndent)); + int indentCount = indent.length() + descriptionIndent; + wrapDescription(out, indentCount, pd.getDescription()); + Object def = pd.getDefault(); + if (pd.isDynamicParameter()) { + out.append("\n" + s(indentCount + 1)) + .append("Syntax: " + parameter.names()[0] + + "key" + parameter.getAssignment() + + "value"); + } + if (def != null) { + String displayedDef = Strings.isStringEmpty(def.toString()) + ? "<empty string>" + : def.toString(); + out.append("\n" + s(indentCount + 1)) + .append("Default: " + (parameter.password()?"********" : displayedDef)); + } + Class<?> type = pd.getParameterized().getType(); + if(type.isEnum()){ + out.append("\n" + s(indentCount + 1)) + .append("Possible Values: " + EnumSet.allOf((Class<? extends Enum>) type)); + } + out.append("\n"); + } + + // + // If commands were specified, show them as well + // + if (hasCommands) { + out.append(" Commands:\n"); + // The magic value 3 is the number of spaces between the name of the option + // and its description + for (Map.Entry<ProgramName, JCommander> commands : m_commands.entrySet()) { + Object arg = commands.getValue().getObjects().get(0); + Parameters p = arg.getClass().getAnnotation(Parameters.class); + if (!p.hidden()) { + ProgramName progName = commands.getKey(); + String dispName = progName.getDisplayName(); + out.append(indent).append(" " + dispName); // + s(spaceCount) + getCommandDescription(progName.name) + "\n"); + + // Options for this command + usage(progName.getName(), out, " "); + out.append("\n"); + } + } + } + } + + private Comparator<? super ParameterDescription> getParameterDescriptionComparator() { + return m_parameterDescriptionComparator; + } + + public void setParameterDescriptionComparator(Comparator<? super ParameterDescription> c) { + m_parameterDescriptionComparator = c; + } + + public void setColumnSize(int columnSize) { + m_columnSize = columnSize; + } + + public int getColumnSize() { + return m_columnSize; + } + + private void wrapDescription(StringBuilder out, int indent, String description) { + int max = getColumnSize(); + String[] words = description.split(" "); + int current = indent; + int i = 0; + while (i < words.length) { + String word = words[i]; + if (word.length() > max || current + word.length() <= max) { + out.append(" ").append(word); + current += word.length() + 1; + } else { + out.append("\n").append(s(indent + 1)).append(word); + current = indent; + } + i++; + } + } + + /** + * @return a Collection of all the \@Parameter annotations found on the + * target class. This can be used to display the usage() in a different + * format (e.g. HTML). + */ + public List<ParameterDescription> getParameters() { + return new ArrayList<ParameterDescription>(m_fields.values()); + } + + /** + * @return the main parameter description or null if none is defined. + */ + public ParameterDescription getMainParameter() { + return m_mainParameterDescription; + } + + private void p(String string) { + if (m_verbose > 0 || System.getProperty(JCommander.DEBUG_PROPERTY) != null) { + getConsole().println("[JCommander] " + string); + } + } + + /** + * Define the default provider for this instance. + */ + public void setDefaultProvider(IDefaultProvider defaultProvider) { + m_defaultProvider = defaultProvider; + + for (Map.Entry<ProgramName, JCommander> entry : m_commands.entrySet()) { + entry.getValue().setDefaultProvider(defaultProvider); + } + } + + public void addConverterFactory(IStringConverterFactory converterFactory) { + CONVERTER_FACTORIES.addFirst(converterFactory); + } + + public <T> Class<? extends IStringConverter<T>> findConverter(Class<T> cls) { + for (IStringConverterFactory f : CONVERTER_FACTORIES) { + Class<? extends IStringConverter<T>> result = f.getConverter(cls); + if (result != null) return result; + } + + return null; + } + + public Object convertValue(ParameterDescription pd, String value) { + return convertValue(pd.getParameterized(), pd.getParameterized().getType(), value); + } + + /** + * @param type The type of the actual parameter + * @param value The value to convert + */ + public Object convertValue(Parameterized parameterized, Class type, + String value) { + Parameter annotation = parameterized.getParameter(); + + // Do nothing if it's a @DynamicParameter + if (annotation == null) return value; + + Class<? extends IStringConverter<?>> converterClass = annotation.converter(); + boolean listConverterWasSpecified = annotation.listConverter() != NoConverter.class; + + // + // Try to find a converter on the annotation + // + if (converterClass == null || converterClass == NoConverter.class) { + // If no converter specified and type is enum, used enum values to convert + if (type.isEnum()){ + converterClass = type; + } else { + converterClass = findConverter(type); + } + } + + if (converterClass == null) { + Type elementType = parameterized.findFieldGenericType(); + converterClass = elementType != null + ? findConverter((Class<? extends IStringConverter<?>>) elementType) + : StringConverter.class; + // Check for enum type parameter + if (converterClass == null && Enum.class.isAssignableFrom((Class) elementType)) { + converterClass = (Class<? extends IStringConverter<?>>) elementType; + } + } + + IStringConverter<?> converter; + Object result = null; + try { + String[] names = annotation.names(); + String optionName = names.length > 0 ? names[0] : "[Main class]"; + if (converterClass != null && converterClass.isEnum()) { + try { + result = Enum.valueOf((Class<? extends Enum>) converterClass, value); + } catch (IllegalArgumentException e) { + try { + result = Enum.valueOf((Class<? extends Enum>) converterClass, value.toUpperCase()); + } catch (IllegalArgumentException ex) { + throw new ParameterException("Invalid value for " + optionName + " parameter. Allowed values:" + + EnumSet.allOf((Class<? extends Enum>) converterClass)); + } + } catch (Exception e) { + throw new ParameterException("Invalid value for " + optionName + " parameter. Allowed values:" + + EnumSet.allOf((Class<? extends Enum>) converterClass)); + } + } else { + converter = instantiateConverter(optionName, converterClass); + if (type.isAssignableFrom(List.class) + && parameterized.getGenericType() instanceof ParameterizedType) { + + // The field is a List + if (listConverterWasSpecified) { + // If a list converter was specified, pass the value to it + // for direct conversion + IStringConverter<?> listConverter = + instantiateConverter(optionName, annotation.listConverter()); + result = listConverter.convert(value); + } else { + // No list converter: use the single value converter and pass each + // parsed value to it individually + result = convertToList(value, converter, annotation.splitter()); + } + } else { + result = converter.convert(value); + } + } + } catch (InstantiationException e) { + throw new ParameterException(e); + } catch (IllegalAccessException e) { + throw new ParameterException(e); + } catch (InvocationTargetException e) { + throw new ParameterException(e); + } + + return result; + } + + /** + * Use the splitter to split the value into multiple values and then convert + * each of them individually. + */ + private Object convertToList(String value, IStringConverter<?> converter, + Class<? extends IParameterSplitter> splitterClass) + throws InstantiationException, IllegalAccessException { + IParameterSplitter splitter = splitterClass.newInstance(); + List<Object> result = Lists.newArrayList(); + for (String param : splitter.split(value)) { + result.add(converter.convert(param)); + } + return result; + } + + private IStringConverter<?> instantiateConverter(String optionName, + Class<? extends IStringConverter<?>> converterClass) + throws IllegalArgumentException, InstantiationException, IllegalAccessException, + InvocationTargetException { + Constructor<IStringConverter<?>> ctor = null; + Constructor<IStringConverter<?>> stringCtor = null; + Constructor<IStringConverter<?>>[] ctors + = (Constructor<IStringConverter<?>>[]) converterClass.getDeclaredConstructors(); + for (Constructor<IStringConverter<?>> c : ctors) { + Class<?>[] types = c.getParameterTypes(); + if (types.length == 1 && types[0].equals(String.class)) { + stringCtor = c; + } else if (types.length == 0) { + ctor = c; + } + } + + IStringConverter<?> result = stringCtor != null + ? stringCtor.newInstance(optionName) + : (ctor != null + ? ctor.newInstance() + : null); + + return result; + } + + /** + * Add a command object. + */ + public void addCommand(String name, Object object) { + addCommand(name, object, new String[0]); + } + + public void addCommand(Object object) { + Parameters p = object.getClass().getAnnotation(Parameters.class); + if (p != null && p.commandNames().length > 0) { + for (String commandName : p.commandNames()) { + addCommand(commandName, object); + } + } else { + throw new ParameterException("Trying to add command " + object.getClass().getName() + + " without specifying its names in @Parameters"); + } + } + + /** + * Add a command object and its aliases. + */ + public void addCommand(String name, Object object, String... aliases) { + JCommander jc = new JCommander(object); + jc.setProgramName(name, aliases); + jc.setDefaultProvider(m_defaultProvider); + jc.setAcceptUnknownOptions(m_acceptUnknownOptions); + ProgramName progName = jc.m_programName; + m_commands.put(progName, jc); + + /* + * Register aliases + */ + //register command name as an alias of itself for reverse lookup + //Note: Name clash check is intentionally omitted to resemble the + // original behaviour of clashing commands. + // Aliases are, however, are strictly checked for name clashes. + aliasMap.put(new StringKey(name), progName); + for (String a : aliases) { + IKey alias = new StringKey(a); + //omit pointless aliases to avoid name clash exception + if (!alias.equals(name)) { + ProgramName mappedName = aliasMap.get(alias); + if (mappedName != null && !mappedName.equals(progName)) { + throw new ParameterException("Cannot set alias " + alias + + " for " + name + + " command because it has already been defined for " + + mappedName.m_name + " command"); + } + aliasMap.put(alias, progName); + } + } + } + + public Map<String, JCommander> getCommands() { + Map<String, JCommander> res = Maps.newLinkedHashMap(); + for (Map.Entry<ProgramName, JCommander> entry : m_commands.entrySet()) { + res.put(entry.getKey().m_name, entry.getValue()); + } + return res; + } + + public String getParsedCommand() { + return m_parsedCommand; + } + + /** + * The name of the command or the alias in the form it was + * passed to the command line. <code>null</code> if no + * command or alias was specified. + * + * @return Name of command or alias passed to command line. If none passed: <code>null</code>. + */ + public String getParsedAlias() { + return m_parsedAlias; + } + + /** + * @return n spaces + */ + private String s(int count) { + StringBuilder result = new StringBuilder(); + for (int i = 0; i < count; i++) { + result.append(" "); + } + + return result.toString(); + } + + /** + * @return the objects that JCommander will fill with the result of + * parsing the command line. + */ + public List<Object> getObjects() { + return m_objects; + } + + private ParameterDescription findParameterDescription(String arg) { + return FuzzyMap.findInMap(m_descriptions, new StringKey(arg), m_caseSensitiveOptions, + m_allowAbbreviatedOptions); + } + + private JCommander findCommand(ProgramName name) { + return FuzzyMap.findInMap(m_commands, name, + m_caseSensitiveOptions, m_allowAbbreviatedOptions); +// if (! m_caseSensitiveOptions) { +// return m_commands.get(name); +// } else { +// for (ProgramName c : m_commands.keySet()) { +// if (c.getName().equalsIgnoreCase(name.getName())) { +// return m_commands.get(c); +// } +// } +// } +// return null; + } + + private ProgramName findProgramName(String name) { + return FuzzyMap.findInMap(aliasMap, new StringKey(name), + m_caseSensitiveOptions, m_allowAbbreviatedOptions); + } + + /* + * Reverse lookup JCommand object by command's name or its alias + */ + private JCommander findCommandByAlias(String commandOrAlias) { + ProgramName progName = findProgramName(commandOrAlias); + if (progName == null) { + return null; + } + JCommander jc = findCommand(progName); + if (jc == null) { + throw new IllegalStateException( + "There appears to be inconsistency in the internal command database. " + + " This is likely a bug. Please report."); + } + return jc; + } + + /** + * Encapsulation of either a main application or an individual command. + */ + private static final class ProgramName implements IKey { + private final String m_name; + private final List<String> m_aliases; + + ProgramName(String name, List<String> aliases) { + m_name = name; + m_aliases = aliases; + } + + @Override + public String getName() { + return m_name; + } + + private String getDisplayName() { + StringBuilder sb = new StringBuilder(); + sb.append(m_name); + if (!m_aliases.isEmpty()) { + sb.append("("); + Iterator<String> aliasesIt = m_aliases.iterator(); + while (aliasesIt.hasNext()) { + sb.append(aliasesIt.next()); + if (aliasesIt.hasNext()) { + sb.append(","); + } + } + sb.append(")"); + } + return sb.toString(); + } + + @Override + public int hashCode() { + final int prime = 31; + int result = 1; + result = prime * result + ((m_name == null) ? 0 : m_name.hashCode()); + return result; + } + + @Override + public boolean equals(Object obj) { + if (this == obj) + return true; + if (obj == null) + return false; + if (getClass() != obj.getClass()) + return false; + ProgramName other = (ProgramName) obj; + if (m_name == null) { + if (other.m_name != null) + return false; + } else if (!m_name.equals(other.m_name)) + return false; + return true; + } + + /* + * Important: ProgramName#toString() is used by longestName(Collection) function + * to format usage output. + */ + @Override + public String toString() { + return getDisplayName(); + + } + } + + public void setVerbose(int verbose) { + m_verbose = verbose; + } + + public void setCaseSensitiveOptions(boolean b) { + m_caseSensitiveOptions = b; + } + + public void setAllowAbbreviatedOptions(boolean b) { + m_allowAbbreviatedOptions = b; + } + + public void setAcceptUnknownOptions(boolean b) { + m_acceptUnknownOptions = b; + } + + public List<String> getUnknownOptions() { + return m_unknownArgs; + } + public void setAllowParameterOverwriting(boolean b) { + m_allowParameterOverwriting = b; + } + + public boolean isParameterOverwritingAllowed() { + return m_allowParameterOverwriting; + } +// public void setCaseSensitiveCommands(boolean b) { +// m_caseSensitiveCommands = b; +// } +} + diff --git a/src/main/java/com/beust/jcommander/MissingCommandException.java b/src/main/java/com/beust/jcommander/MissingCommandException.java new file mode 100644 index 0000000..1d572ab --- /dev/null +++ b/src/main/java/com/beust/jcommander/MissingCommandException.java @@ -0,0 +1,36 @@ +/** + * Copyright (C) 2010 the original author or authors. + * See the notice.md file distributed with this work for additional + * information regarding copyright ownership. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.beust.jcommander; + +/** + * Thrown when a command was expected. + * + * @author Cedric Beust <cedric@beust.com> + */ +@SuppressWarnings("serial") +public class MissingCommandException extends ParameterException { + + public MissingCommandException(String string) { + super(string); + } + + public MissingCommandException(Throwable t) { + super(t); + } +} diff --git a/src/main/java/com/beust/jcommander/Parameter.java b/src/main/java/com/beust/jcommander/Parameter.java new file mode 100644 index 0000000..d8cf87d --- /dev/null +++ b/src/main/java/com/beust/jcommander/Parameter.java @@ -0,0 +1,130 @@ +/** + * Copyright (C) 2010 the original author or authors. + * See the notice.md file distributed with this work for additional + * information regarding copyright ownership. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.beust.jcommander; + +import static java.lang.annotation.ElementType.FIELD; +import static java.lang.annotation.ElementType.METHOD; + +import com.beust.jcommander.converters.CommaParameterSplitter; +import com.beust.jcommander.converters.IParameterSplitter; +import com.beust.jcommander.converters.NoConverter; +import com.beust.jcommander.validators.NoValidator; +import com.beust.jcommander.validators.NoValueValidator; + +import java.lang.annotation.Retention; +import java.lang.annotation.Target; + +@Retention(java.lang.annotation.RetentionPolicy.RUNTIME) +@Target({ FIELD, METHOD }) +public @interface Parameter { + + /** + * An array of allowed command line parameters (e.g. "-d", "--outputdir", etc...). + * If this attribute is omitted, the field it's annotating will receive all the + * unparsed options. There can only be at most one such annotation. + */ + String[] names() default {}; + + /** + * A description of this option. + */ + String description() default ""; + + /** + * Whether this option is required. + */ + boolean required() default false; + + /** + * The key used to find the string in the message bundle. + */ + String descriptionKey() default ""; + + /** + * How many parameter values this parameter will consume. For example, + * an arity of 2 will allow "-pair value1 value2". + */ + int arity() default -1; + + /** + * If true, this parameter is a password and it will be prompted on the console + * (if available). + */ + boolean password() default false; + + /** + * The string converter to use for this field. If the field is of type <tt>List</tt> + * and not <tt>listConverter</tt> attribute was specified, JCommander will split + * the input in individual values and convert each of them separately. + */ + Class<? extends IStringConverter<?>> converter() default NoConverter.class; + + /** + * The list string converter to use for this field. If it's specified, the + * field has to be of type <tt>List</tt> and the converter needs to return + * a List that's compatible with that type. + */ + Class<? extends IStringConverter<?>> listConverter() default NoConverter.class; + + /** + * If true, this parameter won't appear in the usage(). + */ + boolean hidden() default false; + + /** + * Validate the parameter found on the command line. + */ + Class<? extends IParameterValidator> validateWith() default NoValidator.class; + + /** + * Validate the value for this parameter. + */ + Class<? extends IValueValidator> validateValueWith() default NoValueValidator.class; + + /** + * @return true if this parameter has a variable arity. See @{IVariableArity} + */ + boolean variableArity() default false; + + /** + * What splitter to use (applicable only on fields of type <tt>List</tt>). By default, + * a comma separated splitter will be used. + */ + Class<? extends IParameterSplitter> splitter() default CommaParameterSplitter.class; + + /** + * If true, console will not echo typed input + * Used in conjunction with password = true + */ + boolean echoInput() default false; + + /** + * If true, this parameter is for help. If such a parameter is specified, + * required parameters are no longer checked for their presence. + */ + boolean help() default false; + + /** + * If true, this parameter can be overwritten through a file or another appearance of the parameter + * @return + */ + boolean forceNonOverwritable() default false; + + +} diff --git a/src/main/java/com/beust/jcommander/ParameterDescription.java b/src/main/java/com/beust/jcommander/ParameterDescription.java new file mode 100644 index 0000000..2ef2d5f --- /dev/null +++ b/src/main/java/com/beust/jcommander/ParameterDescription.java @@ -0,0 +1,364 @@ +/** + * Copyright (C) 2010 the original author or authors. + * See the notice.md file distributed with this work for additional + * information regarding copyright ownership. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.beust.jcommander; + +import com.beust.jcommander.validators.NoValidator; +import com.beust.jcommander.validators.NoValueValidator; + +import java.util.ArrayList; +import java.util.Collection; +import java.util.EnumSet; +import java.util.HashSet; +import java.util.LinkedHashSet; +import java.util.List; +import java.util.Locale; +import java.util.Map; +import java.util.ResourceBundle; +import java.util.Set; +import java.util.SortedSet; +import java.util.TreeSet; + +public class ParameterDescription { + private Object m_object; + + private WrappedParameter m_wrappedParameter; + private Parameter m_parameterAnnotation; + private DynamicParameter m_dynamicParameterAnnotation; + + /** The field/method */ + private Parameterized m_parameterized; + /** Keep track of whether a value was added to flag an error */ + private boolean m_assigned = false; + private ResourceBundle m_bundle; + private String m_description; + private JCommander m_jCommander; + private Object m_default; + /** Longest of the names(), used to present usage() alphabetically */ + private String m_longestName = ""; + + public ParameterDescription(Object object, DynamicParameter annotation, + Parameterized parameterized, + ResourceBundle bundle, JCommander jc) { + if (! Map.class.isAssignableFrom(parameterized.getType())) { + throw new ParameterException("@DynamicParameter " + parameterized.getName() + + " should be of type " + + "Map but is " + parameterized.getType().getName()); + } + + m_dynamicParameterAnnotation = annotation; + m_wrappedParameter = new WrappedParameter(m_dynamicParameterAnnotation); + init(object, parameterized, bundle, jc); + } + + public ParameterDescription(Object object, Parameter annotation, Parameterized parameterized, + ResourceBundle bundle, JCommander jc) { + m_parameterAnnotation = annotation; + m_wrappedParameter = new WrappedParameter(m_parameterAnnotation); + init(object, parameterized, bundle, jc); + } + + /** + * Find the resource bundle in the annotations. + * @return + */ + @SuppressWarnings("deprecation") + private ResourceBundle findResourceBundle(Object o) { + ResourceBundle result = null; + + Parameters p = o.getClass().getAnnotation(Parameters.class); + if (p != null && ! isEmpty(p.resourceBundle())) { + result = ResourceBundle.getBundle(p.resourceBundle(), Locale.getDefault()); + } else { + com.beust.jcommander.ResourceBundle a = o.getClass().getAnnotation( + com.beust.jcommander.ResourceBundle.class); + if (a != null && ! isEmpty(a.value())) { + result = ResourceBundle.getBundle(a.value(), Locale.getDefault()); + } + } + + return result; + } + + private boolean isEmpty(String s) { + return s == null || "".equals(s); + } + + private void initDescription(String description, String descriptionKey, String[] names) { + m_description = description; + if (! "".equals(descriptionKey)) { + if (m_bundle != null) { + m_description = m_bundle.getString(descriptionKey); + } else { +// JCommander.getConsole().println("Warning: field " + object.getClass() + "." + field.getName() +// + " has a descriptionKey but no bundle was defined with @ResourceBundle, using " + +// "default description:'" + m_description + "'"); + } + } + + for (String name : names) { + if (name.length() > m_longestName.length()) m_longestName = name; + } + } + + @SuppressWarnings("unchecked") + private void init(Object object, Parameterized parameterized, ResourceBundle bundle, + JCommander jCommander) { + m_object = object; + m_parameterized = parameterized; + m_bundle = bundle; + if (m_bundle == null) { + m_bundle = findResourceBundle(object); + } + m_jCommander = jCommander; + + if (m_parameterAnnotation != null) { + String description; + if (Enum.class.isAssignableFrom(parameterized.getType()) + && m_parameterAnnotation.description().isEmpty()) { + description = "Options: " + EnumSet.allOf((Class<? extends Enum>) parameterized.getType()); + }else { + description = m_parameterAnnotation.description(); + } + initDescription(description, m_parameterAnnotation.descriptionKey(), + m_parameterAnnotation.names()); + } else if (m_dynamicParameterAnnotation != null) { + initDescription(m_dynamicParameterAnnotation.description(), + m_dynamicParameterAnnotation.descriptionKey(), + m_dynamicParameterAnnotation.names()); + } else { + throw new AssertionError("Shound never happen"); + } + + try { + m_default = parameterized.get(object); + } catch (Exception e) { + } + + // + // Validate default values, if any and if applicable + // + if (m_default != null) { + if (m_parameterAnnotation != null) { + validateDefaultValues(m_parameterAnnotation.names()); + } + } + } + + private void validateDefaultValues(String[] names) { + String name = names.length > 0 ? names[0] : ""; + validateValueParameter(name, m_default); + } + + public String getLongestName() { + return m_longestName; + } + + public Object getDefault() { + return m_default; + } + + public String getDescription() { + return m_description; + } + + public Object getObject() { + return m_object; + } + + public String getNames() { + StringBuilder sb = new StringBuilder(); + String[] names = m_wrappedParameter.names(); + for (int i = 0; i < names.length; i++) { + if (i > 0) sb.append(", "); + sb.append(names[i]); + } + return sb.toString(); + } + + public WrappedParameter getParameter() { + return m_wrappedParameter; + } + + public Parameterized getParameterized() { + return m_parameterized; + } + + private boolean isMultiOption() { + Class<?> fieldType = m_parameterized.getType(); + return fieldType.equals(List.class) || fieldType.equals(Set.class) + || m_parameterized.isDynamicParameter(); + } + + public void addValue(String value) { + addValue(value, false /* not default */); + } + + /** + * @return true if this parameter received a value during the parsing phase. + */ + public boolean isAssigned() { + return m_assigned; + } + + + public void setAssigned(boolean b) { + m_assigned = b; + } + + /** + * Add the specified value to the field. First, validate the value if a + * validator was specified. Then look up any field converter, then any type + * converter, and if we can't find any, throw an exception. + */ + public void addValue(String value, boolean isDefault) { + p("Adding " + (isDefault ? "default " : "") + "value:" + value + + " to parameter:" + m_parameterized.getName()); + String name = m_wrappedParameter.names()[0]; + if (m_assigned && ! isMultiOption() && !m_jCommander.isParameterOverwritingAllowed() || isNonOverwritableForced()) { + throw new ParameterException("Can only specify option " + name + " once."); + } + + validateParameter(name, value); + + Class<?> type = m_parameterized.getType(); + + Object convertedValue = m_jCommander.convertValue(this, value); + validateValueParameter(name, convertedValue); + boolean isCollection = Collection.class.isAssignableFrom(type); + + if (isCollection) { + @SuppressWarnings("unchecked") + Collection<Object> l = (Collection<Object>) m_parameterized.get(m_object); + if (l == null || fieldIsSetForTheFirstTime(isDefault)) { + l = newCollection(type); + m_parameterized.set(m_object, l); + } + if (convertedValue instanceof Collection) { + l.addAll((Collection) convertedValue); + } else { // if (isMainParameter || m_parameterAnnotation.arity() > 1) { + l.add(convertedValue); +// } else { +// l. + } + } else { + m_wrappedParameter.addValue(m_parameterized, m_object, convertedValue); + } + if (! isDefault) m_assigned = true; + } + + private void validateParameter(String name, String value) { + Class<? extends IParameterValidator> validator = m_wrappedParameter.validateWith(); + if (validator != null) { + validateParameter(this, validator, name, value); + } + } + + private void validateValueParameter(String name, Object value) { + Class<? extends IValueValidator> validator = m_wrappedParameter.validateValueWith(); + if (validator != null) { + validateValueParameter(validator, name, value); + } + } + + public static void validateValueParameter(Class<? extends IValueValidator> validator, + String name, Object value) { + try { + if (validator != NoValueValidator.class) { + p("Validating value parameter:" + name + " value:" + value + " validator:" + validator); + } + validator.newInstance().validate(name, value); + } catch (InstantiationException e) { + throw new ParameterException("Can't instantiate validator:" + e); + } catch (IllegalAccessException e) { + throw new ParameterException("Can't instantiate validator:" + e); + } + } + + public static void validateParameter(ParameterDescription pd, + Class<? extends IParameterValidator> validator, + String name, String value) { + try { + if (validator != NoValidator.class) { + p("Validating parameter:" + name + " value:" + value + " validator:" + validator); + } + validator.newInstance().validate(name, value); + if (IParameterValidator2.class.isAssignableFrom(validator)) { + IParameterValidator2 instance = (IParameterValidator2) validator.newInstance(); + instance.validate(name, value, pd); + } + } catch (InstantiationException e) { + throw new ParameterException("Can't instantiate validator:" + e); + } catch (IllegalAccessException e) { + throw new ParameterException("Can't instantiate validator:" + e); + } catch(ParameterException ex) { + throw ex; + } catch(Exception ex) { + throw new ParameterException(ex); + } + } + + /* + * Creates a new collection for the field's type. + * + * Currently only List and Set are supported. Support for + * Queues and Stacks could be useful. + */ + @SuppressWarnings("unchecked") + private Collection<Object> newCollection(Class<?> type) { + if (SortedSet.class.isAssignableFrom(type)) return new TreeSet(); + else if (LinkedHashSet.class.isAssignableFrom(type)) return new LinkedHashSet(); + else if (Set.class.isAssignableFrom(type)) return new HashSet(); + else if (List.class.isAssignableFrom(type)) return new ArrayList(); + else { + throw new ParameterException("Parameters of Collection type '" + type.getSimpleName() + + "' are not supported. Please use List or Set instead."); + } + } + + /* + * Tests if its the first time a non-default value is + * being added to the field. + */ + private boolean fieldIsSetForTheFirstTime(boolean isDefault) { + return (!isDefault && !m_assigned); + } + + private static void p(String string) { + if (System.getProperty(JCommander.DEBUG_PROPERTY) != null) { + JCommander.getConsole().println("[ParameterDescription] " + string); + } + } + + @Override + public String toString() { + return "[ParameterDescription " + m_parameterized.getName() + "]"; + } + + public boolean isDynamicParameter() { + return m_dynamicParameterAnnotation != null; + } + + public boolean isHelp() { + return m_wrappedParameter.isHelp(); + } + + public boolean isNonOverwritableForced() { + return m_wrappedParameter.isNonOverwritableForced(); + } +} diff --git a/src/main/java/com/beust/jcommander/ParameterException.java b/src/main/java/com/beust/jcommander/ParameterException.java new file mode 100644 index 0000000..2bba7d1 --- /dev/null +++ b/src/main/java/com/beust/jcommander/ParameterException.java @@ -0,0 +1,42 @@ +/** + * Copyright (C) 2010 the original author or authors. + * See the notice.md file distributed with this work for additional + * information regarding copyright ownership. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.beust.jcommander; + +/** + * The main exception that JCommand will throw when something goes wrong while + * parsing parameters. + * + * @author Cedric Beust <cedric@beust.com> + */ +@SuppressWarnings("serial") +public class ParameterException extends RuntimeException { + + public ParameterException(Throwable t) { + super(t); + } + + public ParameterException(String string) { + super(string); + } + + public ParameterException(String string, Throwable t) { + super(string, t); + } + +} diff --git a/src/main/java/com/beust/jcommander/Parameterized.java b/src/main/java/com/beust/jcommander/Parameterized.java new file mode 100644 index 0000000..ff8753b --- /dev/null +++ b/src/main/java/com/beust/jcommander/Parameterized.java @@ -0,0 +1,244 @@ +package com.beust.jcommander; + +import com.beust.jcommander.internal.Lists; + +import java.lang.annotation.Annotation; +import java.lang.reflect.Field; +import java.lang.reflect.InvocationTargetException; +import java.lang.reflect.Method; +import java.lang.reflect.ParameterizedType; +import java.lang.reflect.Type; +import java.util.List; + +/** + * Encapsulate a field or a method annotated with @Parameter or @DynamicParameter + */ +public class Parameterized { + + // Either a method or a field + private Field m_field; + private Method m_method; + private Method m_getter; + + // Either of these two + private WrappedParameter m_wrappedParameter; + private ParametersDelegate m_parametersDelegate; + + public Parameterized(WrappedParameter wp, ParametersDelegate pd, + Field field, Method method) { + m_wrappedParameter = wp; + m_method = method; + m_field = field; + if (m_field != null) { + m_field.setAccessible(true); + } + m_parametersDelegate = pd; + } + + public static List<Parameterized> parseArg(Object arg) { + List<Parameterized> result = Lists.newArrayList(); + + Class<? extends Object> cls = arg.getClass(); + while (!Object.class.equals(cls)) { + for (Field f : cls.getDeclaredFields()) { + Annotation annotation = f.getAnnotation(Parameter.class); + Annotation delegateAnnotation = f.getAnnotation(ParametersDelegate.class); + Annotation dynamicParameter = f.getAnnotation(DynamicParameter.class); + if (annotation != null) { + result.add(new Parameterized(new WrappedParameter((Parameter) annotation), null, + f, null)); + } else if (dynamicParameter != null) { + result.add(new Parameterized(new WrappedParameter((DynamicParameter) dynamicParameter), null, + f, null)); + } else if (delegateAnnotation != null) { + result.add(new Parameterized(null, (ParametersDelegate) delegateAnnotation, + f, null)); + } + } + cls = cls.getSuperclass(); + } + + // Reassigning + cls = arg.getClass(); + while (!Object.class.equals(cls)) { + for (Method m : cls.getDeclaredMethods()) { + Annotation annotation = m.getAnnotation(Parameter.class); + Annotation delegateAnnotation = m.getAnnotation(ParametersDelegate.class); + Annotation dynamicParameter = m.getAnnotation(DynamicParameter.class); + if (annotation != null) { + result.add(new Parameterized(new WrappedParameter((Parameter) annotation), null, + null, m)); + } else if (dynamicParameter != null) { + result.add(new Parameterized(new WrappedParameter((DynamicParameter) annotation), null, + null, m)); + } else if (delegateAnnotation != null) { + result.add(new Parameterized(null, (ParametersDelegate) delegateAnnotation, + null, m)); + } + } + cls = cls.getSuperclass(); + } + + return result; + } + + public WrappedParameter getWrappedParameter() { + return m_wrappedParameter; + } + + public Class<?> getType() { + if (m_method != null) { + return m_method.getParameterTypes()[0]; + } else { + return m_field.getType(); + } + } + + public String getName() { + if (m_method != null) { + return m_method.getName(); + } else { + return m_field.getName(); + } + } + + public Object get(Object object) { + try { + if (m_method != null) { + if (m_getter == null) { + m_getter = m_method.getDeclaringClass() + .getMethod("g" + m_method.getName().substring(1), + new Class[0]); + } + return m_getter.invoke(object); + } else { + return m_field.get(object); + } + } catch (SecurityException e) { + throw new ParameterException(e); + } catch (NoSuchMethodException e) { + // Try to find a field + String name = m_method.getName(); + String fieldName = Character.toLowerCase(name.charAt(3)) + name.substring(4); + Object result = null; + try { + Field field = m_method.getDeclaringClass().getDeclaredField(fieldName); + if (field != null) { + field.setAccessible(true); + result = field.get(object); + } + } catch(NoSuchFieldException ex) { + // ignore + } catch(IllegalAccessException ex) { + // ignore + } + return result; + } catch (IllegalArgumentException e) { + throw new ParameterException(e); + } catch (IllegalAccessException e) { + throw new ParameterException(e); + } catch (InvocationTargetException e) { + throw new ParameterException(e); + } + } + + @Override + public int hashCode() { + final int prime = 31; + int result = 1; + result = prime * result + ((m_field == null) ? 0 : m_field.hashCode()); + result = prime * result + ((m_method == null) ? 0 : m_method.hashCode()); + return result; + } + + @Override + public boolean equals(Object obj) { + if (this == obj) + return true; + if (obj == null) + return false; + if (getClass() != obj.getClass()) + return false; + Parameterized other = (Parameterized) obj; + if (m_field == null) { + if (other.m_field != null) + return false; + } else if (!m_field.equals(other.m_field)) + return false; + if (m_method == null) { + if (other.m_method != null) + return false; + } else if (!m_method.equals(other.m_method)) + return false; + return true; + } + + public boolean isDynamicParameter(Field field) { + if (m_method != null) { + return m_method.getAnnotation(DynamicParameter.class) != null; + } else { + return m_field.getAnnotation(DynamicParameter.class) != null; + } + } + + public void set(Object object, Object value) { + try { + if (m_method != null) { + m_method.invoke(object, value); + } else { + m_field.set(object, value); + } + } catch (IllegalArgumentException ex) { + throw new ParameterException(ex); + } catch (IllegalAccessException ex) { + throw new ParameterException(ex); + } catch (InvocationTargetException ex) { + // If a ParameterException was thrown, don't wrap it into another one + if (ex.getTargetException() instanceof ParameterException) { + throw (ParameterException) ex.getTargetException(); + } else { + throw new ParameterException(ex); + } + } + } + + public ParametersDelegate getDelegateAnnotation() { + return m_parametersDelegate; + } + + public Type getGenericType() { + if (m_method != null) { + return m_method.getGenericParameterTypes()[0]; + } else { + return m_field.getGenericType(); + } + } + + public Parameter getParameter() { + return m_wrappedParameter.getParameter(); + } + + /** + * @return the generic type of the collection for this field, or null if not applicable. + */ + public Type findFieldGenericType() { + if (m_method != null) { + return null; + } else { + if (m_field.getGenericType() instanceof ParameterizedType) { + ParameterizedType p = (ParameterizedType) m_field.getGenericType(); + Type cls = p.getActualTypeArguments()[0]; + if (cls instanceof Class) { + return cls; + } + } + } + + return null; + } + + public boolean isDynamicParameter() { + return m_wrappedParameter.getDynamicParameter() != null; + } + +} diff --git a/src/main/java/com/beust/jcommander/Parameters.java b/src/main/java/com/beust/jcommander/Parameters.java new file mode 100644 index 0000000..f2e8c76 --- /dev/null +++ b/src/main/java/com/beust/jcommander/Parameters.java @@ -0,0 +1,75 @@ +/** + * Copyright (C) 2010 the original author or authors. + * See the notice.md file distributed with this work for additional + * information regarding copyright ownership. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.beust.jcommander; + +import java.lang.annotation.Inherited; +import java.lang.annotation.Retention; +import java.lang.annotation.Target; + +import static java.lang.annotation.ElementType.TYPE; + +/** + * An annotation used to specify settings for parameter parsing. + * + * @author cbeust + */ +@Retention(java.lang.annotation.RetentionPolicy.RUNTIME) +@Target({ TYPE }) +@Inherited +public @interface Parameters { + + public static final String DEFAULT_OPTION_PREFIXES = "-"; + + /** + * The name of the resource bundle to use for this class. + */ + String resourceBundle() default ""; + + /** + * The character(s) that separate options. + */ + String separators() default " "; + + /** + * What characters an option starts with. + */ + String optionPrefixes() default DEFAULT_OPTION_PREFIXES; + + /** + * If the annotated class was added to {@link JCommander} as a command with + * {@link JCommander#addCommand}, then this string will be displayed in the + * description when @{link JCommander#usage} is invoked. + */ + String commandDescription() default ""; + + /** + * @return the key used to find the command description in the resource bundle. + */ + String commandDescriptionKey() default ""; + + /** + * An array of allowed command names. + */ + String[] commandNames() default {}; + + /** + * If true, this command won't appear in the usage(). + */ + boolean hidden() default false; +} diff --git a/src/main/java/com/beust/jcommander/ParametersDelegate.java b/src/main/java/com/beust/jcommander/ParametersDelegate.java new file mode 100644 index 0000000..5a06f8e --- /dev/null +++ b/src/main/java/com/beust/jcommander/ParametersDelegate.java @@ -0,0 +1,44 @@ +/** + * Copyright (C) 2010 the original author or authors. + * See the notice.md file distributed with this work for additional + * information regarding copyright ownership. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.beust.jcommander; + +import java.lang.annotation.Retention; +import java.lang.annotation.Target; + +import static java.lang.annotation.ElementType.FIELD; + +/** + * <p>When applied to a field all of its child fields annotated + * with {@link Parameter} will be included during arguments + * parsing.</p> + * + * <p>Mainly useful when creating complex command based CLI interfaces, + * where several commands can share a set of arguments, but using + * object inheritance is not enough, due to no-multiple-inheritance + * restriction. Using {@link ParametersDelegate} any number of + * command sets can be shared by using composition pattern.</p> + * + * <p>Delegations can be chained (nested).</p> + * + * @author rodionmoiseev + */ +@Retention(java.lang.annotation.RetentionPolicy.RUNTIME) +@Target({ FIELD }) +public @interface ParametersDelegate { +} diff --git a/src/main/java/com/beust/jcommander/ResourceBundle.java b/src/main/java/com/beust/jcommander/ResourceBundle.java new file mode 100644 index 0000000..806ade8 --- /dev/null +++ b/src/main/java/com/beust/jcommander/ResourceBundle.java @@ -0,0 +1,38 @@ +/** + * Copyright (C) 2010 the original author or authors. + * See the notice.md file distributed with this work for additional + * information regarding copyright ownership. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.beust.jcommander; + +import static java.lang.annotation.ElementType.TYPE; + +import java.lang.annotation.Retention; +import java.lang.annotation.Target; + +/** + * @deprecated use @Parameters + * + * @author Cedric Beust <cedric@beust.com> + */ +@Retention(java.lang.annotation.RetentionPolicy.RUNTIME) +@Target({ TYPE }) +public @interface ResourceBundle { + /** + * The name of the resource bundle to use for this class. + */ + String value(); +} diff --git a/src/main/java/com/beust/jcommander/StringKey.java b/src/main/java/com/beust/jcommander/StringKey.java new file mode 100644 index 0000000..09d1149 --- /dev/null +++ b/src/main/java/com/beust/jcommander/StringKey.java @@ -0,0 +1,48 @@ +package com.beust.jcommander; + +import com.beust.jcommander.FuzzyMap.IKey; + +public class StringKey implements IKey { + + private String m_name; + + public StringKey(String name) { + m_name = name; + } + + @Override + public String getName() { + return m_name; + } + + @Override + public String toString() { + return m_name; + } + + @Override + public int hashCode() { + final int prime = 31; + int result = 1; + result = prime * result + ((m_name == null) ? 0 : m_name.hashCode()); + return result; + } + + @Override + public boolean equals(Object obj) { + if (this == obj) + return true; + if (obj == null) + return false; + if (getClass() != obj.getClass()) + return false; + StringKey other = (StringKey) obj; + if (m_name == null) { + if (other.m_name != null) + return false; + } else if (!m_name.equals(other.m_name)) + return false; + return true; + } + +} diff --git a/src/main/java/com/beust/jcommander/Strings.java b/src/main/java/com/beust/jcommander/Strings.java new file mode 100644 index 0000000..591a38a --- /dev/null +++ b/src/main/java/com/beust/jcommander/Strings.java @@ -0,0 +1,7 @@ +package com.beust.jcommander; + +public class Strings { + public static boolean isStringEmpty(String s) { + return s == null || "".equals(s); + } +} diff --git a/src/main/java/com/beust/jcommander/WrappedParameter.java b/src/main/java/com/beust/jcommander/WrappedParameter.java new file mode 100644 index 0000000..f4e7d56 --- /dev/null +++ b/src/main/java/com/beust/jcommander/WrappedParameter.java @@ -0,0 +1,115 @@ +package com.beust.jcommander; + +import java.lang.reflect.InvocationTargetException; +import java.lang.reflect.Method; + +/** + * Encapsulates the operations common to @Parameter and @DynamicParameter + */ +public class WrappedParameter { + private Parameter m_parameter; + private DynamicParameter m_dynamicParameter; + + public WrappedParameter(Parameter p) { + m_parameter = p; + } + + public WrappedParameter(DynamicParameter p) { + m_dynamicParameter = p; + } + + public Parameter getParameter() { + return m_parameter; + } + + public DynamicParameter getDynamicParameter() { + return m_dynamicParameter; + } + + public int arity() { + return m_parameter != null ? m_parameter.arity() : 1; + } + + public boolean hidden() { + return m_parameter != null ? m_parameter.hidden() : m_dynamicParameter.hidden(); + } + + public boolean required() { + return m_parameter != null ? m_parameter.required() : m_dynamicParameter.required(); + } + + public boolean password() { + return m_parameter != null ? m_parameter.password() : false; + } + + public String[] names() { + return m_parameter != null ? m_parameter.names() : m_dynamicParameter.names(); + } + + public boolean variableArity() { + return m_parameter != null ? m_parameter.variableArity() : false; + } + + public Class<? extends IParameterValidator> validateWith() { + return m_parameter != null ? m_parameter.validateWith() : m_dynamicParameter.validateWith(); + } + + public Class<? extends IValueValidator> validateValueWith() { + return m_parameter != null + ? m_parameter.validateValueWith() + : m_dynamicParameter.validateValueWith(); + } + + public boolean echoInput() { + return m_parameter != null ? m_parameter.echoInput() : false; + } + + public void addValue(Parameterized parameterized, Object object, Object value) { + if (m_parameter != null) { + parameterized.set(object, value); + } else { + String a = m_dynamicParameter.assignment(); + String sv = value.toString(); + + int aInd = sv.indexOf(a); + if (aInd == -1) { + throw new ParameterException( + "Dynamic parameter expected a value of the form a" + a + "b" + + " but got:" + sv); + } + callPut(object, parameterized, sv.substring(0, aInd), sv.substring(aInd + 1)); + } + } + + private void callPut(Object object, Parameterized parameterized, String key, String value) { + try { + Method m; + m = findPut(parameterized.getType()); + m.invoke(parameterized.get(object), key, value); + } catch (SecurityException e) { + e.printStackTrace(); + } catch(IllegalAccessException e) { + e.printStackTrace(); + } catch(InvocationTargetException e) { + e.printStackTrace(); + } catch (NoSuchMethodException e) { + e.printStackTrace(); + } + } + + private Method findPut(Class<?> cls) throws SecurityException, NoSuchMethodException { + return cls.getMethod("put", Object.class, Object.class); + } + + public String getAssignment() { + return m_dynamicParameter != null ? m_dynamicParameter.assignment() : ""; + } + + public boolean isHelp() { + return m_parameter != null && m_parameter.help(); + } + + public boolean isNonOverwritableForced() { + return m_parameter != null && m_parameter.forceNonOverwritable(); + } +} diff --git a/src/main/java/com/beust/jcommander/converters/BaseConverter.java b/src/main/java/com/beust/jcommander/converters/BaseConverter.java new file mode 100644 index 0000000..4287163 --- /dev/null +++ b/src/main/java/com/beust/jcommander/converters/BaseConverter.java @@ -0,0 +1,44 @@ +/** + * Copyright (C) 2010 the original author or authors. + * See the notice.md file distributed with this work for additional + * information regarding copyright ownership. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.beust.jcommander.converters; + +import com.beust.jcommander.IStringConverter; + +/** + * Base class for converters that stores the name of the option. + * + * @author cbeust + */ +abstract public class BaseConverter<T> implements IStringConverter<T> { + + private String m_optionName; + + public BaseConverter(String optionName) { + m_optionName = optionName; + } + + public String getOptionName() { + return m_optionName; + } + + protected String getErrorString(String value, String to) { + return "\"" + getOptionName() + "\": couldn't convert \"" + value + "\" to " + to; + } + +} diff --git a/src/main/java/com/beust/jcommander/converters/BigDecimalConverter.java b/src/main/java/com/beust/jcommander/converters/BigDecimalConverter.java new file mode 100644 index 0000000..dfbba34 --- /dev/null +++ b/src/main/java/com/beust/jcommander/converters/BigDecimalConverter.java @@ -0,0 +1,43 @@ +/** + * Copyright (C) 2010 the original author or authors. + * See the notice.md file distributed with this work for additional + * information regarding copyright ownership. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.beust.jcommander.converters; + +import com.beust.jcommander.ParameterException; + +import java.math.BigDecimal; + +/** + * Converts a String to a BigDecimal. + * + * @author Angus Smithson + */ +public class BigDecimalConverter extends BaseConverter<BigDecimal> { + + public BigDecimalConverter(String optionName) { + super(optionName); + } + + public BigDecimal convert(String value) { + try { + return new BigDecimal(value); + } catch (NumberFormatException nfe) { + throw new ParameterException(getErrorString(value, "a BigDecimal")); + } + } +} diff --git a/src/main/java/com/beust/jcommander/converters/BooleanConverter.java b/src/main/java/com/beust/jcommander/converters/BooleanConverter.java new file mode 100644 index 0000000..5126d22 --- /dev/null +++ b/src/main/java/com/beust/jcommander/converters/BooleanConverter.java @@ -0,0 +1,42 @@ +/** + * Copyright (C) 2010 the original author or authors. + * See the notice.md file distributed with this work for additional + * information regarding copyright ownership. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.beust.jcommander.converters; + +import com.beust.jcommander.ParameterException; + +/** + * Converts a string to a boolean. + * + * @author cbeust + */ +public class BooleanConverter extends BaseConverter<Boolean> { + + public BooleanConverter(String optionName) { + super(optionName); + } + + public Boolean convert(String value) { + if ("false".equalsIgnoreCase(value) || "true".equalsIgnoreCase(value)) { + return Boolean.parseBoolean(value); + } else { + throw new ParameterException(getErrorString(value, "a boolean")); + } + } + +} diff --git a/src/main/java/com/beust/jcommander/converters/CommaParameterSplitter.java b/src/main/java/com/beust/jcommander/converters/CommaParameterSplitter.java new file mode 100644 index 0000000..0e3bb18 --- /dev/null +++ b/src/main/java/com/beust/jcommander/converters/CommaParameterSplitter.java @@ -0,0 +1,12 @@ +package com.beust.jcommander.converters; + +import java.util.Arrays; +import java.util.List; + +public class CommaParameterSplitter implements IParameterSplitter { + + public List<String> split(String value) { + return Arrays.asList(value.split(",")); + } + +} diff --git a/src/main/java/com/beust/jcommander/converters/DoubleConverter.java b/src/main/java/com/beust/jcommander/converters/DoubleConverter.java new file mode 100644 index 0000000..0c36c68 --- /dev/null +++ b/src/main/java/com/beust/jcommander/converters/DoubleConverter.java @@ -0,0 +1,42 @@ +/** + * Copyright (C) 2010 the original author or authors. + * See the notice.md file distributed with this work for additional + * information regarding copyright ownership. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.beust.jcommander.converters; + +import com.beust.jcommander.ParameterException; + +/** + * Convert a string to a double. + * + * @author acornejo + */ +public class DoubleConverter extends BaseConverter<Double> { + + public DoubleConverter(String optionName) { + super(optionName); + } + + public Double convert(String value) { + try { + return Double.parseDouble(value); + } catch(NumberFormatException ex) { + throw new ParameterException(getErrorString(value, "a double")); + } + } + +} diff --git a/src/main/java/com/beust/jcommander/converters/FileConverter.java b/src/main/java/com/beust/jcommander/converters/FileConverter.java new file mode 100644 index 0000000..c18b575 --- /dev/null +++ b/src/main/java/com/beust/jcommander/converters/FileConverter.java @@ -0,0 +1,36 @@ +/** + * Copyright (C) 2010 the original author or authors. + * See the notice.md file distributed with this work for additional + * information regarding copyright ownership. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.beust.jcommander.converters; + +import com.beust.jcommander.IStringConverter; + +import java.io.File; + +/** + * Convert a string into a file. + * + * @author cbeust + */ +public class FileConverter implements IStringConverter<File> { + + public File convert(String value) { + return new File(value); + } + +} diff --git a/src/main/java/com/beust/jcommander/converters/FloatConverter.java b/src/main/java/com/beust/jcommander/converters/FloatConverter.java new file mode 100644 index 0000000..2e2eff8 --- /dev/null +++ b/src/main/java/com/beust/jcommander/converters/FloatConverter.java @@ -0,0 +1,42 @@ +/** + * Copyright (C) 2010 the original author or authors. + * See the notice.md file distributed with this work for additional + * information regarding copyright ownership. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.beust.jcommander.converters; + +import com.beust.jcommander.ParameterException; + +/** + * Convert a string to a float. + * + * @author acornejo + */ +public class FloatConverter extends BaseConverter<Float> { + + public FloatConverter(String optionName) { + super(optionName); + } + + public Float convert(String value) { + try { + return Float.parseFloat(value); + } catch(NumberFormatException ex) { + throw new ParameterException(getErrorString(value, "a float")); + } + } + +} diff --git a/src/main/java/com/beust/jcommander/converters/IParameterSplitter.java b/src/main/java/com/beust/jcommander/converters/IParameterSplitter.java new file mode 100644 index 0000000..5859f4a --- /dev/null +++ b/src/main/java/com/beust/jcommander/converters/IParameterSplitter.java @@ -0,0 +1,11 @@ +package com.beust.jcommander.converters; + +import java.util.List; + +/** + * Convert a string representing several parameters (e.g. "a,b,c" or "d/e/f") into a + * list of arguments ([a,b,c] and [d,e,f]). + */ +public interface IParameterSplitter { + List<String> split(String value); +} diff --git a/src/main/java/com/beust/jcommander/converters/ISO8601DateConverter.java b/src/main/java/com/beust/jcommander/converters/ISO8601DateConverter.java new file mode 100644 index 0000000..f024f5c --- /dev/null +++ b/src/main/java/com/beust/jcommander/converters/ISO8601DateConverter.java @@ -0,0 +1,48 @@ +/** + * Copyright (C) 2010 the original author or authors. + * See the notice.md file distributed with this work for additional + * information regarding copyright ownership. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.beust.jcommander.converters; + +import com.beust.jcommander.ParameterException; + +import java.text.ParseException; +import java.text.SimpleDateFormat; +import java.util.Date; + +/** + * Converts a String to a Date. + * TODO Modify to work with all valid ISO 8601 date formats (currently only works with yyyy-MM-dd). + * + * @author Angus Smithson + */ +public class ISO8601DateConverter extends BaseConverter<Date> { + + private final static SimpleDateFormat DATE_FORMAT = new SimpleDateFormat("yyyy-MM-dd"); + + public ISO8601DateConverter(String optionName) { + super(optionName); + } + + public Date convert(String value) { + try { + return DATE_FORMAT.parse(value); + } catch (ParseException pe) { + throw new ParameterException(getErrorString(value, String.format("an ISO-8601 formatted date (%s)", DATE_FORMAT.toPattern()))); + } + } +} diff --git a/src/main/java/com/beust/jcommander/converters/IntegerConverter.java b/src/main/java/com/beust/jcommander/converters/IntegerConverter.java new file mode 100644 index 0000000..53d1119 --- /dev/null +++ b/src/main/java/com/beust/jcommander/converters/IntegerConverter.java @@ -0,0 +1,42 @@ +/** + * Copyright (C) 2010 the original author or authors. + * See the notice.md file distributed with this work for additional + * information regarding copyright ownership. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.beust.jcommander.converters; + +import com.beust.jcommander.ParameterException; + +/** + * Convert a string to an integer. + * + * @author cbeust + */ +public class IntegerConverter extends BaseConverter<Integer> { + + public IntegerConverter(String optionName) { + super(optionName); + } + + public Integer convert(String value) { + try { + return Integer.parseInt(value); + } catch(NumberFormatException ex) { + throw new ParameterException(getErrorString(value, "an integer")); + } + } + +} diff --git a/src/main/java/com/beust/jcommander/converters/LongConverter.java b/src/main/java/com/beust/jcommander/converters/LongConverter.java new file mode 100644 index 0000000..863956b --- /dev/null +++ b/src/main/java/com/beust/jcommander/converters/LongConverter.java @@ -0,0 +1,42 @@ +/** + * Copyright (C) 2010 the original author or authors. + * See the notice.md file distributed with this work for additional + * information regarding copyright ownership. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.beust.jcommander.converters; + +import com.beust.jcommander.ParameterException; + +/** + * Convert a string to a long. + * + * @author cbeust + */ +public class LongConverter extends BaseConverter<Long> { + + public LongConverter(String optionName) { + super(optionName); + } + + public Long convert(String value) { + try { + return Long.parseLong(value); + } catch(NumberFormatException ex) { + throw new ParameterException(getErrorString(value, "a long")); + } + } + +} diff --git a/src/main/java/com/beust/jcommander/converters/NoConverter.java b/src/main/java/com/beust/jcommander/converters/NoConverter.java new file mode 100644 index 0000000..618daf9 --- /dev/null +++ b/src/main/java/com/beust/jcommander/converters/NoConverter.java @@ -0,0 +1,34 @@ +/** + * Copyright (C) 2010 the original author or authors. + * See the notice.md file distributed with this work for additional + * information regarding copyright ownership. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.beust.jcommander.converters; + +import com.beust.jcommander.IStringConverter; + +/** + * Default value for a converter when none is specified. + * + * @author cbeust + */ +public class NoConverter implements IStringConverter<String> { + + public String convert(String value) { + throw new UnsupportedOperationException(); + } + +} diff --git a/src/main/java/com/beust/jcommander/converters/PathConverter.java b/src/main/java/com/beust/jcommander/converters/PathConverter.java new file mode 100644 index 0000000..b7fdafd --- /dev/null +++ b/src/main/java/com/beust/jcommander/converters/PathConverter.java @@ -0,0 +1,37 @@ +/** + * Copyright (C) 2010 the original author or authors. + * See the notice.md file distributed with this work for additional + * information regarding copyright ownership. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.beust.jcommander.converters; + +import com.beust.jcommander.IStringConverter; + +import java.nio.file.Path; +import java.nio.file.Paths; + +/** + * Convert a string into a path. + * + * @author samvv + */ +public class PathConverter implements IStringConverter<Path> { + + public Path convert(String value) { + return Paths.get(value); + } + +} diff --git a/src/main/java/com/beust/jcommander/converters/StringConverter.java b/src/main/java/com/beust/jcommander/converters/StringConverter.java new file mode 100644 index 0000000..ea1ae38 --- /dev/null +++ b/src/main/java/com/beust/jcommander/converters/StringConverter.java @@ -0,0 +1,34 @@ +/** + * Copyright (C) 2010 the original author or authors. + * See the notice.md file distributed with this work for additional + * information regarding copyright ownership. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.beust.jcommander.converters; + +import com.beust.jcommander.IStringConverter; + +/** + * Default converter for strings. + * + * @author cbeust + */ +public class StringConverter implements IStringConverter<String> { + + public String convert(String value) { + return value; + } + +} diff --git a/src/main/java/com/beust/jcommander/converters/URIConverter.java b/src/main/java/com/beust/jcommander/converters/URIConverter.java new file mode 100644 index 0000000..3473bf0 --- /dev/null +++ b/src/main/java/com/beust/jcommander/converters/URIConverter.java @@ -0,0 +1,45 @@ +/** + * Copyright (C) 2010 the original author or authors. + * See the notice.md file distributed with this work for additional + * information regarding copyright ownership. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.beust.jcommander.converters; + +import com.beust.jcommander.ParameterException; + +import java.net.URI; +import java.net.URISyntaxException; + +/** + * Convert a string into a URI. + * + * @author samvv + */ +public class URIConverter extends BaseConverter<URI> { + + public URIConverter(String optionName) { + super(optionName); + } + + public URI convert(String value) { + try { + return new URI(value); + } catch (URISyntaxException e) { + throw new ParameterException(getErrorString(value, "a RFC 2396 and RFC 2732 compliant URI")); + } + } + +} diff --git a/src/main/java/com/beust/jcommander/converters/URLConverter.java b/src/main/java/com/beust/jcommander/converters/URLConverter.java new file mode 100644 index 0000000..1f3734b --- /dev/null +++ b/src/main/java/com/beust/jcommander/converters/URLConverter.java @@ -0,0 +1,46 @@ +/** + * Copyright (C) 2010 the original author or authors. + * See the notice.md file distributed with this work for additional + * information regarding copyright ownership. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.beust.jcommander.converters; + +import com.beust.jcommander.ParameterException; + +import java.net.MalformedURLException; +import java.net.URL; + +/** + * Convert a string into a URI. + * + * @author samvv + */ +public class URLConverter extends BaseConverter<URL> { + + public URLConverter(String optionName) { + super(optionName); + } + + public URL convert(String value) { + try { + return new URL(value); + } catch (MalformedURLException e) { + throw new ParameterException( + getErrorString(value, "a RFC 2396 and RFC 2732 compliant URL")); + + } + } +}
\ No newline at end of file diff --git a/src/main/java/com/beust/jcommander/defaultprovider/PropertyFileDefaultProvider.java b/src/main/java/com/beust/jcommander/defaultprovider/PropertyFileDefaultProvider.java new file mode 100644 index 0000000..d5401a1 --- /dev/null +++ b/src/main/java/com/beust/jcommander/defaultprovider/PropertyFileDefaultProvider.java @@ -0,0 +1,70 @@ +/** + * Copyright (C) 2010 the original author or authors. + * See the notice.md file distributed with this work for additional + * information regarding copyright ownership. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.beust.jcommander.defaultprovider; + +import com.beust.jcommander.IDefaultProvider; +import com.beust.jcommander.ParameterException; + +import java.io.IOException; +import java.net.URL; +import java.util.Properties; + +/** + * A default provider that reads its default values from a property file. + * + * @author cbeust + */ +public class PropertyFileDefaultProvider implements IDefaultProvider { + public static final String DEFAULT_FILE_NAME = "jcommander.properties"; + private Properties m_properties; + + public PropertyFileDefaultProvider() { + init(DEFAULT_FILE_NAME); + } + + public PropertyFileDefaultProvider(String fileName) { + init(fileName); + } + + private void init(String fileName) { + try { + m_properties = new Properties(); + URL url = ClassLoader.getSystemResource(fileName); + if (url != null) { + m_properties.load(url.openStream()); + } else { + throw new ParameterException("Could not find property file: " + fileName + + " on the class path"); + } + } + catch (IOException e) { + throw new ParameterException("Could not open property file: " + fileName); + } + } + + public String getDefaultValueFor(String optionName) { + int index = 0; + while (index < optionName.length() && ! Character.isLetterOrDigit(optionName.charAt(index))) { + index++; + } + String key = optionName.substring(index); + return m_properties.getProperty(key); + } + +} diff --git a/src/main/java/com/beust/jcommander/internal/Console.java b/src/main/java/com/beust/jcommander/internal/Console.java new file mode 100644 index 0000000..95eafe1 --- /dev/null +++ b/src/main/java/com/beust/jcommander/internal/Console.java @@ -0,0 +1,10 @@ +package com.beust.jcommander.internal; + +public interface Console { + + void print(String msg); + + void println(String msg); + + char[] readPassword(boolean echoInput); +} diff --git a/src/main/java/com/beust/jcommander/internal/DefaultConsole.java b/src/main/java/com/beust/jcommander/internal/DefaultConsole.java new file mode 100644 index 0000000..8fd7d6d --- /dev/null +++ b/src/main/java/com/beust/jcommander/internal/DefaultConsole.java @@ -0,0 +1,32 @@ +package com.beust.jcommander.internal; + +import com.beust.jcommander.ParameterException; + +import java.io.BufferedReader; +import java.io.IOException; +import java.io.InputStreamReader; + +public class DefaultConsole implements Console { + + public void print(String msg) { + System.out.print(msg); + } + + public void println(String msg) { + System.out.println(msg); + } + + public char[] readPassword(boolean echoInput) { + try { + // Do not close the readers since System.in should not be closed + InputStreamReader isr = new InputStreamReader(System.in); + BufferedReader in = new BufferedReader(isr); + String result = in.readLine(); + return result.toCharArray(); + } + catch (IOException e) { + throw new ParameterException(e); + } + } + +} diff --git a/src/main/java/com/beust/jcommander/internal/DefaultConverterFactory.java b/src/main/java/com/beust/jcommander/internal/DefaultConverterFactory.java new file mode 100644 index 0000000..7eb5ae5 --- /dev/null +++ b/src/main/java/com/beust/jcommander/internal/DefaultConverterFactory.java @@ -0,0 +1,79 @@ +/** + * Copyright (C) 2010 the original author or authors. + * See the notice.md file distributed with this work for additional + * information regarding copyright ownership. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.beust.jcommander.internal; + +import com.beust.jcommander.IStringConverter; +import com.beust.jcommander.IStringConverterFactory; +import com.beust.jcommander.converters.BigDecimalConverter; +import com.beust.jcommander.converters.BooleanConverter; +import com.beust.jcommander.converters.DoubleConverter; +import com.beust.jcommander.converters.FileConverter; +import com.beust.jcommander.converters.FloatConverter; +import com.beust.jcommander.converters.ISO8601DateConverter; +import com.beust.jcommander.converters.IntegerConverter; +import com.beust.jcommander.converters.LongConverter; +import com.beust.jcommander.converters.StringConverter; +import com.beust.jcommander.converters.URIConverter; +import com.beust.jcommander.converters.URLConverter; + +import java.io.File; +import java.math.BigDecimal; +import java.util.Date; +import java.net.URI; +import java.net.URL; +import java.util.Map; + +public class DefaultConverterFactory implements IStringConverterFactory { + /** + * A map of converters per class. + */ + private static Map<Class, Class<? extends IStringConverter<?>>> m_classConverters; + + static { + m_classConverters = Maps.newHashMap(); + m_classConverters.put(String.class, StringConverter.class); + m_classConverters.put(Integer.class, IntegerConverter.class); + m_classConverters.put(int.class, IntegerConverter.class); + m_classConverters.put(Long.class, LongConverter.class); + m_classConverters.put(long.class, LongConverter.class); + m_classConverters.put(Float.class, FloatConverter.class); + m_classConverters.put(float.class, FloatConverter.class); + m_classConverters.put(Double.class, DoubleConverter.class); + m_classConverters.put(double.class, DoubleConverter.class); + m_classConverters.put(Boolean.class, BooleanConverter.class); + m_classConverters.put(boolean.class, BooleanConverter.class); + m_classConverters.put(File.class, FileConverter.class); + m_classConverters.put(BigDecimal.class, BigDecimalConverter.class); + m_classConverters.put(Date.class, ISO8601DateConverter.class); + try { + Class<?> pathClass = Class.forName("java.nio.file.Path"); + Class<?> pathConverterClass = Class.forName("com.beust.jcommander.converters.PathConverter"); + m_classConverters.put(pathClass, (Class<? extends IStringConverter<?>>)pathConverterClass); + } catch (ClassNotFoundException e) { + // Do nothing: Android does not have java.nio.file.Path + } + m_classConverters.put(URI.class, URIConverter.class); + m_classConverters.put(URL.class, URLConverter.class); + } + + public Class<? extends IStringConverter<?>> getConverter(Class forType) { + return m_classConverters.get(forType); + } + +} diff --git a/src/main/java/com/beust/jcommander/internal/JDK6Console.java b/src/main/java/com/beust/jcommander/internal/JDK6Console.java new file mode 100644 index 0000000..70cb186 --- /dev/null +++ b/src/main/java/com/beust/jcommander/internal/JDK6Console.java @@ -0,0 +1,45 @@ +package com.beust.jcommander.internal; + +import com.beust.jcommander.ParameterException; + +import java.io.PrintWriter; +import java.lang.reflect.Method; + +public class JDK6Console implements Console { + + private Object console; + + private PrintWriter writer; + + public JDK6Console(Object console) throws Exception { + this.console = console; + Method writerMethod = console.getClass().getDeclaredMethod("writer", new Class<?>[0]); + writer = (PrintWriter) writerMethod.invoke(console, new Object[0]); + } + + public void print(String msg) { + writer.print(msg); + } + + public void println(String msg) { + writer.println(msg); + } + + public char[] readPassword(boolean echoInput) { + try { + writer.flush(); + Method method; + if (echoInput) { + method = console.getClass().getDeclaredMethod("readLine", new Class<?>[0]); + return ((String) method.invoke(console, new Object[0])).toCharArray(); + } else { + method = console.getClass().getDeclaredMethod("readPassword", new Class<?>[0]); + return (char[]) method.invoke(console, new Object[0]); + } + } + catch (Exception e) { + throw new ParameterException(e); + } + } + +}
\ No newline at end of file diff --git a/src/main/java/com/beust/jcommander/internal/Lists.java b/src/main/java/com/beust/jcommander/internal/Lists.java new file mode 100644 index 0000000..fdbee55 --- /dev/null +++ b/src/main/java/com/beust/jcommander/internal/Lists.java @@ -0,0 +1,54 @@ +/** + * Copyright (C) 2010 the original author or authors. + * See the notice.md file distributed with this work for additional + * information regarding copyright ownership. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.beust.jcommander.internal; + +import java.util.ArrayList; +import java.util.Arrays; +import java.util.Collection; +import java.util.LinkedList; +import java.util.List; + +public class Lists { + + public static <K> List<K> newArrayList() { + return new ArrayList<K>(); + } + + public static <K> List<K> newArrayList(Collection<K> c) { + return new ArrayList<K>(c); + } + + public static <K> List<K> newArrayList(K... c) { + return new ArrayList<K>(Arrays.asList(c)); + } + + public static <K> List<K> newArrayList(int size) { + return new ArrayList<K>(size); + } + + public static <K> LinkedList<K> newLinkedList() { + return new LinkedList<K>(); + } + + public static <K> LinkedList<K> newLinkedList(Collection<K> c) { + return new LinkedList<K>(c); + } + + +} diff --git a/src/main/java/com/beust/jcommander/internal/Maps.java b/src/main/java/com/beust/jcommander/internal/Maps.java new file mode 100644 index 0000000..e272122 --- /dev/null +++ b/src/main/java/com/beust/jcommander/internal/Maps.java @@ -0,0 +1,43 @@ +/** + * Copyright (C) 2010 the original author or authors. + * See the notice.md file distributed with this work for additional + * information regarding copyright ownership. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.beust.jcommander.internal; + +import java.util.HashMap; +import java.util.LinkedHashMap; +import java.util.Map; + +public class Maps { + + public static <K, V> Map<K,V> newHashMap() { + return new HashMap<K, V>(); + } + + public static <K, V> Map<K,V> newLinkedHashMap() { + return new LinkedHashMap<K, V>(); + } + + public static <T> Map<T, T> newHashMap(T... parameters) { + Map<T, T> result = Maps.newHashMap(); + for (int i = 0; i < parameters.length; i += 2) { + result.put(parameters[i], parameters[i + 1]); + } + return result; + } + +} diff --git a/src/main/java/com/beust/jcommander/internal/Nullable.java b/src/main/java/com/beust/jcommander/internal/Nullable.java new file mode 100644 index 0000000..b988373 --- /dev/null +++ b/src/main/java/com/beust/jcommander/internal/Nullable.java @@ -0,0 +1,12 @@ +package com.beust.jcommander.internal; + +import static java.lang.annotation.ElementType.FIELD; +import static java.lang.annotation.ElementType.PARAMETER; + +import java.lang.annotation.Retention; +import java.lang.annotation.Target; + +@Retention(java.lang.annotation.RetentionPolicy.RUNTIME) +@Target({FIELD, PARAMETER}) +public @interface Nullable { +} diff --git a/src/main/java/com/beust/jcommander/internal/Sets.java b/src/main/java/com/beust/jcommander/internal/Sets.java new file mode 100644 index 0000000..77949c3 --- /dev/null +++ b/src/main/java/com/beust/jcommander/internal/Sets.java @@ -0,0 +1,35 @@ +/** + * Copyright (C) 2010 the original author or authors. + * See the notice.md file distributed with this work for additional + * information regarding copyright ownership. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.beust.jcommander.internal; + +import java.util.HashSet; +import java.util.LinkedHashSet; +import java.util.Set; + +public class Sets { + + public static <K> Set<K> newHashSet() { + return new HashSet<K>(); + } + + public static <K> Set<K> newLinkedHashSet() { + return new LinkedHashSet<K>(); + } + +} diff --git a/src/main/java/com/beust/jcommander/validators/NoValidator.java b/src/main/java/com/beust/jcommander/validators/NoValidator.java new file mode 100644 index 0000000..f1b4df2 --- /dev/null +++ b/src/main/java/com/beust/jcommander/validators/NoValidator.java @@ -0,0 +1,35 @@ +/** + * Copyright (C) 2011 the original author or authors. + * See the notice.md file distributed with this work for additional + * information regarding copyright ownership. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.beust.jcommander.validators; + +import com.beust.jcommander.IParameterValidator; +import com.beust.jcommander.ParameterException; + +/** + * This is the default value of the validateWith attribute. + * + * @author Cedric Beust <cedric@beust.com> + */ +public class NoValidator implements IParameterValidator { + + public void validate(String parameterName, String parameterValue) + throws ParameterException { + } + +} diff --git a/src/main/java/com/beust/jcommander/validators/NoValueValidator.java b/src/main/java/com/beust/jcommander/validators/NoValueValidator.java new file mode 100644 index 0000000..21fa820 --- /dev/null +++ b/src/main/java/com/beust/jcommander/validators/NoValueValidator.java @@ -0,0 +1,35 @@ +/** + * Copyright (C) 2011 the original author or authors. + * See the notice.md file distributed with this work for additional + * information regarding copyright ownership. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.beust.jcommander.validators; + +import com.beust.jcommander.IValueValidator; +import com.beust.jcommander.ParameterException; + +/** + * This is the default value of the validateValueWith attribute. + * + * @author Cedric Beust <cedric@beust.com> + */ +public class NoValueValidator<T> implements IValueValidator<T> { + + public void validate(String parameterName, T parameterValue) + throws ParameterException { + } + +} diff --git a/src/main/java/com/beust/jcommander/validators/PositiveInteger.java b/src/main/java/com/beust/jcommander/validators/PositiveInteger.java new file mode 100644 index 0000000..7b5c1b7 --- /dev/null +++ b/src/main/java/com/beust/jcommander/validators/PositiveInteger.java @@ -0,0 +1,40 @@ +/** + * Copyright (C) 2011 the original author or authors. + * See the notice.md file distributed with this work for additional + * information regarding copyright ownership. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.beust.jcommander.validators; + +import com.beust.jcommander.IParameterValidator; +import com.beust.jcommander.ParameterException; + +/** + * A validator that makes sure the value of the parameter is a positive integer. + * + * @author Cedric Beust <cedric@beust.com> + */ +public class PositiveInteger implements IParameterValidator { + + public void validate(String name, String value) + throws ParameterException { + int n = Integer.parseInt(value); + if (n < 0) { + throw new ParameterException("Parameter " + name + + " should be positive (found " + value +")"); + } + } + +} |