Package com.spotify.github.v3.git

Class ImmutableReferenceObject

java.lang.Object

com.spotify.github.v3.git.ImmutableReferenceObject

All Implemented Interfaces:

ReferenceObject, ShaLink

@ParametersAreNonnullByDefault
@Generated("org.immutables.processor.ProxyProcessor")
@Immutable
@CheckReturnValue
public final class ImmutableReferenceObject
extends Object
implements ReferenceObject

Immutable implementation of ReferenceObject.

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ImmutableReferenceObject.Builder	Builds instances of type ImmutableReferenceObject.

Method Summary

Modifier and Type	Method	Description
static ImmutableReferenceObject.Builder	builder()	Creates a builder for ImmutableReferenceObject.
static ImmutableReferenceObject	copyOf(ReferenceObject instance)	Creates an immutable copy of a ReferenceObject value.
boolean	equals(Object another)	This instance is equal to all instances of ImmutableReferenceObject that have equal attribute values.
int	hashCode()	Computes a hash code from attributes: sha, url, type.
String	sha()	SHA.
String	toString()	Prints the immutable value ReferenceObject with attribute values.
String	type()	The type of the reference object.
URI	url()	URL.
ImmutableReferenceObject	withSha(String value)	Copy the current immutable object by setting a value for the sha attribute.
ImmutableReferenceObject	withType(String value)	Copy the current immutable object by setting a value for the type attribute.
ImmutableReferenceObject	withUrl(URI value)	Copy the current immutable object by setting a value for the url attribute.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

type

@Nullable
public String type()

The type of the reference object.

Specified by:

type in interface ReferenceObject

withSha

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

withType

public final ImmutableReferenceObject withType(@Nullable
                                               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 (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 ImmutableReferenceObject 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, type.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value ReferenceObject with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableReferenceObject copyOf(ReferenceObject instance)

Creates an immutable copy of a ReferenceObject 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 ReferenceObject instance

builder

public static ImmutableReferenceObject.Builder builder()

Creates a builder for ImmutableReferenceObject.

 ImmutableReferenceObject.builder()
    .sha(String | null) // nullable sha
    .url(java.net.URI | null) // nullable url
    .type(String | null) // nullable type
    .build();
 

Returns:

A new ImmutableReferenceObject builder