org.spongepowered.api.data.value.mutable

Interface PatternListValue

All Superinterfaces:

BaseValue<List<PatternLayer>>, CollectionValue<PatternLayer,List<PatternLayer>,ListValue<PatternLayer>,ImmutableListValue<PatternLayer>>, Iterable<PatternLayer>, ListValue<PatternLayer>, Value<List<PatternLayer>>

public interface PatternListValue
extends ListValue<PatternLayer>

Represents a customized ListValue handling PatternLayers. Virtually, this is the same as a ListValue; however, the core difference is the ability to add a BannerPatternShape and DyeColor to create a new PatternLayer.

Method Summary

Modifier and Type	Method and Description
PatternListValue	add(BannerPatternShape patternShape, DyeColor color) Creates and adds a new PatternLayer based on the provided BannerPatternShape and DyeColor.
PatternListValue	add(int index, BannerPatternShape patternShape, DyeColor color) Creates and adds a PatternLayer based on the BannerPatternShape and DyeColor at the desired index such that the element at the provided index is shifted to the left.
PatternListValue	add(int index, Iterable<PatternLayer> values) Adds the specified elements in the order that they are iterated to the list at the specified index.
PatternListValue	add(int index, PatternLayer value) Adds the specified element at the specified position in the list.
PatternListValue	add(PatternLayer element) Adds the given element to this CollectionValue.
PatternListValue	addAll(Iterable<PatternLayer> elements) Adds all the given Iterable elements to the underlying Collection.
ImmutablePatternListValue	asImmutable() Gets the ImmutableValue version of this Value such that all data is duplicated across to the new ImmutableValue.
PatternListValue	filter(Predicate<? super PatternLayer> predicate) Applies a Predicate to filter the underlying elements in the backed Collection to create a new CollectionValue separate from this CollectionValue.
PatternListValue	remove(int index) Removes the element at the specified position in this list (optional operation).
PatternListValue	remove(PatternLayer element) Removes the given element from the backed Collection.
PatternListValue	removeAll(Iterable<PatternLayer> elements) Removes all elements from the Iterable from the backed Collection.
PatternListValue	removeAll(Predicate<PatternLayer> predicate) Iterates over all existing elements and removes any elements that Predicate.test(Object) returns true.
PatternListValue	set(int index, PatternLayer element) Replaces the element at the specified index in this list with the specified element.
PatternListValue	set(List<PatternLayer> value) Sets the underlying value to the provided value.
PatternListValue	transform(Function<List<PatternLayer>,List<PatternLayer>> function) Attempts to transform the underlying value based on the provided Function such that the result of Function.apply(Object) will replace the underlying value.

Methods inherited from interface org.spongepowered.api.data.value.mutable.ListValue

get, indexOf

Methods inherited from interface org.spongepowered.api.data.value.mutable.CollectionValue

contains, containsAll, copy, getAll, isEmpty, size

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

exists, get, getDefault, getDirect, getKey

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

add

PatternListValue add(PatternLayer element)

Description copied from interface: CollectionValue

Adds the given element to this CollectionValue.

Specified by:

add in interface CollectionValue<PatternLayer,List<PatternLayer>,ListValue<PatternLayer>,ImmutableListValue<PatternLayer>>

Parameters:

element - The element to add

Returns:

This value, for chaining

add

PatternListValue add(BannerPatternShape patternShape,
                     DyeColor color)

Creates and adds a new PatternLayer based on the provided BannerPatternShape and DyeColor.

Parameters:

patternShape - The pattern shape

color - The color

Returns:

This value, for chaining

add

PatternListValue add(int index,
                     PatternLayer value)

Description copied from interface: ListValue

Adds the specified element at the specified position in the list. As well, the element at the provided index is shifted to the right, increasing its and the elements thereafter their indices by one.

Specified by:

add in interface ListValue<PatternLayer>

Parameters:

index - The index to add the provided element at

value - The element to add

Returns:

This value, for chaining

add

PatternListValue add(int index,
                     BannerPatternShape patternShape,
                     DyeColor color)

Creates and adds a PatternLayer based on the BannerPatternShape and DyeColor at the desired index such that the element at the provided index is shifted to the left.

Parameters:

index - The index to add the element at

patternShape - The pattern shape

color - The color of the pattern

Returns:

This value, for chaining

add

PatternListValue add(int index,
                     Iterable<PatternLayer> values)

Description copied from interface: ListValue

Adds the specified elements in the order that they are iterated to the list at the specified index. The element at the provided index and elements thereafter are shifted to the right, increasing their indices by one.

Specified by:

add in interface ListValue<PatternLayer>

Parameters:

index - The index to add the elements at

values - The elements to add

Returns:

This value, for chaining

set

PatternListValue set(int index,
                     PatternLayer element)

Description copied from interface: ListValue

Replaces the element at the specified index in this list with the specified element.

Specified by:

set in interface ListValue<PatternLayer>

Parameters:

index - The index to replace the element with

element - The element to set

Returns:

This value, for chaining

set

PatternListValue set(List<PatternLayer> value)

Description copied from interface: Value

Sets the underlying value to the provided value.

Specified by:

set in interface CollectionValue<PatternLayer,List<PatternLayer>,ListValue<PatternLayer>,ImmutableListValue<PatternLayer>>

Specified by:

set in interface Value<List<PatternLayer>>

Parameters:

value - The value to set

Returns:

The owning ValueContainer

transform

PatternListValue transform(Function<List<PatternLayer>,List<PatternLayer>> function)

Description copied from interface: Value

Attempts to transform the underlying value based on the provided Function such that the result of Function.apply(Object) will replace the underlying value.

Specified by:

transform in interface CollectionValue<PatternLayer,List<PatternLayer>,ListValue<PatternLayer>,ImmutableListValue<PatternLayer>>

Specified by:

transform in interface Value<List<PatternLayer>>

Parameters:

function - The function to apply on the existing value

Returns:

The owning ValueContainer

addAll

PatternListValue addAll(Iterable<PatternLayer> elements)

Description copied from interface: CollectionValue

Adds all the given Iterable elements to the underlying Collection.

Specified by:

addAll in interface CollectionValue<PatternLayer,List<PatternLayer>,ListValue<PatternLayer>,ImmutableListValue<PatternLayer>>

Parameters:

elements - The elements to add

Returns:

This value, for chaining

See Also:

Collection.addAll(Collection)

remove

PatternListValue remove(int index)

Description copied from interface: ListValue

Removes the element at the specified position in this list (optional operation). Shifts any subsequent elements to the left, subtracts one from their indices.

Specified by:

remove in interface ListValue<PatternLayer>

Parameters:

index - The index of the element to remove

Returns:

This value, for chaining

remove

PatternListValue remove(PatternLayer element)

Description copied from interface: CollectionValue

Removes the given element from the backed Collection.

Specified by:

remove in interface CollectionValue<PatternLayer,List<PatternLayer>,ListValue<PatternLayer>,ImmutableListValue<PatternLayer>>

Parameters:

element - The element to remove

Returns:

This value, for chaining

removeAll

PatternListValue removeAll(Iterable<PatternLayer> elements)

Description copied from interface: CollectionValue

Removes all elements from the Iterable from the backed Collection.

Specified by:

removeAll in interface CollectionValue<PatternLayer,List<PatternLayer>,ListValue<PatternLayer>,ImmutableListValue<PatternLayer>>

Parameters:

elements - The elements to remove

Returns:

This value, for chaining

removeAll

PatternListValue removeAll(Predicate<PatternLayer> predicate)

Description copied from interface: CollectionValue

Iterates over all existing elements and removes any elements that Predicate.test(Object) returns true.

Specified by:

removeAll in interface CollectionValue<PatternLayer,List<PatternLayer>,ListValue<PatternLayer>,ImmutableListValue<PatternLayer>>

Parameters:

predicate - The predicate to remove elements

Returns:

This value, for chaining

filter

PatternListValue filter(Predicate<? super PatternLayer> predicate)

Description copied from interface: CollectionValue

Applies a Predicate to filter the underlying elements in the backed Collection to create a new CollectionValue separate from this CollectionValue. This value is not modified, nor is the underlying Collection. Elements that return true from Predicate.test(Object) are kept, and those that return false are excluded.

Specified by:

filter in interface CollectionValue<PatternLayer,List<PatternLayer>,ListValue<PatternLayer>,ImmutableListValue<PatternLayer>>

Parameters:

predicate - The predicate to filter

Returns:

This value, for chaining

asImmutable

ImmutablePatternListValue asImmutable()

Description copied from interface: Value

Gets the ImmutableValue version of this Value such that all data is duplicated across to the new ImmutableValue. Note that once created, the ImmutableValue is not going to change.

Specified by:

asImmutable in interface CollectionValue<PatternLayer,List<PatternLayer>,ListValue<PatternLayer>,ImmutableListValue<PatternLayer>>

Specified by:

asImmutable in interface Value<List<PatternLayer>>

Returns:

A new ImmutableValue instance