Package com.spotify.github.v3.checks

Class ImmutableAccessToken

java.lang.Object

com.spotify.github.v3.checks.ImmutableAccessToken

All Implemented Interfaces:

AccessToken

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

Immutable implementation of AccessToken.

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ImmutableAccessToken.Builder	builder()	Creates a builder for ImmutableAccessToken.
static ImmutableAccessToken	copyOf(AccessToken instance)	Creates an immutable copy of a AccessToken value.
boolean	equals(Object another)	This instance is equal to all instances of ImmutableAccessToken that have equal attribute values.
ZonedDateTime	expiresAt()	Token expiration date.
int	hashCode()	Computes a hash code from attributes: token, expiresAt.
String	token()	Access Token.
String	toString()	Prints the immutable value AccessToken with attribute values.
ImmutableAccessToken	withExpiresAt(ZonedDateTime value)	Copy the current immutable object by setting a value for the expiresAt attribute.
ImmutableAccessToken	withToken(String value)	Copy the current immutable object by setting a value for the token attribute.

Methods inherited from class java.lang.Object

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

Method Detail

token

public String token()

Access Token.

Specified by:

token in interface AccessToken

Returns:

the token content

expiresAt

public ZonedDateTime expiresAt()

Token expiration date.

Specified by:

expiresAt in interface AccessToken

Returns:

the zoned date time

withToken

public final ImmutableAccessToken withToken(String value)

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

Parameters:

value - A new value for token

Returns:

A modified copy of the this object

withExpiresAt

public final ImmutableAccessToken withExpiresAt(ZonedDateTime value)

Copy the current immutable object by setting a value for the expiresAt attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for expiresAt

Returns:

A modified copy of the this object

equals

public boolean equals(@Nullable
                      Object another)

This instance is equal to all instances of ImmutableAccessToken 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: token, expiresAt.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value AccessToken with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableAccessToken copyOf(AccessToken instance)

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

builder

public static ImmutableAccessToken.Builder builder()

Creates a builder for ImmutableAccessToken.

 ImmutableAccessToken.builder()
    .token(String) // required token
    .expiresAt(java.time.ZonedDateTime) // required expiresAt
    .build();
 

Returns:

A new ImmutableAccessToken builder