org.spongepowered.api.data.value.immutable

Interface ImmutableBoundedValue<E>

Type Parameters:

E - The type of element

All Superinterfaces:

BaseValue<E>, BoundedValue<E>, ImmutableValue<E>

public interface ImmutableBoundedValue<E>
extends BoundedValue<E>, ImmutableValue<E>

A type of BoundedValue that is immutable as an ImmutableValue.

Method Summary

Modifier and Type	Method and Description
MutableBoundedValue<E>	asMutable() Creates a mutable Value for this ImmutableValue.
ImmutableBoundedValue<E>	transform(Function<E,E> function) Retrieves the underlying value for this ImmutableValue and applies the given Function onto that value, after which, the product is sent to a new ImmutableValue replacing this one.

Methods inherited from interface org.spongepowered.api.data.value.BoundedValue

getComparator, getMaxValue, getMinValue

Methods inherited from interface org.spongepowered.api.data.value.immutable.ImmutableValue

with

Methods inherited from interface org.spongepowered.api.data.value.BaseValue

exists, get, getDefault, getDirect, getKey

Method Detail

transform

ImmutableBoundedValue<E> transform(Function<E,E> function)

Description copied from interface: ImmutableValue

Retrieves the underlying value for this ImmutableValue and applies the given Function onto that value, after which, the product is sent to a new ImmutableValue replacing this one.

If the ValueContainer too is immutable, a new instance of the ValueContainer may be created. If the ValueContainer is mutable, the same instance of the ValueContainer is retained.

Specified by:

transform in interface ImmutableValue<E>

Parameters:

function - The function to apply onto the existing value

Returns:

The owning ValueContainer, a new instance if it too is immutable

asMutable

MutableBoundedValue<E> asMutable()

Description copied from interface: ImmutableValue

Creates a mutable Value for this ImmutableValue.

Specified by:

asMutable in interface ImmutableValue<E>

Returns:

A mutable value