Package com.spotify.github.v3.git

Class ImmutableReference

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

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

    • Method Detail

      • ref

        @Nullable
public String ref()
        Full reference path. E.g. lrefs/heads/featureA.
        Specified by:
        ref in interface Reference

      • url

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

      • withRef

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

      • withUrl

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

      • withObject

        public final ImmutableReference withObject​(@Nullable
                                           ReferenceObject 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 ImmutableReference 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: ref, url, object.
        Overrides:
        hashCode in class Object
        Returns:
        hashCode value

      • toString

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

      • copyOf

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

      • builder

        public static ImmutableReference.Builder builder()
        Creates a builder for ImmutableReference. 
         ImmutableReference.builder()
    .ref(String | null) // nullable ref
    .url(java.net.URI | null) // nullable url
    .object(com.spotify.github.v3.git.ReferenceObject | null) // nullable object
    .build();
        Returns:
        A new ImmutableReference builder