List (Groovy JDK enhancements)

Methods Summary

Methods
Return type	Name and parameters
`boolean`	`addAll(int index, Object[] items)` Modifies this list by inserting all of the elements in the specified array into the list at the specified position.
`List`	`asImmutable()` A convenience method for creating an immutable list
`List`	`asSynchronized()` A convenience method for creating a synchronized List.
`List`	`drop(int num)` Drops the given number of elements from the head of this List.
`List`	`dropRight(int num)` Drops the given number of elements from the tail of this List.
`List`	`dropWhile(Closure condition)` Returns a suffix of this List where elements are dropped from the front while the given Closure evaluates to true.
`List`	`each(Closure closure)` Iterates through an List, passing each item to the given closure.
`List`	`eachWithIndex(Closure closure)` Iterates through an List, passing each item and the item's index (a counter starting at zero) to the given closure.
`boolean`	`equals(Object[] right)` Determines if the contents of this list are equal to the contents of the given array in the same order.
`boolean`	`equals(List right)` Compare the contents of two Lists.
`Process`	`execute()` Executes the command specified by the given list.
`Process`	`execute(String[] envp, File dir)` Executes the command specified by the given list, with the environment defined by `envp` and under the working directory `dir`.
`Process`	`execute(List envp, File dir)` Executes the command specified by the given list, with the environment defined by `envp` and under the working directory `dir`.
`List`	`findAll()` Finds the items matching the IDENTITY Closure (i.e. matching Groovy truth).
`List`	`findAll(Closure closure)` Finds all values matching the closure condition.
`Object`	`first()` Returns the first item from the List.
`List`	`flatten()` Flatten a List.
`List`	`getAt(EmptyRange range)` Support the range subscript operator for a List.
`List`	`getAt(Range range)` Support the range subscript operator for a List.
`Object`	`getAt(int idx)` Support the subscript operator for a List.
`List`	`getAt(Collection indices)` Select a List of items from a List using a Collection to identify the indices to be selected.
`List`	`grep()` Iterates over the collection returning each element that matches using the IDENTITY Closure as a filter - effectively returning all elements which satisfy Groovy truth.
`List`	`grep(Object filter)` Iterates over the collection of items and returns each item that matches the given filter - calling the `Object#isCase(java.lang.Object)` method used by switch statements.
`Object`	`head()` Returns the first item from the List.
`List`	`init()` Returns the items from the List excluding the last item.
`List`	`intersect(Iterable right)` Create a List composed of the intersection of a List and an Iterable.
`Object`	`last()` Returns the last item from the List.
`List`	`leftShift(Object value)` Overloads the left shift operator to provide an easy way to append objects to a List.
`List`	`minus(Iterable removeMe)` Create a new List composed of the elements of the first List minus every occurrence of elements of the given Iterable.
`List`	`minus(Object removeMe)` Create a new List composed of the elements of the first List minus every occurrence of the given element to remove.
`List`	`minus(Collection removeMe)` Create a List composed of the elements of the first list minus every occurrence of elements of the given Collection.
`List`	`multiply(Number factor)` Create a List composed of the elements of this Iterable, repeated a certain number of times.
`List`	`plus(int index, Iterable additions)` Creates a new List by inserting all of the elements in the given Iterable to the elements from this List at the specified index.
`List`	`plus(int index, Object[] items)` Creates a new List by inserting all of the elements in the specified array to the elements from the original List at the specified index.
`List`	`plus(int index, List additions)` Creates a new List by inserting all of the elements in the given additions List to the elements from the original List at the specified index.
`List`	`plus(Iterable right)` Create a List as a union of a List and an Iterable.
`List`	`plus(Object right)` Create a List as a union of a List and an Object.
`List`	`plus(Collection right)` Create a List as a union of a List and an Collection.
`Object`	`pop()` Removes the last item from the List.
`boolean`	`push(Object value)` Appends an item to the List.
`void`	`putAt(EmptyRange range, Object value)` A helper method to allow lists to work with subscript operators.
`void`	`putAt(EmptyRange range, Collection value)` A helper method to allow lists to work with subscript operators.
`void`	`putAt(IntRange range, Object value)` List subscript assignment operator when given a range as the index.
`void`	`putAt(IntRange range, Collection col)` List subscript assignment operator when given a range as the index and the assignment operand is a collection.
`void`	`putAt(int idx, Object value)` A helper method to allow lists to work with subscript operators.
`void`	`putAt(List splice, Object value)` A helper method to allow lists to work with subscript operators.
`void`	`putAt(List splice, List values)` A helper method to allow lists to work with subscript operators.
`Object`	`removeAt(int index)` Modifies this list by removing the element at the specified position in this list.
`List`	`reverse()` Creates a new List with the identical contents to this list but in reverse order.
`List`	`reverse(boolean mutate)` Reverses the elements in a list.
`List`	`reverseEach(Closure closure)` Iterate over each element of the list in the reverse order.
`List`	`split(Closure closure)` Splits all items into two collections based on the closure condition.
`Set`	`subsequences()` Finds all non-null subsequences of a list.
`List`	`swap(int i, int j)` Swaps two elements at the specified positions.
`List`	`tail()` Returns the items from the List excluding the first item.
`List`	`take(int num)` Returns the first `num` elements from the head of this List.
`List`	`takeRight(int num)` Returns the last `num` elements from the tail of this List.
`List`	`takeWhile(Closure condition)` Returns the longest prefix of this list where each element passed to the given closure condition evaluates to true.
`SpreadMap`	`toSpreadMap()` Creates a spreadable map from this list.
`List`	`toUnique()` Returns a List containing the items from the List but with duplicates removed using the natural ordering of the items to determine uniqueness.
`List`	`toUnique(Closure condition)` Returns a List containing the items from the List but with duplicates removed.
`List`	`toUnique(Comparator comparator)` Returns a List containing the items from the List but with duplicates removed.
`List`	`transpose()` Adds GroovyCollections#transpose(List) as a method on lists.
`List`	`unique()` Modifies this List to remove all duplicated items, using the default comparator.
`List`	`unique(boolean mutate)` Remove all duplicates from a given List using the default comparator.
`List`	`unique(boolean mutate, Closure closure)` A convenience method for making a List unique using a Closure to determine duplicate (equal) items.
`List`	`unique(boolean mutate, Comparator comparator)` Remove all duplicates from a given List.
`List`	`unique(Closure closure)` A convenience method for making a List unique using a Closure to determine duplicate (equal) items.
`List`	`unique(Comparator comparator)` Remove all duplicates from a given List.
`List`	`withDefault(Closure init)` An alias for `withLazyDefault` which decorates a list allowing it to grow when called with index values outside the normal list bounds.
`List`	`withEagerDefault(Closure init)` Decorates a list allowing it to grow when called with a non-existent index value.
`List`	`withLazyDefault(Closure init)` Decorates a list allowing it to grow when called with a non-existent index value.

Methods inherited from interface java.util.Collection

addAll, addAll, addAll, asBoolean, asImmutable, asSynchronized, asType, collect, collect, collect, collectNested, each, eachWithIndex, find, find, findAll, findAll, findResult, findResult, flatten, getAt, getIndices, grep, grep, inject, inject, intersect, isCase, leftShift, minus, plus, plus, plus, removeAll, removeAll, removeElement, retainAll, retainAll, split, toListString, toListString, toSet, unique, unique, unique, unique, unique, unique

Methods inherited from interface java.lang.Iterable

any, asCollection, asList, collate, collate, collate, collate, collectEntries, collectEntries, collectEntries, collectEntries, collectMany, collectMany, collectNested, collectNested, combinations, combinations, contains, containsAll, count, count, countBy, disjoint, drop, dropRight, dropWhile, each, eachCombination, eachPermutation, eachWithIndex, every, findResults, first, flatten, flatten, getAt, groupBy, groupBy, groupBy, head, indexed, indexed, init, intersect, join, last, max, max, max, min, min, min, minus, minus, multiply, permutations, permutations, plus, plus, size, sort, sort, sort, sort, sort, sum, sum, sum, sum, tail, take, takeRight, takeWhile, toList, toSet, toSorted, toSorted, toSorted, toSpreadMap, toUnique, toUnique, toUnique, withIndex, withIndex

- Methods Detail
  - public boolean addAll(int index, Object[] items)
    
    Modifies this list by inserting all of the elements in the specified array into the list at the specified position. Shifts the element currently at that position (if any) and any subsequent elements to the right (increases their indices). The new elements will appear in this list in the order that they occur in the array. The behavior of this operation is undefined if the specified array is modified while the operation is in progress. See also plus for similar functionality with copy semantics, i.e. which produces a new list after adding the additional items at the specified position but leaves the original list unchanged.
    
    Parameters:
    
    items - array containing elements to be added to this collection
    
    index - index at which to insert the first element from the specified array
    
    Returns:
    
    true if this collection changed as a result of the call
    
    Since:
    
    1.7.2
    
    See Also:
    
    List#addAll(int, Collection)
  - public List asImmutable()
    
    A convenience method for creating an immutable list
    
    Returns:
    
    an immutable List
    
    Since:
    
    1.0
    
    See Also:
    
    Collections#unmodifiableList(java.util.List)
  - public List asSynchronized()
    
    A convenience method for creating a synchronized List.
    
    Returns:
    
    a synchronized List
    
    Since:
    
    1.0
    
    See Also:
    
    Collections#synchronizedList(java.util.List)
  - public List drop(int num)
    
    Drops the given number of elements from the head of this List.
```
def strings = [ 'a', 'b', 'c' ]
assert strings.drop( 0 ) == [ 'a', 'b', 'c' ]
assert strings.drop( 2 ) == [ 'c' ]
assert strings.drop( 5 ) == []
```
    Parameters:
    
    num - the number of elements to drop from this Iterable
    
    Returns:
    
    a List consisting of all the elements of this Iterable minus the first num elements, or an empty list if it has less then num elements.
    
    Since:
    
    1.8.1
  - public List dropRight(int num)
    
    Drops the given number of elements from the tail of this List.
```
def strings = [ 'a', 'b', 'c' ]
assert strings.dropRight( 0 ) == [ 'a', 'b', 'c' ]
assert strings.dropRight( 2 ) == [ 'a' ]
assert strings.dropRight( 5 ) == []
```
    Parameters:
    
    num - the number of elements to drop from this List
    
    Returns:
    
    a List consisting of all the elements of this List minus the last num elements, or an empty List if it has less then num elements.
    
    Since:
    
    2.4.0
  - public List dropWhile(Closure condition)
    
    Returns a suffix of this List where elements are dropped from the front while the given Closure evaluates to true. Similar to Iterable#dropWhile(groovy.lang.Closure) except that it attempts to preserve the type of the original list.
```
def nums = [ 1, 3, 2 ]
assert nums.dropWhile{ it < 4 } == []
assert nums.dropWhile{ it < 3 } == [ 3, 2 ]
assert nums.dropWhile{ it != 2 } == [ 2 ]
assert nums.dropWhile{ it == 0 } == [ 1, 3, 2 ]
```
    Parameters:
    
    condition - the closure that must evaluate to true to continue dropping elements
    
    Returns:
    
    the shortest suffix of the given List such that the given closure condition evaluates to true for each element dropped from the front of the List
    
    Since:
    
    1.8.7
  - public List each(Closure closure)
    
    Iterates through an List, passing each item to the given closure.
    
    Parameters:
    
    closure - the closure applied on each element found
    
    Returns:
    
    the self List
    
    Since:
    
    2.4.0
  - public List eachWithIndex(Closure closure)
    
    Iterates through an List, passing each item and the item's index (a counter starting at zero) to the given closure.
    
    Parameters:
    
    closure - a Closure to operate on each item
    
    Returns:
    
    the self List
    
    Since:
    
    2.4.0
  - public boolean equals(Object[] right)
    
    Determines if the contents of this list are equal to the contents of the given array in the same order. This returns false if either collection is null.
```
assert [1, "a"].equals( [ 1, "a" ] as Object[] )
```
    Parameters:
    
    right - the Object[] being compared to
    
    Returns:
    
    true if the contents of both collections are equal
    
    Since:
    
    1.5.0
  - public boolean equals(List right)
    
    Compare the contents of two Lists. Order matters. If numbers exist in the Lists, then they are compared as numbers, for example 2 == 2L. If both lists are null, the result is true; otherwise if either list is null, the result is false.
```
assert ["a", 2].equals(["a", 2])
assert ![2, "a"].equals("a", 2)
assert [2.0, "a"].equals(2L, "a") // number comparison at work
```
    Parameters:
    
    right - the List being compared to
    
    Returns:
    
    boolean true if the contents of both lists are identical, false otherwise.
    
    Since:
    
    1.0
  - public Process execute()
    
    Executes the command specified by the given list. The toString() method is called for each item in the list to convert into a resulting String. The first item in the list is the command the others are the parameters.
    For more control over Process construction you can use java.lang.ProcessBuilder.
    
    Returns:
    
    the Process which has just started for this command line representation.
    
    Since:
    
    1.0
  - public Process execute(String[] envp, File dir)
    
    Executes the command specified by the given list, with the environment defined by envp and under the working directory dir. The first item in the list is the command; the others are the parameters. The toString() method is called on items in the list to convert them to Strings.
    For more control over Process construction you can use java.lang.ProcessBuilder.
    
    Parameters:
    
    envp - an array of Strings, each member of which has environment variable settings in the format name=value, or null if the subprocess should inherit the environment of the current process.
    
    dir - the working directory of the subprocess, or null if the subprocess should inherit the working directory of the current process.
    
    Returns:
    
    the Process which has just started for this command line representation.
    
    Since:
    
    1.7.1
  - public Process execute(List envp, File dir)
    
    Executes the command specified by the given list, with the environment defined by envp and under the working directory dir. The first item in the list is the command; the others are the parameters. The toString() method is called on items in the list to convert them to Strings.
    For more control over Process construction you can use java.lang.ProcessBuilder.
    
    Parameters:
    
    envp - a List of Objects (converted to Strings using toString), each member of which has environment variable settings in the format name=value, or null if the subprocess should inherit the environment of the current process.
    
    dir - the working directory of the subprocess, or null if the subprocess should inherit the working directory of the current process.
    
    Returns:
    
    the Process which has just started for this command line representation.
    
    Since:
    
    1.7.1
  - public List findAll()
    
    Finds the items matching the IDENTITY Closure (i.e. matching Groovy truth).
    Example:
```
def items = [1, 2, 0, false, true, '', 'foo', [], [4, 5], null]
assert items.findAll() == [1, 2, true, 'foo', [4, 5]]
```
    Returns:
    
    a List of the values found
    
    Since:
    
    2.4.0
    
    See Also:
    
    Closure#IDENTITY
  - public List findAll(Closure closure)
    
    Finds all values matching the closure condition.
```
assert [2,4] == [1,2,3,4].findAll { it % 2 == 0 }
```
    Parameters:
    
    closure - a closure condition
    
    Returns:
    
    a List of matching values
    
    Since:
    
    2.4.0
  - public Object first()
    
    Returns the first item from the List.
```
def list = [3, 4, 2]
assert list.first() == 3
// check original is unaltered
assert list == [3, 4, 2]
```
    Returns:
    
    the first item from the List
    
    Since:
    
    1.5.5
  - public List flatten()
    
    Flatten a List. This List and any nested arrays or collections have their contents (recursively) added to the new List.
```
assert [1,2,3,4,5] == [1,[2,3],[[4]],[],5].flatten()
```
    Returns:
    
    a flattened List
    
    Since:
    
    2.4.0
  - public List getAt(EmptyRange range)
    
    Support the range subscript operator for a List.
```
def list = [true, 1, 3.4]
assert list[0..<0] == []
```
    Parameters:
    
    range - a Range indicating the items to get
    
    Returns:
    
    a new list instance based on range borders
    
    Since:
    
    1.0
  - public List getAt(Range range)
    
    Support the range subscript operator for a List.
```
def list = [1, "a", 4.5, true]
assert list[1..2] == ["a", 4.5]
```
    Parameters:
    
    range - a Range indicating the items to get
    
    Returns:
    
    a new list instance based on range borders
    
    Since:
    
    1.0
  - public Object getAt(int idx)
    
    Support the subscript operator for a List.
```
def list = [2, "a", 5.3]
assert list[1] == "a"
```
    Parameters:
    
    idx - an index
    
    Returns:
    
    the value at the given index
    
    Since:
    
    1.0
  - public List getAt(Collection indices)
    
    Select a List of items from a List using a Collection to identify the indices to be selected.
```
def list = [true, 1, 3.4, false]
assert list[1,0,2] == [1, true, 3.4]
```
    Parameters:
    
    indices - a Collection of indices
    
    Returns:
    
    a new list of the values at the given indices
    
    Since:
    
    1.0
  - public List grep()
    
    Iterates over the collection returning each element that matches using the IDENTITY Closure as a filter - effectively returning all elements which satisfy Groovy truth.
    Example:
```
def items = [1, 2, 0, false, true, '', 'foo', [], [4, 5], null]
assert items.grep() == [1, 2, true, 'foo', [4, 5]]
```
    Returns:
    
    a List of elements satisfy Groovy truth
    
    Since:
    
    2.4.0
    
    See Also:
    
    Closure#IDENTITY
  - public List grep(Object filter)
    
    Iterates over the collection of items and returns each item that matches the given filter - calling the Object#isCase(java.lang.Object) method used by switch statements. This method can be used with different kinds of filters like regular expressions, classes, ranges etc. Example:
```
def list = ['a', 'b', 'aa', 'bc', 3, 4.5]
assert list.grep( ~/a+/ )  == ['a', 'aa']
assert list.grep( ~/../ )  == ['aa', 'bc']
assert list.grep( Number ) == [ 3, 4.5 ]
assert list.grep{ it.toString().size() == 1 } == [ 'a', 'b', 3 ]
```
    Parameters:
    
    filter - the filter to perform on each element of the collection (using the Object#isCase(java.lang.Object) method)
    
    Returns:
    
    a List of objects which match the filter
    
    Since:
    
    2.4.0
  - public Object head()
    
    Returns the first item from the List.
```
def list = [3, 4, 2]
assert list.head() == 3
assert list == [3, 4, 2]
```
    Returns:
    
    the first item from the List
    
    Since:
    
    1.5.5
  - public List init()
    
    Returns the items from the List excluding the last item. Leaves the original List unchanged.
```
def list = [3, 4, 2]
assert list.init() == [3, 4]
assert list == [3, 4, 2]
```
    Returns:
    
    a List without its last element
    
    Since:
    
    2.4.0
  - public List intersect(Iterable right)
    
    Create a List composed of the intersection of a List and an Iterable. Any elements that exist in both iterables are added to the resultant collection.
```
assert [4,5] == [1,2,3,4,5].intersect([4,5,6,7,8])
```
    Parameters:
    
    right - an Iterable
    
    Returns:
    
    a List as an intersection of a List and an Iterable
    
    Since:
    
    2.4.0
  - public Object last()
    
    Returns the last item from the List.
```
def list = [3, 4, 2]
assert list.last() == 2
// check original is unaltered
assert list == [3, 4, 2]
```
    Returns:
    
    the last item from the List
    
    Since:
    
    1.5.5
  - public List leftShift(Object value)
    
    Overloads the left shift operator to provide an easy way to append objects to a List.
```
def list = [1,2]
list << 3
assert list == [1,2,3]
```
    Parameters:
    
    value - an Object to be added to the List.
    
    Returns:
    
    same List, after the value was added to it.
    
    Since:
    
    2.4.0
  - public List minus(Iterable removeMe)
    
    Create a new List composed of the elements of the first List minus every occurrence of elements of the given Iterable.
```
assert [1, "a", true, true, false, 5.3] - [true, 5.3] == [1, "a", false]
```
    Parameters:
    
    removeMe - a Iterable of elements to remove
    
    Returns:
    
    a new List with the given elements removed
    
    Since:
    
    1.8.7
  - public List minus(Object removeMe)
    
    Create a new List composed of the elements of the first List minus every occurrence of the given element to remove.
```
assert ["a", 5, 5, true] - 5 == ["a", true]
```
    Parameters:
    
    removeMe - an element to remove from the List
    
    Returns:
    
    the resulting List with the given element removed
    
    Since:
    
    1.0
  - public List minus(Collection removeMe)
    
    Create a List composed of the elements of the first list minus every occurrence of elements of the given Collection.
```
assert [1, "a", true, true, false, 5.3] - [true, 5.3] == [1, "a", false]
```
    Parameters:
    
    removeMe - a Collection of elements to remove
    
    Returns:
    
    a List with the given elements removed
    
    Since:
    
    1.0
  - public List multiply(Number factor)
    
    Create a List composed of the elements of this Iterable, repeated a certain number of times. Note that for non-primitive elements, multiple references to the same instance will be added.
```
assert [1,2,3,1,2,3] == [1,2,3] * 2
```
    Note: if the Iterable happens to not support duplicates, e.g. a Set, then the method will effectively return a Collection with a single copy of the Iterable's items.
    
    Parameters:
    
    factor - the number of times to append
    
    Returns:
    
    the multiplied List
    
    Since:
    
    2.4.0
  - public List plus(int index, Iterable additions)
    
    Creates a new List by inserting all of the elements in the given Iterable to the elements from this List at the specified index.
    
    Parameters:
    
    additions - an Iterable containing elements to be merged with the elements from the original List
    
    index - index at which to insert the first element from the given additions Iterable
    
    Returns:
    
    the new list
    
    Since:
    
    1.8.7
    
    See Also:
    
    List#plus(int, List)
  - public List plus(int index, Object[] items)
    
    Creates a new List by inserting all of the elements in the specified array to the elements from the original List at the specified index. Shifts the element currently at that index (if any) and any subsequent elements to the right (increasing their indices). The new elements will appear in the resulting List in the order that they occur in the original array. The behavior of this operation is undefined if the list or array operands are modified while the operation is in progress. The original list and array operands remain unchanged.
```
def items = [1, 2, 3]
def newItems = items.plus(2, 'a'..'c' as String[])
assert newItems == [1, 2, 'a', 'b', 'c', 3]
assert items == [1, 2, 3]
```
    See also addAll for similar functionality with modify semantics, i.e. which performs the changes on the original list itself.
    
    Parameters:
    
    items - array containing elements to be merged with elements from the original list
    
    index - index at which to insert the first element from the specified array
    
    Returns:
    
    the new list
    
    Since:
    
    1.8.1
    
    See Also:
    
    List#plus(int, List)
  - public List plus(int index, List additions)
    
    Creates a new List by inserting all of the elements in the given additions List to the elements from the original List at the specified index. Shifts the element currently at that index (if any) and any subsequent elements to the right (increasing their indices). The new elements will appear in the resulting List in the order that they occur in the original lists. The behavior of this operation is undefined if the original lists are modified while the operation is in progress. The original lists remain unchanged.
```
def items = [1, 2, 3]
def newItems = items.plus(2, 'a'..'c')
assert newItems == [1, 2, 'a', 'b', 'c', 3]
assert items == [1, 2, 3]
```
    See also addAll for similar functionality with modify semantics, i.e. which performs the changes on the original list itself.
    
    Parameters:
    
    additions - a List containing elements to be merged with elements from the original List
    
    index - index at which to insert the first element from the given additions List
    
    Returns:
    
    the new list
    
    Since:
    
    1.8.1
  - public List plus(Iterable right)
    
    Create a List as a union of a List and an Iterable. This operation will always create a new object for the result, while the operands remain unchanged.
    
    Parameters:
    
    right - the right Iterable
    
    Returns:
    
    the merged List
    
    Since:
    
    2.4.0
    
    See Also:
    
    Collection#plus(Collection)
  - public List plus(Object right)
    
    Create a List as a union of a List and an Object. This operation will always create a new object for the result, while the operands remain unchanged.
```
assert [1,2,3] == [1,2] + 3
```
    Parameters:
    
    right - an object to add/append
    
    Returns:
    
    the resulting List
    
    Since:
    
    2.4.0
  - public List plus(Collection right)
    
    Create a List as a union of a List and an Collection. This operation will always create a new object for the result, while the operands remain unchanged.
    
    Parameters:
    
    right - the right Collection
    
    Returns:
    
    the merged List
    
    Since:
    
    2.4.0
    
    See Also:
    
    Collection#plus(Collection)
  - public Object pop()
    
    Removes the last item from the List. Using add() and pop() is similar to push and pop on a Stack.
```
def list = ["a", false, 2]
assert list.pop() == 2
assert list == ["a", false]
```
    Returns:
    
    the item removed from the List
    
    Since:
    
    1.0
  - public boolean push(Object value)
    
    Appends an item to the List. Synonym for add().
```
def list = [3, 4, 2]
list.push("x")
assert list == [3, 4, 2, "x"]
```
    Parameters:
    
    value - element to be appended to this list.
    
    Returns:
    
    true (as per the general contract of the Collection.add method).
    
    Since:
    
    1.5.5
  - public void putAt(EmptyRange range, Object value)
    
    A helper method to allow lists to work with subscript operators.
```
def list = ["a", true]
list[1..<1] = 5
assert list == ["a", 5, true]
```
    Parameters:
    
    range - the (in this case empty) subset of the list to set
    
    value - the values to put at the given sublist or a Collection of values
    
    Since:
    
    1.0
  - public void putAt(EmptyRange range, Collection value)
    
    A helper method to allow lists to work with subscript operators.
```
def list = ["a", true]
list[1..<1] = [4, 3, 2]
assert list == ["a", 4, 3, 2, true]
```
    Parameters:
    
    range - the (in this case empty) subset of the list to set
    
    value - the Collection of values
    
    Since:
    
    1.0
    
    See Also:
    
    List#putAt(groovy.lang.EmptyRange, java.lang.Object)
  - public void putAt(IntRange range, Object value)
    
    List subscript assignment operator when given a range as the index. Example:
```
def myList = [4, 3, 5, 1, 2, 8, 10]
myList[3..5] = "b"
assert myList == [4, 3, 5, "b", 10]
```
    Items in the given range are replaced with the operand. The value operand is always treated as a single value.
    
    Parameters:
    
    range - the subset of the list to set
    
    value - the value to put at the given sublist
    
    Since:
    
    1.0
  - public void putAt(IntRange range, Collection col)
    
    List subscript assignment operator when given a range as the index and the assignment operand is a collection. Example:
```
def myList = [4, 3, 5, 1, 2, 8, 10]
myList[3..5] = ["a", true]
assert myList == [4, 3, 5, "a", true, 10]
```
    Items in the given range are replaced with items from the collection.
    
    Parameters:
    
    range - the subset of the list to set
    
    col - the collection of values to put at the given sublist
    
    Since:
    
    1.5.0
  - public void putAt(int idx, Object value)
    
    A helper method to allow lists to work with subscript operators.
```
def list = [2, 3]
list[0] = 1
assert list == [1, 3]
```
    Parameters:
    
    idx - an index
    
    value - the value to put at the given index
    
    Since:
    
    1.0
  - public void putAt(List splice, Object value)
    
    A helper method to allow lists to work with subscript operators.
```
def list = ["a", true, 42, 9.4]
list[1, 3] = 5
assert list == ["a", 5, 42, 5]
```
    Parameters:
    
    splice - the subset of the list to set
    
    value - the value to put at the given sublist
    
    Since:
    
    1.0
  - public void putAt(List splice, List values)
    
    A helper method to allow lists to work with subscript operators.
```
def list = ["a", true, 42, 9.4]
list[1, 4] = ["x", false]
assert list == ["a", "x", 42, 9.4, false]
```
    Parameters:
    
    splice - the subset of the list to set
    
    values - the value to put at the given sublist
    
    Since:
    
    1.0
  - public Object removeAt(int index)
    
    Modifies this list by removing the element at the specified position in this list. Returns the removed element. Essentially an alias for List#remove(int) but with no ambiguity for List<Integer>.
    Example:
```
def list = [1, 2, 3]
list.removeAt(1)
assert [1, 3] == list
```
    Parameters:
    
    index - the index of the element to be removed
    
    Returns:
    
    the element previously at the specified position
    
    Since:
    
    2.4.0
  - public List reverse()
    
    Creates a new List with the identical contents to this list but in reverse order.
```
def list = ["a", 4, false]
assert list.reverse() == [false, 4, "a"]
assert list == ["a", 4, false]
```
    Returns:
    
    a reversed List
    
    Since:
    
    1.0
    
    See Also:
    
    List#reverse(boolean)
  - public List reverse(boolean mutate)
    
    Reverses the elements in a list. If mutate is true, the original list is modified in place and returned. Otherwise, a new list containing the reversed items is produced.
```
def list = ["a", 4, false]
assert list.reverse(false) == [false, 4, "a"]
assert list == ["a", 4, false]
assert list.reverse(true) == [false, 4, "a"]
assert list == [false, 4, "a"]
```
    Parameters:
    
    mutate - true if the list itself should be reversed in place and returned, false if a new list should be created
    
    Returns:
    
    a reversed List
    
    Since:
    
    1.8.1
  - public List reverseEach(Closure closure)
    
    Iterate over each element of the list in the reverse order.
```
def result = []
[1,2,3].reverseEach { result << it }
assert result == [3,2,1]
```
    Parameters:
    
    closure - a closure to which each item is passed.
    
    Returns:
    
    the original list
    
    Since:
    
    1.5.0
  - public List split(Closure closure)
    
    Splits all items into two collections based on the closure condition. The first list contains all items which match the closure expression. The second list all those that don't.
    Example usage:
```
assert [[2,4],[1,3]] == [1,2,3,4].split { it % 2 == 0 }
```
    Parameters:
    
    closure - a closure condition
    
    Returns:
    
    a List whose first item is the accepted values and whose second item is the rejected values
    
    Since:
    
    2.4.0
  - public Set subsequences()
    
    Finds all non-null subsequences of a list.
    Example usage:
```
def result = [1, 2, 3].subsequences()
assert result == [[1, 2, 3], [1, 3], [2, 3], [1, 2], [1], [2], [3]] as Set
```
    Returns:
    
    the subsequences from the list
    
    Since:
    
    1.7.0
  - public List swap(int i, int j)
    
    Swaps two elements at the specified positions.
    Example:
```
assert [1, 3, 2, 4] == [1, 2, 3, 4].swap(1, 2)
```
    Parameters:
    
    i - a position
    
    j - a position
    
    Returns:
    
    self
    
    Since:
    
    2.4.0
    
    See Also:
    
    Collections#swap(List, int, int)
  - public List tail()
    
    Returns the items from the List excluding the first item.
```
def list = [3, 4, 2]
assert list.tail() == [4, 2]
assert list == [3, 4, 2]
```
    Returns:
    
    a List without its first element
    
    Since:
    
    1.5.6
  - public List take(int num)
    
    Returns the first num elements from the head of this List.
```
def strings = [ 'a', 'b', 'c' ]
assert strings.take( 0 ) == []
assert strings.take( 2 ) == [ 'a', 'b' ]
assert strings.take( 5 ) == [ 'a', 'b', 'c' ]
```
    Parameters:
    
    num - the number of elements to take from this List
    
    Returns:
    
    a List consisting of the first num elements from this List, or else all the elements from the List if it has less then num elements.
    
    Since:
    
    1.8.1
  - public List takeRight(int num)
    
    Returns the last num elements from the tail of this List.
```
def strings = [ 'a', 'b', 'c' ]
assert strings.takeRight( 0 ) == []
assert strings.takeRight( 2 ) == [ 'b', 'c' ]
assert strings.takeRight( 5 ) == [ 'a', 'b', 'c' ]
```
    Parameters:
    
    num - the number of elements to take from this List
    
    Returns:
    
    a List consisting of the last num elements from this List, or else all the elements from the List if it has less then num elements.
    
    Since:
    
    2.4.0
  - public List takeWhile(Closure condition)
    
    Returns the longest prefix of this list where each element passed to the given closure condition evaluates to true. Similar to Iterable#takeWhile(groovy.lang.Closure) except that it attempts to preserve the type of the original list.
```
def nums = [ 1, 3, 2 ]
assert nums.takeWhile{ it < 1 } == []
assert nums.takeWhile{ it < 3 } == [ 1 ]
assert nums.takeWhile{ it < 4 } == [ 1, 3, 2 ]
```
    Parameters:
    
    condition - the closure that must evaluate to true to continue taking elements
    
    Returns:
    
    a prefix of the given list where each element passed to the given closure evaluates to true
    
    Since:
    
    1.8.7
  - public SpreadMap toSpreadMap()
    
    Creates a spreadable map from this list.
    
    Returns:
    
    a newly created SpreadMap
    
    Since:
    
    1.8.0
    
    See Also:
    
    SpreadMap#SpreadMap(java.util.List)
    
    Map#toSpreadMap()
  - public List toUnique()
    
    Returns a List containing the items from the List but with duplicates removed using the natural ordering of the items to determine uniqueness.
```
def letters = ['c', 'a', 't', 's', 'a', 't', 'h', 'a', 't']
def expected = ['c', 'a', 't', 's', 'h']
assert letters.toUnique() == expected
```
    Returns:
    
    the List of non-duplicate items
    
    Since:
    
    2.4.0
  - public List toUnique(Closure condition)
    
    Returns a List containing the items from the List but with duplicates removed. The items in the List are compared by the given Closure condition. For each duplicate, the first member which is returned from the Iterable is retained, but all other ones are removed.
    If the closure takes a single parameter, each element from the Iterable will be passed to the closure. The closure should return a value used for comparison (either using Comparable#compareTo(java.lang.Object) or Object#equals(java.lang.Object)). If the closure takes two parameters, two items from the Iterable will be passed as arguments, and the closure should return an int value (with 0 indicating the items are not unique).
```
class Person {
    def fname, lname
    String toString() {
        return fname + " " + lname
    }
}

Person a = new Person(fname:"John", lname:"Taylor")
Person b = new Person(fname:"Clark", lname:"Taylor")
Person c = new Person(fname:"Tom", lname:"Cruz")
Person d = new Person(fname:"Clark", lname:"Taylor")

def list = [a, b, c, d]
def list2 = list.toUnique{ p1, p2 -> p1.lname != p2.lname ? p1.lname <=> p2.lname : p1.fname <=> p2.fname }
assert( list2 == [a, b, c] && list == [a, b, c, d] )
def list3 = list.toUnique{ it.toString() }
assert( list3 == [a, b, c] && list == [a, b, c, d] )
```
    Parameters:
    
    condition - a Closure used to determine unique items
    
    Returns:
    
    a new List
    
    Since:
    
    2.4.0
    
    See Also:
    
    Iterable#toUnique(Comparator)
  - public List toUnique(Comparator comparator)
    
    Returns a List containing the items from the List but with duplicates removed. The items in the List are compared by the given Comparator. For each duplicate, the first member which is returned from the List is retained, but all other ones are removed.
```
class Person {
    def fname, lname
    String toString() {
        return fname + " " + lname
    }
}

class PersonComparator implements Comparator {
    int compare(Object o1, Object o2) {
        Person p1 = (Person) o1
        Person p2 = (Person) o2
        if (p1.lname != p2.lname)
            return p1.lname.compareTo(p2.lname)
        else
            return p1.fname.compareTo(p2.fname)
    }

    boolean equals(Object obj) {
        return this.equals(obj)
    }
}

Person a = new Person(fname:"John", lname:"Taylor")
Person b = new Person(fname:"Clark", lname:"Taylor")
Person c = new Person(fname:"Tom", lname:"Cruz")
Person d = new Person(fname:"Clark", lname:"Taylor")

def list = [a, b, c, d]
List list2 = list.toUnique(new PersonComparator())
assert( list2 == list && list == [a, b, c] )
```
    Parameters:
    
    comparator - a Comparator used to determine unique (equal) items If null, the Comparable natural ordering of the elements will be used.
    
    Returns:
    
    the List of non-duplicate items
    
    Since:
    
    2.4.0
  - public List transpose()
    
    Adds GroovyCollections#transpose(List) as a method on lists. A Transpose Function takes a collection of columns and returns a collection of rows. The first row consists of the first element from each column. Successive rows are constructed similarly.
    Example usage:
```
def result = [['a', 'b'], [1, 2]].transpose()
assert result == [['a', 1], ['b', 2]]
```
```
def result = [['a', 'b'], [1, 2], [3, 4]].transpose()
assert result == [['a', 1, 3], ['b', 2, 4]]
```
    Returns:
    
    a List of the transposed lists
    
    Since:
    
    1.5.0
    
    See Also:
    
    GroovyCollections#transpose(java.util.List)
  - public List unique()
    
    Modifies this List to remove all duplicated items, using the default comparator.
```
assert [1,3] == [1,3,3].unique()
```
    Returns:
    
    the now modified List
    
    Since:
    
    2.4.0
    
    See Also:
    
    Collection#unique(boolean)
  - public List unique(boolean mutate)
    
    Remove all duplicates from a given List using the default comparator. If mutate is true, it works by modifying the original object (and also returning it). If mutate is false, a new collection is returned leaving the original unchanged.
```
assert [1,3] == [1,3,3].unique()
```
```
def orig = [1, 3, 2, 3]
def uniq = orig.unique(false)
assert orig == [1, 3, 2, 3]
assert uniq == [1, 3, 2]
```
    Parameters:
    
    mutate - false will cause a new List containing unique items from the List to be created, true will mutate List in place
    
    Returns:
    
    the now modified List
    
    Since:
    
    2.4.0
  - public List unique(boolean mutate, Closure closure)
    
    A convenience method for making a List unique using a Closure to determine duplicate (equal) items. If mutate is true, it works on the receiver object and returns it. If mutate is false, a new collection is returned.
    If the closure takes a single parameter, each element from the List will be passed to the closure. The closure should return a value used for comparison (either using Comparable#compareTo(java.lang.Object) or Object#equals(java.lang.Object)). If the closure takes two parameters, two items from the collection will be passed as arguments, and the closure should return an int value (with 0 indicating the items are not unique).
```
def orig = [1, 3, 4, 5]
def uniq = orig.unique(false) { it % 2 }
assert orig == [1, 3, 4, 5]
assert uniq == [1, 4]
```
```
def orig = [2, 3, 3, 4]
def uniq = orig.unique(false) { a, b -> a <=> b }
assert orig == [2, 3, 3, 4]
assert uniq == [2, 3, 4]
```
    Parameters:
    
    mutate - false will always cause a new list to be created, true will mutate lists in place
    
    closure - a 1 or 2 arg Closure used to determine unique items
    
    Returns:
    
    self without any duplicates
    
    Since:
    
    2.4.0
  - public List unique(boolean mutate, Comparator comparator)
    
    Remove all duplicates from a given List. If mutate is true, it works on the original object (and also returns it). If mutate is false, a new List is returned. The order of members in the List are compared by the given Comparator. For each duplicate, the first member which is returned by the given List's iterator is retained, but all other ones are removed. The given List's original order is preserved.
```
class Person {
    def fname, lname
    String toString() {
        return fname + " " + lname
    }
}

class PersonComparator implements Comparator {
    int compare(Object o1, Object o2) {
        Person p1 = (Person) o1
        Person p2 = (Person) o2
        if (p1.lname != p2.lname)
            return p1.lname.compareTo(p2.lname)
        else
            return p1.fname.compareTo(p2.fname)
    }

    boolean equals(Object obj) {
        return this.equals(obj)
    }
}

Person a = new Person(fname:"John", lname:"Taylor")
Person b = new Person(fname:"Clark", lname:"Taylor")
Person c = new Person(fname:"Tom", lname:"Cruz")
Person d = new Person(fname:"Clark", lname:"Taylor")

def list = [a, b, c, d]
List list2 = list.unique(false, new PersonComparator())
assert( list2 != list && list2 == [a, b, c] )
```
    Parameters:
    
    mutate - false will always cause a new List to be created, true will mutate List in place
    
    comparator - a Comparator
    
    Returns:
    
    self the List without duplicates
    
    Since:
    
    2.4.0
  - public List unique(Closure closure)
    
    A convenience method for making a List unique using a Closure to determine duplicate (equal) items.
    If the closure takes a single parameter, the argument passed will be each element, and the closure should return a value used for comparison (either using Comparable#compareTo(java.lang.Object) or Object#equals(java.lang.Object)). If the closure takes two parameters, two items from the List will be passed as arguments, and the closure should return an int value (with 0 indicating the items are not unique).
```
assert [1,4] == [1,3,4,5].unique { it % 2 }
```
```
assert [2,3,4] == [2,3,3,4].unique { a, b -> a <=> b }
```
    Parameters:
    
    closure - a 1 or 2 arg Closure used to determine unique items
    
    Returns:
    
    self without any duplicates
    
    Since:
    
    2.4.0
    
    See Also:
    
    Collection#unique(boolean, Closure)
  - public List unique(Comparator comparator)
    
    Remove all duplicates from a given List. Works on the original object (and also returns it). The order of members in the List are compared by the given Comparator. For each duplicate, the first member which is returned by the given List's iterator is retained, but all other ones are removed. The given List's original order is preserved.
```
class Person {
    def fname, lname
    String toString() {
        return fname + " " + lname
    }
}

class PersonComparator implements Comparator {
    int compare(Object o1, Object o2) {
        Person p1 = (Person) o1
        Person p2 = (Person) o2
        if (p1.lname != p2.lname)
            return p1.lname.compareTo(p2.lname)
        else
            return p1.fname.compareTo(p2.fname)
    }

    boolean equals(Object obj) {
        return this.equals(obj)
    }
}

Person a = new Person(fname:"John", lname:"Taylor")
Person b = new Person(fname:"Clark", lname:"Taylor")
Person c = new Person(fname:"Tom", lname:"Cruz")
Person d = new Person(fname:"Clark", lname:"Taylor")

def list = [a, b, c, d]
List list2 = list.unique(new PersonComparator())
assert( list2 == list && list == [a, b, c] )
```
    Parameters:
    
    comparator - a Comparator
    
    Returns:
    
    self the now modified List without duplicates
    
    Since:
    
    2.4.0
    
    See Also:
    
    Collection#unique(boolean, java.util.Comparator)
  - public List withDefault(Closure init)
    
    An alias for withLazyDefault which decorates a list allowing it to grow when called with index values outside the normal list bounds.
    
    Parameters:
    
    init - a Closure with the target index as parameter which generates the default value
    
    Returns:
    
    the decorated List
    
    Since:
    
    1.8.7
    
    See Also:
    
    List#withLazyDefault(groovy.lang.Closure)
    
    List#withEagerDefault(groovy.lang.Closure)
  - public List withEagerDefault(Closure init)
    
    Decorates a list allowing it to grow when called with a non-existent index value. When called with such values, the list is grown in size and a default value is placed in the list by calling a supplied init Closure. Null values can be stored in the list.
    How it works: The decorated list intercepts all calls to getAt(index) and get(index). If an index greater than or equal to the current size() is used, the list will grow automatically up to the specified index. Gaps will be filled by calling the init Closure. If generating a default value is a costly operation consider using withLazyDefault.
    Example usage:
```
def list = [0, 1].withEagerDefault{ 42 }
assert list[0] == 0
assert list[1] == 1
assert list[3] == 42   // default value
assert list == [0, 1, 42, 42]   // gap filled with default value

// illustrate using the index when generating default values
def list2 = [5].withEagerDefault{ index -> index * index }
assert list2[3] == 9
assert list2 == [5, 1, 4, 9]

// illustrate what happens with null values
list2[2] = null
assert list2[2] == null
assert list2 == [5, 1, null, 9]
```
    Parameters:
    
    init - a Closure with the target index as parameter which generates the default value
    
    Returns:
    
    the wrapped List
    
    Since:
    
    1.8.7
  - public List withLazyDefault(Closure init)
    
    Decorates a list allowing it to grow when called with a non-existent index value. When called with such values, the list is grown in size and a default value is placed in the list by calling a supplied init Closure. Subsequent retrieval operations if finding a null value in the list assume it was set as null from an earlier growing operation and again call the init Closure to populate the retrieved value; consequently the list can't be used to store null values.
    How it works: The decorated list intercepts all calls to getAt(index) and get(index). If an index greater than or equal to the current size() is used, the list will grow automatically up to the specified index. Gaps will be filled by null. If a default value should also be used to fill gaps instead of null, use withEagerDefault. If getAt(index) or get(index) are called and a null value is found, it is assumed that the null value was a consequence of an earlier grow list operation and the init Closure is called to populate the value.
    Example usage:
```
def list = [0, 1].withLazyDefault{ 42 }
assert list[0] == 0
assert list[1] == 1
assert list[3] == 42   // default value
assert list == [0, 1, null, 42] // gap filled with null

// illustrate using the index when generating default values
def list2 = [5].withLazyDefault{ index -> index * index }
assert list2[3] == 9
assert list2 == [5, null, null, 9]
assert list2[2] == 4
assert list2 == [5, null, 4, 9]

// illustrate what happens with null values
list2[2] = null
assert list2[2] == 4
```
    Parameters:
    
    init - a Closure with the target index as parameter which generates the default value
    
    Returns:
    
    the decorated List
    
    Since:
    
    1.8.7

Interface List

Methods Summary

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

Methods Detail

public boolean addAll(int index, Object[] items)

public List asImmutable()

public List asSynchronized()

public List drop(int num)

public List dropRight(int num)

public List dropWhile(Closure condition)

public List each(Closure closure)

public List eachWithIndex(Closure closure)

public boolean equals(Object[] right)

public boolean equals(List right)

public Process execute()

public Process execute(String[] envp, File dir)

public Process execute(List envp, File dir)

public List findAll()

public List findAll(Closure closure)

public Object first()

public List flatten()

public List getAt(EmptyRange range)

public List getAt(Range range)

public Object getAt(int idx)

public List getAt(Collection indices)

public List grep()

public List grep(Object filter)

public Object head()

public List init()

public List intersect(Iterable right)

public Object last()

public List leftShift(Object value)

public List minus(Iterable removeMe)

public List minus(Object removeMe)

public List minus(Collection removeMe)

public List multiply(Number factor)

public List plus(int index, Iterable additions)

public List plus(int index, Object[] items)

public List plus(int index, List additions)

public List plus(Iterable right)

public List plus(Object right)

public List plus(Collection right)

public Object pop()

public boolean push(Object value)

public void putAt(EmptyRange range, Object value)

public void putAt(EmptyRange range, Collection value)

public void putAt(IntRange range, Object value)

public void putAt(IntRange range, Collection col)

public void putAt(int idx, Object value)

public void putAt(List splice, Object value)

public void putAt(List splice, List values)

public Object removeAt(int index)

public List reverse()

public List reverse(boolean mutate)

public List reverseEach(Closure closure)

public List split(Closure closure)

public Set subsequences()

public List swap(int i, int j)

public List tail()

public List take(int num)

public List takeRight(int num)

public List takeWhile(Closure condition)

public SpreadMap toSpreadMap()

public List toUnique()

public List toUnique(Closure condition)

public List toUnique(Comparator comparator)

public List transpose()

public List unique()

public List unique(boolean mutate)

public List unique(boolean mutate, Closure closure)

public List unique(boolean mutate, Comparator comparator)

public List unique(Closure closure)

public List unique(Comparator comparator)

public List withDefault(Closure init)

public List withEagerDefault(Closure init)

public List withLazyDefault(Closure init)