Package io.thestencil.client.api

Class ImmutableLink

    • Method Detail

      • getArticles

        public com.google.common.collect.ImmutableList<String> getArticles()
        Specified by:
        getArticles in interface StencilClient.Link
        Returns:
        The value of the articles attribute

      • withValue

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

      • withDevMode

        public final ImmutableLink withDevMode​(@Nullable
                                       Boolean value)
        Copy the current immutable object by setting a value for the devMode attribute. An equals check used to prevent copying of the same value by returning this.
        Parameters:
        value - A new value for devMode (can be null)
        Returns:
        A modified copy of the this object

      • withContentType

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

      • withArticles

        public final ImmutableLink withArticles​(String... elements)
        Copy the current immutable object with elements that replace the content of articles.
        Parameters:
        elements - The elements to set
        Returns:
        A modified copy of this object

      • withArticles

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

      • withLabels

        public final ImmutableLink withLabels​(StencilClient.LocaleLabel... elements)
        Copy the current immutable object with elements that replace the content of labels.
        Parameters:
        elements - The elements to set
        Returns:
        A modified copy of this object

      • withLabels

        public final ImmutableLink withLabels​(Iterable<? extends StencilClient.LocaleLabel> elements)
        Copy the current immutable object with elements that replace the content of labels. A shallow reference equality check is used to prevent copying of the same value by returning this.
        Parameters:
        elements - An iterable of labels 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 ImmutableLink 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: value, devMode, contentType, articles, labels.
        Overrides:
        hashCode in class Object
        Returns:
        hashCode value

      • toString

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

      • copyOf

        public static ImmutableLink copyOf​(StencilClient.Link instance)
        Creates an immutable copy of a StencilClient.Link 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 Link instance

      • builder

        public static ImmutableLink.Builder builder()
        Creates a builder for ImmutableLink. 
         ImmutableLink.builder()
    .value(String) // required value
    .devMode(Boolean | null) // nullable devMode
    .contentType(String) // required contentType
    .addArticles|addAllArticles(String) // articles elements
    .addLabels|addAllLabels(io.thestencil.client.api.StencilClient.LocaleLabel) // labels elements
    .build();
        Returns:
        A new ImmutableLink builder