org.kohsuke.args4j
Class IllegalOptionParameterException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by org.kohsuke.args4j.CmdLineException
              extended by org.kohsuke.args4j.IllegalOptionParameterException
All Implemented Interfaces:
Serializable

public class IllegalOptionParameterException
extends CmdLineException

Signals an error in a parameter of an option.

The Throwable.getMessage() method returns a human-readable localized description of the error message.

Author:
Kohsuke Kawaguchi (kk@kohsuke.org)
See Also:
Serialized Form

Constructor Summary
IllegalOptionParameterException(String optionName, String value)
           
 
Method Summary
 String getOptionName()
          Returns the name of the option that caused a problem.
 String getValue()
          Returns the parameter of the option that caused a problem.
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

IllegalOptionParameterException

public IllegalOptionParameterException(String optionName,
                                       String value)
Parameters:
optionName - The name of the option whose parameter has a problem.
value - The token that is causing the problem.
Method Detail

getOptionName

public String getOptionName()
Returns the name of the option that caused a problem.

Returns:
For example, if the command line is "-n abc" where the "-n" option expects a number, then this method returns "-n".

getValue

public String getValue()
Returns the parameter of the option that caused a problem.

Returns:
For example, if the command line is "-n abc" where the "-n" option expects a number, then this method returns "abc".


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