001package com.pingidenitty.arno.args;
002
003import com.unboundid.util.args.ArgumentException;
004import com.unboundid.util.args.StringArgument;
005
006import java.util.List;
007
008/*
009 * A collection of helper methods to make it simpler to deal with declaring arguments
010 */
011public final class StringArg {
012    private StringArg() {
013    }
014
015    /*
016     * The most generic StringArgument wrapper
017     */
018    public static final StringArgument get(final String name,
019                                           final Boolean required, final int max, final String description,
020                                           final String defaultValue) throws ArgumentException {
021        return new StringArgument(null, name, required, max,
022                ArgumentConstraints.getPlaceHolder(name), ArgumentConstraints.getDescription(
023                description, defaultValue), defaultValue);
024    }
025
026    public static final StringArgument get(final String name,
027                                           final Boolean required, final int max, final String description,
028                                           final List<String> defaultValues) throws ArgumentException {
029        return new StringArgument(null, name, required, max,
030                ArgumentConstraints.getPlaceHolder(name), ArgumentConstraints.getDescription(
031                description, defaultValues), defaultValues);
032    }
033
034    /*
035     *
036     * Unbounded wrapper for Required and Optional StringArgument
037     */
038    public static final StringArgument getRequired(final String name,
039                                                   final int max, final String description) throws ArgumentException {
040        return get(name, ArgumentConstraints.REQUIRED, max, description, (String) null);
041    }
042
043    public static final StringArgument getOptionalWithDefault(final String name,
044                                                              final int max, final String description, final String defaultValue)
045            throws ArgumentException {
046        return get(name, ArgumentConstraints.OPTIONAL, max, description, defaultValue);
047    }
048
049    public static final StringArgument getOptional(final String name,
050                                                   final int max, final String description) throws ArgumentException {
051        return getOptionalWithDefault(name, max, description, null);
052    }
053
054    /*
055     * Dealing with the Single String argument in this section
056     */
057    public static final StringArgument getSingleWithDefault(final String name,
058                                                            final Boolean required, final String description,
059                                                            final String defaultValue) throws ArgumentException {
060        return get(name, required, ArgumentConstraints.UNIQUE, description, defaultValue);
061    }
062
063    public static final StringArgument getSingle(final String name,
064                                                 final Boolean required, final String description)
065            throws ArgumentException {
066        return getSingleWithDefault(name, required, description, null);
067    }
068
069    public static final StringArgument getRequiredSingle(final String name,
070                                                         final String description) throws ArgumentException {
071        return getSingle(name, ArgumentConstraints.REQUIRED, description);
072    }
073
074    public static final StringArgument getOptionalSingleWithDefault(
075            final String name, final String description, final String defaultValue)
076            throws ArgumentException {
077        return getSingleWithDefault(name, ArgumentConstraints.OPTIONAL, description,
078                defaultValue);
079    }
080
081    public static final StringArgument getOptionalSingle(final String name,
082                                                         final String description) throws ArgumentException {
083        return getOptionalSingleWithDefault(name, description, null);
084    }
085
086    /*
087     * Dealing with the unlimited arguments in this section
088     */
089    public static final StringArgument getUnboundedWithDefault(final String name,
090                                                               final Boolean required, final String description,
091                                                               final String defaultValue) throws ArgumentException {
092        return get(name, required, ArgumentConstraints.UNBOUNDED, description, defaultValue);
093    }
094
095    public static final StringArgument getUnbounded(final String name,
096                                                    final Boolean required, final String description,
097                                                    final String defaultValue) throws ArgumentException {
098        return getUnboundedWithDefault(name, required, description, null);
099    }
100
101    public static final StringArgument getRequiredUnbounded(final String name,
102                                                            final String description) throws ArgumentException {
103        return getUnboundedWithDefault(name, ArgumentConstraints.REQUIRED, description,
104                null);
105    }
106
107    public static final StringArgument getOptionalUnboundedWithDefault(
108            final String name, final String description, final String defaultValue)
109            throws ArgumentException {
110        return getUnboundedWithDefault(name, ArgumentConstraints.OPTIONAL, description,
111                defaultValue);
112    }
113
114    public static final StringArgument getOptionalUnbounded(final String name,
115                                                            final String description) throws ArgumentException {
116        return getOptionalUnboundedWithDefault(name, description, null);
117    }
118
119}