Package org.spongepowered.api.data.persistence

Interface DataStore

public interface DataStore

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	DataStore.Builder

Method Summary

Modifier and Type	Method	Description
static DataStore.Builder	builder()	Returns the DataStore builder.
void	deserialize(DataManipulator.Mutable dataManipulator, DataView view)	Deserializes the data from the DataView and puts it in the DataManipulator.Mutable.
default DataManipulator.Mutable	deserialize(DataView view)	Deserializes the DataView as a DataManipulator.Mutable.
static <T,V extends Value<T>> DataStore	of(Key<V> key, DataQuery dataQuery, io.leangen.geantyref.TypeToken<? extends DataHolder> typeToken, io.leangen.geantyref.TypeToken<? extends DataHolder>... typeTokens)	Provides a DataStore for a single Key.
static <T,V extends Value<T>> DataStore	of(Key<V> key, DataQuery dataQuery, java.lang.Class<? extends DataHolder> type, java.lang.Class<? extends DataHolder>... types)	Provides a DataStore for a single Key.
default DataView	serialize(java.lang.Iterable<Value<?>> values)	Serializes the Values.
default DataView	serialize(java.lang.Iterable<Value<?>> values, DataView view)	Serializes the passed in values to the view.
default DataView	serialize(DataManipulator dataManipulator)	Serializes the values of the DataManipulator.
DataView	serialize(DataManipulator dataManipulator, DataView view)	Serializes the values of the DataManipulator into the DataView.
java.util.Collection<java.lang.reflect.Type>	supportedTypes()	Gets the supported DataHolder types.

Method Detail

supportedTypes

java.util.Collection<java.lang.reflect.Type> supportedTypes()

Gets the supported DataHolder types.

Every returned Type will be a subtype of DataHolder.

Returns:

The supported dataHolder type.

serialize

DataView serialize(DataManipulator dataManipulator,
                   DataView view)

Serializes the values of the DataManipulator into the DataView.

Parameters:

dataManipulator - The data manipulator

view - The data view to serialize to

Returns:

The view, for chaining

serialize

default DataView serialize(java.lang.Iterable<Value<?>> values,
                           DataView view)

Serializes the passed in values to the view.

Parameters:

values - The values to serialize

view - The view

Returns:

The view, for chaining

serialize

default DataView serialize(java.lang.Iterable<Value<?>> values)

Serializes the Values.

Parameters:

values - The value container

Returns:

This view, for chaining

serialize

default DataView serialize(DataManipulator dataManipulator)

Serializes the values of the DataManipulator.

Parameters:

dataManipulator - The data manipulator

Returns:

This view, for chaining

deserialize

void deserialize(DataManipulator.Mutable dataManipulator,
                 DataView view)

Deserializes the data from the DataView and puts it in the DataManipulator.Mutable.

Parameters:

dataManipulator - The mutable data manipulator

view - The data view to deserialize

deserialize

default DataManipulator.Mutable deserialize(DataView view)

Deserializes the DataView as a DataManipulator.Mutable.

Parameters:

view - The data view to deserialize

Returns:

The value store

of

@SafeVarargs
static <T,V extends Value<T>> DataStore of(Key<V> key,
                                                 DataQuery dataQuery,
                                                 io.leangen.geantyref.TypeToken<? extends DataHolder> typeToken,
                                                 io.leangen.geantyref.TypeToken<? extends DataHolder>... typeTokens)

Provides a DataStore for a single Key.

Note that default deserializers do not support Collection, Map or Array types! Use DataStore.Builder.SerializersStep.key(Key, BiConsumer, Function) for these.

Parameters:

key - The data key

dataQuery - The dataQuery to serialize this key under

typeTokens - The dataHolder types

Returns:

The new data store

of

@SafeVarargs
static <T,V extends Value<T>> DataStore of(Key<V> key,
                                                 DataQuery dataQuery,
                                                 java.lang.Class<? extends DataHolder> type,
                                                 java.lang.Class<? extends DataHolder>... types)

Provides a DataStore for a single Key.

Note that default deserializers do not support Collection, Map or Array types! Use DataStore.Builder.SerializersStep.key(Key, BiConsumer, Function) for these.

Parameters:

key - The data key

dataQuery - The dataQuery to serialize this key under

types - The dataHolder types

Returns:

The new data store

builder

static DataStore.Builder builder()

Returns the DataStore builder.

Returns:

The dataStore builder.