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 typeImmutableReference
. Initialize attributes and then invoke thebuild()
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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ImmutableReference
build()
Builds a newImmutableReference
.ImmutableReference.Builder
from(Reference instance)
Fill a builder with attribute values from the providedReference
instance.ImmutableReference.Builder
object(ReferenceObject object)
Initializes the value for theobject
attribute.ImmutableReference.Builder
ref(String ref)
Initializes the value for theref
attribute.ImmutableReference.Builder
url(URI url)
Initializes the value for theurl
attribute.
-
-
-
Method Detail
-
from
@CanIgnoreReturnValue public final ImmutableReference.Builder from(Reference instance)
Fill a builder with attribute values from the providedReference
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 theref
attribute.- Parameters:
ref
- The value for ref (can benull
)- Returns:
this
builder for use in a chained invocation
-
url
@CanIgnoreReturnValue public final ImmutableReference.Builder url(@Nullable URI url)
Initializes the value for theurl
attribute.- Parameters:
url
- The value for url (can benull
)- Returns:
this
builder for use in a chained invocation
-
object
@CanIgnoreReturnValue public final ImmutableReference.Builder object(@Nullable ReferenceObject object)
Initializes the value for theobject
attribute.- Parameters:
object
- The value for object (can benull
)- Returns:
this
builder for use in a chained invocation
-
build
public ImmutableReference build()
Builds a newImmutableReference
.- Returns:
- An immutable instance of Reference
- Throws:
IllegalStateException
- if any required attributes are missing
-
-