Package rife.bld.extension.spotbugs

Enum Class SpotBugsFlag

java.lang.Object
java.lang.Enum<SpotBugsFlag>
rife.bld.extension.spotbugs.SpotBugsFlag
All Implemented Interfaces:
Serializable, Comparable<SpotBugsFlag>, Constable
public enum SpotBugsFlag extends Enum<SpotBugsFlag>
Command line flags supported by SpotBugs -textui.

Values correspond to flags accepted by edu.umd.cs.findbugs.FindBugs2 as of SpotBugs 4.9.8. See java -jar spotbugs.jar -textui -help.

  • Enum Constant Details

    • ADJUST_EXPERIMENTAL

      public static final SpotBugsFlag ADJUST_EXPERIMENTAL
      Lower priority of experimental Bug Patterns

    • ADJUST_PRIORITY

      public static final SpotBugsFlag ADJUST_PRIORITY
      Adjust priority of warnings for given detectors or bug patterns

    • ANALYZE_FROM_FILE

      public static final SpotBugsFlag ANALYZE_FROM_FILE
      Get the list of class/jar files from a designated file

    • APPLY_SUPPRESSION

      public static final SpotBugsFlag APPLY_SUPPRESSION
      Exclude any bugs that match suppression filter loaded from fbp file

    • AUX_CLASSPATH

      public static final SpotBugsFlag AUX_CLASSPATH
      Set aux classpath for analysis

    • AUX_CLASSPATH_FROM_FILE

      public static final SpotBugsFlag AUX_CLASSPATH_FROM_FILE
      Read aux classpaths from a designated file

    • AUX_CLASSPATH_FROM_INPUT

      public static final SpotBugsFlag AUX_CLASSPATH_FROM_INPUT
      Read aux classpath from standard input

    • BUG_CATEGORIES

      public static final SpotBugsFlag BUG_CATEGORIES
      Only report bugs in given categories: -bugCategories cat1[,cat2...]

    • BUG_REPORTERS

      public static final SpotBugsFlag BUG_REPORTERS
      Bug reporter decorators to explicitly enable/disable

    • CHOOSE_PLUGINS

      public static final SpotBugsFlag CHOOSE_PLUGINS
      Selectively enable/disable plugins: -choosePlugins +p1,-p2,...

    • CHOOSE_VISITORS

      public static final SpotBugsFlag CHOOSE_VISITORS
      Selectively enable/disable detectors: -chooseVisitors +v1,-v2,...

    • CONSERVE_SPACE

      public static final SpotBugsFlag CONSERVE_SPACE
      Same as -effort:min, for backward compatibility

    • DONT_COMBINE_WARNINGS

      public static final SpotBugsFlag DONT_COMBINE_WARNINGS
      Don't combine warnings that differ only in line number

    • EFFORT

      public static final SpotBugsFlag EFFORT
      Set analysis effort level: -effort:[min|less|default|more|max]

    • EMACS

      public static final SpotBugsFlag EMACS
      Use emacs reporting format

    • EXCLUDE

      public static final SpotBugsFlag EXCLUDE
      Exclude bugs matching given filter

    • EXCLUDE_BUGS

      public static final SpotBugsFlag EXCLUDE_BUGS
      Exclude bugs that are also reported in the baseline xml output

    • EXIT_CODE

      public static final SpotBugsFlag EXIT_CODE
      Set exit code of process

    • EXPERIMENTAL

      public static final SpotBugsFlag EXPERIMENTAL
      Report of any confidence level including experimental bug patterns

    • HIGH

      public static final SpotBugsFlag HIGH
      Report only high confidence warnings

    • HOME

      public static final SpotBugsFlag HOME
      Specify SpotBugs home directory

    • HTML

      public static final SpotBugsFlag HTML
      Generate HTML output: -html[:stylesheet]

    • INCLUDE

      public static final SpotBugsFlag INCLUDE
      Include only bugs matching given filter

    • JAVA_HOME

      public static final SpotBugsFlag JAVA_HOME
      Specify location of JRE

    • JVM_ARGS

      public static final SpotBugsFlag JVM_ARGS
      Pass args to JVM

    • LONG_BUG_CODES

      public static final SpotBugsFlag LONG_BUG_CODES
      Report long bug codes

    • LOW

      public static final SpotBugsFlag LOW
      Report warnings of any confidence level

    • MAX_HEAP

      public static final SpotBugsFlag MAX_HEAP
      Maximum Java heap size in megabytes

    • MAX_RANK

      public static final SpotBugsFlag MAX_RANK
      Only report issues with a bug rank at least as scary as that provided

    • MEDIUM

      public static final SpotBugsFlag MEDIUM
      Report only medium and high confidence warnings [default]

    • NESTED

      public static final SpotBugsFlag NESTED
      Analyze nested jar/zip archives: -nested[:true|false]

    • NO_CLASS_OK

      public static final SpotBugsFlag NO_CLASS_OK
      Output empty warning file if no classes are specified

    • OMIT_VISITORS

      public static final SpotBugsFlag OMIT_VISITORS
      Omit named visitors: -omitVisitors v1[,v2...]

    • ONLY_ANALYZE

      public static final SpotBugsFlag ONLY_ANALYZE
      Only analyze given classes and packages

    • OUTPUT

      public static final SpotBugsFlag OUTPUT
      Save output in named file

    • PLUGIN_LIST

      public static final SpotBugsFlag PLUGIN_LIST
      Specify list of plugin Jar files to load: -pluginList jar1[:jar2...]

    • PROGRESS

      public static final SpotBugsFlag PROGRESS
      Display progress in terminal window

    • PROJECT

      public static final SpotBugsFlag PROJECT
      Analyze given project

    • PROJECT_NAME

      public static final SpotBugsFlag PROJECT_NAME
      Descriptive name of project

    • QUIET

      public static final SpotBugsFlag QUIET
      Suppress error messages

    • REANALYZE

      public static final SpotBugsFlag REANALYZE
      Redo analysis in provided file

    • REDO_ANALYSIS

      public static final SpotBugsFlag REDO_ANALYSIS
      Redo analysis using configuration from previous analysis

    • RELAXED

      public static final SpotBugsFlag RELAXED
      Relaxed reporting mode (more false positives!)

    • RELEASE

      public static final SpotBugsFlag RELEASE
      Set the release name of the analyzed application

    • SARIF

      public static final SpotBugsFlag SARIF
      SARIF 2.1.0 output

    • SHOW_PLUGINS

      public static final SpotBugsFlag SHOW_PLUGINS
      Show list of available detector plugins

    • SORT_BY_CLASS

      public static final SpotBugsFlag SORT_BY_CLASS
      Sort warnings by class

    • SOURCE_INFO

      public static final SpotBugsFlag SOURCE_INFO
      Specify source info file (line numbers for fields/classes)

    • SOURCE_PATH

      public static final SpotBugsFlag SOURCE_PATH
      Set source path for analyzed classes

    • TIMESTAMP_NOW

      public static final SpotBugsFlag TIMESTAMP_NOW
      Set timestamp of results to be current time

    • TRAIN

      public static final SpotBugsFlag TRAIN
      Save training data (experimental): -train[:outputDir]

    • USER_PREFS

      public static final SpotBugsFlag USER_PREFS
      User preferences file

    • USE_TRAINING

      public static final SpotBugsFlag USE_TRAINING
      Use training data (experimental): -useTraining[:inputDir]

    • VERSION

      public static final SpotBugsFlag VERSION
      Print version, check for updates and exit, without running analysis

    • VISITORS

      public static final SpotBugsFlag VISITORS
      Run only named visitors: -visitors v1[,v2...]

    • WORK_HARD

      public static final SpotBugsFlag WORK_HARD
      Ensure analysis effort is at least 'default'

    • XARGS

      public static final SpotBugsFlag XARGS
      Get list of classfiles/jarfiles from standard input rather than command line

    • XDOCS

      public static final SpotBugsFlag XDOCS
      xdoc XML output to use with Apache Maven

    • XML

      public static final SpotBugsFlag XML
      XML output: -xml[:withMessages]

    • XML_WITH_MESSAGES

      public static final SpotBugsFlag XML_WITH_MESSAGES
      XML output with messages: -xml:withMessages

  • Method Details

    • values

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

    • valueOf

      public static SpotBugsFlag valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null

    • toString

      public String toString()
      Overrides:
      toString in class Enum<SpotBugsFlag>

    • flag

      public String flag()
      Returns:
      the literal flag, e.g. "-noClassOk"