org.spongepowered.api.data.value

Interface ValueFactory

public interface ValueFactory

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ValueFactory.BoundedValueBuilder<E> A builder pattern for constructing MutableBoundedValues without the hassle of keeping track of the order of arguments.

Method Summary

Modifier and Type	Method and Description
<E> ValueFactory.BoundedValueBuilder<E>	createBoundedValueBuilder(Key<MutableBoundedValue<E>> key) Creates a ValueFactory.BoundedValueBuilder
<E> ListValue<E>	createListValue(Key<ListValue<E>> key, List<E> elements) Creates a new ListValue with the provided Key and List of elements.
<E> ListValue<E>	createListValue(Key<ListValue<E>> key, List<E> elements, List<E> defaults) Creates a new ListValue with the provided Key and List of elements.
<K,V> MapValue<K,V>	createMapValue(Key<MapValue<K,V>> key, Map<K,V> map) Creates a new MapValue of the provided Key with the types K and V.
<K,V> MapValue<K,V>	createMapValue(Key<MapValue<K,V>> key, Map<K,V> map, Map<K,V> defaults) Creates a new MapValue of the provided Key with the types K and V along with the provided Map defaults.
<E> OptionalValue<E>	createOptionalValue(Key<OptionalValue<E>> key, E element) Creates an OptionalValue where even the default value may be Optional.empty().
<E> OptionalValue<E>	createOptionalValue(Key<OptionalValue<E>> key, E element, E defaultElement) Creates an OptionalValue where the default is NOT null, such that the actual value may be retained as null.
<E> SetValue<E>	createSetValue(Key<SetValue<E>> key, Set<E> elements) Creates a new SetValue with the provided Key and Set of elements.
<E> SetValue<E>	createSetValue(Key<SetValue<E>> key, Set<E> elements, Set<E> defaults) Creates a new SetValue with the provided Key and Set of elements.
<E> Value<E>	createValue(Key<Value<E>> key, E element) Creates a new Value with the provided Key and the E element.
<E> Value<E>	createValue(Key<Value<E>> key, E element, E defaultValue) Creates a new Value with the provided Key and the E element and the provided E default value.

Method Detail

createValue

<E> Value<E> createValue(Key<Value<E>> key,
                         E element)

Creates a new Value with the provided Key and the E element.

Type Parameters:

E - The type of element

Parameters:

key - The key for the value

element - The element

Returns:

The newly created value

createValue

<E> Value<E> createValue(Key<Value<E>> key,
                         E element,
                         E defaultValue)

Creates a new Value with the provided Key and the E element and the provided E default value.

Type Parameters:

E - The type of element

Parameters:

key - The key for the value

element - The element

defaultValue - The default value

Returns:

The newly created value

createListValue

<E> ListValue<E> createListValue(Key<ListValue<E>> key,
                                 List<E> elements)

Creates a new ListValue with the provided Key and List of elements. The default value will be an empty list.

Type Parameters:

E - The type of element

Parameters:

key - The key for the value

elements - The list of elements

Returns:

The list value

createListValue

<E> ListValue<E> createListValue(Key<ListValue<E>> key,
                                 List<E> elements,
                                 List<E> defaults)

Creates a new ListValue with the provided Key and List of elements.

Type Parameters:

E - The type of element

Parameters:

key - The key for the value

elements - The list of elements

defaults - The default list

Returns:

The list value

createSetValue

<E> SetValue<E> createSetValue(Key<SetValue<E>> key,
                               Set<E> elements)

Creates a new SetValue with the provided Key and Set of elements.

Type Parameters:

E - The type of element

Parameters:

key - The key for the value

elements - The set of elements

Returns:

The set value

createSetValue

<E> SetValue<E> createSetValue(Key<SetValue<E>> key,
                               Set<E> elements,
                               Set<E> defaults)

Creates a new SetValue with the provided Key and Set of elements.

Type Parameters:

E - The type of element

Parameters:

key - The key for the value

elements - The set of elements

defaults - The default set

Returns:

The set value

createMapValue

<K,V> MapValue<K,V> createMapValue(Key<MapValue<K,V>> key,
                                   Map<K,V> map)

Creates a new MapValue of the provided Key with the types K and V.

Type Parameters:

K - The type of key

V - The type of value

Parameters:

key - The key for the value

map - The map of elements

Returns:

The map value

createMapValue

<K,V> MapValue<K,V> createMapValue(Key<MapValue<K,V>> key,
                                   Map<K,V> map,
                                   Map<K,V> defaults)

Creates a new MapValue of the provided Key with the types K and V along with the provided Map defaults.

Type Parameters:

K - The type of key

V - The type of value

Parameters:

key - The key for the value

map - The map of elements

defaults - The default map

Returns:

The map value

createBoundedValueBuilder

<E> ValueFactory.BoundedValueBuilder<E> createBoundedValueBuilder(Key<MutableBoundedValue<E>> key)

Creates a ValueFactory.BoundedValueBuilder

Type Parameters:

E - The type of value

Parameters:

key - The key to the value

Returns:

The newly created value

createOptionalValue

<E> OptionalValue<E> createOptionalValue(Key<OptionalValue<E>> key,
                                         @Nullable
                                         E element)

Creates an OptionalValue where even the default value may be Optional.empty(). These types of values should be restricted to values that are live, that can be potentially large to retain a reference to, and otherwise, not thread safe.

Type Parameters:

E - The type of element

Parameters:

key - The key to the value

element - The element, if available

Returns:

The newly created value

createOptionalValue

<E> OptionalValue<E> createOptionalValue(Key<OptionalValue<E>> key,
                                         @Nullable
                                         E element,
                                         E defaultElement)

Creates an OptionalValue where the default is NOT null, such that the actual value may be retained as null.

Type Parameters:

E - The type of element

Parameters:

key - The key of the value

element - The element

defaultElement - The default value

Returns:

The newly created value