Package io.thestencil.staticontent.spi.visitor

Class ImmutableMessage

  • All Implemented Interfaces:
    SiteVisitor.Message
    @ParametersAreNonnullByDefault
@Generated("org.immutables.processor.ProxyProcessor")
@Immutable
@CheckReturnValue
public final class ImmutableMessage
extends Object
implements SiteVisitor.Message
    Immutable implementation of SiteVisitor.Message.

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

    • Method Detail

      • withText

        public final ImmutableMessage withText​(String value)
        Copy the current immutable object by setting a value for the text attribute. An equals check used to prevent copying of the same value by returning this.
        Parameters:
        value - A new value for text
        Returns:
        A modified copy of the this object

      • withObject

        public final ImmutableMessage withObject​(@Nullable
                                         Object value)
        Copy the current immutable object by setting a value for the object attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
        Parameters:
        value - A new value for object (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 ImmutableMessage 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: text, object.
        Overrides:
        hashCode in class Object
        Returns:
        hashCode value

      • toString

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

      • copyOf

        public static ImmutableMessage copyOf​(SiteVisitor.Message instance)
        Creates an immutable copy of a SiteVisitor.Message 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 Message instance

      • builder

        public static ImmutableMessage.Builder builder()
        Creates a builder for ImmutableMessage. 
         ImmutableMessage.builder()
    .text(String) // required text
    .object(Object | null) // nullable object
    .build();
        Returns:
        A new ImmutableMessage builder