Package io.thestencil.client.api

Class ImmutableLinkMutator

    • Method Detail

      • withLinkId

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

      • withValue

        public final ImmutableLinkMutator 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

      • withType

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

      • withLabels

        public final ImmutableLinkMutator withLabels​(@Nullable
                                             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 ImmutableLinkMutator withLabels​(@Nullable
                                             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

      • withArticles

        public final ImmutableLinkMutator withArticles​(@Nullable
                                               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 ImmutableLinkMutator withArticles​(@Nullable
                                               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

      • withDevMode

        public final ImmutableLinkMutator 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

      • equals

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

      • toString

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

      • copyOf

        public static ImmutableLinkMutator copyOf​(UpdateBuilder.LinkMutator instance)
        Creates an immutable copy of a UpdateBuilder.LinkMutator 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 LinkMutator instance

      • builder

        public static ImmutableLinkMutator.Builder builder()
        Creates a builder for ImmutableLinkMutator. 
         ImmutableLinkMutator.builder()
    .linkId(String) // required linkId
    .value(String) // required value
    .type(String) // required type
    .labels(List&lt;io.thestencil.client.api.StencilClient.LocaleLabel&gt; | null) // nullable labels
    .articles(List&lt;String&gt; | null) // nullable articles
    .devMode(Boolean | null) // nullable devMode
    .build();
        Returns:
        A new ImmutableLinkMutator builder