|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.ode.utils.cli.XorGroup
public class XorGroup
Field Summary |
---|
Fields inherited from interface org.apache.ode.utils.cli.CommandlineFragment |
---|
COMMAND_PREFIX |
Constructor Summary | |
---|---|
XorGroup(java.lang.String description,
boolean optional)
|
Method Summary | |
---|---|
void |
addFragment(CommandlineFragment frag)
|
java.util.List<java.lang.String> |
consume(java.util.List<java.lang.String> s)
Grab the pieces of the commandline relevant to this argument, configure the implementation, and then return a new array of arguments that will have the pieces of the original commandline that this command used removed. |
boolean |
didMatch()
|
java.lang.String |
getDescription()
Return a description of this commandline fragment. |
CommandlineFragment |
getMatched()
|
java.lang.String |
getUsage()
Construct a usage string for this commandline fragment. |
boolean |
isOptional()
|
void |
reset()
Reset the fragment to its initial state. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public XorGroup(java.lang.String description, boolean optional)
Method Detail |
---|
public void reset()
CommandlineFragment
Reset the fragment to its initial state. This is useful for reusing fragments in multiple commandline structures.
reset
in interface CommandlineFragment
public void addFragment(CommandlineFragment frag)
public boolean didMatch()
public CommandlineFragment getMatched()
public java.util.List<java.lang.String> consume(java.util.List<java.lang.String> s) throws CommandlineSyntaxException
CommandlineFragment
Grab the pieces of the commandline relevant to this argument, configure the implementation, and then return a new array of arguments that will have the pieces of the original commandline that this command used removed.
consume
in interface CommandlineFragment
s
- the list of arguments
CommandlineSyntaxException
- if the commandline is structurally invalid.public java.lang.String getUsage()
CommandlineFragment
Construct a usage string for this commandline fragment. The usage string is used when constructing a strawman commandline example and when formatting help.
getUsage
in interface CommandlineFragment
public java.lang.String getDescription()
CommandlineFragment
Return a description of this commandline fragment. The description should be a (short) narrative item that describes the purpose of the fragment. It is only used when formatting help.
getDescription
in interface CommandlineFragment
public boolean isOptional()
isOptional
in interface CommandlineFragment
true
if this fragment is optional.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |