java.lang.Object
java.lang.Enum<ResultUsePolicy>
com.google.errorprone.bugpatterns.checkreturnvalue.ResultUsePolicy
All Implemented Interfaces:
Serializable, Comparable<ResultUsePolicy>, java.lang.constant.Constable

public enum ResultUsePolicy extends Enum<ResultUsePolicy>
Policy for use of a method or constructor's result.
  • Enum Constant Details

    • EXPECTED

      public static final ResultUsePolicy EXPECTED
      Use of the result is expected except in certain contexts where the method is being used in a way such that not using the result is likely correct. Examples include when the result type at the callsite is java.lang.Void and when the surrounding context seems to be testing that the method throws an exception.
    • OPTIONAL

      public static final ResultUsePolicy OPTIONAL
      Use of the result is optional.
    • UNSPECIFIED

      public static final ResultUsePolicy UNSPECIFIED
      It is unspecified whether the result should be used or not.
  • Method Details

    • values

      public static ResultUsePolicy[] 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

      public static ResultUsePolicy 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