Package com.spotify.github.v3.git
Class ImmutableReference
- java.lang.Object
-
- com.spotify.github.v3.git.ImmutableReference
-
- All Implemented Interfaces:
Reference
@ParametersAreNonnullByDefault @Generated("org.immutables.processor.ProxyProcessor") @Immutable @CheckReturnValue public final class ImmutableReference extends Object implements Reference
Immutable implementation ofReference
.Use the builder to create immutable instances:
ImmutableReference.builder()
.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ImmutableReference.Builder
Builds instances of typeImmutableReference
.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ImmutableReference.Builder
builder()
Creates a builder forImmutableReference
.static ImmutableReference
copyOf(Reference instance)
Creates an immutable copy of aReference
value.boolean
equals(Object another)
This instance is equal to all instances ofImmutableReference
that have equal attribute values.int
hashCode()
Computes a hash code from attributes:ref
,url
,object
.ReferenceObject
object()
Reference object.String
ref()
Full reference path.String
toString()
Prints the immutable valueReference
with attribute values.URI
url()
Reference API URL.ImmutableReference
withObject(ReferenceObject value)
Copy the current immutable object by setting a value for theobject
attribute.ImmutableReference
withRef(String value)
Copy the current immutable object by setting a value for theref
attribute.ImmutableReference
withUrl(URI value)
Copy the current immutable object by setting a value for theurl
attribute.
-
-
-
Method Detail
-
ref
@Nullable public String ref()
Full reference path. E.g. lrefs/heads/featureA.
-
object
@Nullable public ReferenceObject object()
Reference object.
-
withRef
public final ImmutableReference withRef(@Nullable String value)
Copy the current immutable object by setting a value for theref
attribute. An equals check used to prevent copying of the same value by returningthis
.- Parameters:
value
- A new value for ref (can benull
)- 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 theurl
attribute. A shallow reference equality check is used to prevent copying of the same value by returningthis
.- Parameters:
value
- A new value for url (can benull
)- 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 theobject
attribute. A shallow reference equality check is used to prevent copying of the same value by returningthis
.- Parameters:
value
- A new value for object (can benull
)- Returns:
- A modified copy of the
this
object
-
equals
public boolean equals(@Nullable Object another)
This instance is equal to all instances ofImmutableReference
that have equal attribute values.
-
hashCode
public int hashCode()
Computes a hash code from attributes:ref
,url
,object
.
-
toString
public String toString()
Prints the immutable valueReference
with attribute values.
-
copyOf
public static ImmutableReference copyOf(Reference instance)
Creates an immutable copy of aReference
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 forImmutableReference
.ImmutableReference.builder() .ref(String | null) // nullable
ref
.url(java.net.URI | null) // nullableurl
.object(com.spotify.github.v3.git.ReferenceObject | null) // nullableobject
.build();- Returns:
- A new ImmutableReference builder
-
-