joptsimple
Class OptionException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by java.lang.RuntimeException
              extended by joptsimple.OptionException
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
IllegalOptionClusterException, IllegalOptionSpecificationException, MultipleArgumentsForOptionException, OptionArgumentConversionException, OptionMissingRequiredArgumentException, UnrecognizedOptionException

public abstract class OptionException
extends java.lang.RuntimeException

Thrown when a problem occurs during option parsing.

Version:
$Id: OptionException.java,v 1.20 2009/04/04 01:24:27 pholser Exp $
Author:
Paul Holser
See Also:
Serialized Form

Field Summary
private  java.util.List<java.lang.String> options
           
private static long serialVersionUID
           
 
Constructor Summary
protected OptionException(java.util.Collection<java.lang.String> options)
           
protected OptionException(java.util.Collection<java.lang.String> options, java.lang.Throwable cause)
           
 
Method Summary
(package private) static OptionException illegalOptionCluster(java.lang.String option)
           
protected  java.lang.String multipleOptionMessage()
           
 java.util.Collection<java.lang.String> options()
          Gives the option being considered when the exception was created.
protected  java.lang.String singleOptionMessage()
           
protected  java.lang.String singleOptionMessage(java.lang.String option)
           
(package private) static OptionException unrecognizedOption(java.lang.String option)
           
 
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
 

Field Detail

serialVersionUID

private static final long serialVersionUID
See Also:
Constant Field Values

options

private final java.util.List<java.lang.String> options
Constructor Detail

OptionException

protected OptionException(java.util.Collection<java.lang.String> options)

OptionException

protected OptionException(java.util.Collection<java.lang.String> options,
                          java.lang.Throwable cause)
Method Detail

options

public java.util.Collection<java.lang.String> options()

Gives the option being considered when the exception was created.

Returns:
the option being considered when the exception was created

singleOptionMessage

protected final java.lang.String singleOptionMessage()

singleOptionMessage

protected final java.lang.String singleOptionMessage(java.lang.String option)

multipleOptionMessage

protected final java.lang.String multipleOptionMessage()

illegalOptionCluster

static OptionException illegalOptionCluster(java.lang.String option)

unrecognizedOption

static OptionException unrecognizedOption(java.lang.String option)