ImmutablePatternListValue (SpongeAPI 7.3.0 API)

All Superinterfaces:

BaseValue<List<PatternLayer>>, ImmutableCollectionValue<PatternLayer,List<PatternLayer>,ImmutableListValue<PatternLayer>,ListValue<PatternLayer>>, ImmutableListValue<PatternLayer>, ImmutableValue<List<PatternLayer>>
```
public interface ImmutablePatternListValue
extends ImmutableListValue<PatternLayer>
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`PatternListValue`	`asMutable()` Creates a mutable `Value` for this `ImmutableValue`.
`ImmutablePatternListValue`	`set(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.
`ImmutablePatternListValue`	`set(int index, PatternLayer element)` Creates a new `ImmutableListValue` with the desired element at the desired index.
`ImmutablePatternListValue`	`with(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.
`ImmutablePatternListValue`	`with(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.
`ImmutablePatternListValue`	`with(int index, Iterable<PatternLayer> values)` Creates a new `ImmutableListValue` with the specified elements in the order that they are iterated to the list at the specified index.
`ImmutablePatternListValue`	`with(int index, PatternLayer value)` Creates a new `ImmutableListValue` with the specified element at the specified position in the list.
`ImmutablePatternListValue`	`with(List<PatternLayer> collection)` Creates a new `ImmutableValue` with the given `E` typed value, such that if the owning `ValueContainer` is immutable, the `ValueContainer` too is recreated as a new instance with the new `ImmutableValue`.
`ImmutablePatternListValue`	`withAll(Iterable<PatternLayer> elements)` Creates a new `ImmutableCollectionValue` with the given elements along with any pre-existing values within this value.
`ImmutablePatternListValue`	`withElement(PatternLayer elements)` Creates a new `ImmutableCollectionValue` with the given values along with any pre-existing values within this value.
`ImmutablePatternListValue`	`without(int index)` Creates a new `ImmutableListValue` without the element at the specified index.
`ImmutablePatternListValue`	`without(PatternLayer element)` Creates a new `ImmutableCollectionValue` without the given `E` element.
`ImmutablePatternListValue`	`withoutAll(Iterable<PatternLayer> elements)` Creates a new `ImmutableCollectionValue` without the given elements of the provided `Iterable`.
`ImmutablePatternListValue`	`withoutAll(Predicate<PatternLayer> predicate)` Creates a new `ImmutableCollectionValue` with elements that when the given `Predicate` is `Predicate.test(Object)` on the element and `true` is returned, the element will remain in the new `ImmutableCollectionValue`.

Methods inherited from interface org.spongepowered.api.data.value.immutable.ImmutableListValue
get, indexOf

Methods inherited from interface org.spongepowered.api.data.value.immutable.ImmutableCollectionValue
contains, containsAll, getAll, isEmpty, size, transform

Methods inherited from interface org.spongepowered.api.data.value.BaseValue
exists, get, getDefault, getDirect, getKey

- Method Detail
  - with
```
ImmutablePatternListValue with(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. This returns a new ImmutablePatternListValue.
    
    Parameters:
    
    patternShape - The pattern shape
    
    color - The color of the pattern
    
    Returns:
    
    The new value, for chaining
  - with
```
ImmutablePatternListValue with(int index,
                               PatternLayer value)
```
    Description copied from interface: ImmutableListValue
    
    Creates a new ImmutableListValue with 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:
    
    with in interface ImmutableListValue<PatternLayer>
    
    Parameters:
    
    index - The index to add the provided element at
    
    value - The element to add
    
    Returns:
    
    The new value, for chaining
  - with
```
ImmutablePatternListValue with(int index,
                               Iterable<PatternLayer> values)
```
    Description copied from interface: ImmutableListValue
    
    Creates a new ImmutableListValue with 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:
    
    with in interface ImmutableListValue<PatternLayer>
    
    Parameters:
    
    index - The index to add the elements at
    
    values - The elements to add
    
    Returns:
    
    The new value, for chaining
  - with
```
ImmutablePatternListValue with(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:
    
    The new value, for chaining
  - with
```
ImmutablePatternListValue with(List<PatternLayer> collection)
```
    Description copied from interface: ImmutableValue
    
    Creates a new ImmutableValue with the given E typed value, such that if the owning ValueContainer is immutable, the ValueContainer too is recreated as a new instance with the new ImmutableValue.
    
    Specified by:
    
    with in interface ImmutableCollectionValue<PatternLayer,List<PatternLayer>,ImmutableListValue<PatternLayer>,ListValue<PatternLayer>>
    
    Specified by:
    
    with in interface ImmutableValue<List<PatternLayer>>
    
    Parameters:
    
    collection - The value to replace
    
    Returns:
    
    The owning ValueContainer, a new instance if it too is immutable
  - withElement
```
ImmutablePatternListValue withElement(PatternLayer elements)
```
    Description copied from interface: ImmutableCollectionValue
    
    Creates a new ImmutableCollectionValue with the given values along with any pre-existing values within this value.
    
    Specified by:
    
    withElement in interface ImmutableCollectionValue<PatternLayer,List<PatternLayer>,ImmutableListValue<PatternLayer>,ListValue<PatternLayer>>
    
    Parameters:
    
    elements - The values to add
    
    Returns:
    
    The new value
  - withAll
```
ImmutablePatternListValue withAll(Iterable<PatternLayer> elements)
```
    Description copied from interface: ImmutableCollectionValue
    
    Creates a new ImmutableCollectionValue with the given elements along with any pre-existing values within this value.
    
    Specified by:
    
    withAll in interface ImmutableCollectionValue<PatternLayer,List<PatternLayer>,ImmutableListValue<PatternLayer>,ListValue<PatternLayer>>
    
    Parameters:
    
    elements - The elements to add
    
    Returns:
    
    The new value
    
    See Also:
    
    Collection.addAll(Collection)
  - set
```
ImmutablePatternListValue set(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:
    
    The new value, for chaining
  - set
```
ImmutablePatternListValue set(int index,
                              PatternLayer element)
```
    Description copied from interface: ImmutableListValue
    
    Creates a new ImmutableListValue with the desired element at the desired index.
    
    Specified by:
    
    set in interface ImmutableListValue<PatternLayer>
    
    Parameters:
    
    index - The index to replace the element
    
    element - The element to include at the index
    
    Returns:
    
    The new value, for chaining
  - without
```
ImmutablePatternListValue without(PatternLayer element)
```
    Description copied from interface: ImmutableCollectionValue
    
    Creates a new ImmutableCollectionValue without the given E element.
    
    Specified by:
    
    without in interface ImmutableCollectionValue<PatternLayer,List<PatternLayer>,ImmutableListValue<PatternLayer>,ListValue<PatternLayer>>
    
    Parameters:
    
    element - The element to exclude
    
    Returns:
    
    The new value
  - without
```
ImmutablePatternListValue without(int index)
```
    Description copied from interface: ImmutableListValue
    
    Creates a new ImmutableListValue without the element at the specified index. Shifts any subsequent elements to the left, subtracts one from their indices.
    
    Specified by:
    
    without in interface ImmutableListValue<PatternLayer>
    
    Parameters:
    
    index - The index of the element to exclude
    
    Returns:
    
    The new value, for chaining
  - withoutAll
```
ImmutablePatternListValue withoutAll(Iterable<PatternLayer> elements)
```
    Description copied from interface: ImmutableCollectionValue
    
    Creates a new ImmutableCollectionValue without the given elements of the provided Iterable.
    
    Specified by:
    
    withoutAll in interface ImmutableCollectionValue<PatternLayer,List<PatternLayer>,ImmutableListValue<PatternLayer>,ListValue<PatternLayer>>
    
    Parameters:
    
    elements - The elements to exclude
    
    Returns:
    
    The new value
  - withoutAll
```
ImmutablePatternListValue withoutAll(Predicate<PatternLayer> predicate)
```
    Description copied from interface: ImmutableCollectionValue
    
    Creates a new ImmutableCollectionValue with elements that when the given Predicate is Predicate.test(Object) on the element and true is returned, the element will remain in the new ImmutableCollectionValue.
    
    Specified by:
    
    withoutAll in interface ImmutableCollectionValue<PatternLayer,List<PatternLayer>,ImmutableListValue<PatternLayer>,ListValue<PatternLayer>>
    
    Parameters:
    
    predicate - The predicte to apply
    
    Returns:
    
    The new value
  - asMutable
```
PatternListValue asMutable()
```
    Description copied from interface: ImmutableValue
    
    Creates a mutable Value for this ImmutableValue.
    
    Specified by:
    
    asMutable in interface ImmutableCollectionValue<PatternLayer,List<PatternLayer>,ImmutableListValue<PatternLayer>,ListValue<PatternLayer>>
    
    Specified by:
    
    asMutable in interface ImmutableValue<List<PatternLayer>>
    
    Returns:
    
    A mutable value

Interface ImmutablePatternListValue

Method Summary

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

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

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

Method Detail

with

with

with

with

with

withElement

withAll

set

set

without

without

withoutAll

withoutAll

asMutable