gov.nasa.pds.report.cli.options
Enum Flag

java.lang.Object
  extended by java.lang.Enum<Flag>
      extended by gov.nasa.pds.report.cli.options.Flag
All Implemented Interfaces:
Serializable, Comparable<Flag>

public enum Flag
extends Enum<Flag>

Describes all the flags used in the CLI

Author:
jpadams

Enum Constant Summary
CLEANUP
          Flag to cleanup logs in staging and old logs in final and backup
FORCE_BACKUP
          Flag to force a backup of logs in staging
FROM_DATE
          Flags to filter log files by date specified in log filename
HELP
          Flag to display the help.
ID_PATTERN
          Flag to filter by profile ID
NODE_PATTERN
          Flag to filter by node name specified in profile
PROCESS_LOGS
          Flag to instruct the Report Manager to process logs
PULL
          Flag to instruct Logs Manager component to pull logs from nodes
REBUILD_SAWMILL
          Flag to run a Sawmill command to rebuild the Sawmill DB
RUN_NAME
          Flag to specify a run name for generated reports
SAWMILL_REPORTS
          Flag to run a Sawmill command to generate Sawmill reports
TO_DATE
           
UPDATE_SAWMILL
          Flag to run a Sawmill command to update the Sawmill DB
VERBOSE
          Flag to change the severity level of the messaging in the report.
VERSION
          Flag to display the version.
 
Method Summary
 boolean allowsMultipleArgs()
          Find out if the flag can handle multiple arguments.
 String getArgName()
          Get the argument name of the flag.
 Object getArgType()
          Get the argument type of the flag.
 String getDescription()
          Get the flag description.
 String getLongName()
          Get the long name of the flag.
static org.apache.commons.cli.Options getOptions()
          Get the command-line options.
 String getShortName()
          Get the short name of the flag.
static Flag valueOf(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.
 
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
 

Enum Constant Detail

PULL

public static final Flag PULL
Flag to instruct Logs Manager component to pull logs from nodes


PROCESS_LOGS

public static final Flag PROCESS_LOGS
Flag to instruct the Report Manager to process logs


UPDATE_SAWMILL

public static final Flag UPDATE_SAWMILL
Flag to run a Sawmill command to update the Sawmill DB


REBUILD_SAWMILL

public static final Flag REBUILD_SAWMILL
Flag to run a Sawmill command to rebuild the Sawmill DB


SAWMILL_REPORTS

public static final Flag SAWMILL_REPORTS
Flag to run a Sawmill command to generate Sawmill reports


NODE_PATTERN

public static final Flag NODE_PATTERN
Flag to filter by node name specified in profile


ID_PATTERN

public static final Flag ID_PATTERN
Flag to filter by profile ID


RUN_NAME

public static final Flag RUN_NAME
Flag to specify a run name for generated reports


FORCE_BACKUP

public static final Flag FORCE_BACKUP
Flag to force a backup of logs in staging


CLEANUP

public static final Flag CLEANUP
Flag to cleanup logs in staging and old logs in final and backup


FROM_DATE

public static final Flag FROM_DATE
Flags to filter log files by date specified in log filename


TO_DATE

public static final Flag TO_DATE

HELP

public static final Flag HELP
Flag to display the help.


VERBOSE

public static final Flag VERBOSE
Flag to change the severity level of the messaging in the report.


VERSION

public static final Flag VERSION
Flag to display the version.

Method Detail

values

public static Flag[] 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 (Flag c : Flag.values())
    System.out.println(c);

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

getOptions

public static org.apache.commons.cli.Options getOptions()
Get the command-line options.

Returns:
A class representation of the command-line options.

allowsMultipleArgs

public boolean allowsMultipleArgs()
Find out if the flag can handle multiple arguments.

Returns:
'true' if yes.

getArgName

public String getArgName()
Get the argument name of the flag.

Returns:
The argument name.

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.

getLongName

public String getLongName()
Get the long name of the flag.

Returns:
The long name.

getShortName

public String getShortName()
Get the short name of the flag.

Returns:
The short name.


Copyright © 2010–2015 Planetary Data System. All rights reserved.