Package jakarta.validation.metadata

Enum Class ValidateUnwrappedValue

java.lang.Object
java.lang.Enum<ValidateUnwrappedValue>
jakarta.validation.metadata.ValidateUnwrappedValue
All Implemented Interfaces:
Serializable, Comparable<ValidateUnwrappedValue>, Constable
public enum ValidateUnwrappedValue extends Enum<ValidateUnwrappedValue>
The unwrapping behavior that can be applied to a specific constraint.
Since:
2.0
Author:
Guillaume Smet

  • 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
    DEFAULT
    No specific unwrapping behavior has been defined for this constraint and the default behavior applies: if there is exactly one maximally-specific type-compliant ValueExtractor and this extractor is marked with UnwrapByDefault, this extractor is applied and the constraint is applied to the value(s) wrapped by the annotated container.
    SKIP
    The value is not unwrapped before validation, i.e. the constraint is applied to the annotated element.
    UNWRAP
    The value is unwrapped before validation, i.e. the constraint is applied to the value(s) wrapped by the annotated container.

  • Method Summary

    Modifier and Type
    Method
    Description
    static ValidateUnwrappedValue
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static ValidateUnwrappedValue[]
    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

    • DEFAULT

      public static final ValidateUnwrappedValue DEFAULT
      No specific unwrapping behavior has been defined for this constraint and the default behavior applies: if there is exactly one maximally-specific type-compliant ValueExtractor and this extractor is marked with UnwrapByDefault, this extractor is applied and the constraint is applied to the value(s) wrapped by the annotated container. Otherwise, no value extractor is applied.

    • UNWRAP

      public static final ValidateUnwrappedValue UNWRAP
      The value is unwrapped before validation, i.e. the constraint is applied to the value(s) wrapped by the annotated container.

    • SKIP

      public static final ValidateUnwrappedValue SKIP
      The value is not unwrapped before validation, i.e. the constraint is applied to the annotated element.

  • Method Details

    • values

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