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

Class ImmutableBaseEvent

  • All Implemented Interfaces:
    BaseEvent
    @ParametersAreNonnullByDefault
@Generated("org.immutables.processor.ProxyProcessor")
@Immutable
@CheckReturnValue
public final class ImmutableBaseEvent
extends Object
implements BaseEvent
    Immutable implementation of BaseEvent.

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

    • Method Detail

      • sender

        @Nullable
public User sender()
        The User that triggered/sent the event.
        Specified by:
        sender in interface BaseEvent

      • withRepository

        public final ImmutableBaseEvent withRepository​(@Nullable
                                               Repository value)
        Copy the current immutable object by setting a value for the repository attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
        Parameters:
        value - A new value for repository (can be null)
        Returns:
        A modified copy of the this object

      • withSender

        public final ImmutableBaseEvent withSender​(@Nullable
                                           User value)
        Copy the current immutable object by setting a value for the sender attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
        Parameters:
        value - A new value for sender (can be null)
        Returns:
        A modified copy of the this object

      • withEventInstallation

        public final ImmutableBaseEvent withEventInstallation​(@Nullable
                                                      EventInstallation value)
        Copy the current immutable object by setting a value for the eventInstallation attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
        Parameters:
        value - A new value for eventInstallation (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 ImmutableBaseEvent 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: repository, sender, eventInstallation.
        Overrides:
        hashCode in class Object
        Returns:
        hashCode value

      • toString

        public String toString()
        Prints the immutable value BaseEvent with attribute values.
        Overrides:
        toString in class Object
        Returns:
        A string representation of the value

      • copyOf

        public static ImmutableBaseEvent copyOf​(BaseEvent instance)
        Creates an immutable copy of a BaseEvent 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 BaseEvent instance

      • builder

        public static ImmutableBaseEvent.Builder builder()
        Creates a builder for ImmutableBaseEvent. 
         ImmutableBaseEvent.builder()
    .repository(com.spotify.github.v3.repos.Repository | null) // nullable repository
    .sender(com.spotify.github.v3.User | null) // nullable sender
    .eventInstallation(com.spotify.github.v3.activity.events.EventInstallation | null) // nullable eventInstallation
    .build();
        Returns:
        A new ImmutableBaseEvent builder