Package io.thestencil.staticontent.spi.visitor

Class ImmutableSites

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

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

    • Method Detail

      • withMessage

        public final ImmutableSites withMessage​(SiteVisitor.Message... elements)
        Copy the current immutable object with elements that replace the content of message.
        Parameters:
        elements - The elements to set
        Returns:
        A modified copy of this object

      • withMessage

        public final ImmutableSites withMessage​(Iterable<? extends SiteVisitor.Message> elements)
        Copy the current immutable object with elements that replace the content of message. A shallow reference equality check is used to prevent copying of the same value by returning this.
        Parameters:
        elements - An iterable of message elements to set
        Returns:
        A modified copy of this object

      • withSites

        public final ImmutableSites withSites​(SiteContent.Site... elements)
        Copy the current immutable object with elements that replace the content of sites.
        Parameters:
        elements - The elements to set
        Returns:
        A modified copy of this object

      • withSites

        public final ImmutableSites withSites​(Iterable<? extends SiteContent.Site> elements)
        Copy the current immutable object with elements that replace the content of sites. A shallow reference equality check is used to prevent copying of the same value by returning this.
        Parameters:
        elements - An iterable of sites elements to set
        Returns:
        A modified copy of this object

      • equals

        public boolean equals​(@Nullable
                      Object another)
        This instance is equal to all instances of ImmutableSites 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, sites.
        Overrides:
        hashCode in class Object
        Returns:
        hashCode value

      • toString

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

      • copyOf

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

      • builder

        public static ImmutableSites.Builder builder()
        Creates a builder for ImmutableSites. 
         ImmutableSites.builder()
    .addMessage|addAllMessage(io.thestencil.staticontent.spi.visitor.SiteVisitor.Message) // message elements
    .addSites|addAllSites(io.thestencil.staticontent.api.SiteContent.Site) // sites elements
    .build();
        Returns:
        A new ImmutableSites builder