com.github.startsmercury.simply.no.shading.util.storage

Interface Storage<T>

Type Parameters:

T - the supported type for storing

All Known Implementing Classes:

JsonPathStorage, PathStorage

public interface Storage<T>

A Storage allows load and save operations on objects. The mode of achieving this such as where the states are stored, null-safety, stored format and others will depend on the implementation.

Since:

6.0.0

Method Summary

Modifier and Type	Method and Description
T	load() Loads the stored state as a new object.
default java.util.concurrent.CompletableFuture<? extends T>	loadAsync() Loads the stored state asynchronously.
void	save(T obj) Stores the state of a given object.
default java.util.concurrent.CompletableFuture<java.lang.Void>	saveAsync(T obj) Stores the state of a given object asynchronously.

Method Detail

load

T load()
throws java.lang.Exception

Loads the stored state as a new object.

Returns:

a new object loaded with the stored state

Throws:

java.lang.Exception - thrown when an implementation encountered a checked exception; the actual type may depend on the implementation

java.lang.NullPointerException - thrown when an implementation does not recognize null as a valid destination; usually it isn't

loadAsync

default java.util.concurrent.CompletableFuture<? extends T> loadAsync()

Loads the stored state asynchronously.

Returns:

the load future

See Also:

load()

save

void save(T obj)
   throws java.lang.Exception

Stores the state of a given object.

Parameters:

obj - the object to store the state of

Throws:

java.lang.Exception - thrown when an implementation encountered a checked exception; the actual type may depend on the implementation

java.lang.NullPointerException - thrown when an implementation does not recognize null as a valid state to store

saveAsync

default java.util.concurrent.CompletableFuture<java.lang.Void> saveAsync(T obj)

Stores the state of a given object asynchronously.

Parameters:

obj - the object to store the state of

Returns:

the save future

See Also:

save(Object)