COWList (warpscript 3.0.0 API)

java.lang.Object
- io.warp10.continuum.gts.COWList

All Implemented Interfaces:

java.lang.Iterable, java.util.Collection, java.util.List
```
public class COWList
extends java.lang.Object
implements java.util.List
```
Copy On Write List implementation backed by an existing array or bitset. Data is duplicated when the list is modified. The original array or bitset is never modified.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class COWList.TYPE

Nested Classes
Modifier and Type	Class and Description
`static class`	`COWList.TYPE`

Constructor Summary

Constructors
Constructor and Description
`COWList(java.util.BitSet elementData, int startIdx, int length)` Wrap a BitSet into a Copy On Write SubList
`COWList(double[] elementData, int startIdx, int length)` Wrap an array of double (primitive) into a Copy On Write SubList
`COWList(long[] elementData, int startIdx, int length)` Wrap an array of long (primitive) into a Copy On Write SubList
`COWList(java.lang.String[] elementData, int startIdx, int length)` Wrap an array of String into a Copy On Write SubList

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(int index, java.lang.Object element)` Modification of the underlying array or bitset is forbidden.
`boolean`	`add(java.lang.Object o)` Modification of the underlying array or bitset is forbidden.
`boolean`	`addAll(java.util.Collection c)` Modification of the underlying array or bitset is forbidden.
`boolean`	`addAll(int index, java.util.Collection c)` Modification of the underlying array or bitset is forbidden.
`void`	`clear()` Modification of the underlying array or bitset is forbidden.
`boolean`	`contains(java.lang.Object o)`
`boolean`	`containsAll(java.util.Collection c)`
`java.lang.Object`	`get(int index)` If not altered, get will return the element at index + startidx of the underlying array or bitset.
`COWList.TYPE`	`getDataType()` getDataType is only valid when the list has not been altered.
`int`	`indexOf(java.lang.Object o)`
`boolean`	`isEmpty()`
`boolean`	`isReadOnly()`
`java.util.Iterator`	`iterator()`
`int`	`lastIndexOf(java.lang.Object o)`
`java.util.ListIterator`	`listIterator()`
`java.util.ListIterator`	`listIterator(int index)`
`java.lang.Object`	`remove(int index)` Modification of the underlying array or bitset is forbidden.
`boolean`	`remove(java.lang.Object o)` Modification of the underlying array or bitset is forbidden.
`boolean`	`removeAll(java.util.Collection c)`
`void`	`replaceAll(java.util.function.UnaryOperator operator)` Modification of the underlying array or bitset is forbidden.
`boolean`	`retainAll(java.util.Collection c)`
`java.lang.Object`	`set(int index, java.lang.Object element)` Modification of the underlying array or bitset is forbidden.
`int`	`size()`
`void`	`sort(java.util.Comparator c)` Modification of the underlying array or bitset is forbidden.
`java.util.List`	`subList(int fromIndex, int toIndex)` When non altered, returns a new copy on write subList from existing one, backed by the original array.
`java.lang.Object[]`	`toArray()` creates a new long/double/String/boolean array from the current subList (deep copy).
`java.lang.Object[]`	`toArray(java.lang.Object[] a)` creates a new long/double/String/boolean/Object array from the current subList (deep copy).

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.List
equals, hashCode, spliterator

Methods inherited from interface java.util.Collection
parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable
forEach

- Constructor Detail
  - COWList
```
public COWList(long[] elementData,
               int startIdx,
               int length)
```
    Wrap an array of long (primitive) into a Copy On Write SubList
    
    Parameters:
    
    elementData - array of long
    
    startIdx - index of the first element
    
    length - length of the subList. startidx+length cannot exceed elementData.length
  - COWList
```
public COWList(double[] elementData,
               int startIdx,
               int length)
```
    Wrap an array of double (primitive) into a Copy On Write SubList
    
    Parameters:
    
    elementData - array of double
    
    startIdx - index of the first element
    
    length - length of the subList. startidx+length cannot exceed elementData.length
  - COWList
```
public COWList(java.util.BitSet elementData,
               int startIdx,
               int length)
```
    Wrap a BitSet into a Copy On Write SubList
    
    Parameters:
    
    elementData - BitSet
    
    startIdx - index of the first element
    
    length - length of the subList. startidx+length cannot exceed BitSet size
  - COWList
```
public COWList(java.lang.String[] elementData,
               int startIdx,
               int length)
```
    Wrap an array of String into a Copy On Write SubList
    
    Parameters:
    
    elementData - array of String
    
    startIdx - index of the first element
    
    length - length of the subList. startidx+length cannot exceed elementData.length
- Method Detail
  - getDataType
```
public COWList.TYPE getDataType()
```
    getDataType is only valid when the list has not been altered.
  - isReadOnly
```
public boolean isReadOnly()
```
  - indexOf
```
public int indexOf(java.lang.Object o)
```
    Specified by:
    
    indexOf in interface java.util.List
  - size
```
public int size()
```
    Specified by:
    
    size in interface java.util.Collection
    
    Specified by:
    
    size in interface java.util.List
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface java.util.Collection
    
    Specified by:
    
    isEmpty in interface java.util.List
  - contains
```
public boolean contains(java.lang.Object o)
```
    Specified by:
    
    contains in interface java.util.Collection
    
    Specified by:
    
    contains in interface java.util.List
  - iterator
```
public java.util.Iterator iterator()
```
    Specified by:
    
    iterator in interface java.lang.Iterable
    
    Specified by:
    
    iterator in interface java.util.Collection
    
    Specified by:
    
    iterator in interface java.util.List
  - add
```
public boolean add(java.lang.Object o)
```
    Modification of the underlying array or bitset is forbidden. add will allocate a new ArrayList, then alter this ArrayList.
    
    Specified by:
    
    add in interface java.util.Collection
    
    Specified by:
    
    add in interface java.util.List
  - remove
```
public boolean remove(java.lang.Object o)
```
    Modification of the underlying array or bitset is forbidden. remove will allocate a new ArrayList, then alter this ArrayList.
    
    Specified by:
    
    remove in interface java.util.Collection
    
    Specified by:
    
    remove in interface java.util.List
  - addAll
```
public boolean addAll(java.util.Collection c)
```
    Modification of the underlying array or bitset is forbidden. addAll will allocate a new ArrayList, then alter this ArrayList.
    
    Specified by:
    
    addAll in interface java.util.Collection
    
    Specified by:
    
    addAll in interface java.util.List
  - addAll
```
public boolean addAll(int index,
                      java.util.Collection c)
```
    Modification of the underlying array or bitset is forbidden. addAll will allocate a new ArrayList, then alter this ArrayList.
    
    Specified by:
    
    addAll in interface java.util.List
  - replaceAll
```
public void replaceAll(java.util.function.UnaryOperator operator)
```
    Modification of the underlying array or bitset is forbidden. replaceAll will allocate a new ArrayList, then alter this ArrayList.
    
    Specified by:
    
    replaceAll in interface java.util.List
  - sort
```
public void sort(java.util.Comparator c)
```
    Modification of the underlying array or bitset is forbidden. sort will allocate a new ArrayList, then alter this ArrayList.
    
    Specified by:
    
    sort in interface java.util.List
  - clear
```
public void clear()
```
    Modification of the underlying array or bitset is forbidden. clear will allocate a new ArrayList, then alter this ArrayList.
    
    Specified by:
    
    clear in interface java.util.Collection
    
    Specified by:
    
    clear in interface java.util.List
  - get
```
public java.lang.Object get(int index)
```
    If not altered, get will return the element at index + startidx of the underlying array or bitset. If altered, get will return the element of the underlying ArrayList.
    
    Specified by:
    
    get in interface java.util.List
    
    Parameters:
    
    index - cannot be less than 0 or greater than list length
    
    Returns:
    
    element at index + startidx
  - set
```
public java.lang.Object set(int index,
                            java.lang.Object element)
```
    Modification of the underlying array or bitset is forbidden. set will allocate a new ArrayList, then alter this ArrayList.
    
    Specified by:
    
    set in interface java.util.List
  - add
```
public void add(int index,
                java.lang.Object element)
```
    Modification of the underlying array or bitset is forbidden. add will allocate a new ArrayList, then alter this ArrayList.
    
    Specified by:
    
    add in interface java.util.List
  - remove
```
public java.lang.Object remove(int index)
```
    Modification of the underlying array or bitset is forbidden. remove will allocate a new ArrayList, then alter this ArrayList.
    
    Specified by:
    
    remove in interface java.util.List
  - lastIndexOf
```
public int lastIndexOf(java.lang.Object o)
```
    Specified by:
    
    lastIndexOf in interface java.util.List
  - listIterator
```
public java.util.ListIterator listIterator()
```
    Specified by:
    
    listIterator in interface java.util.List
  - listIterator
```
public java.util.ListIterator listIterator(int index)
```
    Specified by:
    
    listIterator in interface java.util.List
  - subList
```
public java.util.List subList(int fromIndex,
                              int toIndex)
```
    When non altered, returns a new copy on write subList from existing one, backed by the original array. When altered, returns a new ArrayList, backed by the same array The portion of the list is specified by fromIndex, inclusive, and toIndex, exclusive. (If fromIndex and toIndex are equal, the returned list is empty.)
    
    Specified by:
    
    subList in interface java.util.List
  - retainAll
```
public boolean retainAll(java.util.Collection c)
```
    Specified by:
    
    retainAll in interface java.util.Collection
    
    Specified by:
    
    retainAll in interface java.util.List
  - removeAll
```
public boolean removeAll(java.util.Collection c)
```
    Specified by:
    
    removeAll in interface java.util.Collection
    
    Specified by:
    
    removeAll in interface java.util.List
  - containsAll
```
public boolean containsAll(java.util.Collection c)
```
    Specified by:
    
    containsAll in interface java.util.Collection
    
    Specified by:
    
    containsAll in interface java.util.List
  - toArray
```
public java.lang.Object[] toArray(java.lang.Object[] a)
```
    creates a new long/double/String/boolean/Object array from the current subList (deep copy). if the array provided as a is not big enough, toArray allocates and returns a new array
    
    Specified by:
    
    toArray in interface java.util.Collection
    
    Specified by:
    
    toArray in interface java.util.List
  - toArray
```
public java.lang.Object[] toArray()
```
    creates a new long/double/String/boolean array from the current subList (deep copy).
    
    Specified by:
    
    toArray in interface java.util.Collection
    
    Specified by:
    
    toArray in interface java.util.List

Class COWList

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.List

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

Constructor Detail

COWList

COWList

COWList

COWList

Method Detail

getDataType

isReadOnly

indexOf

size

isEmpty

contains

iterator

add

remove

addAll

addAll

replaceAll

sort

clear

get

set

add

remove

lastIndexOf

listIterator

listIterator

subList

retainAll

removeAll

containsAll

toArray

toArray