Package Apache.CLI



Class MissingOptionException

  • All Implemented Interfaces:
    java.io.Serializable
    public class MissingOptionException
extends ParseException
    This Class-File has been copied, directly from the Apache Commons Software Foundation. Other than the minor, cosmetic changes (mentioned in the second-list below), this file is perfectly identical to the original that may be found on the Apache Website: apache.org.

    1. The suggested license for using this file may be read here: Apache License
    2. The Source-Code Header for this file may be viewed here: Source-File Header
    3. Partial contents of the 'site/resources/images' directory: Resource Images

    Notes about changes that have been made as a result of the import process:

    • Within all files, the original Package-Name declaration has been changed:
      Original:   package org.apache.commons.cli;
      Updated:   package Apache.CLI;

    • All Classes and Class-Members (Methods, Fields, etc...) that were previously Annotated with the @Deprecated Annotation have been summarily removed.

    • Code Formattings and Styling has been heavily modified to conform to the Standard Java-HTML Indentation & Styling Choices. The code itself remains identical, with only a few squiggly-braces '{' and '}' being removed, for cosmetic reasons (and for lowering "Developer Stress" Levels)..
    Thrown when a required option has not been provided.
    See Also:
    Serialized Form


    • Constructor Summary

      Constructors 
      Constructor Description
      MissingOptionException​(String message)
      Constructs a new MissingSelectedException with the specified detail message.
      MissingOptionException​(List missingOptions)
      Constructs a new MissingSelectedException with the specified list of missing options.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      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

    • Constructor Detail

      • 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 and groups

      • MissingOptionException

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public MissingOptionException​(java.lang.String message)
        Constructs a new MissingSelectedException with the specified detail message.
        Parameters:
        message - the detail message

    • Method Detail

      • getMissingOptions

        🡅  ⇈  ⮫ 🗕  🗗  🗖 
        public java.util.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.
        Code:
        Exact Method Body:
         return missingOptions;