CmdLineException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.kohsuke.args4j.CmdLineException

All Implemented Interfaces:: Serializable

public class CmdLineException extends Exception

Signals an error in the user input.

Author:

Kohsuke Kawaguchi

See Also:

Constructor Summary

Constructors

Constructor

Description

CmdLineException(String message)

Deprecated.
Use CmdLineException(CmdLineParser, String)

CmdLineException(String message, Throwable cause)

Deprecated.
Use CmdLineException(CmdLineParser, String, Throwable)

CmdLineException(Throwable cause)

Deprecated.
Use CmdLineException(CmdLineParser, Throwable)

CmdLineException(CmdLineParser parser, String message)

Deprecated.
Use CmdLineException(org.kohsuke.args4j.CmdLineParser, Localizable, java.lang.String...)

CmdLineException(CmdLineParser parser, String message, Throwable cause)

CmdLineException(CmdLineParser parser, Throwable cause)

CmdLineException(CmdLineParser parser, Localizable message, String... args)
Method Summary

Modifier and Type

Method

Description

String

getLocalizedMessage()

CmdLineParser

getParser()

Obtains the CmdLineParser that triggered an exception.

Methods inherited from class Throwable
addSuppressed, fillInStackTrace, getCause, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details
- CmdLineException
  
  public CmdLineException(String message)
  
  Deprecated.
  Use CmdLineException(CmdLineParser, String)
- CmdLineException
  
  public CmdLineException(String message, Throwable cause)
  
  Deprecated.
  Use CmdLineException(CmdLineParser, String, Throwable)
- CmdLineException
  
  public CmdLineException(Throwable cause)
  
  Deprecated.
  Use CmdLineException(CmdLineParser, Throwable)
- CmdLineException
  
  public CmdLineException(CmdLineParser parser, Localizable message, String... args)
- CmdLineException
  
  public CmdLineException(CmdLineParser parser, String message)
  
  Deprecated.
  Use CmdLineException(org.kohsuke.args4j.CmdLineParser, Localizable, java.lang.String...)
- CmdLineException
  
  public CmdLineException(CmdLineParser parser, String message, Throwable cause)
- CmdLineException
  
  public CmdLineException(CmdLineParser parser, Throwable cause)
Method Details
- getLocalizedMessage
  
  public String getLocalizedMessage()
  
  Overrides:
  
  getLocalizedMessage in class Throwable
- getParser
  
  public CmdLineParser getParser()
  
  Obtains the CmdLineParser that triggered an exception.
  Unless you have legacy OptionHandler that doesn't pass in this information when it throws an exception, this method should always return a non-null value.