Enum 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
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>> -
Enum Constant Summary
Enum Constants Enum Constant Description ALLOW_UNLABELED_FILESALTERNATE_FILE_PATHSBASE_PATHCATALOGCHECKSUM_MANIFESTFlag to specify one or more checksum manifest files in order to perform checksum validation.CONFIGFlag to specify a configuration file to configure the tool behavior.FORCEDEPRECATED: Flag to force the tool to perform validation against the schema and schematron specified in a given label.HELPFlag to display the help.LATEST_JSON_FILEFlag to download the latest Registered Context Products JSON file and replace the existing file.LOCALFlag that disables recursion when traversing a target directory.MAX_ERRORSFlag to specify file patterns to look for when validating a target directory.MODELDEPRECATED: Flag to specify a model version to use during validation.NO_DATAFlag to disable data content validation.NONREGPROD_JSON_FILEREGEXPFlag to specify file patterns to look for when validating a target directory.REPORTFlag to specify a report file name.RULESCHEMAFlag to specify a list of schemas to use during validation.SCHEMATRONFlag to specify a list of schematron files to use during validation.SKIP_CONTENT_VALIDATIONFlag to disable data content validation.SKIP_CONTEXT_VALIDATIONflag to temporarily disable context validation.SKIP_PRODUCT_VALIDATIONSPOT_CHECK_DATASTYLEFlag to specify the report style.TARGETFlag to explicitly specify the targets to validate.TARGET_MANIFESTflag to Flag to specify the file that contains a list of files/directories to validate.VERBOSEFlag to specify the severity level and above to include in the report.VERSIONDisplays the tool version. -
Method Summary
Modifier and Type Method Description booleanallowsMultipleArgs()Find out if the flag can handle multiple arguments.StringgetArgName()Get the argument name of the flag.ObjectgetArgType()Get the argument type of the flag.StringgetDescription()Get the flag description.StringgetLongName()Get the long name of the flag.StringgetShortName()Get the short name of the flag.static FlagvalueOf(String name)Returns the enum constant of this type with the specified name.static Flag[]values()Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
ALTERNATE_FILE_PATHS
-
BASE_PATH
-
CATALOG
-
CONFIG
Flag to specify a configuration file to configure the tool behavior. -
MAX_ERRORS
Flag to specify file patterns to look for when validating a target directory. -
REGEXP
Flag to specify file patterns to look for when validating a target directory. -
FORCE
DEPRECATED: Flag to force the tool to perform validation against the schema and schematron specified in a given label. -
HELP
Flag to display the help. -
LOCAL
Flag that disables recursion when traversing a target directory. -
CHECKSUM_MANIFEST
Flag to specify one or more checksum manifest files in order to perform checksum validation. -
MODEL
DEPRECATED: Flag to specify a model version to use during validation. -
NO_DATA
Flag to disable data content validation. -
SKIP_CONTENT_VALIDATION
Flag to disable data content validation. -
REPORT
Flag to specify a report file name. -
SCHEMATRON
Flag to specify a list of schematron files to use during validation. -
STYLE
Flag to specify the report style. -
TARGET
Flag to explicitly specify the targets to validate. -
VERSION
Displays the tool version. -
VERBOSE
Flag to specify the severity level and above to include in the report. -
SCHEMA
Flag to specify a list of schemas to use during validation. -
SPOT_CHECK_DATA
-
ALLOW_UNLABELED_FILES
-
RULE
-
SKIP_PRODUCT_VALIDATION
-
LATEST_JSON_FILE
Flag to download the latest Registered Context Products JSON file and replace the existing file. -
NONREGPROD_JSON_FILE
-
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
flag to Flag to specify the file that contains a list of files/directories to validate.
-
-
Method Details
-
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
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 nameNullPointerException- if the argument is null
-
getShortName
Get the short name of the flag.- Returns:
- The short name.
-
getLongName
Get the long name of the flag.- Returns:
- The long name.
-
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
Get the argument type of the flag.- Returns:
- The argument type.
-
getDescription
Get the flag description.- Returns:
- The description.
-