gov.llnl.babel
Class UserOptions.DefaultRepositoryPathSwitch

java.lang.Object
  extended by gov.llnl.babel.UserOptions.RequiredArgSwitch
      extended by gov.llnl.babel.UserOptions.DefaultRepositoryPathSwitch
All Implemented Interfaces:
CommandLineSwitch
Enclosing class:
UserOptions

public class UserOptions.DefaultRepositoryPathSwitch
extends UserOptions.RequiredArgSwitch


Constructor Summary
UserOptions.DefaultRepositoryPathSwitch()
           
 
Method Summary
 boolean isHidden()
          Return true if this command line option should be hidden when the help text is generated.
 void processCommandSwitch(java.lang.String optarg)
          This method is called when the Babel end user specifies this command line switch on the command line.
 
Methods inherited from class gov.llnl.babel.UserOptions.RequiredArgSwitch
getArgumentName, hasRequiredArgument
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

UserOptions.DefaultRepositoryPathSwitch

public UserOptions.DefaultRepositoryPathSwitch()
Method Detail

processCommandSwitch

public final void processCommandSwitch(java.lang.String optarg)
                                throws InvalidArgumentException
Description copied from interface: CommandLineSwitch
This method is called when the Babel end user specifies this command line switch on the command line.

Parameters:
optarg - this argument will be null if the command line switch doesn't take a required argument (i.e., CommandLineSwitch.hasRequiredArgument() is false) or if the command line switch takes an optional argument (i.e., CommandLineSwitch.hasOptionalArgument() is true) and an argument wasn't provided; otherwise, the argument is a non-null string including the text from the command line.
Throws:
InvalidArgumentException - this indicates that the command line argument provided is wrong somehow. For example, if the argument should be an integer and the input isn't a valid integer, throw this exception.

isHidden

public final boolean isHidden()
Description copied from interface: CommandLineSwitch
Return true if this command line option should be hidden when the help text is generated.

Specified by:
isHidden in interface CommandLineSwitch
Returns:
true means that this options requests to not be printed with the help text.