Package dev.crafty.core.storage.providers

Class YamlStorageProvider<K,V>

java.lang.Object

dev.crafty.core.storage.AbstractStorageProvider<K,V>

dev.crafty.core.storage.providers.YamlStorageProvider<K,V>

All Implemented Interfaces:

StorageProvider<K,V>

public class YamlStorageProvider<K,V>
extends AbstractStorageProvider<K,V>

Field Summary

Fields inherited from class dev.crafty.core.storage.AbstractStorageProvider

valueType

Constructor Summary

Constructors

Constructor	Description
YamlStorageProvider(Class<V> valueType, Path directory)
YamlStorageProvider(Class<V> valueType, Path directory, String fileExtension)

Method Summary

Modifier and Type	Method	Description
CompletableFuture<Void>	delete(K key)	Deletes an object from the storage.
CompletableFuture<Optional<V>>	get(K key)	Retrieves an object from the storage.
CompletableFuture<Collection<V>>	getAll()	Retrieves all objects from the storage.
CompletableFuture<Void>	initialize()	Initializes the storage provider.
CompletableFuture<Void>	save(K key, V value)	Saves an object to the storage.

Methods inherited from class dev.crafty.core.storage.AbstractStorageProvider

close, exists, serializeKey

Methods inherited from class java.lang.Object

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

Constructor Details

YamlStorageProvider

public YamlStorageProvider(Class<V> valueType,
 Path directory)

YamlStorageProvider

public YamlStorageProvider(Class<V> valueType,
 Path directory,
 String fileExtension)

Method Details

initialize

public CompletableFuture<Void> initialize()

Description copied from interface: StorageProvider

Initializes the storage provider. This method should be called before using the provider.

Specified by:

initialize in interface StorageProvider<K,V>

Overrides:

initialize in class AbstractStorageProvider<K,V>

Returns:

A CompletableFuture that completes when initialization is done

save

public CompletableFuture<Void> save(K key,
 V value)

Description copied from interface: StorageProvider

Saves an object to the storage.

Parameters:

key - The key to identify the object

value - The object to save

Returns:

A CompletableFuture that completes when the operation is done

get

public CompletableFuture<Optional<V>> get(K key)

Description copied from interface: StorageProvider

Retrieves an object from the storage.

Parameters:

key - The key of the object to retrieve

Returns:

A CompletableFuture that completes with the retrieved object, or empty if not found

getAll

public CompletableFuture<Collection<V>> getAll()

Description copied from interface: StorageProvider

Retrieves all objects from the storage.

Returns:

A CompletableFuture that completes with a collection of all objects

delete

public CompletableFuture<Void> delete(K key)

Description copied from interface: StorageProvider

Deletes an object from the storage.

Parameters:

key - The key of the object to delete

Returns:

A CompletableFuture that completes when the operation is done