org.apache.commons.cli
Class MissingOptionException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by org.apache.commons.cli.ParseException
              extended by org.apache.commons.cli.MissingOptionException
All Implemented Interfaces:
java.io.Serializable

public class MissingOptionException
extends ParseException

Thrown when a required option has not been provided.

Version:
$Revision: 680644 $, $Date: 2008-07-29 01:13:48 -0700 (Tue, 29 Jul 2008) $
Author:
John Keyes ( john at integralsource.com )
See Also:
Serialized Form

Field Summary
private  java.util.List missingOptions
          The list of missing options
 
Constructor Summary
MissingOptionException(java.util.List missingOptions)
          Constructs a new MissingSelectedException with the specified list of missing options.
MissingOptionException(java.lang.String message)
          Construct a new MissingSelectedException with the specified detail message.
 
Method Summary
private static java.lang.String createMessage(java.util.List missingOptions)
          Build the exception message from the specified list of options.
 java.util.List getMissingOptions()
          Return the list of options (as strings) missing in the command line parsed.
 
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

missingOptions

private java.util.List missingOptions
The list of missing options

Constructor Detail

MissingOptionException

public MissingOptionException(java.lang.String message)
Construct a new MissingSelectedException with the specified detail message.

Parameters:
message - the detail message

MissingOptionException

public MissingOptionException(java.util.List missingOptions)
Constructs a new MissingSelectedException with the specified list of missing options.

Parameters:
missingOptions - the list of missing options
Since:
1.2
Method Detail

getMissingOptions

public java.util.List getMissingOptions()
Return the list of options (as strings) missing in the command line parsed.

Returns:
the missing options
Since:
1.2

createMessage

private static java.lang.String createMessage(java.util.List missingOptions)
Build the exception message from the specified list of options.

Parameters:
missingOptions -
Since:
1.2