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
|
asUnmodifiable()
Creates an unmodifiable view of a List. |
BufferedIterator
|
bufferedIterator()
Returns a BufferedIterator that allows examining the next element without
consuming it.
|
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 a List, passing each item to the given closure. |
List
|
eachWithIndex(Closure closure)
Iterates through a 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. |
List
|
intersect(Iterable right, Comparator comparator)
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 a Collection. |
Object
|
pop()
Removes the initial item from the List. |
boolean
|
push(Object value)
Prepends an item to the start of 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. |
Object
|
removeLast()
Removes the last item from the 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 Groovy's default number-aware comparator. |
List
|
unique(boolean mutate)
Remove all duplicates from a given List using Groovy's default number-aware 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. |
ListWithDefault
|
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.
|
ListWithDefault
|
withEagerDefault(Closure init)
Decorates a list allowing it to grow when called with a non-existent index value. |
ListWithDefault
|
withLazyDefault(Closure init)
Decorates a list allowing it to grow when called with a non-existent index value. |
addAll
, addAll
, addAll
, asBoolean
, asImmutable
, asSynchronized
, asType
, asUnmodifiable
, collectNested
, each
, eachWithIndex
, find
, find
, findAll
, findAll
, flatten
, getAt
, getIndices
, grep
, grep
, inject
, inject
, intersect
, intersect
, isCase
, leftShift
, minus
, plus
, plus
, plus
, removeAll
, removeAll
, removeElement
, retainAll
, retainAll
, split
, toListString
, toListString
, toSet
, unique
, unique
, unique
, unique
, unique
, unique
any
, asCollection
, asList
, asType
, bufferedIterator
, collate
, collate
, collate
, collate
, collect
, collect
, collect
, collectEntries
, collectEntries
, collectEntries
, collectEntries
, collectMany
, collectMany
, collectNested
, collectNested
, combinations
, combinations
, contains
, containsAll
, count
, count
, countBy
, disjoint
, drop
, dropRight
, dropWhile
, each
, eachCombination
, eachPermutation
, eachWithIndex
, every
, findIndexOf
, findIndexOf
, findIndexValues
, findIndexValues
, findLastIndexOf
, findLastIndexOf
, findResult
, findResult
, findResults
, first
, flatten
, flatten
, getAt
, groupBy
, groupBy
, groupBy
, head
, indexed
, indexed
, init
, inits
, intersect
, intersect
, isEmpty
, 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
, tails
, take
, takeRight
, takeWhile
, toList
, toSet
, toSorted
, toSorted
, toSorted
, toSpreadMap
, toUnique
, toUnique
, toUnique
, withIndex
, withIndex
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.
items
- array containing elements to be added to this collectionindex
- index at which to insert the first element from the
specified arrayA convenience method for creating an immutable List.
def mutable = [1,2,3] def immutable = mutable.asImmutable() try { immutable << 4 assert false } catch (UnsupportedOperationException) { assert true } mutable << 4 assert mutable.size() == 4 assert immutable.size() == 3
A convenience method for creating a synchronized List.
Creates an unmodifiable view of a List.
def mutable = [1,2,3] def unmodifiable = mutable.asUnmodifiable() try { unmodifiable << 4 assert false } catch (UnsupportedOperationException) { assert true } mutable << 4 assert unmodifiable.size() == 4
Returns a BufferedIterator
that allows examining the next element without
consuming it.
assert [1, 2, 3, 4].bufferedIterator().with { [head(), toList()] } == [1, [1, 2, 3, 4]]
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 ) == []
num
- the number of elements to drop from this Iterablenum
elements,
or an empty list if it has less then num
elements.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 ) == []
num
- the number of elements to drop from this Listnum
elements,
or an empty List if it has less then num
elements.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 ]
condition
- the closure that must evaluate to true to continue dropping elementsIterates through a List, passing each item to the given closure.
closure
- the closure applied on each element foundIterates through a List, passing each item and the item's index (a counter starting at zero) to the given closure.
closure
- a Closure to operate on each itemDetermines 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[] )
right
- the Object[] being compared toCompare 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
right
- the List being compared totrue
if the contents of both lists are identical,
false
otherwise.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
.
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
.
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.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
.
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.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]]
Finds all values matching the closure condition.
assert [2,4] == [1,2,3,4].findAll { it % 2 == 0 }
closure
- a closure conditionReturns the first item from the List.
def list = [3, 4, 2] assert list.first() == 3 // check original is unaltered assert list == [3, 4, 2]
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()
Support the range subscript operator for a List.
def list = [true, 1, 3.4] assert list[0..<0] == []
range
- a Range indicating the items to getSupport the range subscript operator for a List.
def list = [1, "a", 4.5, true] assert list[1..2] == ["a", 4.5]
range
- a Range indicating the items to getSupport the subscript operator for a List.
def list = [2, "a", 5.3] assert list[1] == "a"
idx
- an indexSelect 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]
indices
- a Collection of indicesIterates 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]]
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 ]
filter
- the filter to perform on each element of the collection (using the Object#isCase(java.lang.Object) method)Returns the first item from the List.
def list = [3, 4, 2] assert list.head() == 3 assert list == [3, 4, 2]
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]
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])By default, Groovy uses a NumberAwareComparator when determining if an element exists in both collections.
right
- an IterableCreate 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 [3,4] == [1,2,3,4].intersect([3,4,5,6])
right
- an Iterablecomparator
- a ComparatorReturns the last item from the List.
def list = [3, 4, 2] assert list.last() == 2 // check original is unaltered assert list == [3, 4, 2]
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]
value
- an Object to be added to the List.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]
removeMe
- an Iterable of elements to removeCreate 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]
removeMe
- an element to remove from the ListCreate 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]
removeMe
- a Collection of elements to removeCreate 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] * 2Note: 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.
factor
- the number of times to appendCreates a new List by inserting all of the elements in the given Iterable to the elements from this List at the specified index.
additions
- an Iterable containing elements to be merged with the elements from the original Listindex
- index at which to insert the first element from the given additions IterableCreates 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.
items
- array containing elements to be merged with elements from the original listindex
- index at which to insert the first element from the specified arrayCreates 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.
additions
- a List containing elements to be merged with elements from the original Listindex
- index at which to insert the first element from the given additions ListCreate 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.
right
- the right IterableCreate 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
right
- an object to add/appendCreate a List as a union of a List and a Collection. This operation will always create a new object for the result, while the operands remain unchanged.
right
- the right CollectionRemoves the initial item from the List.
def list = ["a", false, 2] assert list.pop() == 'a' assert list == [false, 2]This is similar to pop on a Stack where the first item in the list represents the top of the stack. Note: The behavior of this method changed in Groovy 2.5 to align with Java. If you need the old behavior use 'removeLast'.
Prepends an item to the start of the List.
def list = [3, 4, 2] list.push("x") assert list == ['x', 3, 4, 2]This is similar to push on a Stack where the first item in the list represents the top of the stack. Note: The behavior of this method changed in Groovy 2.5 to align with Java. If you need the old behavior use 'add'.
value
- element to be prepended to this list.A helper method to allow lists to work with subscript operators.
def list = ["a", true] list[1..<1] = 5 assert list == ["a", 5, true]
range
- the (in this case empty) subset of the list to setvalue
- the values to put at the given sublist or a Collection of valuesA 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]
range
- the (in this case empty) subset of the list to setvalue
- the Collection of valuesList 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.
range
- the subset of the list to setvalue
- the value to put at the given sublistList 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.
range
- the subset of the list to setcol
- the collection of values to put at the given sublistA helper method to allow lists to work with subscript operators.
def list = [2, 3] list[0] = 1 assert list == [1, 3]
idx
- an indexvalue
- the value to put at the given indexA 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]
splice
- the subset of the list to setvalue
- the value to put at the given sublistA 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]
splice
- the subset of the list to setvalues
- the value to put at the given sublistModifies 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
index
- the index of the element to be removedRemoves the last item from the List.
def list = ["a", false, 2] assert list.removeLast() == 2 assert list == ["a", false]Using add() and removeLast() is similar to push and pop on a Stack where the last item in the list represents the top of the stack.
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]
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"]
mutate
- true if the list itself should be reversed in place and returned, false if a new list should be createdIterate over each element of the list in the reverse order.
def result = [] [1,2,3].reverseEach { result << it } assert result == [3,2,1]
closure
- a closure to which each item is passed.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 }
closure
- a closure conditionFinds 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
Swaps two elements at the specified positions.
Example:
assert [1, 3, 2, 4] == [1, 2, 3, 4].swap(1, 2)
i
- a positionj
- a positionReturns 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 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' ]
num
- the number of elements to take from this Listnum
elements from this List,
or else all the elements from the List if it has less then num
elements.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' ]
num
- the number of elements to take from this Listnum
elements from this List,
or else all the elements from the List if it has less then num
elements.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 ]
condition
- the closure that must evaluate to true to
continue taking elementsCreates a spreadable map from this list.
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 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] )
condition
- a Closure used to determine unique itemsReturns 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 == [a, b, c] && list == [a, b, c, d]
comparator
- a Comparator used to determine unique (equal) items
If null
, the Comparable natural ordering of the elements will be used.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]]
Modifies this List to remove all duplicated items, using Groovy's default number-aware comparator.
assert [1,3] == [1,3,3].unique()
Remove all duplicates from a given List using Groovy's default number-aware 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]
mutate
- false will cause a new List containing unique items from the List to be created, true will mutate List in placeA 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]
mutate
- false will always cause a new list to be created, true will mutate lists in placeclosure
- a 1 or 2 arg Closure used to determine unique itemsRemove 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] )
mutate
- false will always cause a new List to be created, true will mutate List in placecomparator
- a ComparatorA 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 }
closure
- a 1 or 2 arg Closure used to determine unique itemsRemove 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] )
comparator
- a ComparatorAn alias for withLazyDefault
which decorates a list allowing
it to grow when called with index values outside the normal list bounds.
init
- a Closure with the target index as parameter which generates the default valueDecorates 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]
init
- a Closure with the target index as parameter which generates the default valueDecorates 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
init
- a Closure with the target index as parameter which generates the default value