Package com.spotify.github.v3.git

Class ImmutableReference.Builder

java.lang.Object

com.spotify.github.v3.git.ImmutableReference.Builder

Enclosing class:

ImmutableReference

@NotThreadSafe
public static final class ImmutableReference.Builder
extends Object

Builds instances of type ImmutableReference. Initialize attributes and then invoke the build() method to create an immutable instance.

Builder is not thread-safe and generally should not be stored in a field or collection, but instead used immediately to create instances.

Method Summary

Modifier and Type	Method	Description
ImmutableReference	build()	Builds a new ImmutableReference.
ImmutableReference.Builder	from(Reference instance)	Fill a builder with attribute values from the provided Reference instance.
ImmutableReference.Builder	object(ReferenceObject object)	Initializes the value for the object attribute.
ImmutableReference.Builder	ref(String ref)	Initializes the value for the ref attribute.
ImmutableReference.Builder	url(URI url)	Initializes the value for the url attribute.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

from

@CanIgnoreReturnValue
public final ImmutableReference.Builder from(Reference instance)

Fill a builder with attribute values from the provided Reference instance. Regular attribute values will be replaced with those from the given instance. Absent optional values will not replace present values.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

ref

@CanIgnoreReturnValue
public final ImmutableReference.Builder ref(@Nullable
                                            String ref)

Initializes the value for the ref attribute.

Parameters:

ref - The value for ref (can be null)

Returns:

this builder for use in a chained invocation

url

@CanIgnoreReturnValue
public final ImmutableReference.Builder url(@Nullable
                                            URI url)

Initializes the value for the url attribute.

Parameters:

url - The value for url (can be null)

Returns:

this builder for use in a chained invocation

object

@CanIgnoreReturnValue
public final ImmutableReference.Builder object(@Nullable
                                               ReferenceObject object)

Initializes the value for the object attribute.

Parameters:

object - The value for object (can be null)

Returns:

this builder for use in a chained invocation

build

public ImmutableReference build()

Builds a new ImmutableReference.

Returns:

An immutable instance of Reference

Throws:

IllegalStateException - if any required attributes are missing