Package jakarta.validation

Enum Class ConstraintTarget

java.lang.Object
java.lang.Enum<ConstraintTarget>
jakarta.validation.ConstraintTarget
All Implemented Interfaces:
Serializable, Comparable<ConstraintTarget>, Constable
public enum ConstraintTarget extends Enum<ConstraintTarget>
Defines the constraint target.
Since:
1.1

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    IMPLICIT
    Discover the type when no ambiguity is present if neither on a method nor a constructor, it implies the annotated element (type, field etc), if on a method or constructor with no parameter, it implies RETURN_VALUE, if on a method with no return value (void), it implies PARAMETERS. Otherwise, IMPLICIT is not accepted and either RETURN_VALUE or PARAMETERS is required.
    PARAMETERS
    Constraint applies to the parameters of a method or a constructor
    RETURN_VALUE
    Constraint applies to the return value of a method or a constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    static ConstraintTarget
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static ConstraintTarget[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • IMPLICIT

      public static final ConstraintTarget IMPLICIT
      Discover the type when no ambiguity is present
      • if neither on a method nor a constructor, it implies the annotated element (type, field etc),
      • if on a method or constructor with no parameter, it implies RETURN_VALUE,
      • if on a method with no return value (void), it implies PARAMETERS.
      Otherwise, IMPLICIT is not accepted and either RETURN_VALUE or PARAMETERS is required. This is the case for constructors with parameters and methods with parameters and return value.

    • RETURN_VALUE

      public static final ConstraintTarget RETURN_VALUE
      Constraint applies to the return value of a method or a constructor.

    • PARAMETERS

      public static final ConstraintTarget PARAMETERS
      Constraint applies to the parameters of a method or a constructor

  • Method Details

    • values

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