public enum Arg extends Enum<Arg>
Modifier and Type | Class and Description |
---|---|
static class |
Arg.StdMsgs
Standard messages used in descriptions.
|
Enum Constant and Description |
---|
CONFIGURATION
Group of options that read a configuration file
|
CONFIGURATION_NO_DEFAULTS
Group of options that skip the default configuration file
|
DIR
Stop processing an input stream and declare an input file
|
DRY_RUN
Specifies that the run should not perform any updates to files.
|
EDIT_ADD
Defines options to add licenses to files
|
EDIT_COPYRIGHT
Defines options to add copyright to files
|
EDIT_OVERWRITE
Causes file updates to overwrite existing files.
|
EXCLUDE
Excludes files by expression
|
EXCLUDE_FILE
Excludes files based on content of file
|
FAMILIES_APPROVED
Option that specifies approved license families
|
FAMILIES_APPROVED_FILE
Option that specifies approved license families from a file
|
FAMILIES_DENIED
Option to list license families to remove from the approved list
|
FAMILIES_DENIED_FILE
Option to read a list of license families to remove from the approved list
|
HELP_LICENSES
Provide license definition listing
|
LICENSES_APPROVED
Option that adds approved licenses to the list
|
LICENSES_APPROVED_FILE
Option that adds approved licenses from a file
|
LICENSES_DENIED
Option to remove licenses from the approved list
|
LICENSES_DENIED_FILE
Option to read a file licenses to be removed from the approved list
|
LOG_LEVEL
Specifies the log level to log messages at.
|
OUTPUT_ARCHIVE
Specifies the level of reporting detail for archive files.
|
OUTPUT_FAMILIES
Specifies the license families that should be included in the output
|
OUTPUT_FILE
Specifies where the output should be written.
|
OUTPUT_LICENSES
Specifies the license definitions that should be included in the output
|
OUTPUT_STANDARD
Specifies the level of reporting detail for standard files.
|
OUTPUT_STYLE
Defines the stylesheet to use
|
SCAN_HIDDEN_DIRECTORIES
Scan hidden directories
|
Modifier and Type | Method and Description |
---|---|
String |
defaultValue() |
org.apache.commons.cli.Option |
find(String key)
Finds the element associated with the key within the element group.
|
static Arg |
findArg(org.apache.commons.cli.Option optionToFind)
Finds the Arg that an Option is in.
|
static Arg |
findArg(String key)
Finds the Arg that contains an Option with the specified key.
|
static org.apache.commons.cli.Options |
getOptions()
Gets the full set of options.
|
org.apache.commons.cli.Option |
getSelected()
Gets the select element from the group.
|
org.apache.commons.cli.OptionGroup |
group()
Gets the group for this arg.
|
boolean |
isSelected()
Determines if the group has a selected element.
|
org.apache.commons.cli.Option |
option()
Returns the first non-deprecated option from the group.
|
static void |
processArgs(ArgumentContext ctxt)
Process the arguments.
|
static void |
processLogLevel(org.apache.commons.cli.CommandLine commandLine)
Process the log level setting.
|
static void |
reset()
Resets the groups in the Args so that they are unused and ready to detect the next set of arguments.
|
static Arg |
valueOf(String name)
Returns the enum constant of this type with the specified name.
|
static Arg[] |
values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
public static final Arg EDIT_COPYRIGHT
public static final Arg EDIT_OVERWRITE
public static final Arg EDIT_ADD
public static final Arg CONFIGURATION
public static final Arg CONFIGURATION_NO_DEFAULTS
public static final Arg LICENSES_APPROVED
public static final Arg LICENSES_APPROVED_FILE
public static final Arg FAMILIES_APPROVED
public static final Arg FAMILIES_APPROVED_FILE
public static final Arg LICENSES_DENIED
public static final Arg LICENSES_DENIED_FILE
public static final Arg FAMILIES_DENIED
public static final Arg FAMILIES_DENIED_FILE
public static final Arg EXCLUDE
public static final Arg EXCLUDE_FILE
public static final Arg SCAN_HIDDEN_DIRECTORIES
public static final Arg DIR
public static final Arg OUTPUT_STYLE
public static final Arg OUTPUT_LICENSES
public static final Arg OUTPUT_FAMILIES
public static final Arg LOG_LEVEL
public static final Arg DRY_RUN
public static final Arg OUTPUT_FILE
public static final Arg OUTPUT_ARCHIVE
public static final Arg OUTPUT_STANDARD
public static final Arg HELP_LICENSES
public static Arg[] values()
for (Arg c : Arg.values()) System.out.println(c);
public static Arg valueOf(String name)
name
- the name of the enum constant to be returned.IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is nullpublic boolean isSelected()
true
if the group has a selected element.public org.apache.commons.cli.Option getSelected()
null
if no element is selected.public org.apache.commons.cli.Option find(String key)
key
- the key to search for.IllegalArgumentException
- if the key can not be found.public String defaultValue()
public org.apache.commons.cli.OptionGroup group()
public org.apache.commons.cli.Option option()
public static org.apache.commons.cli.Options getOptions()
public static void processLogLevel(org.apache.commons.cli.CommandLine commandLine)
commandLine
- The command line to process.public static void processArgs(ArgumentContext ctxt) throws IOException
ctxt
- the context in which to process the args.IOException
- if input files can not be read.public static void reset()
public static Arg findArg(org.apache.commons.cli.Option optionToFind)
optionToFind
- the Option to locate.null
if no Arg is found.Copyright © 2006–2024 Apache Software Foundation. All rights reserved.