java.lang.Object
java.lang.Enum<Flag>
gov.nasa.pds.validate.commandline.options.Flag
All Implemented Interfaces:
Serializable, Comparable<Flag>, java.lang.constant.Constable

public enum Flag
extends Enum<Flag>
Class that holds the command-line option flags.
Author:
mcayanan
  • Enum Constant Details

    • ALTERNATE_FILE_PATHS

      public static final Flag ALTERNATE_FILE_PATHS
    • BASE_PATH

      public static final Flag BASE_PATH
    • CATALOG

      public static final Flag CATALOG
    • CONFIG

      public static final Flag CONFIG
      Flag to specify a configuration file to configure the tool behavior.
    • MAX_ERRORS

      public static final Flag MAX_ERRORS
      Flag to specify file patterns to look for when validating a target directory.
    • REGEXP

      public static final Flag REGEXP
      Flag to specify file patterns to look for when validating a target directory.
    • FORCE

      public static final Flag FORCE
      DEPRECATED: Flag to force the tool to perform validation against the schema and schematron specified in a given label.
    • HELP

      public static final Flag HELP
      Flag to display the help.
    • LOCAL

      public static final Flag LOCAL
      Flag that disables recursion when traversing a target directory.
    • CHECKSUM_MANIFEST

      public static final Flag CHECKSUM_MANIFEST
      Flag to specify one or more checksum manifest files in order to perform checksum validation.
    • MODEL

      public static final Flag MODEL
      DEPRECATED: Flag to specify a model version to use during validation.
    • NO_DATA

      public static final Flag NO_DATA
      Flag to disable data content validation.
    • SKIP_CONTENT_VALIDATION

      public static final Flag SKIP_CONTENT_VALIDATION
      Flag to disable data content validation.
    • REPORT

      public static final Flag REPORT
      Flag to specify a report file name.
    • SCHEMATRON

      public static final Flag SCHEMATRON
      Flag to specify a list of schematron files to use during validation.
    • STYLE

      public static final Flag STYLE
      Flag to specify the report style.
    • TARGET

      public static final Flag TARGET
      Flag to explicitly specify the targets to validate.
    • VERSION

      public static final Flag VERSION
      Displays the tool version.
    • VERBOSE

      public static final Flag VERBOSE
      Flag to specify the severity level and above to include in the report.
    • SCHEMA

      public static final Flag SCHEMA
      Flag to specify a list of schemas to use during validation.
    • SPOT_CHECK_DATA

      public static final Flag SPOT_CHECK_DATA
    • ALLOW_UNLABELED_FILES

      public static final Flag ALLOW_UNLABELED_FILES
    • RULE

      public static final Flag RULE
    • SKIP_PRODUCT_VALIDATION

      public static final Flag SKIP_PRODUCT_VALIDATION
    • LATEST_JSON_FILE

      public static final Flag LATEST_JSON_FILE
      Flag to download the latest Registered Context Products JSON file and replace the existing file.
    • NONREGPROD_JSON_FILE

      public static final Flag NONREGPROD_JSON_FILE
    • SKIP_CONTEXT_VALIDATION

      public static final Flag SKIP_CONTEXT_VALIDATION
      flag to temporarily disable context validation. When this flag is enabled, the output logs will throw WARNING messages instead of failing validation. Only be enabled during development
    • TARGET_MANIFEST

      public static final Flag TARGET_MANIFEST
      flag to Flag to specify the file that contains a list of files/directories to validate.
  • Method Details

    • values

      public static Flag[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared
    • valueOf

      public static Flag valueOf​(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:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null
    • getShortName

      public String getShortName()
      Get the short name of the flag.
      Returns:
      The short name.
    • getLongName

      public String getLongName()
      Get the long name of the flag.
      Returns:
      The long name.
    • getArgName

      public String getArgName()
      Get the argument name of the flag.
      Returns:
      The argument name.
    • allowsMultipleArgs

      public boolean allowsMultipleArgs()
      Find out if the flag can handle multiple arguments.
      Returns:
      'true' if yes.
    • getArgType

      public Object getArgType()
      Get the argument type of the flag.
      Returns:
      The argument type.
    • getDescription

      public String getDescription()
      Get the flag description.
      Returns:
      The description.