Package com.spotify.github.v3.user.requests

Class ImmutableSuspensionReason

java.lang.Object

com.spotify.github.v3.user.requests.ImmutableSuspensionReason

All Implemented Interfaces:

SuspensionReason

@ParametersAreNonnullByDefault
@Generated("org.immutables.processor.ProxyProcessor")
@Immutable
@CheckReturnValue
public final class ImmutableSuspensionReason
extends Object
implements SuspensionReason

Immutable implementation of SuspensionReason.

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ImmutableSuspensionReason.Builder	Builds instances of type ImmutableSuspensionReason.

Method Summary

Modifier and Type	Method	Description
static ImmutableSuspensionReason.Builder	builder()	Creates a builder for ImmutableSuspensionReason.
static ImmutableSuspensionReason	copyOf(SuspensionReason instance)	Creates an immutable copy of a SuspensionReason value.
boolean	equals(Object another)	This instance is equal to all instances of ImmutableSuspensionReason that have equal attribute values.
int	hashCode()	Computes a hash code from attributes: reason.
String	reason()
String	toString()	Prints the immutable value SuspensionReason with attribute values.
ImmutableSuspensionReason	withReason(String value)	Copy the current immutable object by setting a value for the reason attribute.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

reason

public String reason()

Specified by:

reason in interface SuspensionReason

Returns:

The value of the reason attribute

withReason

public final ImmutableSuspensionReason withReason(String value)

Copy the current immutable object by setting a value for the reason attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for reason

Returns:

A modified copy of the this object

equals

public boolean equals(@Nullable
                      Object another)

This instance is equal to all instances of ImmutableSuspensionReason 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: reason.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value SuspensionReason with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableSuspensionReason copyOf(SuspensionReason instance)

Creates an immutable copy of a SuspensionReason 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 SuspensionReason instance

builder

public static ImmutableSuspensionReason.Builder builder()

Creates a builder for ImmutableSuspensionReason.

 ImmutableSuspensionReason.builder()
    .reason(String) // required reason
    .build();
 

Returns:

A new ImmutableSuspensionReason builder