Interface ListMutator

Protocol for mutation of a MutableList.

See also MutableList

no type hierarchy

ListMutator
- IndexedCorrespondenceMutator
  - CorrespondenceMutator
- List
  - Collection
    Iterable
    Category
  - Correspondence
  - Ranged
    Iterable
    Category

ListMutator
- MutableList
  - Array
    JsonArray
  - ArrayList
  - CeylonMutableList
  - CeylonStringMutableList
  - LinkedList
  - TomlArray

Inherited Attributes
Attributes inherited from: `Object` `hash`, `string`
Attributes inherited from: `Collection<Element>` `empty`, `permutations`, `string`
Attributes inherited from: `Correspondence<Key,Item>` `keys`
Attributes inherited from: `Iterable<Element,Absent>` `coalesced`, `cycled`, `distinct`, `empty`, `exceptLast`, `first`, `indexed`, `last`, `paired`, `rest`, `size`, `string`
Attributes inherited from: `List<Element>` `first`, `hash`, `keys`, `last`, `lastIndex`, `rest`, `reversed`, `size`

Methods
`add`	Source Code `shared formal void add(Element element)` Add the given `element` to the end of this list, incrementing the length of the list.
`addAll`	Source Code `shared default void addAll({Element}Go to Iterable abbreviation {X+} or {X} means Iterable<X,Nothing> or Iterable<X,Null> elements)` Add the given `elements` to the end of this list, increasing the length of the list.
`clear`	Source Code`shared default void clear()` Remove every element from this list, leaving an empty list with no elements.
`clone`	Source Code`shared formal ListMutator<Element> clone()` A shallow copy of this collection, that is, a collection with identical elements which does not change if this collection changes. If this collection is immutable, it is acceptable to return a reference to this collection. If this collection is mutable, a newly instantiated collection must be returned. Refines `List.clone` ultimately refines `Collection.clone`
`delete`	Source Code `shared formal Anything delete(Integer index)` Remove the element at the specified `index`, returning the removed element, if any, or `null` if there was no such element.
`deleteFirst`	Source Code`shared default Anything deleteFirst()` Remove the element with index `0` from this list, returning the removed element, or `null` if there was no such element.
`deleteLast`	Source Code`shared default Anything deleteLast()` Remove the element with index `size-1` from this list, returning the removed element, or `null` if there was no such element.
`deleteMeasure`	Source Code `shared default void deleteMeasure(Integer from, Integer length)` Remove every element with an index in the measured range `from:length`. If `length<=0`, no elements are removed.
`deleteSpan`	Source Code `shared default void deleteSpan(Integer from, Integer to)` Remove every element with an index in the spanned range `from..to`.
`infill`	Source Code`shared formal void infill(Element replacement)` Replace all null values in this list with the given replacement value. Parameters: `replacement` The replacement value
`insert`	Source Code `shared formal void insert(Integer index, Element element)` Insert the given `element` at the specified `index`, incrementing the length of the list. Throws `AssertionError` if the given index is out of bounds, that is, if `index<0` or if `index>lastIndex+1`
`insertAll`	Source Code `shared default void insertAll(Integer index, {Element}Go to Iterable abbreviation {X+} or {X} means Iterable<X,Nothing> or Iterable<X,Null> elements)` Insert the given `elements` at the specified `index`, growing the length of the list by the number of given elements. Throws `AssertionError` if the given index is out of bounds, that is, if `index<0` or if `index>lastIndex+1`
`move`	Source Code`shared formal void move(Integer i, Integer j)` Efficiently move the element of this list at the given source index to the given destination index, shifting every element falling between the two given indices by one position to accommodate the change of position. If the source index is larger than the destination index, elements are shifted toward the end of the list. If the source index is smaller than the destination index, elements are shifted toward the start of the list. If the given indices are identical, no change is made to the list. Parameters: `i` The source index of the element to move. `j` The destination index to which the element is moved. Throws `AssertionError` if either of the given indices is out of bounds
`prune`	Source Code`shared formal Integer prune()` Remove all null elements from this list, leaving a list with no null elements, returning the number of elements removed.
`remove`	Source Code`shared formal Integer remove(Element&Object element)` Remove all occurrences of the given value from this list, returning the number of elements removed. To remove just one occurrence of the given value, use `removeFirst()` or `removeLast()`. Parameters: `element` The non-null value to remove
`removeAll`	Source Code`shared default Integer removeAll({Element&Object}Go to Iterable abbreviation {X+} or {X} means Iterable<X,Nothing> or Iterable<X,Null> elements)` Remove all occurrences of every one of the given values from this list, returning the number of elements removed. Parameters: `elements` The non-null values to remove
`removeFirst`	Source Code`shared formal Boolean removeFirst(Element&Object element)` Remove the first occurrence of the given value from this list, if any, returning `true` if the value occurs in the list, or `false` otherwise. Parameters: `element` The non-null value to remove
`removeLast`	Source Code`shared formal Boolean removeLast(Element&Object element)` Remove the last occurrence of the given value from this list, if any, returning `true` if the value occurs in the list, or `false` otherwise. Parameters: `element` The non-null value to remove
`replace`	Source Code`shared formal Integer replace(Element&Object element, Element replacement)` Replace all occurrences of the given value in this list with the given replacement value. To replace just one occurrence of the given value, use `replaceFirst()` or `replaceLast()`. Parameters: `element` The non-null value to replace `replacement` The replacement value
`replaceFirst`	Source Code`shared formal Boolean replaceFirst(Element&Object element, Element replacement)` Replace the first occurrence of the given value in this list, if any, with the given replacement value, returning `true` if the value occurs in the list, or `false` otherwise. Parameters: `element` The non-null value to replace `replacement` The replacement value
`replaceLast`	Source Code`shared formal Boolean replaceLast(Element&Object element, Element replacement)` Replace the last occurrence of the given value in this list, if any, with the given replacement value, returning `true` if the value occurs in the list, or `false` otherwise. Parameters: `element` The non-null value to replace `replacement` The replacement value
`set`	Source Code `shared formal void set(Integer index, Element element)` Replace the existing element at the specified `index` with the given `element`. Throws `AssertionError` if the given index is out of bounds, that is, if `index<0` or if `index>lastIndex` Refines `IndexedCorrespondenceMutator.set`
`swap`	Source Code`shared formal void swap(Integer i, Integer j)` Given two indices within this list, swap the positions of the elements at these indices. If the two given indices are identical, no change is made to the list. Parameters: `i` The index of the first element. `j` The index of the second element. Throws `AssertionError` if either of the given indices is out of bounds
`truncate`	Source Code`shared default void truncate(Integer size)` Truncate this list to the given `size` by removing elements from the end of the list, if necessary, leaving a list with at most the given size. Parameters: `size` `size >= 0` Throws `AssertionError` if `size<0`

Inherited Methods
Methods inherited from: `Object` `equals()`
Methods inherited from: `Category<Element>` `contains()`, `containsAny()`, `containsEvery()`
Methods inherited from: `Collection<Element>` `clone()`, `combinations()`, `contains()`
Methods inherited from: `Correspondence<Key,Item>` `defines()`, `definesAny()`, `definesEvery()`, `get()`, `getAll()`
Methods inherited from: `IndexedCorrespondenceMutator<Element>` `set()`
Methods inherited from: `Iterable<Element,Absent>` `any()`, `by()`, `chain()`, `collect()`, `contains()`, `count()`, `defaultNullElements()`, `each()`, `every()`, `filter()`, `find()`, `findLast()`, `flatMap()`, `fold()`, `follow()`, `frequencies()`, `getFromFirst()`, `group()`, `indexes()`, `interpose()`, `iterator()`, `locate()`, `locateLast()`, `locations()`, `longerThan()`, `map()`, `max()`, `narrow()`, `partition()`, `product()`, `reduce()`, `repeat()`, `scan()`, `select()`, `sequence()`, `shorterThan()`, `skip()`, `skipWhile()`, `sort()`, `spread()`, `summarize()`, `tabulate()`, `take()`, `takeWhile()`
Methods inherited from: `List<Element>` `clone()`, `collect()`, `contains()`, `defines()`, `endsWith()`, `equals()`, `find()`, `findLast()`, `firstIndexWhere()`, `get()`, `getFromFirst()`, `getFromLast()`, `indexesWhere()`, `initial()`, `iterator()`, `lastIndexWhere()`, `longerThan()`, `mapElements()`, `measure()`, `patch()`, `repeat()`, `shorterThan()`, `slice()`, `span()`, `spanFrom()`, `spanTo()`, `startsWith()`, `sublist()`, `sublistFrom()`, `sublistTo()`, `terminal()`, `trim()`, `trimLeading()`, `trimTrailing()`
Methods inherited from: `Ranged<Index,Element,Subrange>` `measure()`, `span()`, `spanFrom()`, `spanTo()`

Keyboard Shortcuts

Documentation:

Search page:

Filter declarations by tags