MissingOptionException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.apache.commons.cli.ParseException

org.apache.commons.cli.MissingOptionException

All Implemented Interfaces:: Serializable

public class MissingOptionException extends ParseException

Thrown when a required option has not been provided.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type

Field

Description

private List

missingOptions

The list of missing options and groups

private static final long

serialVersionUID

This exception serialVersionUID.
Constructor Summary

Constructors

Constructor

Description

MissingOptionException(String message)

Construct a new MissingSelectedException with the specified detail message.

MissingOptionException(List missingOptions)

Constructs a new MissingSelectedException with the specified list of missing options.
Method Summary

Modifier and Type

Method

Description

private static String

createMessage(List<?> missingOptions)

Build the exception message from the specified list of options.

List

getMissingOptions()

Gets the list of options or option groups missing in the command line parsed.

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

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

Field Details
- serialVersionUID
  
  private static final long serialVersionUID
  
  This exception serialVersionUID.
  See Also:
  
  Constant Field Values
- missingOptions
  
  private List missingOptions
  
  The list of missing options and groups
Constructor Details
- MissingOptionException
  
  public MissingOptionException(List missingOptions)
  
  Constructs a new MissingSelectedException with the specified list of missing options.
  
  Parameters:
  
  missingOptions - the list of missing options and groups
  
  Since:
  
  1.2
- MissingOptionException
  
  public MissingOptionException(String message)
  
  Construct a new MissingSelectedException with the specified detail message.
  
  Parameters:
  
  message - the detail message
Method Details
- createMessage
  
  private static String createMessage(List<?> missingOptions)
  
  Build the exception message from the specified list of options.
  
  Parameters:
  
  missingOptions - the list of missing options and groups
  
  Since:
  
  1.2
- getMissingOptions
  
  public List getMissingOptions()
  
  Gets the list of options or option groups missing in the command line parsed.
  
  Returns:
  
  the missing options, consisting of String instances for simple options, and OptionGroup instances for required option groups.
  
  Since:
  
  1.2