Enum ValidatorCLI.Option

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      CHANGE_FILE
      --change-file=<change-file> Add a change file
      DEBUG
      --debug Set logging level to debug
      HELP
      --help Show the help for validate
      INPUT
      --input=<input-file> Set the current input file
      LANGUAGE
      --language=<language> Set the language
      LOAD_PREFERENCES
      --load-preferences=<url-to-xml> Changes preferences according to the XML file
      OUTPUT
      --output=<output-file> Set the output file for the current input file
      SET
      --set=<key>=<value> Set preference key to value
      TRACE
      --trace Set logging level to trace
      WARN
      --warn Set logging level to warn
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private Option​(boolean requiresArgument, char shortOption)  
      private Option​(boolean requiresArgument, char shortOption, OptionParser.OptionCount optionCount)  
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getName()
      Replies the option name
      OptionParser.OptionCount getOptionCount()
      Get the number of times this option should be seen
      char getShortOption()
      Replies the short option (single letter) associated with this option.
      boolean requiresArgument()
      Determines if this option requires an argument.
      static ValidatorCLI.Option valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static ValidatorCLI.Option[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • Option

        private Option​(boolean requiresArgument,
                       char shortOption)
    • Method Detail

      • values

        public static ValidatorCLI.Option[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (ValidatorCLI.Option c : ValidatorCLI.Option.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static ValidatorCLI.Option valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null
      • getName

        public java.lang.String getName()
        Replies the option name
        Returns:
        The option name, in lowercase
      • getShortOption

        public char getShortOption()
        Replies the short option (single letter) associated with this option.
        Returns:
        the short option or '*' if there is no short option
      • requiresArgument

        public boolean requiresArgument()
        Determines if this option requires an argument.
        Returns:
        true if this option requires an argument, false otherwise