You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by ro...@apache.org on 2003/10/29 18:32:13 UTC
cvs commit: jakarta-commons-sandbox/cli/src/java/org/apache/commons/cli2 ArgumentBuilder.java DefaultOption.java Option.java SwitchBuilder.java GroupImpl.java CommandBuilder.java PropertyOption.java Switch.java ArgumentImpl.java DefaultOptionBuilder.java OptionImpl.java ParentImpl.java Command.java
roxspring 2003/10/29 09:32:13
Modified: cli/src/test/org/apache/commons/cli2 SwitchTest.java
ParentTest.java CommandTest.java GroupTest.java
DefaultOptionTest.java ArgumentTest.java
cli/src/java/org/apache/commons/cli2 ArgumentBuilder.java
DefaultOption.java Option.java SwitchBuilder.java
GroupImpl.java CommandBuilder.java
PropertyOption.java Switch.java ArgumentImpl.java
DefaultOptionBuilder.java OptionImpl.java
ParentImpl.java Command.java
Log:
Added getId() method to Option and implementing classes with necessary changes to the builder and test classes.
This allows users to use a switch statement across each of the Options present to identify which options are present.
No effort is made to prevent clashes of id, this is the users responsiblity.
Revision Changes Path
1.3 +5 -4 jakarta-commons-sandbox/cli/src/test/org/apache/commons/cli2/SwitchTest.java
Index: SwitchTest.java
===================================================================
RCS file: /home/cvs/jakarta-commons-sandbox/cli/src/test/org/apache/commons/cli2/SwitchTest.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- SwitchTest.java 22 Oct 2003 16:32:14 -0000 1.2
+++ SwitchTest.java 29 Oct 2003 17:32:12 -0000 1.3
@@ -85,7 +85,8 @@
"Sets whether to display to screen",
true,
null,
- null);
+ null,
+ 'd');
}
/* (non-Javadoc)
1.3 +13 -5 jakarta-commons-sandbox/cli/src/test/org/apache/commons/cli2/ParentTest.java
Index: ParentTest.java
===================================================================
RCS file: /home/cvs/jakarta-commons-sandbox/cli/src/test/org/apache/commons/cli2/ParentTest.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- ParentTest.java 22 Oct 2003 16:32:14 -0000 1.2
+++ ParentTest.java 29 Oct 2003 17:32:12 -0000 1.3
@@ -83,7 +83,8 @@
null,
false,
argument,
- null);
+ null,
+ 'l');
}
public static Parent buildKParent() {
@@ -98,7 +99,8 @@
null,
false,
null,
- children);
+ children,
+ 'k');
}
public static final Argument COMPLEX_ARGUMENT =
@@ -442,4 +444,10 @@
assertFalse(i.hasNext());
}
+
+ public void testGetId(){
+ assertEquals('h', DefaultOptionTest.buildHelpOption().getId());
+ assertEquals('X', DefaultOptionTest.buildXOption().getId());
+ assertEquals(0, CommandTest.buildStartCommand().getId());
+ }
}
1.3 +9 -6 jakarta-commons-sandbox/cli/src/test/org/apache/commons/cli2/CommandTest.java
Index: CommandTest.java
===================================================================
RCS file: /home/cvs/jakarta-commons-sandbox/cli/src/test/org/apache/commons/cli2/CommandTest.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- CommandTest.java 22 Oct 2003 16:32:14 -0000 1.2
+++ CommandTest.java 29 Oct 2003 17:32:12 -0000 1.3
@@ -81,7 +81,8 @@
Collections.singleton("go"),
false,
null,
- null);
+ null,
+ 0);
}
public static Command buildCommitCommand() {
@@ -91,7 +92,8 @@
null,
true,
null,
- null);
+ null,
+ 0);
}
public static Command buildLoginCommand() {
@@ -101,7 +103,8 @@
null,
false,
ArgumentTest.buildUsernameArgument(),
- null);
+ null,
+ 0);
}
/* (non-Javadoc)
1.4 +9 -7 jakarta-commons-sandbox/cli/src/test/org/apache/commons/cli2/GroupTest.java
Index: GroupTest.java
===================================================================
RCS file: /home/cvs/jakarta-commons-sandbox/cli/src/test/org/apache/commons/cli2/GroupTest.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- GroupTest.java 24 Oct 2003 18:49:48 -0000 1.3
+++ GroupTest.java 29 Oct 2003 17:32:12 -0000 1.4
@@ -77,9 +77,9 @@
public class GroupTest extends GroupTestCase {
public static final Command COMMAND_START =
- new Command("start", "Starts the server", null, false, null, null);
+ new Command("start", "Starts the server", null, false, null, null, 0);
public static final Command COMMAND_STOP =
- new Command("stop", "Stops the server", null, false, null, null);
+ new Command("stop", "Stops the server", null, false, null, null, 0);
public static final Command COMMAND_RESTART =
new Command(
"restart",
@@ -87,7 +87,8 @@
null,
false,
null,
- null);
+ null,
+ 0);
public static final Command COMMAND_GRACEFUL =
new Command(
"graceful",
@@ -95,7 +96,8 @@
null,
false,
null,
- null);
+ null,
+ 0);
public static Group buildApacheCommandGroup() {
final Collection options = new ArrayList();
1.3 +7 -6 jakarta-commons-sandbox/cli/src/test/org/apache/commons/cli2/DefaultOptionTest.java
Index: DefaultOptionTest.java
===================================================================
RCS file: /home/cvs/jakarta-commons-sandbox/cli/src/test/org/apache/commons/cli2/DefaultOptionTest.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- DefaultOptionTest.java 22 Oct 2003 16:32:14 -0000 1.2
+++ DefaultOptionTest.java 29 Oct 2003 17:32:12 -0000 1.3
@@ -85,7 +85,8 @@
aliases,
false,
null,
- null);
+ null,
+ 'h');
}
public static DefaultOption buildXOption() {
@@ -99,7 +100,8 @@
null,
true,
null,
- null);
+ null,
+ 'X');
}
/* (non-Javadoc)
@@ -243,5 +245,4 @@
// TODO Auto-generated method stub
}
-
}
1.6 +18 -11 jakarta-commons-sandbox/cli/src/test/org/apache/commons/cli2/ArgumentTest.java
Index: ArgumentTest.java
===================================================================
RCS file: /home/cvs/jakarta-commons-sandbox/cli/src/test/org/apache/commons/cli2/ArgumentTest.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- ArgumentTest.java 29 Oct 2003 08:34:56 -0000 1.5
+++ ArgumentTest.java 29 Oct 2003 17:32:12 -0000 1.6
@@ -87,11 +87,12 @@
'\0',
null,
ArgumentImpl.DEFAULT_CONSUME_REMAINING,
- null);
+ null,
+ 0);
}
public static Argument buildHostArgument() {
- return new ArgumentImpl("host", "The host name", 2, 3, '\0', ',', null, null, null);
+ return new ArgumentImpl("host", "The host name", 2, 3, '\0', ',', null, null, null, 0);
}
public static Argument buildPathArgument() {
@@ -104,7 +105,8 @@
';',
null,
ArgumentImpl.DEFAULT_CONSUME_REMAINING,
- null);
+ null,
+ 0);
}
public static Argument buildDateLimitArgument() {
@@ -117,7 +119,8 @@
'\0',
new DateValidator(DateValidatorTest.YYYY_MM_YY),
null,
- null);
+ null,
+ 0);
}
public static Argument buildTargetsArgument() {
@@ -130,7 +133,8 @@
',',
null,
null,
- null);
+ null,
+ 0);
}
public void testNew(){
@@ -145,7 +149,8 @@
'\0',
new DateValidator(DateValidatorTest.YYYY_MM_YY),
null,
- null);
+ null,
+ 0);
}
catch(IllegalArgumentException e){
assertEquals("minimum must not exceed maximum",e.getMessage());
@@ -165,7 +170,8 @@
'\0',
null,
ArgumentImpl.DEFAULT_CONSUME_REMAINING,
- defaults);
+ defaults,
+ 0);
}
public static Argument buildBoundsArgument() {
@@ -182,7 +188,8 @@
'\0',
null,
ArgumentImpl.DEFAULT_CONSUME_REMAINING,
- defaults);
+ defaults,
+ 0);
}
/* (non-Javadoc)
1.8 +23 -4 jakarta-commons-sandbox/cli/src/java/org/apache/commons/cli2/ArgumentBuilder.java
Index: ArgumentBuilder.java
===================================================================
RCS file: /home/cvs/jakarta-commons-sandbox/cli/src/java/org/apache/commons/cli2/ArgumentBuilder.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- ArgumentBuilder.java 29 Oct 2003 01:28:17 -0000 1.7
+++ ArgumentBuilder.java 29 Oct 2003 17:32:12 -0000 1.8
@@ -97,6 +97,9 @@
/** default values for argument */
private List defaultValues;
+
+ /** id of the argument */
+ private int id;
/**
* Creates a new ArgumentBuilder instance
@@ -124,7 +127,8 @@
subsequentSeparator,
validator,
consumeRemaining,
- defaultValues);
+ defaultValues,
+ id);
reset();
@@ -146,6 +150,7 @@
subsequentSeparator = ArgumentImpl.DEFAULT_SUBSEQUENT_SEPARATOR;
consumeRemaining = "--";
defaultValues = null;
+ id = 0;
}
/**
@@ -283,6 +288,20 @@
public final ArgumentBuilder withDefaults(final List defaultValues)
{
this.defaultValues = defaultValues;
+ return this;
+ }
+
+ /**
+ * Sets the id
+ *
+ * @param id
+ * the id of the Argument
+ * @return
+ * this ArgumentBuilder
+ */
+ public final ArgumentBuilder withId(final int id)
+ {
+ this.id = id;
return this;
}
}
1.4 +6 -5 jakarta-commons-sandbox/cli/src/java/org/apache/commons/cli2/DefaultOption.java
Index: DefaultOption.java
===================================================================
RCS file: /home/cvs/jakarta-commons-sandbox/cli/src/java/org/apache/commons/cli2/DefaultOption.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- DefaultOption.java 22 Oct 2003 23:48:32 -0000 1.3
+++ DefaultOption.java 29 Oct 2003 17:32:12 -0000 1.4
@@ -97,8 +97,9 @@
final Set burstAliases,
final boolean required,
final Argument argument,
- final Group children) {
- super(argument, children, description);
+ final Group children,
+ final int id) {
+ super(argument, children, description, id);
this.longPrefix = longPrefix;
this.shortPrefix = shortPrefix;
1.3 +5 -3 jakarta-commons-sandbox/cli/src/java/org/apache/commons/cli2/Option.java
Index: Option.java
===================================================================
RCS file: /home/cvs/jakarta-commons-sandbox/cli/src/java/org/apache/commons/cli2/Option.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- Option.java 24 Oct 2003 18:49:48 -0000 1.2
+++ Option.java 29 Oct 2003 17:32:12 -0000 1.3
@@ -168,4 +168,6 @@
* @return a description of the option.
*/
public String getDescription();
+
+ public int getId();
}
1.3 +21 -4 jakarta-commons-sandbox/cli/src/java/org/apache/commons/cli2/SwitchBuilder.java
Index: SwitchBuilder.java
===================================================================
RCS file: /home/cvs/jakarta-commons-sandbox/cli/src/java/org/apache/commons/cli2/SwitchBuilder.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- SwitchBuilder.java 21 Oct 2003 19:28:14 -0000 1.2
+++ SwitchBuilder.java 29 Oct 2003 17:32:12 -0000 1.3
@@ -74,6 +74,7 @@
private boolean required;
private Argument argument;
private Group children;
+ private int id;
public SwitchBuilder() {
this(Switch.DEFAULT_ENABLED_PREFIX, Switch.DEFAULT_DISABLED_PREFIX);
@@ -106,7 +107,8 @@
description,
required,
argument,
- children);
+ children,
+ id);
reset();
@@ -120,6 +122,7 @@
aliases = new HashSet();
argument = null;
children = null;
+ id = 0;
}
public SwitchBuilder withDescription(final String description) {
@@ -151,4 +154,18 @@
this.children = children;
return this;
}
+
+ /**
+ * Sets the id
+ *
+ * @param id
+ * the id of the Switch
+ * @return
+ * this SwitchBuilder
+ */
+ public final SwitchBuilder withId(final int id)
+ {
+ this.id = id;
+ return this;
+ }
}
1.5 +4 -3 jakarta-commons-sandbox/cli/src/java/org/apache/commons/cli2/GroupImpl.java
Index: GroupImpl.java
===================================================================
RCS file: /home/cvs/jakarta-commons-sandbox/cli/src/java/org/apache/commons/cli2/GroupImpl.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- GroupImpl.java 25 Oct 2003 15:02:05 -0000 1.4
+++ GroupImpl.java 29 Oct 2003 17:32:12 -0000 1.5
@@ -90,6 +90,7 @@
final String description,
final int minimum,
final int maximum) {
+ super(0);
this.name = name;
this.description = description;
this.minimum = minimum;
1.2 +21 -4 jakarta-commons-sandbox/cli/src/java/org/apache/commons/cli2/CommandBuilder.java
Index: CommandBuilder.java
===================================================================
RCS file: /home/cvs/jakarta-commons-sandbox/cli/src/java/org/apache/commons/cli2/CommandBuilder.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- CommandBuilder.java 18 Oct 2003 22:00:05 -0000 1.1
+++ CommandBuilder.java 29 Oct 2003 17:32:12 -0000 1.2
@@ -75,6 +75,7 @@
private boolean required;
private Argument argument;
private Group children;
+ private int id;
public CommandBuilder() {
reset();
@@ -99,7 +100,8 @@
aliases,
required,
argument,
- children);
+ children,
+ id);
// reset the builder
reset();
@@ -118,6 +120,7 @@
required = false;
argument = null;
children = null;
+ id = 0;
}
/**
@@ -179,4 +182,18 @@
this.argument = argument;
return this;
}
+
+ /**
+ * Sets the id
+ *
+ * @param id
+ * the id of the Command
+ * @return
+ * this CommandBuilder
+ */
+ public final CommandBuilder withId(final int id)
+ {
+ this.id = id;
+ return this;
+ }
}
1.4 +7 -5 jakarta-commons-sandbox/cli/src/java/org/apache/commons/cli2/PropertyOption.java
Index: PropertyOption.java
===================================================================
RCS file: /home/cvs/jakarta-commons-sandbox/cli/src/java/org/apache/commons/cli2/PropertyOption.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- PropertyOption.java 24 Oct 2003 18:49:48 -0000 1.3
+++ PropertyOption.java 29 Oct 2003 17:32:12 -0000 1.4
@@ -82,12 +82,14 @@
private final String description;
public PropertyOption() {
- this(DEFAULT_OPTION_STRING, DEFAULT_DESCRIPTION);
+ this(DEFAULT_OPTION_STRING, DEFAULT_DESCRIPTION, 'D');
}
public PropertyOption(
final String optionString,
- final String description) {
+ final String description,
+ final int id) {
+ super(id);
this.optionString = optionString;
this.description = description;
}
1.3 +6 -5 jakarta-commons-sandbox/cli/src/java/org/apache/commons/cli2/Switch.java
Index: Switch.java
===================================================================
RCS file: /home/cvs/jakarta-commons-sandbox/cli/src/java/org/apache/commons/cli2/Switch.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- Switch.java 21 Oct 2003 19:28:14 -0000 1.2
+++ Switch.java 29 Oct 2003 17:32:12 -0000 1.3
@@ -89,8 +89,9 @@
final String description,
final boolean required,
final Argument argument,
- final Group children) {
- super(argument, children, description);
+ final Group children,
+ final int id) {
+ super(argument, children, description, id);
if (enabledPrefix == null) {
throw new IllegalArgumentException("enabledPrefix must be supplied");
1.9 +8 -5 jakarta-commons-sandbox/cli/src/java/org/apache/commons/cli2/ArgumentImpl.java
Index: ArgumentImpl.java
===================================================================
RCS file: /home/cvs/jakarta-commons-sandbox/cli/src/java/org/apache/commons/cli2/ArgumentImpl.java,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- ArgumentImpl.java 29 Oct 2003 01:28:17 -0000 1.8
+++ ArgumentImpl.java 29 Oct 2003 17:32:12 -0000 1.9
@@ -103,6 +103,8 @@
* @param initialSeparator The char separating option from value
* @param subsequentSeparator The char separating values from each other
* @param consumeRemaining The String used for the "consuming option" group
+ * @param defaultValues The values to be used if none are specified.
+ * @param id The id of the option, 0 implies automatic assignment.
*/
public ArgumentImpl(
final String name,
@@ -113,8 +115,10 @@
final char subsequentSeparator,
final Validator validator,
final String consumeRemaining,
- final List defaultValues)
+ final List defaultValues,
+ final int id)
{
+ super(id);
if (name == null)
{
@@ -453,5 +457,4 @@
{
return minimum;
}
-
}
1.3 +22 -5 jakarta-commons-sandbox/cli/src/java/org/apache/commons/cli2/DefaultOptionBuilder.java
Index: DefaultOptionBuilder.java
===================================================================
RCS file: /home/cvs/jakarta-commons-sandbox/cli/src/java/org/apache/commons/cli2/DefaultOptionBuilder.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- DefaultOptionBuilder.java 21 Oct 2003 19:28:14 -0000 1.2
+++ DefaultOptionBuilder.java 29 Oct 2003 17:32:12 -0000 1.3
@@ -77,6 +77,7 @@
private String description;
private Argument argument;
private Group children;
+ private int id;
public DefaultOptionBuilder() {
this(DefaultOption.DEFAULT_SHORT_PREFIX, DefaultOption.DEFAULT_LONG_PREFIX, DefaultOption.DEFAULT_BURST_ENABLED);
@@ -118,7 +119,8 @@
burstAliases,
required,
argument,
- children);
+ children,
+ id);
reset();
@@ -133,6 +135,7 @@
required = false;
argument = null;
children = null;
+ id = 0;
}
public DefaultOptionBuilder withShortName(final String shortName) {
@@ -147,7 +150,7 @@
if (burstEnabled && name.length() == shortPrefix.length() + 1) {
burstAliases.add(name);
}
-
+
return this;
}
@@ -180,4 +183,18 @@
this.argument = argument;
return this;
}
+
+ /**
+ * Sets the id
+ *
+ * @param id
+ * the id of the DefaultOption
+ * @return
+ * this DefaultOptionBuilder
+ */
+ public final DefaultOptionBuilder withId(final int id)
+ {
+ this.id = id;
+ return this;
+ }
}
1.2 +16 -3 jakarta-commons-sandbox/cli/src/java/org/apache/commons/cli2/OptionImpl.java
Index: OptionImpl.java
===================================================================
RCS file: /home/cvs/jakarta-commons-sandbox/cli/src/java/org/apache/commons/cli2/OptionImpl.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- OptionImpl.java 24 Oct 2003 18:49:48 -0000 1.1
+++ OptionImpl.java 29 Oct 2003 17:32:12 -0000 1.2
@@ -69,6 +69,12 @@
* Window - Preferences - Java - Code Generation - Code and Comments
*/
public abstract class OptionImpl implements Option {
+
+ private final int id;
+
+ public OptionImpl(final int id){
+ this.id = id;
+ }
/* (non-Javadoc)
* @see org.apache.commons.cli2.Option#canProcess(java.util.ListIterator)
@@ -88,5 +94,12 @@
final StringBuffer buffer = new StringBuffer();
appendUsage(buffer, HelpSetting.ALL, null);
return buffer.toString();
+ }
+
+ /**
+ * @return Returns the id.
+ */
+ public int getId() {
+ return id;
}
}
1.4 +8 -6 jakarta-commons-sandbox/cli/src/java/org/apache/commons/cli2/ParentImpl.java
Index: ParentImpl.java
===================================================================
RCS file: /home/cvs/jakarta-commons-sandbox/cli/src/java/org/apache/commons/cli2/ParentImpl.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- ParentImpl.java 24 Oct 2003 18:49:48 -0000 1.3
+++ ParentImpl.java 29 Oct 2003 17:32:12 -0000 1.4
@@ -77,14 +77,17 @@
private final Argument argument;
private final String description;
-
+
protected ParentImpl(
final Argument argument,
final Group children,
- final String description) {
+ final String description,
+ final int id) {
+ super(id);
this.children = children;
this.argument = argument;
this.description = description;
+
}
/* (non-Javadoc)
@@ -221,5 +224,4 @@
{
return children;
}
-
}
1.2 +6 -5 jakarta-commons-sandbox/cli/src/java/org/apache/commons/cli2/Command.java
Index: Command.java
===================================================================
RCS file: /home/cvs/jakarta-commons-sandbox/cli/src/java/org/apache/commons/cli2/Command.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- Command.java 18 Oct 2003 22:00:05 -0000 1.1
+++ Command.java 29 Oct 2003 17:32:12 -0000 1.2
@@ -104,9 +104,10 @@
final Set aliases,
final boolean required,
final Argument argument,
- final Group children) {
+ final Group children,
+ final int id) {
- super(argument, children, description);
+ super(argument, children, description, id);
// check the preferred name is valid
if (preferredName == null || preferredName.length() < 1) {
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org