Class ImmutableValidation

  • All Implemented Interfaces:
    Validation, Serializable

    @ParametersAreNonnullByDefault
    @Generated("org.immutables.processor.ProxyProcessor")
    @Immutable
    public final class ImmutableValidation
    extends Object
    implements Validation
    Immutable implementation of Validation.

    Use the builder to create immutable instances: ImmutableValidation.builder().

    See Also:
    Serialized Form
    • Method Detail

      • getRule

        public String getRule()
        Specified by:
        getRule in interface Validation
        Returns:
        The value of the rule attribute
      • withMessage

        public final ImmutableValidation withMessage​(Map<String,​? extends String> entries)
        Copy the current immutable object by replacing the message map with the specified map. Nulls are not permitted as keys or values. A shallow reference equality check is used to prevent copying of the same value by returning this.
        Parameters:
        entries - The entries to be added to the message map
        Returns:
        A modified copy of this object
      • withRule

        public final ImmutableValidation withRule​(String value)
        Copy the current immutable object by setting a value for the rule attribute. An equals check used to prevent copying of the same value by returning this.
        Parameters:
        value - A new value for rule (can be null)
        Returns:
        A modified copy of the this object
      • equals

        public boolean equals​(@Nullable
                              Object another)
        This instance is equal to all instances of ImmutableValidation that have equal attribute values.
        Overrides:
        equals in class Object
        Returns:
        true if this is equal to another instance
      • hashCode

        public int hashCode()
        Computes a hash code from attributes: message, rule.
        Overrides:
        hashCode in class Object
        Returns:
        hashCode value
      • toString

        public String toString()
        Prints the immutable value Validation with attribute values.
        Overrides:
        toString in class Object
        Returns:
        A string representation of the value
      • copyOf

        public static ImmutableValidation copyOf​(Validation instance)
        Creates an immutable copy of a Validation value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.
        Parameters:
        instance - The instance to copy
        Returns:
        A copied immutable Validation instance
      • builder

        public static ImmutableValidation.Builder builder()
        Creates a builder for ImmutableValidation.
         ImmutableValidation.builder()
            .putMessage|putAllMessage(String => String) // message mappings
            .rule(String | null) // nullable rule
            .build();
         
        Returns:
        A new ImmutableValidation builder