Class DefaultGroovyMethods
public static String reverse(String self)
provides a reverse()
method for String
.
NOTE: While this class contains many 'public' static methods, it is primarily regarded as an internal class (its internal package name suggests this also). We value backwards compatibility of these methods when used within Groovy but value less backwards compatibility at the Java method call level. I.e. future versions of Groovy may remove or move a method call in this file but would normally aim to keep the method available from within Groovy.
-
Field Summary
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic double
Get the absolute valuestatic float
Get the absolute valuestatic long
Get the absolute valuestatic int
Get the absolute valuestatic <T> boolean
addAll
(Collection<T> self, Iterable<? extends T> items) Adds all items from the iterable to the Collection.static <T> boolean
addAll
(Collection<T> self, Iterator<? extends T> items) Adds all items from the iterator to the Collection.static <T> boolean
addAll
(Collection<T> self, T[] items) Modifies the collection by adding all the elements in the specified array to the collection.static <T> boolean
Modifies this list by inserting all the elements in the specified array into the list at the specified position.static void
addShutdownHook
(Object self, Closure closure) Allows the usage of addShutdownHook without getting the runtime first.static Boolean
Logical conjunction of two boolean operators.static Number
Bitwise AND together two Numbers.static BitSet
Bitwise AND together two BitSets.static <T> boolean
Iterates over the contents of an iterable, and checks whether a predicate is valid for at least one element.static boolean
Iterates over the elements of a collection, and checks whether at least one element is true according to the Groovy Truth.static boolean
Iterates over the contents of an object or collection, and checks whether a predicate is valid for at least one element.static <T> boolean
Iterates over the contents of an iterator, and checks whether a predicate is valid for at least one element.static <K,
V> boolean Iterates over the entries of a map, and checks whether a predicate is valid for at least one entry.static <T> boolean
Iterates over the contents of an Array, and checks whether a predicate is valid for at least one element.static boolean
asBoolean
(boolean[] array) Coerces a boolean array to a boolean value.static boolean
asBoolean
(byte[] array) Coerces a byte array to a boolean value.static boolean
asBoolean
(char[] array) Coerces a char array to a boolean value.static boolean
asBoolean
(double[] array) Coerces a double array to a boolean value.static boolean
asBoolean
(float[] array) Coerces a float array to a boolean value.static boolean
asBoolean
(int[] array) Coerces an int array to a boolean value.static boolean
asBoolean
(long[] array) Coerces a long array to a boolean value.static boolean
asBoolean
(short[] array) Coerces a short array to a boolean value.static boolean
Coerce a Boolean instance to a boolean value.static boolean
Coerce a character to a boolean value.static boolean
Coerce a Double instance to a boolean value.static boolean
Coerce a Float instance to a boolean value.static boolean
Coerce a number to a boolean value.static boolean
Coerce an object instance to a boolean value.static boolean
Coerce an Object array to a boolean value.static boolean
asBoolean
(Collection collection) Coerce a collection instance to a boolean value.static boolean
asBoolean
(Enumeration enumeration) Coerce an enumeration instance to a boolean value.static boolean
Coerce an iterator instance to a boolean value.static boolean
Coerce a map instance to a boolean value.static <T> Collection<T>
asCollection
(Iterable<T> self) Converts this Iterable to a Collection.static <T> Collection<T>
asImmutable
(Collection<T> self) A convenience method for creating an immutable Collection.static <T> List<T>
asImmutable
(List<T> self) A convenience method for creating an immutable List.static <K,
V> Map<K, V> asImmutable
(Map<K, V> self) A convenience method for creating an immutable Map.static <T> Set<T>
asImmutable
(Set<T> self) A convenience method for creating an immutable Set.static <K,
V> SortedMap<K, V> asImmutable
(SortedMap<K, V> self) A convenience method for creating an immutable SortedMap.static <T> SortedSet<T>
asImmutable
(SortedSet<T> self) A convenience method for creating an immutable SortedSet.static <T> List<T>
Converts this Iterable to a List.static <T> List<T>
asReversed
(List<T> self) Creates a view list with reversed order, and the order of original list will not change.static String
Get the detail information ofThrowable
instance's stack tracestatic <T> Collection<T>
asSynchronized
(Collection<T> self) A convenience method for creating a synchronized Collection.static <T> List<T>
asSynchronized
(List<T> self) A convenience method for creating a synchronized List.static <K,
V> Map<K, V> asSynchronized
(Map<K, V> self) A convenience method for creating a synchronized Map.static <T> Set<T>
asSynchronized
(Set<T> self) A convenience method for creating a synchronized Set.static <K,
V> SortedMap<K, V> asSynchronized
(SortedMap<K, V> self) A convenience method for creating a synchronized SortedMap.static <T> SortedSet<T>
asSynchronized
(SortedSet<T> self) A convenience method for creating a synchronized SortedSet.static <T> T
Coerces the closure to an implementation of the given class.static <T> T
Converts the given iterable to another type.static <T> T
Transform this number to the given type, using the 'as' operator.static <T> T
Converts the given array to either a List, Set, or SortedSet.static <T> T
Converts a given object to a type.static <T> T
asType
(Collection col, Class<T> clazz) Converts the given collection to another type.static <T> T
Coerces this map to the given type, using the map's keys as the public method names, and values as the implementation.static <T> Collection<T>
asUnmodifiable
(Collection<T> self) Creates an unmodifiable view of a Collection.static <T> List<T>
asUnmodifiable
(List<T> self) Creates an unmodifiable view of a List.static <K,
V> Map<K, V> asUnmodifiable
(Map<K, V> self) Creates an unmodifiable view of a Map.static <T> Set<T>
asUnmodifiable
(Set<T> self) Creates an unmodifiable view of a Set.static <K,
V> SortedMap<K, V> asUnmodifiable
(SortedMap<K, V> self) Creates an unmodifiable view of a SortedMap.static <T> SortedSet<T>
asUnmodifiable
(SortedSet<T> self) Creates an unmodifiable view of a SortedSet.static BigDecimal
average
(byte[] self) Calculates the average of the bytes in the array.static double
average
(double[] self) Calculates the average of the doubles in the array.static double
average
(float[] self) Calculates the average of the floats in the array.static BigDecimal
average
(int[] self) Calculates the average of the ints in the array.static BigDecimal
average
(long[] self) Calculates the average of the longs in the array.static BigDecimal
average
(short[] self) Calculates the average of the shorts in the array.static Object
Averages the items in an Iterable.static <T> Object
Averages the result of applying a closure to each item of an Iterable.static Object
Averages the items in an array.static Object
Averages the items from an Iterator.static <T> Object
Averages the result of applying a closure to each item returned from an iterator.static <T> Object
Averages the result of applying a closure to each item of an array.static Number
bitwiseNegate
(Number left) Bitwise NEGATE a Number.static BitSet
bitwiseNegate
(BitSet self) Bitwise NEGATE a BitSet.static <T> BufferedIterator<T>
Returns aBufferedIterator
that allows examining the next element without consuming it.static <T> BufferedIterator<T>
bufferedIterator
(Iterable<T> self) Returns aBufferedIterator
that allows examining the next element without consuming it.static <T> BufferedIterator<T>
bufferedIterator
(List<T> self) Returns aBufferedIterator
that allows examining the next element without consuming it.protected static <T> T
callClosureForLine
(Closure<T> closure, String line, int counter) protected static <T,
K, V> T callClosureForMapEntry
(Closure<T> closure, Map.Entry<K, V> entry) protected static <T,
K, V> T callClosureForMapEntryAndCounter
(Closure<T> closure, Map.Entry<K, V> entry, int counter) Chops the Iterable into pieces, returning lists with sizes corresponding to the supplied chop sizes.Chops the iterator items into pieces, returning lists with sizes corresponding to the supplied chop sizes.chop
(T[] self, int... chopSizes) Chops the array into pieces, returning lists with sizes corresponding to the supplied chop sizes.Collates this iterable into sub-lists of lengthsize
.Collates this iterable into sub-lists of lengthsize
.Collates this iterable into sub-lists of lengthsize
stepping through the codestep
elements for each subList.Collates this iterable into sub-lists of lengthsize
stepping through the codestep
elements for each sub-list.collate
(T[] self, int size) Collates an array.collate
(T[] self, int size, boolean keepRemainder) Collates this array into sub-lists.collate
(T[] self, int size, int step) Collates an array into sub-lists.collate
(T[] self, int size, int step, boolean keepRemainder) Collates this array into sub-lists.static <E,
T, C extends Collection<T>>
CIterates through this Array transforming each item into a new value using thetransform
closure and adding it to the suppliedcollector
.static <E,
T> List<T> Iterates through this Array transforming each item into a new value using thetransform
closure, returning a list of transformed values.static <E,
T, C extends Collection<T>>
CIterates through this collection transforming each value into a new value using thetransform
closure and adding it to the suppliedcollector
.static <E,
T> List<T> Iterates through this Iterable transforming each entry into a new value using thetransform
closure returning a list of transformed values.static <T> List<T>
Iterates through this collection transforming each entry into a new value using Closure.IDENTITY as a transformer, basically returning a list of items copied from the original collection.static Collection
Iterates through this aggregate Object transforming each item into a new value using Closure.IDENTITY as a transformer, basically returning a list of items copied from the original object.static <T,
C extends Collection<T>>
CIterates through this aggregate Object transforming each item into a new value using thetransform
closure and adding it to the suppliedcollector
.static <T> List<T>
Iterates through this aggregate Object transforming each item into a new value using thetransform
closure, returning a list of transformed values.static <E,
T, C extends Collection<T>>
CIterates through this Iterator transforming each item into a new value using thetransform
closure and adding it to the suppliedcollector
.static <E,
T> List<T> Iterates through this Iterator transforming each item into a new value using thetransform
closure, returning a list of transformed values.static <T,
K, V, C extends Collection<T>>
CIterates through this Map transforming each map entry into a new value using thetransform
closure returning thecollector
with all transformed values added to it.static <T,
K, V> List<T> Iterates through this Map transforming each map entry into a new value using thetransform
closure returning a list of transformed values.static <K,
V, E> Map<K, V> collectEntries
(E[] self) A variant of collectEntries using the identity closure as the transform.static <K,
V, E> Map<K, V> collectEntries
(E[] self, Closure<?> transform) Iterates through this array transforming each item using thetransform
closure and returning a map of the resulting transformed entries.static <K,
V, E> Map<K, V> collectEntries
(E[] self, Map<K, V> collector) A variant of collectEntries using the identity closure as the transform.static <K,
V, E> Map<K, V> collectEntries
(E[] self, Map<K, V> collector, Closure<?> transform) Iterates through this array transforming each item using thetransform
closure and returning a map of the resulting transformed entries.static <K,
V> Map<K, V> collectEntries
(Iterable<?> self) A variant of collectEntries for Iterable objects using the identity closure as the transform.static <K,
V> Map<K, V> collectEntries
(Iterable<?> self, Map<K, V> collector) A variant of collectEntries for Iterables using the identity closure as the transform and a supplied map as the destination of transformed entries.static <K,
V, E> Map<K, V> collectEntries
(Iterable<E> self, Closure<?> transform) Iterates through this Iterable transforming each item using thetransform
closure and returning a map of the resulting transformed entries.static <K,
V, E> Map<K, V> collectEntries
(Iterable<E> self, Map<K, V> collector, Closure<?> transform) Iterates through this Iterable transforming each item using the closure as a transformer into a map entry, returning the supplied map with all the transformed entries added to it.static <K,
V> Map<K, V> collectEntries
(Iterator<?> self) A variant of collectEntries for Iterators using the identity closure as the transform.static <K,
V> Map<K, V> collectEntries
(Iterator<?> self, Map<K, V> collector) A variant of collectEntries for Iterators using the identity closure as the transform and a supplied map as the destination of transformed entries.static <K,
V, E> Map<K, V> collectEntries
(Iterator<E> self, Closure<?> transform) A variant of collectEntries for Iterators.static <K,
V, E> Map<K, V> collectEntries
(Iterator<E> self, Map<K, V> collector, Closure<?> transform) A variant of collectEntries for Iterators using a supplied map as the destination of transformed entries.static <K,
V, X, Y> Map<K, V> collectEntries
(Map<X, Y> self, Closure<?> transform) Iterates through this Map transforming each entry using thetransform
closure and returning a map of the transformed entries.static <K,
V, X, Y> Map<K, V> collectEntries
(Map<X, Y> self, Map<K, V> collector, Closure<?> transform) Iterates through this Map transforming each map entry using thetransform
closure returning a map of the transformed entries.static <T,
E, C extends Collection<T>>
CcollectMany
(E[] self, C collector, Closure<? extends Collection<? extends T>> projection) Projects each item from a source array to a collection and concatenates (flattens) the resulting collections into a single list.static <T,
E> List<T> collectMany
(E[] self, Closure<? extends Collection<? extends T>> projection) Projects each item from a source array to a collection and concatenates (flattens) the resulting collections into a single list.static <T,
E, C extends Collection<T>>
CcollectMany
(Iterable<E> self, C collector, Closure<? extends Collection<? extends T>> projection) Projects each item from a source collection to a result collection and concatenates (flattens) the resulting collections adding them into thecollector
.static <T,
E> List<T> collectMany
(Iterable<E> self, Closure<? extends Collection<? extends T>> projection) Projects each item from a source Iterable to a collection and concatenates (flattens) the resulting collections into a single list.static <T,
E, C extends Collection<T>>
CcollectMany
(Iterator<E> self, C collector, Closure<? extends Collection<? extends T>> projection) Projects each item from a source iterator to a collection and concatenates (flattens) the resulting collections into a single list.static <T,
E> List<T> collectMany
(Iterator<E> self, Closure<? extends Collection<? extends T>> projection) Projects each item from a source iterator to a collection and concatenates (flattens) the resulting collections into a single list.static <T,
K, V, C extends Collection<T>>
CcollectMany
(Map<K, V> self, C collector, Closure<? extends Collection<? extends T>> projection) Projects each item from a source map to a result collection and concatenates (flattens) the resulting collections adding them into thecollector
.static <T,
K, V> List<T> collectMany
(Map<K, V> self, Closure<? extends Collection<? extends T>> projection) Projects each item from a source map to a result collection and concatenates (flattens) the resulting collections adding them into a collection.static <T,
K, V> Collection<T> collectMany$$bridge
(Map<K, V> self, Closure<? extends Collection<? extends T>> projection) Deprecated.static <C extends Collection>
CcollectNested
(Iterable self, C collector, Closure transform) Recursively iterates through this Iterable transforming each non-Collection value into a new value using thetransform
closure.static List
collectNested
(Iterable self, Closure transform) Recursively iterates through this Iterable transforming each non-Collection value into a new value using the closure as a transformer.static List
collectNested
(Collection self, Closure transform) Recursively iterates through this collection transforming each non-Collection value into a new value using the closure as a transformer.static List
combinations
(Iterable self) Adds GroovyCollections#combinations(Iterable) as a method on Iterables.static List
combinations
(Iterable self, Closure<?> function) Adds GroovyCollections#combinations(Iterable, Closure) as a method on collections.static int
Compare two Characters.static int
Compare a Character and a Number.static int
Compare a Number and a Character.static int
Compare two Numbers.static boolean
Checks whether the array contains the given value.static boolean
Checks whether the array contains the given value.static boolean
Checks whether the array contains the given value.static boolean
Checks whether the array contains the given value.static boolean
Checks whether the array contains the given value.static boolean
Checks whether the array contains the given value.static boolean
Checks whether the array contains the given value.static boolean
Checks whether the array contains the given value.static boolean
Returns true if this iterable contains the item.static boolean
Checks whether the array contains the given value.static boolean
containsAll
(Iterable<?> self, Object[] items) Returns true if this iterable contains all the elements in the specified array.static Number
Counts the number of occurrences of the given value inside this array.static Number
Counts the number of occurrences of the given value inside this array.static Number
Counts the number of occurrences of the given value inside this array.static Number
Counts the number of occurrences of the given value inside this array.static Number
Counts the number of occurrences of the given value inside this array.static Number
Counts the number of occurrences of the given value inside this array.static Number
Counts the number of occurrences of the given value inside this array.static Number
Counts the number of occurrences of the given value inside this array.static <T> Number
Counts the number of occurrences which satisfy the given closure from inside this Iterable.static Number
Counts the number of occurrences of the given value inside this Iterable.static Number
Counts the number of occurrences of the given value inside this array.static <T> Number
Counts the number of occurrences which satisfy the given closure from the items within this Iterator.static Number
Counts the number of occurrences of the given value from the items within this Iterator.static <K,
V> Number Counts the number of occurrences which satisfy the given closure from inside this map.static <T> Number
Counts the number of occurrences which satisfy the given closure from inside this array.Sorts all array members into groups determined by the supplied mapping closure and counts the group size.Sorts all collection members into groups determined by the supplied mapping closure and counts the group size.Sorts all iterator items into groups determined by the supplied mapping closure and counts the group size.Groups the members of a map into groups determined by the supplied mapping closure and counts the frequency of the created groups.static boolean
Returnstrue
if the intersection of two iterables is empty.static Number
Divide one Character by another.static Number
Divide a Character by a Number.static Number
Divide a Number by a Character.static void
Iterates from this number down to the given number, inclusive, decrementing by one each time.static void
Iterates from this number down to the given number, inclusive, decrementing by one each time.static void
Iterates from this number down to the given number, inclusive, decrementing by one each time.static void
Iterates from this number down to the given number, inclusive, decrementing by one each time.static void
Iterates from this number down to the given number, inclusive, decrementing by one each time.static void
Iterates from this number down to the given number, inclusive, decrementing by one each time.static void
Iterates from this number down to the given number, inclusive, decrementing by one each time.static void
downto
(BigDecimal self, Number to, Closure closure) Iterates from this number down to the given number, inclusive, decrementing by one each time.static void
downto
(BigInteger self, Number to, Closure closure) Iterates from this number down to the given number, inclusive, decrementing by one each time.static <T> Collection<T>
Drops the given number of elements from the head of this Iterable.static <T> Iterator<T>
Drops the given number of elements from the head of this iterator if they are available.static <T> List<T>
Drops the given number of elements from the head of this List.static <K,
V> Map<K, V> Drops the given number of key/value pairs from the head of this map if they are available.static <T> SortedSet<T>
Drops the given number of elements from the head of this List.static <T> T[]
drop
(T[] self, int num) Drops the given number of elements from the head of this array if they are available.static <T> Collection<T>
Drops the given number of elements from the tail of this Iterable.static <T> Iterator<T>
Drops the given number of elements from the tail of this Iterator.static <T> List<T>
Drops the given number of elements from the tail of this List.static <T> SortedSet<T>
Drops the given number of elements from the tail of this SortedSet.static <T> T[]
dropRight
(T[] self, int num) Drops the given number of elements from the tail of this array if they are available.static <T> Collection<T>
Returns a suffix of this Iterable where elements are dropped from the front while the given closure evaluates to true.static <T> Iterator<T>
Creates an Iterator that returns a suffix of the elements from an original Iterator.static <T> List<T>
Returns a suffix of this List where elements are dropped from the front while the given Closure evaluates to true.static <K,
V> Map<K, V> Create a suffix of the given Map by dropping as many entries as possible from the front of the original Map such that calling the given closure condition evaluates to true when passed each of the dropped entries (or key/value pairs).static <T> SortedSet<T>
Returns a suffix of this SortedSet where elements are dropped from the front while the given Closure evaluates to true.static <T> T[]
Create a suffix of the given array by dropping as many elements as possible from the front of the original array such that calling the given closure condition evaluates to true when passed each of the dropped elements.static String
Generates a detailed dump string of an object showing its class, hashCode and all accessible fields.static <T> Iterable<T>
Iterates through an Iterable, passing each item to the given closure.static <T> Collection<T>
each
(Collection<T> self, Closure closure) Iterates through a Collection, passing each item to the given closure.static <T> Iterator<T>
Iterates through an Iterator, passing each item to the given closure.static <T> List<T>
Iterates through a List, passing each item to the given closure.static <K,
V> Map<K, V> Allows a Map to be iterated through using a closure.static <T> Set<T>
Iterates through a Set, passing each item to the given closure.static <T> SortedSet<T>
Iterates through a SortedSet, passing each item to the given closure.static <T> T[]
Iterates through an array passing each array entry to the given closure.static <T> T
Iterates through an aggregate type or data structure, passing each item to the given closure.static void
Traverse through each byte of this byte array.static void
Traverse through each byte of this Byte array.static void
eachCombination
(Iterable self, Closure<?> function) Applies a function on each combination of the input lists.eachPermutation
(Iterable<T> self, Closure closure) Iterates over all permutations of a collection, running a closure for each iteration.static <T> Iterable<T>
eachWithIndex
(Iterable<T> self, Closure closure) Iterates through an iterable type, passing each item and the item's index (a counter starting at zero) to the given closure.static <T> Collection<T>
eachWithIndex
(Collection<T> self, Closure closure) Iterates through a Collection, passing each item and the item's index (a counter starting at zero) to the given closure.static <T> Iterator<T>
eachWithIndex
(Iterator<T> self, Closure closure) Iterates through an iterator type, passing each item and the item's index (a counter starting at zero) to the given closure.static <T> List<T>
eachWithIndex
(List<T> self, Closure closure) Iterates through a List, passing each item and the item's index (a counter starting at zero) to the given closure.static <K,
V> Map<K, V> eachWithIndex
(Map<K, V> self, Closure<?> closure) Allows a Map to be iterated through using a closure.static <T> Set<T>
eachWithIndex
(Set<T> self, Closure closure) Iterates through a Set, passing each item and the item's index (a counter starting at zero) to the given closure.static <T> SortedSet<T>
eachWithIndex
(SortedSet<T> self, Closure closure) Iterates through a SortedSet, passing each item and the item's index (a counter starting at zero) to the given closure.static <T> T[]
eachWithIndex
(T[] self, Closure closure) Iterates through an array, passing each array element and the element's index (a counter starting at zero) to the given closure.static <T> T
eachWithIndex
(T self, Closure closure) Iterates through an aggregate type or data structure, passing each item and the item's index (a counter starting at zero) to the given closure.static boolean
equals
(int[] left, int[] right) Compare the contents of this array to the contents of the given array.static boolean
Determines if the contents of this array are equal to the contents of the given list, in the same order.static boolean
Determines if the contents of this list are equal to the contents of the given array in the same order.static boolean
Compare the contents of two Lists.static boolean
Compares two Maps treating coerced numerical values as identical.static <T> boolean
Compare the contents of two Sets for equality using Groovy's coercion rules.static boolean
equalsIgnoreZeroSign
(Double number, Object other) Compares this object against the specified object returning the same result asDouble.equals(Object)
but returning true if this object and the specified object are both zero and negative zero respectively or vice versa.static boolean
equalsIgnoreZeroSign
(Float number, Object other) Compares this object against the specified object returning the same result asFloat.equals(Object)
but returning true if this object and the specified object are both zero and negative zero respectively or vice versa.static <T> boolean
Used to determine if the given predicate closure is valid (i.e.static boolean
Iterates over every element of a collection, and checks whether all elements aretrue
according to the Groovy Truth.static boolean
Used to determine if the given predicate closure is valid (i.e.static <T> boolean
Used to determine if the given predicate closure is valid (i.e.static <K,
V> boolean Iterates over the entries of a map, and checks whether a predicate is valid for all entries.static <T> boolean
Used to determine if the given predicate closure is valid (i.e.static Object
Finds the first item matching the IDENTITY Closure (i.e. matching Groovy truth).static Object
Finds the first value matching the closure condition.static <T> T
find
(Collection<T> self) Finds the first item matching the IDENTITY Closure (i.e. matching Groovy truth).static <T> T
find
(Collection<T> self, Closure closure) Finds the first value matching the closure condition.static <K,
V> Map.Entry<K, V> Finds the first entry matching the closure condition.static <T> T
Finds the first element in the array that matches the given closure condition.static List
Finds all items matching the IDENTITY Closure (i.e. matching Groovy truth).static List
Finds all items matching the closure condition.static <T> Collection<T>
findAll
(Collection<T> self) Finds the items matching the IDENTITY Closure (i.e. matching Groovy truth).static <T> Collection<T>
findAll
(Collection<T> self, Closure closure) Finds all values matching the closure condition.static <T> List<T>
Finds the items matching the IDENTITY Closure (i.e. matching Groovy truth).static <T> List<T>
Finds all values matching the closure condition.static <K,
V> Map<K, V> Finds all entries matching the closure condition.static <T> Set<T>
Finds the items matching the IDENTITY Closure (i.e. matching Groovy truth).static <T> Set<T>
Finds all values matching the closure condition.static <T> List<T>
findAll
(T[] self) Finds the elements of the array matching the IDENTITY Closure (i.e. matching Groovy truth).static <T> List<T>
Finds all elements of the array matching the given Closure condition.static Collection
findAll$$bridge
(Object self) Deprecated.static Collection
findAll$$bridge
(Object self, Closure closure) Deprecated.static <T> Collection<T>
findAll$$bridge
(T[] self) Deprecated.static <T> Collection<T>
findAll$$bridge
(T[] self, Closure condition) Deprecated.static <T> int
findIndexOf
(Iterable<T> self, int startIndex, Closure condition) Iterates over the elements of an Iterable, starting from a specified startIndex, and returns the index of the first item that satisfies the condition specified by the closure.static <T> int
findIndexOf
(Iterable<T> self, Closure condition) Iterates over the elements of an Iterable and returns the index of the first item that satisfies the condition specified by the closure.static int
findIndexOf
(Object self, int startIndex, Closure condition) Iterates over the elements of an aggregate of items, starting from a specified startIndex, and returns the index of the first item that matches the condition specified in the closure.static int
findIndexOf
(Object self, Closure condition) Iterates over the elements of an aggregate of items and returns the index of the first item that matches the condition specified in the closure.static <T> int
findIndexOf
(Iterator<T> self, int startIndex, Closure condition) Iterates over the elements of an Iterator, starting from a specified startIndex, and returns the index of the first item that satisfies the condition specified by the closure.static <T> int
findIndexOf
(Iterator<T> self, Closure condition) Iterates over the elements of an Iterator and returns the index of the first item that satisfies the condition specified by the closure.static <T> int
findIndexOf
(T[] self, int startIndex, Closure condition) Iterates over the elements of an Array, starting from a specified startIndex, and returns the index of the first item that satisfies the condition specified by the closure.static <T> int
findIndexOf
(T[] self, Closure condition) Iterates over the elements of an Array and returns the index of the first item that satisfies the condition specified by the closure.findIndexValues
(Iterable<T> self, Closure condition) Iterates over the elements of an Iterable and returns the index values of the items that match the condition specified in the closure.findIndexValues
(Iterable<T> self, Number startIndex, Closure condition) Iterates over the elements of an Iterable, starting from a specified startIndex, and returns the index values of the items that match the condition specified in the closure.findIndexValues
(Object self, Closure condition) Iterates over the elements of an aggregate of items and returns the index values of the items that match the condition specified in the closure.findIndexValues
(Object self, Number startIndex, Closure condition) Iterates over the elements of an aggregate of items, starting from a specified startIndex, and returns the index values of the items that match the condition specified in the closure.findIndexValues
(Iterator<T> self, Closure condition) Iterates over the elements of an Iterator and returns the index values of the items that match the condition specified in the closure.findIndexValues
(Iterator<T> self, Number startIndex, Closure condition) Iterates over the elements of an Iterator, starting from a specified startIndex, and returns the index values of the items that match the condition specified in the closure.findIndexValues
(T[] self, Closure condition) Iterates over the elements of an Array and returns the index values of the items that match the condition specified in the closure.findIndexValues
(T[] self, Number startIndex, Closure condition) Iterates over the elements of an Array, starting from a specified startIndex, and returns the index values of the items that match the condition specified in the closure.static <T> int
findLastIndexOf
(Iterable<T> self, int startIndex, Closure condition) Iterates over the elements of an Iterable, starting from a specified startIndex, and returns the index of the last item that matches the condition specified in the closure.static <T> int
findLastIndexOf
(Iterable<T> self, Closure condition) Iterates over the elements of an Iterable and returns the index of the last item that matches the condition specified in the closure.static int
findLastIndexOf
(Object self, int startIndex, Closure condition) Iterates over the elements of an aggregate of items, starting from a specified startIndex, and returns the index of the last item that matches the condition specified in the closure.static int
findLastIndexOf
(Object self, Closure condition) Iterates over the elements of an aggregate of items and returns the index of the last item that matches the condition specified in the closure.static <T> int
findLastIndexOf
(Iterator<T> self, int startIndex, Closure condition) Iterates over the elements of an Iterator, starting from a specified startIndex, and returns the index of the last item that matches the condition specified in the closure.static <T> int
findLastIndexOf
(Iterator<T> self, Closure condition) Iterates over the elements of an Iterator and returns the index of the last item that matches the condition specified in the closure.static <T> int
findLastIndexOf
(T[] self, int startIndex, Closure condition) Iterates over the elements of an Array, starting from a specified startIndex, and returns the index of the last item that matches the condition specified in the closure.static <T> int
findLastIndexOf
(T[] self, Closure condition) Iterates over the elements of an Array and returns the index of the last item that matches the condition specified in the closure.static <S,
T, U extends T, V extends T>
TfindResult
(Iterable<S> self, U defaultResult, Closure<V> condition) Iterates through the Iterable calling the given closure condition for each item but stopping once the first non-null result is found and returning that result.static <T> T
findResult
(Iterable<T> self) Iterates through the Iterable stopping once the first non-null result is found and returning that result.static <T,
U> T findResult
(Iterable<U> self, Closure<T> condition) Iterates through the Iterable calling the given closure condition for each item but stopping once the first non-null result is found and returning that result.static <T,
U extends T, V extends T>
TfindResult
(Iterable<U> self, V defaultResult) Iterates through the Iterable calling the given closure condition for each item but stopping once the first non-null result is found and returning that result.static Object
findResult
(Object self) Treats the object as iterable, iterating through the values it represents and returns the first non-null value, otherwise returns null.static Object
findResult
(Object self, Closure condition) Treats the object as iterable, iterating through the values it represents and returns the first non-null result obtained from calling the closure, otherwise returns null.static Object
findResult
(Object self, Object defaultResult) Treats the object as iterable, iterating through the values it represents and returns the first non-null result, otherwise returns the defaultResult.static Object
findResult
(Object self, Object defaultResult, Closure condition) Treats the object as iterable, iterating through the values it represents and returns the first non-null result obtained from calling the closure, otherwise returns the defaultResult.static <S,
T, U extends T, V extends T>
TfindResult
(Iterator<S> self, U defaultResult, Closure<V> condition) Iterates through the Iterator calling the given closure condition for each item but stopping once the first non-null result is found and returning that result.static <T> T
findResult
(Iterator<T> self) Iterates through the Iterator stopping once the first non-null result is found and returning that result.static <T,
U> T findResult
(Iterator<U> self, Closure<T> condition) Iterates through the Iterator calling the given closure condition for each item but stopping once the first non-null result is found and returning that result.static <T,
U extends T, V extends T>
TfindResult
(Iterator<U> self, V defaultResult) Iterates through the Iterator stopping once the first non-null result is found and returning that result.static <T,
U extends T, V extends T, A, B>
TfindResult
(Map<A, B> self, U defaultResult, Closure<V> condition) Returns the first non-null closure result found by passing each map entry to the closure, otherwise the defaultResult is returned.static <T,
K, V> T findResult
(Map<K, V> self, Closure<T> condition) Returns the first non-null closure result found by passing each map entry to the closure, otherwise null is returned.static <S,
T> T findResult
(S[] self, Closure<T> condition) Iterates through the Array calling the given closure condition for each item but stopping once the first non-null result is found and returning that result.static <S,
T, U extends T, V extends T>
TfindResult
(S[] self, U defaultResult, Closure<V> condition) Iterates through the Array calling the given closure condition for each item but stopping once the first non-null result is found and returning that result.static <T> T
findResult
(T[] self) Iterates through the Array stopping once the first non-null result is found and returning that result.static <T,
U extends T, V extends T>
TfindResult
(U[] self, V defaultResult) Iterates through the Array stopping once the first non-null result is found and returning that result.static <T> Collection<T>
findResults
(Iterable<T> self) Iterates through the Iterable collecting any non-null results.static <T,
U> Collection<T> findResults
(Iterable<U> self, Closure<T> filteringTransform) Iterates through the Iterable transforming items using the supplied closure and collecting any non-null results.static <T> Collection<T>
findResults
(Iterator<T> self) Iterates through the Iterator collecting any non-null results.static <T,
U> Collection<T> findResults
(Iterator<U> self, Closure<T> filteringTransform) Iterates through the Iterator transforming items using the supplied closure and collecting any non-null results.static <T,
K, V> Collection<T> findResults
(Map<K, V> self, Closure<T> filteringTransform) Iterates through the map transforming items using the supplied closure and collecting any non-null results.static <T> Collection<T>
findResults
(T[] self) Iterates through the Array collecting any non-null results.static <T,
U> Collection<T> findResults
(U[] self, Closure<T> filteringTransform) Iterates through the Array transforming items using the supplied closure and collecting any non-null results.static <T> T
Returns the first item from the Iterable.static <T> T
Returns the first item from the List.static <T> T
first
(T[] self) Returns the first item from the array.static Collection
flatten
(boolean[] self) Flatten an array.static Collection
flatten
(byte[] self) Flatten an array.static Collection
flatten
(char[] self) Flatten an array.static Collection
flatten
(double[] self) Flatten an array.static Collection
flatten
(float[] self) Flatten an array.static Collection
flatten
(int[] self) Flatten an array.static Collection
flatten
(long[] self) Flatten an array.static Collection
flatten
(short[] self) Flatten an array.static Collection<?>
Flatten an Iterable.static <T> Collection<T>
Flatten an Iterable.static Collection
Flatten an array.static Collection<?>
flatten
(Collection<?> self) Flatten a Collection.static List<?>
Flatten a List.static Set<?>
Flatten a Set.static SortedSet<?>
Flatten a SortedSet.static <K,
V> V Looks up an item in a Map for the given key and returns the corresponding value.Support the subscript operator with an IntRange for a boolean arraygetAt
(boolean[] array, ObjectRange range) Support the subscript operator with an ObjectRange for a byte arraySupport the subscript operator with a range for a boolean arraygetAt
(boolean[] array, Collection indices) Support the subscript operator with a collection for a boolean arraySupport the subscript operator with an IntRange for a byte arraygetAt
(byte[] array, ObjectRange range) Support the subscript operator with an ObjectRange for a byte arraySupport the subscript operator with a range for a byte arraygetAt
(byte[] array, Collection indices) Support the subscript operator with a collection for a byte arraySupport the subscript operator with an IntRange for a char arraygetAt
(char[] array, ObjectRange range) Support the subscript operator with an ObjectRange for a char arraySupport the subscript operator with a range for a char arraygetAt
(char[] array, Collection indices) Support the subscript operator with a collection for a char arraySupport the subscript operator with an IntRange for a double arraygetAt
(double[] array, ObjectRange range) Support the subscript operator with an ObjectRange for a double arraySupport the subscript operator with a range for a double arraygetAt
(double[] array, Collection indices) Support the subscript operator with a collection for a double arraySupport the subscript operator with an IntRange for a float arraygetAt
(float[] array, ObjectRange range) Support the subscript operator with an ObjectRange for a float arraySupport the subscript operator with a range for a float arraygetAt
(float[] array, Collection indices) Support the subscript operator with a collection for a float arraySupport the subscript operator with an IntRange for an int arraygetAt
(int[] array, ObjectRange range) Support the subscript operator with an ObjectRange for an int arraySupport the subscript operator with a range for an int arraygetAt
(int[] array, Collection indices) Support the subscript operator with a collection for an int arraySupport the subscript operator with an IntRange for a long arraygetAt
(long[] array, ObjectRange range) Support the subscript operator with an ObjectRange for a long arraySupport the subscript operator with a range for a long arraygetAt
(long[] array, Collection indices) Support the subscript operator with a collection for a long arraySupport the subscript operator with an IntRange for a short arraygetAt
(short[] array, ObjectRange range) Support the subscript operator with an ObjectRange for a short arraySupport the subscript operator with a range for a short arraygetAt
(short[] array, Collection indices) Support the subscript operator with a collection for a short arraystatic <T> List<T>
getAt
(ListWithDefault<T> self, EmptyRange range) Support the range subscript operator for an eager or lazy List.static <T> List<T>
getAt
(ListWithDefault<T> self, Range range) Support the range subscript operator for an eager or lazy List.static <T> List<T>
getAt
(ListWithDefault<T> self, Collection indices) Select a List of items from an eager or lazy List using a Collection to identify the indices to be selected.static <T> T
Support the subscript operator for an Iterable.static Object
Allows the subscript operator to be used to lookup dynamic property values.static boolean
Support the subscript operator for a Bitsetstatic BitSet
Support retrieving a subset of a BitSet using a Rangestatic List
getAt
(Collection coll, String property) Support the subscript operator for Collection.static <T> T
Support the subscript operator for an Iterator.static <T> T
Support the subscript operator for a List.static <T> List<T>
getAt
(List<T> self, EmptyRange range) Support the range subscript operator for a List.static <T> List<T>
Support the range subscript operator for a List.static <T> T
Support subscript operator for list access.static <T> List<T>
getAt
(List<T> self, Collection indices) Select a List of items from a List using a Collection to identify the indices to be selected.static <K,
V> V Support the subscript operator for a Map.static <T> List<T>
getAt
(T[] array, EmptyRange range) static <T> List<T>
static <T> List<T>
getAt
(T[] array, ObjectRange range) static <T> List<T>
Support the range subscript operator for an Arraystatic <T> List<T>
getAt
(T[] self, Collection indices) Select a List of items from an array using a Collection to identify the indices to be selected.static Groovydoc
getGroovydoc
(AnnotatedElement holder) Get runtime groovydocstatic IntRange
getIndices
(boolean[] self) Returns indices of the boolean array.static IntRange
getIndices
(byte[] self) Returns indices of the byte array.static IntRange
getIndices
(char[] self) Returns indices of the char array.static IntRange
getIndices
(double[] self) Returns indices of the double array.static IntRange
getIndices
(float[] self) Returns indices of the float array.static IntRange
getIndices
(int[] self) Returns indices of the int array.static IntRange
getIndices
(long[] self) Returns indices of the long array.static IntRange
getIndices
(short[] self) Returns indices of the short array.static IntRange
getIndices
(Collection self) Returns indices of the collection.static <T> IntRange
getIndices
(T[] self) Returns indices of the array.static URL
getLocation
(Class self) Gets the url of the jar file/source file containing the specified classstatic MetaClass
getMetaClass
(GroovyObject obj) Obtains a MetaClass for an object either from the registry or in the case of a GroovyObject from the object itself.static MetaClass
Adds a "metaClass" property to all class objects so you can use the syntaxString.metaClass.myMethod = { println "foo" }
static MetaClass
getMetaClass
(Object obj) Obtains a MetaClass for an object either from the registry or in the case of a GroovyObject from the object itself.static List<PropertyValue>
getMetaPropertyValues
(Object self) Retrieves the list ofMetaProperty
objects for 'self' and wraps it in a list ofPropertyValue
objects that additionally provide the value for each property of 'self'.static Map
getProperties
(Object self) Convenience method that callsgetMetaPropertyValues(java.lang.Object)
(self) and provides the data in form of simple key/value pairs, i.e.static ClassLoader
getRootLoader
(ClassLoader self) Iterates through the classloader parents until it finds a loader with a class named "org.codehaus.groovy.tools.RootLoader".protected static List
getSubList
(List self, List splice) Deprecated.static Collection
Iterates over the collection of items which this Object represents and returns each item that matches using the IDENTITY Closure as a filter - effectively returning all elements which satisfy Groovy truth.static Collection
Iterates over the collection of items which this Object represents and returns each item that matches the given filter - calling the
method used by switch statements.isCase(java.lang.Object, java.lang.Object)
static <T> Collection<T>
grep
(Collection<T> self) Iterates over the collection returning each element that matches using the IDENTITY Closure as a filter - effectively returning all elements which satisfy Groovy truth.static <T> Collection<T>
grep
(Collection<T> self, Object filter) Iterates over the collection of items and returns each item that matches the given filter - calling the
method used by switch statements.isCase(java.lang.Object, java.lang.Object)
static <T> List<T>
Iterates over the collection returning each element that matches using the IDENTITY Closure as a filter - effectively returning all elements which satisfy Groovy truth.static <T> List<T>
Iterates over the collection of items and returns each item that matches the given filter - calling the
method used by switch statements.isCase(java.lang.Object, java.lang.Object)
static <T> Set<T>
Iterates over the collection returning each element that matches using the IDENTITY Closure as a filter - effectively returning all elements which satisfy Groovy truth.static <T> Set<T>
Iterates over the collection of items and returns each item that matches the given filter - calling the
method used by switch statements.isCase(java.lang.Object, java.lang.Object)
static <T> Collection<T>
grep
(T[] self) Iterates over the array returning each element that matches using the IDENTITY Closure as a filter - effectively returning all elements which satisfy Groovy truth.static <T> Collection<T>
Iterates over the array of items and returns a collection of items that match the given filter - calling the
method used by switch statements.isCase(java.lang.Object, java.lang.Object)
protected static <K,
T> void groupAnswer
(Map<K, List<T>> answer, T element, K value) Groups the current element according to the valueSorts all Iterable members into groups determined by the supplied mapping closure.static Map
Sorts all Iterable members into (sub)groups determined by the supplied mapping closures.static Map
Sorts all Iterable members into (sub)groups determined by the supplied mapping closures.static Map
Sorts all array members into (sub)groups determined by the supplied mapping closures as per the Iterable variant of this method.static Map
Sorts all array members into (sub)groups determined by the supplied mapping closures as per the list variant of this method.Groups the members of a map into sub maps determined by the supplied mapping closure.Groups the members of a map into sub maps determined by the supplied mapping closures.Groups the members of a map into sub maps determined by the supplied mapping closures.Sorts all array members into groups determined by the supplied mapping closure.groupEntriesBy
(Map<K, V> self, Closure<G> closure) Groups all map entries into groups determined by the supplied mapping closure.static MetaProperty
hasProperty
(Object self, String name) Returns true of the implementing MetaClass has a property of the given namestatic <T> T
Returns the first item from the Iterable.static <T> T
Returns the first item from the List.static <T> T
head
(T[] self) Returns the first item from the Object array.static <T,
U> T Allows the closure to be called for the object reference self.static Boolean
Logical implication of two boolean operatorsindexed
(double[] self) Zips a double[] with indices in (index, value) order starting from index 0.indexed
(double[] self, int offset) Zips a double[] with indices in (index, value) order.indexed
(int[] self) Zips an int[] with indices in (index, value) order starting from index 0.indexed
(int[] self, int offset) Zips an int[] with indices in (index, value) order.indexed
(long[] self) Zips a long[] with indices in (index, value) order starting from index 0.indexed
(long[] self, int offset) Zips a long[] with indices in (index, value) order.Zips an Iterable with indices in (index, value) order.Zips an Iterable with indices in (index, value) order.Zips an iterator with indices in (index, value) order.Zips an iterator with indices in (index, value) order.static <T> Collection<T>
Returns the items from the Iterable excluding the last item.static <T> Iterator<T>
Returns an Iterator containing all the items from this iterator except the last one.static <T> List<T>
Returns the items from the List excluding the last item.static <T> SortedSet<T>
Returns the items from the SortedSet excluding the last item.static <T> T[]
init
(T[] self) Returns the items from the Object array excluding the last item.Calculates the init values of this Iterable: the first value will be this list of all items from the iterable and the final one will be an empty list, with the intervening values the results of successive applications of init on the items.static <E,
T, V extends T>
TIterates through the given array as with inject(Object[],initialValue,closure), but using the first element of the array as the initialValue, and then iterating the remaining elements of the array.static <E,
T, U extends T, V extends T>
TIterates through the given array, passing in the initial value to the closure along with the first item.static <T,
V extends T>
TIterates through the given Object, passing in the first value to the closure along with the first item.static <T,
U extends T, V extends T>
TIterates through the given Object, passing in the initial value to the closure along with the first item.static <E,
T, U extends T, V extends T>
Tinject
(Collection<E> self, U initialValue, Closure<V> closure) Iterates through the given Collection, passing in the initial value to the 2-arg closure along with the first item.static <T,
V extends T>
Tinject
(Collection<T> self, Closure<V> closure) Performs the same function as the version of inject that takes an initial value, but uses the head of the Collection as the initial value, and iterates over the tail.static <E,
T, U extends T, V extends T>
TIterates through the given Iterator, passing in the initial value to the closure along with the first item.static <K,
V, T, U extends T, W extends T>
TIterates through the given Map, passing in the initial value to the 2-arg Closure along with the first item (or 3-arg Closure along with the first key and value).static String
Inspects returns the String that matches what would be typed into a terminal to create this object.static Number
Integer Divide two Characters.static Number
Integer Divide a Character by a Number.static Number
Integer Divide a Number by a Character.static Number
Integer Divide two Numbers.static <T> Collection<T>
Create a Collection composed of the intersection of both iterables.static <T> Collection<T>
Create a Collection composed of the intersection of both iterables.static <T> Collection<T>
intersect
(Iterable<T> left, Iterable<T> right, Comparator<? super T> comparator) Create a Collection composed of the intersection of both iterables.static <T> Collection<T>
intersect
(Collection<T> left, Collection<T> right) Create a Collection composed of the intersection of both collections.static <T> Collection<T>
intersect
(Collection<T> left, Collection<T> right, Comparator<? super T> comparator) Create a Collection composed of the intersection of both collections.static <T> List<T>
Create a List composed of the intersection of a List and an Iterable.static <T> List<T>
intersect
(List<T> left, Iterable<T> right, Comparator<? super T> comparator) Create a List composed of the intersection of a List and an Iterable.static <K,
V> Map<K, V> Create a Map composed of the intersection of both maps.static <T> Set<T>
Create a Set composed of the intersection of a Set and an Iterable.static <T> Set<T>
intersect
(Set<T> left, Iterable<T> right, Comparator<? super T> comparator) Create a Set composed of the intersection of a Set and an Iterable.static <T> SortedSet<T>
Create a SortedSet composed of the intersection of a SortedSet and an Iterable.static <T> SortedSet<T>
intersect
(SortedSet<T> left, Iterable<T> right, Comparator<? super T> comparator) Create a SortedSet composed of the intersection of a SortedSet and an Iterable.static Object
invokeMethod
(Object object, String method, Object arguments) Provide a dynamic method invocation method which can be overloaded in classes to implement dynamic proxies easily.static boolean
Identity check.static Boolean
isAtLeast
(BigDecimal left, String right) Compare a BigDecimal to a String representing a number.static Boolean
isAtLeast
(BigDecimal left, BigDecimal right) Compare a BigDecimal to another.static boolean
Special 'Case' implementation for Class, which allows testing whether some switch value is assignable from the given case class.static boolean
Special 'case' implementation for all numbers, which delegates to thecompareTo()
method for comparing numbers of different types.static boolean
Method for overloading the behavior of the 'case' method in switch statements.static boolean
isCase
(Collection caseValue, Object switchValue) 'Case' implementation for collections which tests if the 'switch' operand is contained in any of the 'case' values.static boolean
'Case' implementation for maps which tests the groovy truth value obtained using the 'switch' operand as key.static boolean
Determines if a character is a digit.static boolean
Check whether anIterable
has elementsstatic boolean
Determines if a character is a letter.static boolean
isLetterOrDigit
(Character self) Determines if a character is a letter or digit.static boolean
isLowerCase
(Character self) Determine if a Character is lowercase.static boolean
static boolean
static boolean
static boolean
static boolean
isNotCase
(Collection<?> caseValue, Object switchValue) static boolean
static boolean
isUpperCase
(Character self) Determine if a Character is uppercase.static boolean
isWhitespace
(Character self) Determines if a character is a whitespace character.static Iterator
Attempts to create an Iterator for the given object by first converting it to a Collection.static <T> Iterator<T>
iterator
(Enumeration<T> enumeration) Allows an Enumeration to behave like an Iterator.static <T> Iterator<T>
An identity function for iterators, supporting 'duck-typing' when trying to get an iterator for each object within a collection, some of which may already be iterators.static <T> Iterator<T>
iterator
(T[] a) Attempts to create an Iterator for the given object by first converting it to a Collection.static String
Concatenates the string representation of each item in this array, with the given String as a separator between each item.static String
Concatenates the string representation of each item in this array, with the given String as a separator between each item.static String
Concatenates the string representation of each item in this array, with the given String as a separator between each item.static String
Concatenates the string representation of each item in this array, with the given String as a separator between each item.static String
Concatenates the string representation of each item in this array, with the given String as a separator between each item.static String
Concatenates the string representation of each item in this array, with the given String as a separator between each item.static String
Concatenates the string representation of each item in this array, with the given String as a separator between each item.static String
Concatenates the string representation of each item in this array, with the given String as a separator between each item.static String
Concatenates thetoString()
representation of each item in this Iterable, with the given String as a separator between each item.static String
Concatenates thetoString()
representation of each item from the iterator, with the given String as a separator between each item.static <T> String
Concatenates thetoString()
representation of each item in this array, with the given String as a separator between each item.static <T> T
Returns the last item from the Iterable.static <T> T
An optimized version oflast(List)
.static <T> T
Returns the last item from the List.static <T> T
last
(T[] self) Returns the last item from the array.static Number
Implementation of the left shift operator for integral types.static <T> Collection<T>
leftShift
(Collection<T> self, T value) Overloads the left shift operator to provide an easy way to append objects to a Collection.static <T> BlockingQueue<T>
leftShift
(BlockingQueue<T> self, T value) Overloads the left shift operator to provide an easy way to append objects to a BlockingQueue.static <T> List<T>
Overloads the left shift operator to provide an easy way to append objects to a List.static <K,
V> Map<K, V> Overloads the left shift operator to provide an easy way to append Map.Entry values to a Map.static <K,
V> Map<K, V> Overloads the left shift operator to provide an easy way to put one maps entries into another map.static <T> Set<T>
Overloads the left shift operator to provide an easy way to append objects to a Set.static <T> SortedSet<T>
Overloads the left shift operator to provide an easy way to append objects to a SortedSet.static double
max
(double[] self) Adds max() method to double arrays.static int
max
(int[] self) Adds max() method to int arrays.static long
max
(long[] self) Adds max() method to long arrays.static <T> T
Adds max() method to Iterable objects.static <T> T
Selects the item in the iterable which when passed as a parameter to the supplied closure returns the maximum value.static <T> T
max
(Iterable<T> self, Comparator<? super T> comparator) Selects the maximum value found in the Iterable using the given comparator.static <T> T
Adds max() method to Iterator objects.static <T> T
Selects the maximum value found from the Iterator using the closure to determine the correct ordering.static <T> T
max
(Iterator<T> self, Comparator<? super T> comparator) Selects the maximum value found from the Iterator using the given comparator.static <K,
V> Map.Entry<K, V> Selects an entry in the map having the maximum calculated value as determined by the supplied closure.static <T> T
max
(T[] self) Adds max() method to Object arrays.static <T> T
Selects the maximum value found from the Object array using the closure to determine the correct ordering.static <T> T
max
(T[] self, Comparator<? super T> comparator) Selects the maximum value found from the Object array using the given comparator.static MetaClass
Sets/updates the metaclass for a given class to a closure.static MetaClass
Sets/updates the metaclass for a given object to a closure.static double
min
(double[] self) Adds min() method to double arrays.static int
min
(int[] self) Adds min() method to int arrays.static long
min
(long[] self) Adds min() method to long arrays.static <T> T
Adds min() method to Collection objects.static <T> T
Selects the item in the iterable which when passed as a parameter to the supplied closure returns the minimum value.static <T> T
min
(Iterable<T> self, Comparator<? super T> comparator) Selects the minimum value found in the Iterable using the given comparator.static <T> T
Adds min() method to Iterator objects.static <T> T
Selects the minimum value found from the Iterator using the closure to determine the correct ordering.static <T> T
min
(Iterator<T> self, Comparator<? super T> comparator) Selects the minimum value found from the Iterator using the given comparator.static <K,
V> Map.Entry<K, V> Selects an entry in the map having the minimum calculated value as determined by the supplied closure.static <T> T
min
(T[] self) Adds min() method to Object arrays.static <T> T
Selects the minimum value found from the Object array using the closure to determine the correct ordering.static <T> T
min
(T[] self, Comparator<? super T> comparator) Selects the minimum value found from the Object array using the given comparator.static Number
Subtract one Character from another.static Number
Subtract a Number from a Character.static <T> Collection<T>
Create a new Collection composed of the elements of the first Iterable minus every occurrence of elements of the given Iterable.static <T> Collection<T>
Create a new Collection composed of the elements of the first Iterable minus every matching occurrence as determined by the condition closure of elements of the given Iterable.static <T> Collection<T>
minus
(Iterable<T> self, Iterable<?> removeMe, Comparator<? super T> comparator) Create a new Collection composed of the elements of the first Iterable minus every matching occurrence as determined by the condition comparator of elements of the given Iterable.static <T> Collection<T>
Create a new Collection composed of the elements of the first Iterable minus every occurrence of the given element to remove.static Number
Subtract a Character from a Number.static <T> Collection<T>
minus
(Collection<T> self, Collection<?> removeMe) Create a new Collection composed of the elements of the first Collection minus every occurrence of elements of the given Collection.static <T> List<T>
Create a new List composed of the elements of the first List minus every occurrence of elements of the given Iterable.static <T> List<T>
Create a new List composed of the elements of the first List minus every occurrence of the given element to remove.static <T> List<T>
minus
(List<T> self, Collection<?> removeMe) Create a List composed of the elements of the first list minus every occurrence of elements of the given Collection.static <K,
V> Map<K, V> Create a Map composed of the entries of the first map minus the entries of the given map.static <T> Set<T>
Create a Set composed of the elements of the first Set minus the elements from the given Iterable.static <T> Set<T>
Create a Set composed of the elements of the first Set minus the given element.static <T> Set<T>
minus
(Set<T> self, Collection<?> removeMe) Create a Set composed of the elements of the first Set minus the elements of the given Collection.static <T> SortedSet<T>
Create a SortedSet composed of the elements of the first SortedSet minus the elements of the given Iterable.static <T> SortedSet<T>
Create a SortedSet composed of the elements of the first SortedSet minus the given element.static <T> SortedSet<T>
minus
(SortedSet<T> self, Collection<?> removeMe) Create a SortedSet composed of the elements of the first SortedSet minus the elements of the given Collection.static <T> T[]
Create a new array composed of the elements of the first array minus the elements of the given Iterable.static <T> T[]
Create a new array composed of the elements of the given array minus every occurrence the given object.static <T> T[]
Create a new array composed of the elements of the first array minus the elements of the given array.static void
Extend class globally with category methods.static void
Extend class globally with category methods.static void
Extend object with category methods.static void
Extend class globally with category methods.static void
Extend class globally with category methods.static void
Extend class globally with category methods.static Number
Performs a division modulus operation.static Number
Multiply two Characters.static Number
Multiply a Character by a Number.static <T> Collection<T>
Create a Collection composed of the elements of this Iterable, repeated a certain number of times.static Number
Multiply a Number by a Character.static Number
multiply
(BigDecimal left, Double right) Multiply a BigDecimal and a Double.static Number
multiply
(BigDecimal left, BigInteger right) Multiply a BigDecimal and a BigInteger.static <T> List<T>
Create a List composed of the elements of this Iterable, repeated a certain number of times.static <T> T
newInstance
(Class<T> c) Convenience method to dynamically create a new instance of this class.static <T> T
newInstance
(Class<T> c, Object[] args) Helper to construct a new instance from the given arguments.static Character
Increment a Character by one.static Number
Increment a Number by one.static int
numberAwareCompareTo
(Comparable self, Comparable other) Provides a method that compares two comparables using Groovy's default number aware comparator.static Boolean
Logical disjunction of two boolean operatorsstatic Number
Bitwise OR together two numbers.static BitSet
Bitwise OR together two BitSets.permutations
(Iterable<T> self) Finds all permutations of an iterable.static <T,
V> List<V> permutations
(Iterable<T> self, Closure<V> function) Finds all permutations of an iterable, applies a function to each permutation and collects the result into a list.static Number
Add one Character to another.static Number
Add a Character and a Number.static <T> Collection<T>
Create a Collection as a union of two iterables.static <T> Collection<T>
Create a collection as a union of an Iterable and an Object.static Number
Add a Number and a Character.static <T> Collection<T>
plus
(Collection<T> left, Iterable<T> right) Create a Collection as a union of a Collection and an Iterable.static <T> Collection<T>
plus
(Collection<T> left, Collection<T> right) Create a Collection as a union of two collections.static <T> Collection<T>
plus
(Collection<T> left, T right) Create a collection as a union of a Collection and an Object.static <T> List<T>
Creates a new List by inserting all the elements in the given Iterable to the elements from this List at the specified index.static <T> List<T>
Creates a new List by inserting all the elements in the given additions List to the elements from the original List at the specified index.static <T> List<T>
Creates a new List by inserting all the elements in the specified array to the elements from the original List at the specified index.static <T> List<T>
Create a List as a union of a List and an Iterable.static <T> List<T>
plus
(List<T> left, Collection<T> right) Create a List as a union of a List and a Collection.static <T> List<T>
Create a List as a union of a List and an Object.static <K,
V> Map<K, V> plus
(Map<K, V> self, Collection<? extends Map.Entry<? extends K, ? extends V>> entries) Returns a newMap
containing all entries fromself
andentries
, giving precedence toentries
.static <K,
V> Map<K, V> Returns a newMap
containing all entries fromleft
andright
, giving precedence toright
.static String
Appends a GString to the literal of the Map instance.static String
Appends a String to the literal of the Map instance.static <T> Set<T>
Create a Set as a union of a Set and an Iterable.static <T> Set<T>
plus
(Set<T> left, Collection<T> right) Create a Set as a union of a Set and a Collection.static <T> Set<T>
Create a Set as a union of a Set and an Object.static <T> SortedSet<T>
Create a SortedSet as a union of a SortedSet and an Iterable.static <T> SortedSet<T>
plus
(SortedSet<T> left, Collection<T> right) Create a SortedSet as a union of a SortedSet and a Collection.static <T> SortedSet<T>
Create a SortedSet as a union of a SortedSet and an Object.static <T> T[]
Create an array containing elements from an original array plus those from an Iterable.static <T> T[]
Create an array containing elements from an original array plus an additional appended element.static <T> T[]
Create an array as a union of two arrays.static <T> T[]
plus
(T[] left, Collection<?> right) Create an array containing elements from an original array plus those from a Collection.static <T> T
Removes the initial item from the List.static Number
Power of an integer to an integer certain exponent.static Number
Power of a long to an integer certain exponent.static Number
Power of a Number to a certain exponent.static Number
power
(BigDecimal self, Integer exponent) Power of a BigDecimal to an integer certain exponent.static Number
power
(BigInteger self, Integer exponent) Power of a BigInteger to an integer certain exponent.static BigInteger
power
(BigInteger self, BigInteger exponent) Power of a BigInteger to a BigInteger certain exponent.static Character
Decrement a Character by one.static Number
Decrement a Number by one.protected static Object
primitiveArrayGet
(Object self, int idx) Implements the getAt(int) method for primitive type arrays.protected static List
primitiveArrayGet
(Object self, Range range) Implements the getAt(Range) method for primitive type arrays.protected static List
primitiveArrayGet
(Object self, Collection indices) Implements the getAt(Collection) method for primitive type arrays.protected static Object
primitiveArrayPut
(Object self, int idx, Object newValue) Implements the setAt(int idx) method for primitive type arrays.static void
Print a value to the standard output stream.static void
print
(PrintStream self, Object value) Print a value formatted Groovy style to the print stream.static void
print
(PrintWriter self, Object value) Print a value formatted Groovy style to the print writer.static void
print
(Object self, PrintWriter out) Print to a console in interactive format.static void
Print a value formatted Groovy style to self if it is a Writer, otherwise to the standard output stream.static void
Printf a value to the standard output stream using a format string.static void
Printf 0 or more values to the standard output stream using a format string.static void
Prints a formatted string using the specified format string and arguments.static void
Printf to the standard output stream.static void
Print a linebreak to the standard output stream.static void
Print a value (followed by a newline) to the standard output stream.static void
println
(PrintStream self, Object value) Print a value formatted Groovy style (followed by a newline) to the print stream.static void
println
(PrintWriter self, Object value) Print a value formatted Groovy style (followed by a newline) to the print writer.static void
Print a linebreak to the standard output stream.static void
println
(Object self, PrintWriter out) Print to a console in interactive format.static void
Print a value formatted Groovy style (followed by a newline) to self if it is a Writer, otherwise to the standard output stream.static <T> boolean
Prepends an item to the start of the List.static <K,
V> Map<K, V> putAll
(Map<K, V> self, Collection<? extends Map.Entry<? extends K, ? extends V>> entries) Provides an easy way to append multiple Map.Entry values to a Map.static void
Allows the subscript operator to be used to set dynamically named property values.static void
Support subscript-style assignment for a BitSet.static void
Support assigning a range of values with a single assignment statement.static <T> void
A helper method to allow lists to work with subscript operators.static <T> void
Support subscript operator for list modification.static void
putAt
(List self, EmptyRange range, Object value) A helper method to allow lists to work with subscript operators.static void
putAt
(List self, EmptyRange range, Collection value) A helper method to allow lists to work with subscript operators.static void
List subscript assignment operator when given a range as the index.static void
putAt
(List self, IntRange range, Collection col) List subscript assignment operator when given a range as the index and the assignment operand is a collection.static void
A helper method to allow lists to work with subscript operators.static void
A helper method to allow lists to work with subscript operators.static <K,
V> V A helper method to allow maps to work with subscript operatorsstatic <T> boolean
removeAll
(Collection<T> self, Closure condition) Modifies this collection by removing the elements that are matched according to the specified closure condition.static boolean
removeAll
(Collection self, Object[] items) Modifies this collection by removing its elements that are contained within the specified object array.static <K,
V> boolean Modifies this map by removing the elements that are matched according to the specified closure condition.static <E> E
Modifies this list by removing the element at the specified position in this list.static <E> boolean
removeElement
(Collection<E> self, Object o) Modifies this collection by removing a single instance of the specified element from this collection, if it is present.static <T> T
removeLast
(List<T> self) Removes the last item from the List.static List<MetaMethod>
respondsTo
(Object self, String name) Returns an object satisfying Groovy truth if the implementing MetaClass responds to a method with the given name regardless of the arguments.static List<MetaMethod>
respondsTo
(Object self, String name, Object[] argTypes) Returns an object satisfying Groovy truth if the implementing MetaClass responds to a method with the given name and arguments types.static <T> boolean
retainAll
(Collection<T> self, Closure condition) Modifies this collection so that it retains only its elements that are matched according to the specified closure condition.static boolean
retainAll
(Collection self, Object[] items) Modifies this collection so that it retains only its elements that are contained in the specified array.static <K,
V> boolean Modifies this map so that it retains only its elements that are matched according to the specified closure condition.static <T> Iterator<T>
Reverses the iterator.static <T> List<T>
Creates a new List with the identical contents to this list but in reverse order.static <T> List<T>
Reverses the elements in a list.static <T> T[]
reverse
(T[] self) Creates a new array containing items which are the same as this array but in reverse order.static <T> T[]
reverse
(T[] self, boolean mutate) Reverse the items in an array.static <T> List<T>
reverseEach
(List<T> self, Closure closure) Iterate over each element of the list in the reverse order.static <K,
V> Map<K, V> reverseEach
(Map<K, V> self, Closure<?> closure) Allows a Map to be iterated through in reverse order using a closure.static <T> T[]
reverseEach
(T[] self, Closure closure) Iterate over each element of the array in the reverse order.static Number
rightShift
(Number self, Number operand) Implementation of the right shift operator for integral types.static Number
rightShiftUnsigned
(Number self, Number operand) Implementation of the right shift (unsigned) operator for integral types.static long
Round the valuestatic double
Round the valuestatic int
Round the valuestatic float
Round the valuestatic BigDecimal
round
(BigDecimal number) Round the valuestatic BigDecimal
round
(BigDecimal number, int precision) Round the valuestatic TimerTask
Allows a simple syntax for using timers.static void
setMetaClass
(GroovyObject self, MetaClass metaClass) Sets the metaclass for aGroovyObject
.static void
setMetaClass
(Class self, MetaClass metaClass) Sets the metaclass for a given class.static void
setMetaClass
(Object self, MetaClass metaClass) Sets the metaclass for an object.static void
Randomly reorders the elements of the specified list.static void
Randomly reorders the elements of the specified list using the specified random instance as the source of randomness.static <T> void
shuffle
(T[] self) Randomly reorders the elements of the specified array.static <T> void
Randomly reorders the elements of the specified array using the specified random instance as the source of randomness.static <T> List<T>
Creates a new list containing the elements of the specified list but in a random order.static <T> List<T>
Creates a new list containing the elements of the specified list but in a random order using the specified random instance as the source of randomness.static <T> T[]
shuffled
(T[] self) Creates a new array containing the elements of the specified array but in a random order.static <T> T[]
Creates a new array containing the elements of the specified array but in a random order using the specified random instance as the source of randomness.static int
size
(boolean[] array) Allows arrays to behave similar to collections.static int
size
(byte[] array) Allows arrays to behave similar to collections.static int
size
(char[] array) Allows arrays to behave similar to collections.static int
size
(double[] array) Allows arrays to behave similar to collections.static int
size
(float[] array) Allows arrays to behave similar to collections.static int
size
(int[] array) Allows arrays to behave similar to collections.static int
size
(long[] array) Allows arrays to behave similar to collections.static int
size
(short[] array) Allows arrays to behave similar to collections.static int
Provide the standard Groovysize()
method forIterable
.static int
Provide the standard Groovysize()
method for an array.static int
Provide the standard Groovysize()
method forIterator
.static <T> List<T>
Sorts the Collection.static <T> List<T>
Sorts the Iterable.static <T> List<T>
Sorts this Iterable using the given Closure to determine the correct ordering.static <T> List<T>
sort
(Iterable<T> self, boolean mutate, Comparator<? super T> comparator) Sorts the Iterable using the given Comparator.static <T> List<T>
Sorts this Iterable using the given Closure to determine the correct ordering.static <T> Iterator<T>
Sorts the given iterator items into a sorted iterator.static <T> Iterator<T>
Sorts the given iterator items into a sorted iterator using the Closure to determine the correct ordering.static <T> Iterator<T>
sort
(Iterator<T> self, Comparator<? super T> comparator) Sorts the given iterator items into a sorted iterator using the comparator.static <K,
V> Map<K, V> Sorts the elements from the given map into a new ordered Map using the natural ordering of the keys to determine the ordering.static <K,
V> Map<K, V> Sorts the elements from the given map into a new ordered map using the closure as a comparator to determine the ordering.static <K,
V> Map<K, V> sort
(Map<K, V> self, Comparator<? super K> comparator) Sorts the elements from the given map into a new ordered Map using the specified key comparator to determine the ordering.static <K,
V> SortedMap<K, V> Avoids doing unnecessary work when sorting an already sorted map (i.e.static <T> SortedSet<T>
Avoids doing unnecessary work when sorting an already sorted set (i.e.static <T> T[]
sort
(T[] self) Modifies this array so that its elements are in sorted order.static <T> T[]
sort
(T[] self, boolean mutate) Sorts the given array into sorted order.static <T> T[]
Modifies this array so that its elements are in sorted order using the Closure to determine the correct ordering.static <T> T[]
sort
(T[] self, boolean mutate, Comparator<? super T> comparator) Modifies this array so that its elements are in sorted order as determined by the given comparator.static <T> T[]
Sorts the elements from this array into a newly created array using the Closure to determine the correct ordering.static <T> T[]
sort
(T[] self, Comparator<? super T> comparator) Sorts the given array into sorted order using the given comparator.static Collection
Splits all items into two lists based on the closure condition.static <T> Collection<Collection<T>>
split
(Collection<T> self, Closure closure) Splits all items into two collections based on the closure condition.Splits all items into two collections based on the closure condition.Splits all items into two collections based on the closure condition.static <T> Collection<Collection<T>>
Splits all items into two collections based on the closure condition.static SpreadMap
Synonym fortoSpreadMap(java.util.Map)
.static String
Returns a formatted string using the specified format string and arguments.static String
Sprintf to a string.static void
Iterates from this number up to the given number using a step increment.static <K,
V> Map<K, V> subMap
(Map<K, V> map, Collection<K> keys) Creates a sub-Map containing the given keys.static <K,
V> Map<K, V> Creates a sub-Map containing the given keys.subsequences
(List<T> self) Finds all non-null subsequences of a list.static byte
sum
(byte[] self) Sums the items in an array.static byte
sum
(byte[] self, byte initialValue) Sums the items in an array, adding the result to some initial value.static char
sum
(char[] self) Sums the items in an array.static char
sum
(char[] self, char initialValue) Sums the items in an array, adding the result to some initial value.static double
sum
(double[] self) Sums the items in an array.static double
sum
(double[] self, double initialValue) Sums the items in an array, adding the result to some initial value.static float
sum
(float[] self) Sums the items in an array.static float
sum
(float[] self, float initialValue) Sums the items in an array, adding the result to some initial value.static int
sum
(int[] self) Sums the items in an array.static int
sum
(int[] self, int initialValue) Sums the items in an array, adding the result to some initial value.static long
sum
(long[] self) Sums the items in an array.static long
sum
(long[] self, long initialValue) Sums the items in an array, adding the result to some initial value.static short
sum
(short[] self) Sums the items in an array.static short
sum
(short[] self, short initialValue) Sums the items in an array, adding the result to some initial value.static Object
Sums the items in an Iterable.static Object
Sums the items in an Iterable, adding the result to some initial value.static <T> Object
Sums the result of applying a closure to each item of an Iterable.static <T> Object
Sums the result of applying a closure to each item of an Iterable to some initial value.static Object
Sums the items in an array.static Object
Sums the items in an array, adding the result to some initial value.static Object
Sums the items from an Iterator, adding the result to some initial value.static Object
Sums the items from an Iterator.static <T> Object
Sums the result of applying a closure to each item returned from an iterator.static <T> Object
Sums the result of applying a closure to each item of an Iterator to some initial value.static <T> Object
Sums the result of applying a closure to each item of an array.static <T> Object
Sums the result of applying a closure to each item of an array to some initial value.static boolean[]
swap
(boolean[] self, int i, int j) Swaps two elements at the specified positions.static byte[]
swap
(byte[] self, int i, int j) Swaps two elements at the specified positions.static char[]
swap
(char[] self, int i, int j) Swaps two elements at the specified positions.static double[]
swap
(double[] self, int i, int j) Swaps two elements at the specified positions.static float[]
swap
(float[] self, int i, int j) Swaps two elements at the specified positions.static int[]
swap
(int[] self, int i, int j) Swaps two elements at the specified positions.static long[]
swap
(long[] self, int i, int j) Swaps two elements at the specified positions.static short[]
swap
(short[] self, int i, int j) Swaps two elements at the specified positions.static <T> List<T>
Swaps two elements at the specified positions.static <T> T[]
swap
(T[] self, int i, int j) Swaps two elements at the specified positions.static <T> Collection<T>
Returns the items from the Iterable excluding the first item.static <T> Iterator<T>
Returns the original iterator after throwing away the first element.static <T> List<T>
Returns the items from the List excluding the first item.static <T> SortedSet<T>
Returns the items from the SortedSet excluding the first item.static <T> T[]
tail
(T[] self) Returns the items from the array excluding the first item.Calculates the tail values of this Iterable: the first value will be this list of all items from the iterable and the final one will be an empty list, with the intervening values the results of successive applications of tail on the items.static <T> Collection<T>
Returns the firstnum
elements from the head of this Iterable.static <T> Iterator<T>
Returns an iterator of up to the firstnum
elements from this iterator.static <T> List<T>
Returns the firstnum
elements from the head of this List.static <K,
V> Map<K, V> Returns a new map containing the firstnum
elements from the head of this map.static <T> SortedSet<T>
Returns the firstnum
elements from the head of this SortedSet.static <T> T[]
take
(T[] self, int num) Returns the firstnum
elements from the head of this array.static <T> Collection<T>
Returns the lastnum
elements from the tail of this Iterable.static <T> List<T>
Returns the lastnum
elements from the tail of this List.static <T> SortedSet<T>
Returns the lastnum
elements from the tail of this SortedSet.static <T> T[]
takeRight
(T[] self, int num) Returns the lastnum
elements from the tail of this array.static <T> Collection<T>
Returns a Collection containing the longest prefix of the elements from this Iterable where each element passed to the given closure evaluates to true.static <T> Iterator<T>
Returns the longest prefix of elements in this iterator where each element passed to the given condition closure evaluates to true.static <T> List<T>
Returns the longest prefix of this list where each element passed to the given closure condition evaluates to true.static <K,
V> Map<K, V> Returns the longest prefix of this Map where each entry (or key/value pair) when passed to the given closure evaluates to true.static <T> SortedSet<T>
Returns the longest prefix of this SortedSet where each element passed to the given closure condition evaluates to true.static <T> T[]
Returns the longest prefix of this array where each element passed to the given closure evaluates to true.static <T,
U> U Allows the closure to be called for the object reference self (similar towith
) and always returns self.static void
Executes the closure this many times, starting from zero.static String
toArrayString
(Object[] self) Returns the string representation of the given array.static BigDecimal
toBigDecimal
(Number self) Transform a Number into a BigDecimalstatic BigInteger
toBigInteger
(Number self) Transform this Number into a BigInteger.static Boolean
Identity conversion which returns Boolean.TRUE for a true Boolean and Boolean.FALSE for a false Boolean.static Double
Transform a Number into a Doublestatic Float
Transform a Number into a Floatstatic Integer
Transform a Number into an IntegertoList
(boolean[] array) Converts this array to a List of the same size, with each element added to the list.toList
(byte[] array) Converts this array to a List of the same size, with each element added to the list.toList
(char[] array) Converts this array to a List of the same size, with each element added to the list.toList
(double[] array) Converts this array to a List of the same size, with each element added to the list.toList
(float[] array) Converts this array to a List of the same size, with each element added to the list.toList
(int[] array) Converts this array to a List of the same size, with each element added to the list.toList
(long[] array) Converts this array to a List of the same size, with each element added to the list.toList
(short[] array) Converts this array to a List of the same size, with each element added to the list.static <T> List<T>
Convert an Iterable to a List.static <T> List<T>
toList
(Enumeration<T> self) Convert an enumeration to a List.static <T> List<T>
Convert an iterator to a List.static <T> List<T>
toList
(T[] array) Allows conversion of arrays into a mutable List.static String
toListString
(Collection self) Returns the string representation of the given list.static String
toListString
(Collection self, int maxSize) Returns the string representation of the given list.static Long
Transform a Number into a Longstatic char
toLowerCase
(Character self) Converts the character to lowercase.static String
toMapString
(Map self) Returns the string representation of this map.static String
toMapString
(Map self, int maxSize) Returns the string representation of this map.toSet
(boolean[] array) Converts this array to a Set, with each unique element added to the set.toSet
(byte[] array) Converts this array to a Set, with each unique element added to the set.toSet
(char[] array) Converts this array to a Set, with each unique element added to the set.toSet
(double[] array) Converts this array to a Set, with each unique element added to the set.toSet
(float[] array) Converts this array to a Set, with each unique element added to the set.toSet
(int[] array) Converts this array to a Set, with each unique element added to the set.toSet
(long[] array) Converts this array to a Set, with each unique element added to the set.toSet
(short[] array) Converts this array to a Set, with each unique element added to the set.static <T> Set<T>
Convert an Iterable to a Set.static <T> Set<T>
toSet
(Collection<T> self) Convert a Collection to a Set.static <T> Set<T>
toSet
(Enumeration<T> self) Convert an enumeration to a Set.static <T> Set<T>
Convert an iterator to a Set.static <T> List<T>
Sorts the Iterable.static <T> List<T>
Sorts this Iterable using the given Closure to determine the correct ordering.static <T> List<T>
toSorted
(Iterable<T> self, Comparator<? super T> comparator) Sorts the Iterable using the given Comparator.static <T> Iterator<T>
Sorts the Iterator.static <T> Iterator<T>
Sorts the given iterator items into a sorted iterator using the Closure to determine the correct ordering.static <T> Iterator<T>
toSorted
(Iterator<T> self, Comparator<? super T> comparator) Sorts the given iterator items using the comparator.static <K,
V> Map<K, V> Sorts the elements from the given map into a new ordered map using aNumberAwareComparator
on map entry values to determine the resulting order.static <K,
V> Map<K, V> Sorts the elements from the given map into a new ordered map using the supplied Closure condition as a comparator to determine the ordering.static <K,
V> Map<K, V> toSorted
(Map<K, V> self, Comparator<Map.Entry<K, V>> comparator) Sorts the elements from the given map into a new ordered map using the supplied comparator to determine the ordering.static <K,
V> Map<K, V> Avoids doing unnecessary work when sorting an already sorted mapstatic <T> Set<T>
Avoids doing unnecessary work when sorting an already sorted setstatic <T> T[]
toSorted
(T[] self) Returns a sorted version of the given array using the supplied comparator.static <T> T[]
Sorts the elements from this array into a newly created array using the Closure to determine the correct ordering.static <T> T[]
toSorted
(T[] self, Comparator<? super T> comparator) Returns a sorted version of the given array using the supplied comparator to determine the resulting order.static SpreadMap
toSpreadMap
(Iterable self) Creates a spreadable map from this iterable.static SpreadMap
toSpreadMap
(Object[] self) Creates a spreadable map from this array.static SpreadMap
toSpreadMap
(List self) Creates a spreadable map from this list.static SpreadMap
toSpreadMap
(Map self) Returns a newSpreadMap
from this map.static String
toString
(boolean[] self) Returns the string representation of the given array.static String
toString
(byte[] self) Returns the string representation of the given array.static String
toString
(char[] self) Returns the string representation of the given array.static String
toString
(double[] self) Returns the string representation of the given array.static String
toString
(float[] self) Returns the string representation of the given array.static String
toString
(int[] self) Returns the string representation of the given array.static String
toString
(long[] self) Returns the string representation of the given array.static String
toString
(short[] self) Returns the string representation of the given array.static String
Create a String representation of this object.static String
Returns the string representation of this array's contents.static String
toString
(AbstractCollection self) Returns the string representation of the given collection.static String
toString
(AbstractMap self) Returns the string representation of the given map.static <T> Collection<T>
Returns a Collection containing the items from the Iterable but with duplicates removed using the natural ordering of the items to determine uniqueness.static <T> Collection<T>
Returns a Collection containing the items from the Iterable but with duplicates removed.static <T> Collection<T>
toUnique
(Iterable<T> self, Comparator<? super T> comparator) Returns a Collection containing the items from the Iterable but with duplicates removed.static <T> Iterator<T>
Returns an iterator equivalent to this iterator with all duplicated items removed by using the natural ordering of the items.static <T> Iterator<T>
Returns an iterator equivalent to this iterator but with all duplicated items removed where duplicate (equal) items are deduced by calling the supplied Closure condition.static <T> Iterator<T>
toUnique
(Iterator<T> self, Comparator<? super T> comparator) Returns an iterator equivalent to this iterator with all duplicated items removed by using the supplied comparator.static <T> List<T>
Returns a List containing the items from the List but with duplicates removed using the natural ordering of the items to determine uniqueness.static <T> List<T>
Returns a List containing the items from the List but with duplicates removed.static <T> List<T>
toUnique
(List<T> self, Comparator<? super T> comparator) Returns a List containing the items from the List but with duplicates removed.static <T> T[]
toUnique
(T[] self) Returns a new Array containing the items from the original Array but with duplicates removed using the natural ordering of the items in the array.static <T> T[]
Returns a new Array containing the items from the original Array but with duplicates removed with the supplied comparator determining which items are unique.static <T> T[]
toUnique
(T[] self, Comparator<? super T> comparator) Returns a new Array containing the items from the original Array but with duplicates removed with the supplied comparator determining which items are unique.static char
toUpperCase
(Character self) Converts the character to uppercase.static double[][]
transpose
(double[][] self) A transpose method for 2D double arrays.static int[][]
transpose
(int[][] self) A transpose method for 2D int arrays.static long[][]
transpose
(long[][] self) A transpose method for 2D long arrays.static List
Adds GroovyCollections#transpose(List) as a method on lists.static double
Truncate the valuestatic double
Truncate the valuestatic float
Truncate the valuestatic float
Truncate the valuestatic BigDecimal
trunc
(BigDecimal number) Truncate the valuestatic BigDecimal
trunc
(BigDecimal number, int precision) Truncate the valuestatic Number
unaryMinus
(Number left) Negates the number.static Number
Returns the number, effectively being a noop for numbers.static Object[]
Create an Object array containing elements from an original array plus those from an Iterable.static Object[]
Create an Object array containing elements from an original array plus an additional appended element.static Object[]
Create an Object array as a union of two arrays.static Object[]
union
(Object[] left, Collection<?> right) Create an object array containing elements from an original array plus those from a Collection.static <T> Collection<T>
unique
(Collection<T> self) Modifies this collection to remove all duplicated items, using Groovy's default number-aware comparator.static <T> Collection<T>
unique
(Collection<T> self, boolean mutate) Remove all duplicates from a given Collection using Groovy's default number-aware comparator.static <T> Collection<T>
unique
(Collection<T> self, boolean mutate, Closure closure) A convenience method for making a collection unique using a Closure to determine duplicate (equal) items.static <T> Collection<T>
unique
(Collection<T> self, boolean mutate, Comparator<? super T> comparator) Remove all duplicates from a given Collection.static <T> Collection<T>
unique
(Collection<T> self, Closure closure) A convenience method for making a collection unique using a Closure to determine duplicate (equal) items.static <T> Collection<T>
unique
(Collection<T> self, Comparator<? super T> comparator) Remove all duplicates from a given Collection.static <T> Iterator<T>
Returns an iterator equivalent to this iterator with all duplicated items removed by using Groovy's default number-aware comparator.static <T> Iterator<T>
Returns an iterator equivalent to this iterator but with all duplicated items removed by using a Closure to determine duplicate (equal) items.static <T> Iterator<T>
unique
(Iterator<T> self, Comparator<? super T> comparator) Returns an iterator equivalent to this iterator with all duplicated items removed by using the supplied comparator.static <T> List<T>
Modifies this List to remove all duplicated items, using Groovy's default number-aware comparator.static <T> List<T>
Remove all duplicates from a given List using Groovy's default number-aware comparator.static <T> List<T>
A convenience method for making a List unique using a Closure to determine duplicate (equal) items.static <T> List<T>
unique
(List<T> self, boolean mutate, Comparator<? super T> comparator) Remove all duplicates from a given List.static <T> List<T>
A convenience method for making a List unique using a Closure to determine duplicate (equal) items.static <T> List<T>
unique
(List<T> self, Comparator<? super T> comparator) Remove all duplicates from a given List.static void
Iterates from this number up to the given number, inclusive, incrementing by one each time.static void
Iterates from this number up to the given number, inclusive, incrementing by one each time.static void
Iterates from this number up to the given number, inclusive, incrementing by one each time.static void
Iterates from this number up to the given number, inclusive, incrementing by one each time.static void
Iterates from this number up to the given number, inclusive, incrementing by one each time.static void
Iterates from this number up to the given number, inclusive, incrementing by one each time.static void
Iterates from this number up to the given number, inclusive, incrementing by one each time.static void
upto
(BigDecimal self, Number to, Closure closure) Iterates from this number up to the given number, inclusive, incrementing by one each time.static void
upto
(BigInteger self, Number to, Closure closure) Iterates from this number up to the given number, inclusive, incrementing by one each time.static <T> T
Scoped use methodstatic Object
Allows you to use a list of categories, specifying the list as varargs.static <T> T
Scoped use method with list of categories.static <T,
U extends T, V extends T>
TAllows the closure to be called for the object reference self.static <T,
U> T Allows the closure to be called for the object reference self.static <T> ListWithDefault<T>
withDefault
(List<T> self, Closure<T> init) An alias forwithLazyDefault
which decorates a list allowing it to grow when called with index values outside the normal list bounds.static <K,
V> Map<K, V> withDefault
(Map<K, V> self, boolean autoGrow, boolean autoShrink, Closure<V> init) Wraps a map using the decorator pattern with a wrapper that intercepts all calls toget(key)
andput(key, value)
.static <K,
V> Map<K, V> withDefault
(Map<K, V> self, Closure<V> init) Wraps a map using the decorator pattern with a wrapper that intercepts all calls toget(key)
.static <T> List<T>
withDefault$$bridge
(List<T> self, Closure<T> init) Deprecated.static <T> ListWithDefault<T>
withEagerDefault
(List<T> self, Closure<T> init) Decorates a list allowing it to grow when called with a non-existent index value.static <T> List<T>
withEagerDefault$$bridge
(List<T> self, Closure<T> init) Deprecated.Zips an Iterable with indices in (value, index) order.Zips an Iterable with indices in (value, index) order.Zips an iterator with indices in (value, index) order.Zips an iterator with indices in (value, index) order.static <T> ListWithDefault<T>
withLazyDefault
(List<T> self, Closure<T> init) Decorates a list allowing it to grow when called with a non-existent index value.static <T> List<T>
withLazyDefault$$bridge
(List<T> self, Closure<T> init) Deprecated.static Object
withTraits
(Object self, Class<?>... traits) Dynamically wraps an instance into something which implements the supplied trait classes.static Boolean
Exclusive disjunction of two boolean operatorsstatic Number
Bitwise XOR together two Numbers.static BitSet
Bitwise XOR together two BitSets.Methods inherited from class org.codehaus.groovy.runtime.DefaultGroovyMethodsSupport
cloneSimilarCollection, cloneSimilarMap, closeQuietly, closeWithWarning, createSimilarArray, createSimilarCollection, createSimilarCollection, createSimilarCollection, createSimilarList, createSimilarMap, createSimilarOrDefaultCollection, createSimilarQueue, createSimilarSet, normaliseIndex, sameType, subListBorders, subListBorders, subListRange, writeUTF16BomIfRequired, writeUTF16BomIfRequired, writeUTF16BomIfRequired, writeUTF16BomIfRequired
-
Field Details
-
ADDITIONAL_CLASSES
-
DGM_LIKE_CLASSES
-
-
Constructor Details
-
DefaultGroovyMethods
public DefaultGroovyMethods()
-
-
Method Details
-
is
Identity check. Since == is overridden in Groovy with the meaning of equality we need some fallback to check for object identity. Invoke using the 'is' method, like so:def same = this.is(that)
- Parameters:
self
- an objectother
- an object to compare identity with- Returns:
- true if self and other are both references to the same instance, false otherwise
- Since:
- 1.0
-
identity
public static <T,U> T identity(U self, @DelegatesTo(value=Target.class,target="self",strategy=1) Closure<T> closure) Allows the closure to be called for the object reference self. Synonym for 'with()'.- Parameters:
self
- the object to have a closure act uponclosure
- the closure to call on the object- Returns:
- result of calling the closure
- Since:
- 1.0
- See Also:
-
with
public static <T,U> T with(U self, @DelegatesTo(value=Target.class,target="self",strategy=1) Closure<T> closure) Allows the closure to be called for the object reference self.Any method invoked inside the closure will first be invoked on the self reference. For instance, the following method calls to the append() method are invoked on the StringBuilder instance:
def b = new StringBuilder().with { append('foo') append('bar') return it } assert b.toString() == 'foobar'
This is commonly used to simplify object creation, such as this example:def p = new Person().with { firstName = 'John' lastName = 'Doe' return it }
The other typical usage, uses the self object while creating some value:def fullName = person.with{ "$firstName $lastName" }
- Parameters:
self
- the object to have a closure act uponclosure
- the closure to call on the object- Returns:
- result of calling the closure
- Since:
- 1.5.0
- See Also:
-
with
public static <T,U extends T, T withV extends T> (U self, boolean returning, @DelegatesTo(value=Target.class,target="self",strategy=1) Closure<T> closure) Allows the closure to be called for the object reference self. Any method invoked inside the closure will first be invoked on the self reference. For example, the following method calls to the append() method are invoked on the StringBuilder instance and then, because 'returning' is true, the self instance is returned:def b = new StringBuilder().with(true) { append('foo') append('bar') } assert b.toString() == 'foobar'
The returning parameter is commonly set to true when using with to simplify object creation, such as this example:def p = new Person().with(true) { firstName = 'John' lastName = 'Doe' }
Alternatively, 'tap' is an alias for 'with(true)', so that method can be used instead. The other main use case for with is when returning a value calculated using self as shown here:def fullName = person.with(false){ "$firstName $lastName" }
Alternatively, 'with' is an alias for 'with(false)', so the boolean parameter can be omitted instead.- Parameters:
self
- the object to have a closure act uponreturning
- if true, return the self object; otherwise, the result of calling the closureclosure
- the closure to call on the object- Returns:
- the self object or the result of calling the closure depending on 'returning'
- Since:
- 2.5.0
- See Also:
-
tap
public static <T,U> U tap(U self, @DelegatesTo(value=Target.class,target="self",strategy=1) Closure<T> closure) Allows the closure to be called for the object reference self (similar towith
) and always returns self.Any method invoked inside the closure will first be invoked on the self reference. For instance, the following method calls to the append() method are invoked on the StringBuilder instance:
def b = new StringBuilder().tap { append('foo') append('bar') } assert b.toString() == 'foobar'
This is commonly used to simplify object creation, such as this example:def p = new Person().tap { firstName = 'John' lastName = 'Doe' }
- Parameters:
self
- the object to have a closure act uponclosure
- the closure to call on the object- Returns:
- self
- Since:
- 2.5.0
- See Also:
-
getAt
Allows the subscript operator to be used to lookup dynamic property values.bean[somePropertyNameExpression]
. The normal property notation of groovy is neater and more concise but only works with compile-time known property names.- Parameters:
self
- the object to act uponproperty
- the property name of interest- Returns:
- the property value
- Since:
- 1.0
-
putAt
Allows the subscript operator to be used to set dynamically named property values.bean[somePropertyNameExpression] = foo
. The normal property notation of groovy is neater and more concise but only works with property names which are known at compile time.- Parameters:
self
- the object to act uponproperty
- the name of the property to setnewValue
- the value to set- Since:
- 1.0
-
dump
Generates a detailed dump string of an object showing its class, hashCode and all accessible fields.- Parameters:
self
- an object- Returns:
- the dump representation
- Since:
- 1.0
-
getMetaPropertyValues
Retrieves the list ofMetaProperty
objects for 'self' and wraps it in a list ofPropertyValue
objects that additionally provide the value for each property of 'self'.- Parameters:
self
- the receiver object- Returns:
- list of
PropertyValue
objects - Since:
- 1.0
- See Also:
-
getProperties
Convenience method that callsgetMetaPropertyValues(java.lang.Object)
(self) and provides the data in form of simple key/value pairs, i.e. without type() information.- Parameters:
self
- the receiver object- Returns:
- meta properties as Map of key/value pairs
- Since:
- 1.0
-
use
Scoped use method- Parameters:
self
- any ObjectcategoryClass
- a category class to useclosure
- the closure to invoke with the category in place- Returns:
- the value returned from the closure
- Since:
- 1.0
-
mixin
Extend object with category methods. All methods for given class and all super classes will be added to the object.- Parameters:
self
- any ClasscategoryClasses
- a category classes to use- Since:
- 1.6.0
-
mixin
Extend class globally with category methods. All methods for given class and all super classes will be added to the class.- Parameters:
self
- any ClasscategoryClasses
- a category classes to use- Since:
- 1.6.0
-
mixin
Extend class globally with category methods.- Parameters:
self
- any ClasscategoryClass
- a category class to use- Since:
- 1.6.0
-
mixin
Extend class globally with category methods.- Parameters:
self
- any ClasscategoryClass
- a category class to use- Since:
- 1.6.0
-
mixin
Extend class globally with category methods.- Parameters:
self
- any ClasscategoryClass
- a category class to use- Since:
- 1.6.0
-
mixin
Extend class globally with category methods.- Parameters:
self
- any ClasscategoryClass
- a category class to use- Since:
- 1.6.0
-
getLocation
Gets the url of the jar file/source file containing the specified class- Parameters:
self
- the class- Returns:
- the url of the jar,
null
if the specified class is from JDK - Since:
- 2.5.0
-
addShutdownHook
Allows the usage of addShutdownHook without getting the runtime first.- Parameters:
self
- the object the method is called on (ignored)closure
- the shutdown hook action- Since:
- 1.5.0
-
use
Scoped use method with list of categories.- Parameters:
self
- any ObjectcategoryClassList
- a list of category classesclosure
- the closure to invoke with the categories in place- Returns:
- the value returned from the closure
- Since:
- 1.0
-
use
Allows you to use a list of categories, specifying the list as varargs.use(CategoryClass1, CategoryClass2) { ... }
This method saves having to wrap the category classes in a list.- Parameters:
self
- any Objectarray
- a list of category classes and a Closure- Returns:
- the value returned from the closure
- Since:
- 1.0
-
inspect
Inspects returns the String that matches what would be typed into a terminal to create this object.- Parameters:
self
- any Object- Returns:
- a String that matches what would be typed into a terminal to
create this object. e.g. [1, 'hello'].inspect()
->
[1, 'hello'] - Since:
- 1.0
-
invokeMethod
Provide a dynamic method invocation method which can be overloaded in classes to implement dynamic proxies easily.- Parameters:
object
- any Objectmethod
- the name of the method to callarguments
- the arguments to use- Returns:
- the result of the method call
- Since:
- 1.0
-
print
Print a value formatted Groovy style to self if it is a Writer, otherwise to the standard output stream.- Parameters:
self
- any Objectvalue
- the value to print- Since:
- 1.0
-
print
Print a value formatted Groovy style to the print writer.- Parameters:
self
- a PrintWritervalue
- the value to print- Since:
- 1.0
-
print
Print a value formatted Groovy style to the print stream.- Parameters:
self
- a PrintStreamvalue
- the value to print- Since:
- 1.6.0
-
print
Print a value to the standard output stream. This method delegates to the owner to execute the method.- Parameters:
self
- a generated closurevalue
- the value to print- Since:
- 1.0
-
print
Print to a console in interactive format.- Parameters:
self
- any Objectout
- the PrintWriter used for printing- Since:
- 1.0
-
println
Print a linebreak to the standard output stream.- Parameters:
self
- any Object- Since:
- 1.0
-
println
Print a linebreak to the standard output stream. This method delegates to the owner to execute the method.- Parameters:
self
- a closure- Since:
- 1.0
-
println
Print a value formatted Groovy style (followed by a newline) to self if it is a Writer, otherwise to the standard output stream.- Parameters:
self
- any Objectvalue
- the value to print- Since:
- 1.0
-
println
Print a value formatted Groovy style (followed by a newline) to the print writer.- Parameters:
self
- a PrintWritervalue
- the value to print- Since:
- 1.0
-
println
Print a value formatted Groovy style (followed by a newline) to the print stream.- Parameters:
self
- any Objectvalue
- the value to print- Since:
- 1.6.0
-
println
Print a value (followed by a newline) to the standard output stream. This method delegates to the owner to execute the method.- Parameters:
self
- a closurevalue
- the value to print- Since:
- 1.0
-
println
Print to a console in interactive format.- Parameters:
self
- any Objectout
- the PrintWriter used for printing- Since:
- 1.0
-
printf
Printf to the standard output stream.- Parameters:
self
- any Objectformat
- a format stringvalues
- values referenced by the format specifiers in the format string- Since:
- 1.0
-
printf
Printf 0 or more values to the standard output stream using a format string. This method delegates to the owner to execute the method.- Parameters:
self
- a generated closureformat
- a format stringvalues
- values referenced by the format specifiers in the format string- Since:
- 3.0.0
-
printf
Printf a value to the standard output stream using a format string. This method delegates to the owner to execute the method.- Parameters:
self
- a generated closureformat
- a format stringvalue
- value referenced by the format specifier in the format string- Since:
- 3.0.0
-
printf
Prints a formatted string using the specified format string and arguments.Examples:
printf ( "Hello, %s!\n" , [ "world" ] as String[] ) printf ( "Hello, %s!\n" , [ "Groovy" ]) printf ( "%d + %d = %d\n" , [ 1 , 2 , 1+2 ] as Integer[] ) printf ( "%d + %d = %d\n" , [ 3 , 3 , 3+3 ]) ( 1..5 ).each { printf ( "-- %d\n" , [ it ] as Integer[] ) } ( 1..5 ).each { printf ( "-- %d\n" , [ it ] as int[] ) } ( 0x41..0x45 ).each { printf ( "-- %c\n" , [ it ] as char[] ) } ( 07..011 ).each { printf ( "-- %d\n" , [ it ] as byte[] ) } ( 7..11 ).each { printf ( "-- %d\n" , [ it ] as short[] ) } ( 7..11 ).each { printf ( "-- %d\n" , [ it ] as long[] ) } ( 7..11 ).each { printf ( "-- %5.2f\n" , [ it ] as float[] ) } ( 7..11 ).each { printf ( "-- %5.2g\n" , [ it ] as double[] ) }
- Parameters:
self
- any Objectformat
- A format stringarg
- Argument which is referenced by the format specifiers in the format string. The type ofarg
should be one of Object[], List, int[], short[], byte[], char[], boolean[], long[], float[], or double[].- Since:
- 1.0
-
sprintf
Sprintf to a string.- Parameters:
self
- any Objectformat
- a format stringvalues
- values referenced by the format specifiers in the format string- Returns:
- the resulting formatted string
- Since:
- 1.5.0
-
sprintf
Returns a formatted string using the specified format string and arguments.- Parameters:
self
- any Objectformat
- A format stringarg
- Argument which is referenced by the format specifiers in the format string. The type ofarg
should be one of Object[], List, int[], short[], byte[], char[], boolean[], long[], float[], or double[].- Returns:
- the resulting printf'd string
- Since:
- 1.5.0
-
isCase
Method for overloading the behavior of the 'case' method in switch statements. The default implementation handles arrays types but otherwise simply delegates to Object#equals, but this may be overridden for other types. In this example:switch( a ) { case b: //some code }
"some code" is called whenb.isCase( a )
returnstrue
.- Parameters:
caseValue
- the case valueswitchValue
- the switch value- Returns:
- true if the switchValue is deemed to be equal to the caseValue
- Since:
- 1.0
-
isCase
Special 'Case' implementation for Class, which allows testing whether some switch value is assignable from the given case class. If the switch value is an object,isCase
will return true if the switch value is assignment compatible with the class (case value), i.e. is aninstanceof
the class, for example:def someList = [] switch (someList) { case List: assert true : 'is a list' break case Map: assert false : 'is not a Map' break default: assert false : 'should never get here' break }
If the switch value is a class,isCase
will return true if the switch value is assignable from the given class (case value), i.e. the case class is the same as, or a superclass, or a super-interface of the switch class, for example:switch (ArrayList) { case List: assert true : 'is a list' break case Map: assert false : 'is not a Map' break default: assert false : 'should never get here' break }
- Parameters:
caseValue
- the case valueswitchValue
- the switch value- Returns:
- true if the switchValue is deemed to be assignable from the given class
- Since:
- 1.0
-
isCase
'Case' implementation for collections which tests if the 'switch' operand is contained in any of the 'case' values. For example:switch( 3 ) { case [1,3,5]: assert true break default: assert false }
- Parameters:
caseValue
- the case valueswitchValue
- the switch value- Returns:
- true if the caseValue is deemed to contain the switchValue
- Since:
- 1.0
- See Also:
-
isCase
'Case' implementation for maps which tests the groovy truth value obtained using the 'switch' operand as key. For example:switch( 'foo' ) { case [foo:true, bar:false]: assert true break default: assert false }
- Parameters:
caseValue
- the case valueswitchValue
- the switch value- Returns:
- the groovy truth value from caseValue corresponding to the switchValue key
- Since:
- 1.7.6
-
isCase
Special 'case' implementation for all numbers, which delegates to thecompareTo()
method for comparing numbers of different types.- Parameters:
caseValue
- the case valueswitchValue
- the switch value- Returns:
- true if the numbers are deemed equal
- Since:
- 1.5.0
-
isNotCase
- Since:
- 4.0.0
-
isNotCase
- Since:
- 4.0.0
-
isNotCase
- Since:
- 4.0.0
-
isNotCase
- Since:
- 4.0.0
-
isNotCase
- Since:
- 4.0.0
-
isNotCase
- Since:
- 4.0.0
-
unique
Returns an iterator equivalent to this iterator with all duplicated items removed by using Groovy's default number-aware comparator. The original iterator will become exhausted of elements after determining the unique values. A new iterator for the unique values will be returned.- Parameters:
self
- an Iterator- Returns:
- a new Iterator of the unique items from the original iterator
- Since:
- 1.5.5
-
unique
Modifies this collection to remove all duplicated items, using Groovy's default number-aware comparator.assert [1,3] == [1,3,3].unique()
- Parameters:
self
- a collection- Returns:
- the now modified collection
- Since:
- 1.0
- See Also:
-
unique
Modifies this List to remove all duplicated items, using Groovy's default number-aware comparator.assert [1,3] == [1,3,3].unique()
- Parameters:
self
- a List- Returns:
- the now modified List
- Since:
- 2.4.0
- See Also:
-
unique
Remove all duplicates from a given Collection 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]
- Parameters:
self
- a collectionmutate
- false will cause a new list containing unique items from the collection to be created, true will mutate collections in place- Returns:
- the now modified collection
- Since:
- 1.8.1
-
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]
- Parameters:
self
- a Listmutate
- 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
-
numberAwareCompareTo
Provides a method that compares two comparables using Groovy's default number aware comparator.- Parameters:
self
- a Comparableother
- another Comparable- Returns:
- a -ve number, 0 or a +ve number according to Groovy's compareTo contract
- Since:
- 1.6.0
-
unique
Returns an iterator equivalent to this iterator but with all duplicated items removed by using a Closure to determine duplicate (equal) items. The original iterator will be fully processed after the call.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)
orObject.equals(java.lang.Object)
). If the closure takes two parameters, two items from the Iterator will be passed as arguments, and the closure should return an int value (with 0 indicating the items are not unique).- Parameters:
self
- an Iteratorcondition
- a Closure used to determine unique items- Returns:
- the modified Iterator
- Since:
- 1.5.5
-
unique
A convenience method for making a collection 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)
orObject.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).assert [1,4] == [1,3,4,5].unique { it % 2 }
assert [2,3,4] == [2,3,3,4].unique { a, b
->
a<=>
b }- Parameters:
self
- a Collectionclosure
- a 1 or 2 arg Closure used to determine unique items- Returns:
- self without any duplicates
- Since:
- 1.0
- See Also:
-
unique
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)
orObject.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:
self
- a Listclosure
- a 1 or 2 arg Closure used to determine unique items- Returns:
- self without any duplicates
- Since:
- 2.4.0
- See Also:
-
unique
A convenience method for making a collection 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 Collection will be passed to the closure. The closure should return a value used for comparison (either using
Comparable.compareTo(java.lang.Object)
orObject.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:
self
- a Collectionmutate
- 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 items- Returns:
- self without any duplicates
- Since:
- 1.8.1
-
unique
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)
orObject.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:
self
- a Listmutate
- 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 items- Returns:
- self without any duplicates
- Since:
- 2.4.0
-
unique
Returns an iterator equivalent to this iterator with all duplicated items removed by using the supplied comparator. The original iterator will be exhausted upon returning.- Parameters:
self
- an Iteratorcomparator
- a Comparator- Returns:
- the modified Iterator
- Since:
- 1.5.5
-
unique
Remove all duplicates from a given Collection. Works on the original object (and also returns it). The order of members in the Collection are compared by the given Comparator. For each duplicate, the first member which is returned by the given Collection's iterator is retained, but all other ones are removed. The given Collection'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:
self
- a Collectioncomparator
- a Comparator- Returns:
- self the now modified collection without duplicates
- Since:
- 1.0
- See Also:
-
unique
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:
self
- a Listcomparator
- a Comparator- Returns:
- self the now modified List without duplicates
- Since:
- 2.4.0
- See Also:
-
unique
public static <T> Collection<T> unique(Collection<T> self, boolean mutate, Comparator<? super T> comparator) Remove all duplicates from a given Collection. If mutate is true, it works on the original object (and also returns it). If mutate is false, a new collection is returned. The order of members in the Collection are compared by the given Comparator. For each duplicate, the first member which is returned by the given Collection's iterator is retained, but all other ones are removed. The given Collection'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:
self
- a Collectionmutate
- false will always cause a new collection to be created, true will mutate collections in placecomparator
- a Comparator- Returns:
- self the collection without duplicates
- Since:
- 1.8.1
-
unique
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:
self
- a Listmutate
- false will always cause a new List to be created, true will mutate List in placecomparator
- a Comparator- Returns:
- self the List without duplicates
- Since:
- 2.4.0
-
toUnique
Returns an iterator equivalent to this iterator but with all duplicated items removed where duplicate (equal) items are deduced by calling the supplied Closure condition.If the supplied 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)
orObject.equals(java.lang.Object)
). If the closure takes two parameters, two items from the Iterator will be passed as arguments, and the closure should return an int value (with 0 indicating the items are not unique).def items = "Hello".toList() + [null, null] + "there".toList() def toLower = { it == null ? null : it.toLowerCase() } def noDups = items.iterator().toUnique(toLower).toList() assert noDups == ['H', 'e', 'l', 'o', null, 't', 'r']
assert [1,4] == [1,3,4,5].toUnique { it % 2 }
assert [2,3,4] == [2,3,3,4].toUnique { a, b
->
a<=>
b }- Parameters:
self
- an Iteratorcondition
- a Closure used to determine unique items- Returns:
- an Iterator with no duplicate items
- Since:
- 2.4.0
-
toUnique
Returns an iterator equivalent to this iterator with all duplicated items removed by using the supplied comparator.- Parameters:
self
- an Iteratorcomparator
- a Comparator used to determine unique (equal) items Ifnull
, the Comparable natural ordering of the elements will be used.- Returns:
- an Iterator with no duplicate items
- Since:
- 2.4.0
-
toUnique
Returns an iterator equivalent to this iterator with all duplicated items removed by using the natural ordering of the items.- Parameters:
self
- an Iterator- Returns:
- an Iterator with no duplicate items
- Since:
- 2.4.0
-
toUnique
Returns a Collection containing the items from the Iterable but with duplicates removed. The items in the Iterable are compared by the given Comparator. For each duplicate, the first member which is returned from the Iterable 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]- Parameters:
self
- an Iterablecomparator
- a Comparator used to determine unique (equal) items Ifnull
, the Comparable natural ordering of the elements will be used.- Returns:
- the Collection of non-duplicate items
- Since:
- 2.4.0
-
toUnique
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 == [a, b, c]
&&
list == [a, b, c, d]- Parameters:
self
- a Listcomparator
- a Comparator used to determine unique (equal) items Ifnull
, the Comparable natural ordering of the elements will be used.- Returns:
- the List of non-duplicate items
- Since:
- 2.4.0
-
toUnique
Returns a Collection containing the items from the Iterable but with duplicates removed using the natural ordering of the items to determine uniqueness.String[] letters = ['c', 'a', 't', 's', 'a', 't', 'h', 'a', 't'] String[] expected = ['c', 'a', 't', 's', 'h'] assert letters.toUnique() == expected
- Parameters:
self
- an Iterable- Returns:
- the Collection of non-duplicate items
- Since:
- 2.4.0
-
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
- Parameters:
self
- a List- Returns:
- the List of non-duplicate items
- Since:
- 2.4.0
-
toUnique
Returns a Collection containing the items from the Iterable but with duplicates removed. The items in the Iterable 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)
orObject.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:
self
- an Iterablecondition
- a Closure used to determine unique items- Returns:
- a new Collection
- Since:
- 2.4.0
- See Also:
-
toUnique
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)
orObject.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:
self
- a Listcondition
- a Closure used to determine unique items- Returns:
- a new List
- Since:
- 2.4.0
- See Also:
-
toUnique
Returns a new Array containing the items from the original Array but with duplicates removed with the supplied comparator determining which items are unique.String[] letters = ['c', 'a', 't', 's', 'A', 't', 'h', 'a', 'T'] String[] lower = ['c', 'a', 't', 's', 'h'] class LowerComparator implements Comparator { int compare(let1, let2) { let1.toLowerCase()
<=>
let2.toLowerCase() } } assert letters.toUnique(new LowerComparator()) == lower- Parameters:
self
- an arraycomparator
- a Comparator used to determine unique (equal) items Ifnull
, the Comparable natural ordering of the elements will be used.- Returns:
- the unique items from the array
-
toUnique
public static <T> T[] toUnique(T[] self) Returns a new Array containing the items from the original Array but with duplicates removed using the natural ordering of the items in the array.String[] letters = ['c', 'a', 't', 's', 'a', 't', 'h', 'a', 't'] String[] expected = ['c', 'a', 't', 's', 'h'] def result = letters.toUnique() assert result == expected assert result.class.componentType == String
- Parameters:
self
- an array- Returns:
- the unique items from the array
-
toUnique
Returns a new Array containing the items from the original Array but with duplicates removed with the supplied comparator determining which items are unique.String[] letters = ['c', 'a', 't', 's', 'A', 't', 'h', 'a', 'T'] String[] expected = ['c', 'a', 't', 's', 'h'] assert letters.toUnique{ p1, p2
->
p1.toLowerCase()<=>
p2.toLowerCase() } == expected assert letters.toUnique{ it.toLowerCase() } == expected- Parameters:
self
- an arraycondition
- a Closure used to determine unique items- Returns:
- the unique items from the array
-
each
Iterates through an array passing each array entry to the given closure.String[] letters = ['a', 'b', 'c'] String result = '' letters.each{ result += it } assert result == 'abc'
- Parameters:
self
- the array over which we iterateclosure
- the closure applied on each array entry- Returns:
- the self array
- Since:
- 2.5.0
-
each
Iterates through an aggregate type or data structure, passing each item to the given closure. Custom types may utilize this method by simply providing an "iterator()" method. The items returned from the resulting iterator will be passed to the closure.String result = '' ['a', 'b', 'c'].each{ result += it } assert result == 'abc'
- Parameters:
self
- the object over which we iterateclosure
- the closure applied on each element found- Returns:
- the self Object
- Since:
- 1.0
-
eachWithIndex
Iterates through an array, passing each array element and the element's index (a counter starting at zero) to the given closure.String[] letters = ['a', 'b', 'c'] String result = '' letters.eachWithIndex{ letter, index
->
result += "$index:$letter" } assert result == '0:a1:b2:c'- Parameters:
self
- an arrayclosure
- a Closure to operate on each array entry- Returns:
- the self array
- Since:
- 2.5.0
-
eachWithIndex
Iterates through an aggregate type or data structure, passing each item and the item's index (a counter starting at zero) to the given closure.String result = '' ['a', 'b', 'c'].eachWithIndex{ letter, index
->
result += "$index:$letter" } assert result == '0:a1:b2:c'- Parameters:
self
- an Objectclosure
- a Closure to operate on each item- Returns:
- the self Object
- Since:
- 1.0
-
eachWithIndex
Iterates through an iterable type, passing each item and the item's index (a counter starting at zero) to the given closure.- Parameters:
self
- an Iterableclosure
- a Closure to operate on each item- Returns:
- the self Iterable
- Since:
- 2.3.0
-
eachWithIndex
Iterates through an iterator type, passing each item and the item's index (a counter starting at zero) to the given closure.- Parameters:
self
- an Iteratorclosure
- a Closure to operate on each item- Returns:
- the self Iterator (now exhausted)
- Since:
- 2.3.0
-
eachWithIndex
Iterates through a Collection, passing each item and the item's index (a counter starting at zero) to the given closure.- Parameters:
self
- a Collectionclosure
- a Closure to operate on each item- Returns:
- the self Collection
- Since:
- 2.4.0
-
eachWithIndex
Iterates through a List, passing each item and the item's index (a counter starting at zero) to the given closure.- Parameters:
self
- a Listclosure
- a Closure to operate on each item- Returns:
- the self List
- Since:
- 2.4.0
-
eachWithIndex
Iterates through a Set, passing each item and the item's index (a counter starting at zero) to the given closure.- Parameters:
self
- a Setclosure
- a Closure to operate on each item- Returns:
- the self Set
- Since:
- 2.4.0
-
eachWithIndex
Iterates through a SortedSet, passing each item and the item's index (a counter starting at zero) to the given closure.- Parameters:
self
- a SortedSetclosure
- a Closure to operate on each item- Returns:
- the self SortedSet
- Since:
- 2.4.0
-
each
Iterates through an Iterable, passing each item to the given closure.- Parameters:
self
- the Iterable over which we iterateclosure
- the closure applied on each element found- Returns:
- the self Iterable
-
each
Iterates through an Iterator, passing each item to the given closure.- Parameters:
self
- the Iterator over which we iterateclosure
- the closure applied on each element found- Returns:
- the self Iterator
- Since:
- 2.4.0
-
each
Iterates through a Collection, passing each item to the given closure.- Parameters:
self
- the Collection over which we iterateclosure
- the closure applied on each element found- Returns:
- the self Collection
- Since:
- 2.4.0
-
each
Iterates through a List, passing each item to the given closure.- Parameters:
self
- the List over which we iterateclosure
- the closure applied on each element found- Returns:
- the self List
- Since:
- 2.4.0
-
each
Iterates through a Set, passing each item to the given closure.- Parameters:
self
- the Set over which we iterateclosure
- the closure applied on each element found- Returns:
- the self Set
- Since:
- 2.4.0
-
each
Iterates through a SortedSet, passing each item to the given closure.- Parameters:
self
- the SortedSet over which we iterateclosure
- the closure applied on each element found- Returns:
- the self SortedSet
- Since:
- 2.4.0
-
each
Allows a Map to be iterated through using a closure. If the closure takes one parameter then it will be passed the Map.Entry otherwise if the closure takes two parameters then it will be passed the key and the value.def result = "" [a:1, b:3].each { key, value
->
result += "$key$value" } assert result == "a1b3"def result = "" [a:1, b:3].each { entry
In general, the order in which the map contents are processed cannot be guaranteed. In practise, specialized forms of Map, e.g. a TreeMap will have its contents processed according to the natural ordering of the map.->
result += entry } assert result == "a=1b=3"- Parameters:
self
- the map over which we iterateclosure
- the 1 or 2 arg closure applied on each entry of the map- Returns:
- returns the self parameter
- Since:
- 1.5.0
-
reverseEach
Allows a Map to be iterated through in reverse order using a closure. In general, the order in which the map contents are processed cannot be guaranteed. In practise, specialized forms of Map, e.g. a TreeMap will have its contents processed according to the reverse of the natural ordering of the map.- Parameters:
self
- the map over which we iterateclosure
- the 1 or 2 arg closure applied on each entry of the map- Returns:
- returns the self parameter
- Since:
- 1.7.2
- See Also:
-
eachWithIndex
Allows a Map to be iterated through using a closure. If the closure takes two parameters then it will be passed the Map.Entry and the item's index (a counter starting at zero) otherwise if the closure takes three parameters then it will be passed the key, the value, and the index.def result = "" [a:1, b:3].eachWithIndex { key, value, index
->
result += "$index($key$value)" } assert result == "0(a1)1(b3)"def result = "" [a:1, b:3].eachWithIndex { entry, index
->
result += "$index($entry)" } assert result == "0(a=1)1(b=3)"- Parameters:
self
- the map over which we iterateclosure
- a 2 or 3 arg Closure to operate on each item- Returns:
- the self Object
- Since:
- 1.5.0
-
reverseEach
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:
self
- a Listclosure
- a closure to which each item is passed.- Returns:
- the original list
- Since:
- 1.5.0
-
reverseEach
Iterate over each element of the array in the reverse order.- Parameters:
self
- an arrayclosure
- a closure to which each item is passed- Returns:
- the original array
- Since:
- 1.5.2
-
every
Used to determine if the given predicate closure is valid (i.e. returnstrue
for all items in this data structure). A simple example for a list:def list = [3,4,5] def greaterThanTwo = list.every { it
>
2 }- Parameters:
self
- the object over which we iteratepredicate
- the closure predicate used for matching- Returns:
- true if every iteration of the object matches the closure predicate
- Since:
- 1.0
-
every
Used to determine if the given predicate closure is valid (i.e. returnstrue
for all items in this iterator). A simple example for a list:def list = [3,4,5] def greaterThanTwo = list.iterator().every { it
>
2 }- Parameters:
self
- the iterator over which we iteratepredicate
- the closure predicate used for matching- Returns:
- true if every iteration of the object matches the closure predicate
- Since:
- 2.3.0
-
every
Used to determine if the given predicate closure is valid (i.e. returnstrue
for all items in this Array).- Parameters:
self
- an Arraypredicate
- the closure predicate used for matching- Returns:
- true if every element of the Array matches the closure predicate
- Since:
- 2.5.0
-
every
Used to determine if the given predicate closure is valid (i.e. returnstrue
for all items in this iterable). A simple example for a list:def list = [3,4,5] def greaterThanTwo = list.every { it
>
2 }- Parameters:
self
- the iterable over which we iteratepredicate
- the closure predicate used for matching- Returns:
- true if every iteration of the object matches the closure predicate
- Since:
- 2.3.0
-
every
Iterates over the entries of a map, and checks whether a predicate is valid for all entries. If the closure takes one parameter then it will be passed the Map.Entry otherwise if the closure takes two parameters then it will be passed the key and the value.def map = [a:1, b:2.0, c:2L] assert !map.every { key, value
->
value instanceof Integer } assert map.every { entry->
entry.value instanceof Number }- Parameters:
self
- the map over which we iteratepredicate
- the 1 or 2 arg Closure predicate used for matching- Returns:
- true if every entry of the map matches the closure predicate
- Since:
- 1.5.0
-
every
Iterates over every element of a collection, and checks whether all elements aretrue
according to the Groovy Truth. Equivalent toself.every({element
->
element})assert [true, true].every() assert [1, 1].every() assert ![1, 0].every()
- Parameters:
self
- the object over which we iterate- Returns:
- true if every item in the collection matches satisfies Groovy truth
- Since:
- 1.5.0
-
any
Iterates over the contents of an object or collection, and checks whether a predicate is valid for at least one element.assert [1, 2, 3].any { it == 2 } assert ![1, 2, 3].any { it
>
3 }- Parameters:
self
- the object over which we iteratepredicate
- the closure predicate used for matching- Returns:
- true if any iteration for the object matches the closure predicate
- Since:
- 1.0
-
any
Iterates over the contents of an iterator, and checks whether a predicate is valid for at least one element.assert [1, 2, 3].iterator().any { it == 2 } assert ![1, 2, 3].iterator().any { it
>
3 }- Parameters:
self
- the iterator over which we iteratepredicate
- the closure predicate used for matching- Returns:
- true if any iteration for the object matches the closure predicate
- Since:
- 1.0
-
any
Iterates over the contents of an iterable, and checks whether a predicate is valid for at least one element.assert [1, 2, 3].any { it == 2 } assert ![1, 2, 3].any { it
>
3 }- Parameters:
self
- the iterable over which we iteratepredicate
- the closure predicate used for matching- Returns:
- true if any iteration for the object matches the closure predicate
- Since:
- 1.0
-
any
Iterates over the contents of an Array, and checks whether a predicate is valid for at least one element.- Parameters:
self
- the array over which we iteratepredicate
- the closure predicate used for matching- Returns:
- true if any iteration for the object matches the closure predicate
- Since:
- 2.5.0
-
any
Iterates over the entries of a map, and checks whether a predicate is valid for at least one entry. If the closure takes one parameter then it will be passed the Map.Entry otherwise if the closure takes two parameters then it will be passed the key and the value.assert [2:3, 4:5, 5:10].any { key, value
->
key * 2 == value } assert ![2:3, 4:5, 5:10].any { entry->
entry.key == entry.value * 2 }- Parameters:
self
- the map over which we iteratepredicate
- the 1 or 2 arg closure predicate used for matching- Returns:
- true if any entry in the map matches the closure predicate
- Since:
- 1.5.0
-
any
Iterates over the elements of a collection, and checks whether at least one element is true according to the Groovy Truth. Equivalent to self.any({element->
element})assert [false, true].any() assert [0, 1].any() assert ![0, 0].any()
- Parameters:
self
- the object over which we iterate- Returns:
- true if any item in the collection matches the closure predicate
- Since:
- 1.5.0
-
grep
Iterates over the collection of items which this Object represents and returns each item that matches the given filter - calling the
method used by switch statements. This method can be used with different kinds of filters like regular expressions, classes, ranges etc. Example:isCase(java.lang.Object, java.lang.Object)
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:
self
- the object over which we iteratefilter
- the filter to perform on the object (using theisCase(java.lang.Object, java.lang.Object)
method)- Returns:
- a collection of objects which match the filter
- Since:
- 1.5.6
-
grep
public static <T>
-