org.kohsuke.args4j.opts
Class AliasOption

java.lang.Object
  extended by org.kohsuke.args4j.opts.AliasOption
All Implemented Interfaces:
CmdLineOption

public class AliasOption
extends java.lang.Object
implements CmdLineOption

Option which is simply an alias to a set of other options.

For example, you could define "-quiet" as "-verbose 0".

Author:
Kohsuke Kawaguchi (kk@kohsuke.org)

Nested Class Summary
 
Nested classes/interfaces inherited from interface org.kohsuke.args4j.CmdLineOption
CmdLineOption.Parameters
 
Constructor Summary
AliasOption(java.lang.String optionName, java.lang.String[] realOptions)
           
 
Method Summary
 boolean accepts(java.lang.String optionName)
          Checks if this option parser recognizes the specified option name.
 int parseArguments(CmdLineParser parser, CmdLineOption.Parameters params)
          Called if the option that this parser recognizes is found.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AliasOption

public AliasOption(java.lang.String optionName,
                   java.lang.String[] realOptions)
Method Detail

accepts

public boolean accepts(java.lang.String optionName)
Description copied from interface: CmdLineOption
Checks if this option parser recognizes the specified option name.

Specified by:
accepts in interface CmdLineOption

parseArguments

public int parseArguments(CmdLineParser parser,
                          CmdLineOption.Parameters params)
                   throws CmdLineException
Description copied from interface: CmdLineOption
Called if the option that this parser recognizes is found.

Specified by:
parseArguments in interface CmdLineOption
Parameters:
parser - The parser that's using this option object. For example, if the option "-quiet" is simply an alias to "-verbose 5", then the implementation can just call the CmdLineParser.parse(String[]) method recursively.
params - The rest of the arguments. This method can use this object to access the arguments of the option if necessary.
Returns:
The number of arguments consumed. For example, return 0 if this option doesn't take any parameter.
Throws:
CmdLineException


Copyright © 2003-2011 Kohsuke Kawaguchi. All Rights Reserved.