Package com.github.spotbugs.snom

Enum Effort

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<Effort>
    public enum Effort
extends java.lang.Enum<Effort>
    The Effort is configuration to adjust SpotBugs detectors. Use lower effort to reduce computation cost.

    Usage:

    Set via the spotbugs extension to configure all tasks in your project:

    spotbugs {
        effort = 'less'
    }

    Or via SpotBugsTask to configure the specific task in your project:

    spotbugsMain { // or name of another task
        effort = 'max'
    }
    See Also:
    SpotBugs Manual

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      DEFAULT
      The default level that provides the same feature with MORE.
      LESS
      The effort level to reduce the computation cost.
      MAX
      The effort level that maximize the computation cost.
      MIN
      The effort level to minimize the computation cost.
      MORE
      The effort level that uses more computation cost.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static Effort valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static Effort[] 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

      • MIN

        public static final Effort MIN
        The effort level to minimize the computation cost. SpotBugs will try to conserve space at the expense of precision.

      • LESS

        public static final Effort LESS
        The effort level to reduce the computation cost.

      • DEFAULT

        public static final Effort DEFAULT
        The default level that provides the same feature with MORE.

      • MORE

        public static final Effort MORE
        The effort level that uses more computation cost. SpotBugs will try to detect more problems by Interprocedural Analysis and Null Pointer Analysis.

      • MAX

        public static final Effort MAX
        The effort level that maximize the computation cost. SpotBugs will run Interprocedural Analysis of Referenced Classes.

    • Method Detail

      • values

        public static Effort[] 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 (Effort c : Effort.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

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