net.raphimc.minecraftauth.util.holder

Class Holder<T extends Expirable>

java.lang.Object

net.raphimc.minecraftauth.util.holder.Holder<T>

Type Parameters:

T - The type of the held value.

public class Holder<T extends Expirable>
extends java.lang.Object

A thread-safe holder for an expirable value that can be refreshed as needed.

Constructor Summary

Constructors

Constructor and Description
Holder(IoSupplier<T> supplier)
Holder(IoSupplier<T> supplier, java.lang.Object lock)

Method Summary

Modifier and Type	Method and Description
T	getCached() Returns the currently cached value.
T	getUpToDate() Returns the up-to-date value, refreshing it if necessary.
java.util.concurrent.CompletableFuture<T>	getUpToDateAsync() Returns the up-to-date value, refreshing it if necessary.
T	getUpToDateUnchecked() Returns the up-to-date value, refreshing it if necessary.
boolean	hasValue() Checks if the holder currently has a non-null value.
T	refresh() Forces a refresh of the value, regardless of its current state.
java.util.concurrent.CompletableFuture<T>	refreshAsync() Forces a refresh of the value, regardless of its current state.
boolean	refreshIfExpired() Refreshes the value if it is null or expired.
java.util.concurrent.CompletableFuture<java.lang.Boolean>	refreshIfExpiredAsync() Refreshes the value if it is null or expired.
boolean	refreshIfExpiredUnchecked() Refreshes the value if it is null or expired.
T	refreshUnchecked() Forces a refresh of the value, regardless of its current state.
void	set(T value)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Holder

public Holder(IoSupplier<T> supplier)

Holder

public Holder(IoSupplier<T> supplier,
              java.lang.Object lock)

Method Detail

getCached

public T getCached()

Returns the currently cached value.
This method does not perform any validation or refresh. It simply returns the last known value.
This is suitable for scenarios where you want to access the value without triggering any network requests (Like in a UI).

Returns:

The cached value, which may be null or expired.

getUpToDate

public T getUpToDate()
              throws java.io.IOException

Returns the up-to-date value, refreshing it if necessary.
If the cached value is null or expired, this method may send network requests to obtain a fresh or valid value.
Use this method when you need to ensure that the value is current and valid (For example, before using it for authentication).

Returns:

The up-to-date value.

Throws:

java.io.IOException

getUpToDateUnchecked

public T getUpToDateUnchecked()

Returns the up-to-date value, refreshing it if necessary.
If the cached value is null or expired, this method may send network requests to obtain a fresh or valid value.
Use this method when you need to ensure that the value is current and valid (For example, before using it for authentication).

Returns:

The up-to-date value.

getUpToDateAsync

public java.util.concurrent.CompletableFuture<T> getUpToDateAsync()

Returns the up-to-date value, refreshing it if necessary.
If the cached value is null or expired, this method may send network requests to obtain a fresh or valid value.
Use this method when you need to ensure that the value is current and valid (For example, before using it for authentication).

Returns:

The up-to-date value.

hasValue

public boolean hasValue()

Checks if the holder currently has a non-null value.

Returns:

True if the holder has a non-null value, false otherwise.

refreshIfExpired

public boolean refreshIfExpired()
                         throws java.io.IOException

Refreshes the value if it is null or expired.

Returns:

True if a refresh was performed, false otherwise.

Throws:

java.io.IOException

refreshIfExpiredUnchecked

public boolean refreshIfExpiredUnchecked()

Refreshes the value if it is null or expired.

Returns:

True if a refresh was performed, false otherwise.

refreshIfExpiredAsync

public java.util.concurrent.CompletableFuture<java.lang.Boolean> refreshIfExpiredAsync()

Refreshes the value if it is null or expired.

Returns:

True if a refresh was performed, false otherwise.

refresh

public T refresh()
          throws java.io.IOException

Forces a refresh of the value, regardless of its current state.

Returns:

The refreshed value.

Throws:

java.io.IOException

refreshUnchecked

public T refreshUnchecked()

Forces a refresh of the value, regardless of its current state.

Returns:

The refreshed value.

refreshAsync

public java.util.concurrent.CompletableFuture<T> refreshAsync()

Forces a refresh of the value, regardless of its current state.

Returns:

The refreshed value.

set

@ApiStatus.Internal
public void set(T value)