Package com.spotify.github.v3.activity.events

Class ImmutableBaseEvent.Builder

java.lang.Object

com.spotify.github.v3.activity.events.ImmutableBaseEvent.Builder

Enclosing class:

ImmutableBaseEvent

@NotThreadSafe
public static final class ImmutableBaseEvent.Builder
extends Object

Builds instances of type ImmutableBaseEvent. 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
ImmutableBaseEvent	build()	Builds a new ImmutableBaseEvent.
ImmutableBaseEvent.Builder	eventInstallation(EventInstallation eventInstallation)	Initializes the value for the eventInstallation attribute.
ImmutableBaseEvent.Builder	from(BaseEvent instance)	Fill a builder with attribute values from the provided BaseEvent instance.
ImmutableBaseEvent.Builder	repository(Repository repository)	Initializes the value for the repository attribute.
ImmutableBaseEvent.Builder	sender(User sender)	Initializes the value for the sender 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 ImmutableBaseEvent.Builder from(BaseEvent instance)

Fill a builder with attribute values from the provided BaseEvent 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

repository

@CanIgnoreReturnValue
public final ImmutableBaseEvent.Builder repository(@Nullable
                                                   Repository repository)

Initializes the value for the repository attribute.

Parameters:

repository - The value for repository (can be null)

Returns:

this builder for use in a chained invocation

sender

@CanIgnoreReturnValue
public final ImmutableBaseEvent.Builder sender(@Nullable
                                               User sender)

Initializes the value for the sender attribute.

Parameters:

sender - The value for sender (can be null)

Returns:

this builder for use in a chained invocation

eventInstallation

@CanIgnoreReturnValue
public final ImmutableBaseEvent.Builder eventInstallation(@Nullable
                                                          EventInstallation eventInstallation)

Initializes the value for the eventInstallation attribute.

Parameters:

eventInstallation - The value for eventInstallation (can be null)

Returns:

this builder for use in a chained invocation

build

public ImmutableBaseEvent build()

Builds a new ImmutableBaseEvent.

Returns:

An immutable instance of BaseEvent

Throws:

IllegalStateException - if any required attributes are missing