Package com.spotify.github.v3.git

Class ImmutableTree

  • All Implemented Interfaces:
    ShaLink, Tree
    @ParametersAreNonnullByDefault
@Generated("org.immutables.processor.ProxyProcessor")
@Immutable
@CheckReturnValue
public final class ImmutableTree
extends Object
implements Tree
    Immutable implementation of Tree.

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

    • Method Detail

      • sha

        @Nullable
public String sha()
        SHA.
        Specified by:
        sha in interface ShaLink

      • url

        @Nullable
public URI url()
        URL.
        Specified by:
        url in interface ShaLink

      • truncated

        @Nullable
public Boolean truncated()
        If true, the number of items in the tree array exceeded our maximum limit.
        Specified by:
        truncated in interface Tree

      • withSha

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

      • withUrl

        public final ImmutableTree withUrl​(@Nullable
                                   URI value)
        Copy the current immutable object by setting a value for the url attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
        Parameters:
        value - A new value for url (can be null)
        Returns:
        A modified copy of the this object

      • withTree

        public final ImmutableTree withTree​(@Nullable
                                    TreeItem... elements)
        Copy the current immutable object with elements that replace the content of tree.
        Parameters:
        elements - The elements to set
        Returns:
        A modified copy of this object

      • withTree

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

      • withTruncated

        public final ImmutableTree withTruncated​(@Nullable
                                         Boolean value)
        Copy the current immutable object by setting a value for the truncated attribute. An equals check used to prevent copying of the same value by returning this.
        Parameters:
        value - A new value for truncated (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 ImmutableTree 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: sha, url, tree, truncated.
        Overrides:
        hashCode in class Object
        Returns:
        hashCode value

      • toString

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

      • copyOf

        public static ImmutableTree copyOf​(Tree instance)
        Creates an immutable copy of a Tree 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 Tree instance

      • builder

        public static ImmutableTree.Builder builder()
        Creates a builder for ImmutableTree. 
         ImmutableTree.builder()
    .sha(String | null) // nullable sha
    .url(java.net.URI | null) // nullable url
    .tree(List&lt;com.spotify.github.v3.git.TreeItem&gt; | null) // nullable tree
    .truncated(Boolean | null) // nullable truncated
    .build();
        Returns:
        A new ImmutableTree builder