org.spongepowered.api.data.value

Interface ValueFactory.BoundedValueBuilder<E>

Type Parameters:

E - The type of element

Enclosing interface:

ValueFactory

public 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
ValueFactory.BoundedValueBuilder<E>	actualValue(E actual) Sets the actual value.
MutableBoundedValue<E>	build() Builds a new MutableBoundedValue.
ValueFactory.BoundedValueBuilder<E>	comparator(Comparator<E> comparator) If E is not Comparable, a Comparator is required.
ValueFactory.BoundedValueBuilder<E>	defaultValue(E defaultValue) Sets the default value.
ValueFactory.BoundedValueBuilder<E>	maximum(E max) Sets the maximum supported value.
ValueFactory.BoundedValueBuilder<E>	minimum(E min) Sets the minimum supported value.

Method Detail

comparator

ValueFactory.BoundedValueBuilder<E> comparator(Comparator<E> comparator)

If E is not Comparable, a Comparator is required. The builder by default will attempt to check if the type is a Comparable and delegate to the default Comparable.compareTo(Object) for comparisons. In short, the Comparator is only required if the element is not Comparable, or custom comparisons are required.

Parameters:

comparator - The comparator to use

Returns:

This builder, for chaining

minimum

ValueFactory.BoundedValueBuilder<E> minimum(E min)

Sets the minimum supported value.

Parameters:

min - The minimum supported value

Returns:

This builder, for chaining

maximum

ValueFactory.BoundedValueBuilder<E> maximum(E max)

Sets the maximum supported value.

Parameters:

max - The maximum supported value

Returns:

This builder, for chaining

defaultValue

ValueFactory.BoundedValueBuilder<E> defaultValue(E defaultValue)

Sets the default value. This is required. If no value is set, the default value transitively sets the value.

Parameters:

defaultValue - The default value

Returns:

This builder, for chaining

actualValue

ValueFactory.BoundedValueBuilder<E> actualValue(E actual)

Sets the actual value. Though not required, if the value is different from the defaultValue(Object), it should be set.

Parameters:

actual - The actual value

Returns:

This builder, for chaining

build

MutableBoundedValue<E> build()

Builds a new MutableBoundedValue. The requirements are that the minimum(Object), maximum(Object), defaultValue(Object) are set, and if the E is not Comparable, comparator(Comparator) is set.

Returns:

The newly constructed value