DefaultGroovyMethods (groovy 2.1.9 API)

Overview

Package

Class

Deprecated

Index

Help

Groovy 2.1.9

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.codehaus.groovy.runtime
[Java] Class DefaultGroovyMethods

java.lang.Object
  org.codehaus.groovy.runtime.DefaultGroovyMethodsSupport
      org.codehaus.groovy.runtime.DefaultGroovyMethods

public class DefaultGroovyMethods
extends DefaultGroovyMethodsSupport

This class defines new groovy methods which appear on normal JDK classes inside the Groovy environment. Static methods are used with the first parameter being the destination class, i.e. 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.

Authors:: James Strachan; Jeremy Rayner; Sam Pullara; Rod Cope; Guillaume Laforge; John Wilson; Hein Meling; Dierk Koenig; Pilho Kim; Marc Guillemot; Russel Winder; bing ran; Jochen Theodorou; Paul King; Michael Baehr; Joachim Baumann; Alex Tkachman; Ted Naleid; Brad Long; Jim Jagielski; Rodolfo Velasco; jeremi Joslin; Hamlet D'Arcy; Cedric Champeau; Tim Yates; Dinko Srkoc; Andre Steingress

Field Summary
`static Class[]`	`DGM_LIKE_CLASSES`
`static Class[]`	`additionals`

Method Summary
`static int`	`abs(Number number)` Truncate the value
`static long`	`abs(Long number)` Truncate the value
`static float`	`abs(Float number)` Determine if a Character is uppercase.
`static double`	`abs(Double number)`
`static Socket`	`accept(ServerSocket serverSocket, Closure closure)`
`static Socket`	`accept(ServerSocket serverSocket, boolean runInANewThread, Closure closure)`
`static boolean`	`addAll(Collection self, Object[] items)`
`static boolean`	`addAll(List self, int index, Object[] items)` Splits all items into two lists based on the closure condition.
`static void`	`addShutdownHook(Object self, Closure closure)`
`static Number`	`and(Number left, Number right)`
`static BitSet`	`and(BitSet left, BitSet right)`
`static Boolean`	`and(Boolean left, Boolean right)` Iterates over the elements of an iterable collection of items, starting from a specified startIndex, and returns the index of the first item that matches the condition specified in the closure.
`static boolean`	`any(Object self, Closure closure)`
`static boolean`	`any(Map self, Closure closure)`
`static boolean`	`any(Object self)`
`static void`	`append(File file, Object text)`
`static void`	`append(File file, byte[] bytes)`
`static void`	`append(File self, InputStream stream)`
`static void`	`append(File file, Object text, String charset)`
`static boolean`	`asBoolean(Object object)` Coerce a collection instance to a boolean value.
`static boolean`	`asBoolean(Boolean bool)`
`static boolean`	`asBoolean(Collection collection)` Coerce an iterator instance to a boolean value.
`static boolean`	`asBoolean(Map map)` Coerce an enumeration instance to a boolean value.
`static boolean`	`asBoolean(Iterator iterator)` Coerce an Object array to a boolean value.
`static boolean`	`asBoolean(Enumeration enumeration)` Coerces a byte array to a boolean value.
`static boolean`	`asBoolean(Object[] array)` Coerces a short array to a boolean value.
`static boolean`	`asBoolean(byte[] array)` Coerces an int array to a boolean value.
`static boolean`	`asBoolean(short[] array)` Coerces a long array to a boolean value.
`static boolean`	`asBoolean(int[] array)` Coerces a float array to a boolean value.
`static boolean`	`asBoolean(long[] array)` Coerces a double array to a boolean value.
`static boolean`	`asBoolean(float[] array)` Coerces a boolean array to a boolean value.
`static boolean`	`asBoolean(double[] array)` Coerces a char array to a boolean value.
`static boolean`	`asBoolean(boolean[] array)` Coerce a character to a boolean value.
`static boolean`	`asBoolean(char[] array)` Coerce a number to a boolean value.
`static boolean`	`asBoolean(Character character)`
`static boolean`	`asBoolean(Number number)`
`static boolean`	`asBoolean(CharSequence string)`
`static boolean`	`asBoolean(Matcher matcher)`
`static Map`	`asImmutable(Map self)` A convenience method for creating an immutable sorted map.
`static SortedMap`	`asImmutable(SortedMap self)`
`static List`	`asImmutable(List self)`
`static Set`	`asImmutable(Set self)`
`static SortedSet`	`asImmutable(SortedSet self)`
`static Collection`	`asImmutable(Collection self)` A convenience method for creating a synchronized SortedMap.
`static List`	`asList(Collection self)` Coerce an object instance to a boolean value.
`static Map`	`asSynchronized(Map self)`
`static SortedMap`	`asSynchronized(SortedMap self)`
`static Collection`	`asSynchronized(Collection self)`
`static List`	`asSynchronized(List self)`
`static Set`	`asSynchronized(Set self)`
`static SortedSet`	`asSynchronized(SortedSet self)`
`static Object`	`asType(Collection col, Class clazz)`
`static Object`	`asType(Object[] ary, Class clazz)` Converts the given array to either a List, Set, or SortedSet.
`static Object`	`asType(Closure cl, Class clazz)` Coerces this map to the given type, using the map's keys as the public method names, and values as the implementation.
`static Object`	`asType(Map map, Class clazz)`
`static Object`	`asType(Number self, Class c)` Traverse through each byte of this Byte array.
`static Object`	`asType(Object obj, Class type)` Adds a "metaClass" property to all class objects so you can use the syntax `String.metaClass.myMethod = { println "foo" }`
`static Object`	`asType(CharSequence self, Class c)`
`static Object`	`asType(GString self, Class c)`
`static Object`	`asType(String self, Class c)`
`static Object`	`asType(File f, Class c)`
`static File`	`asWritable(File file)`
`static File`	`asWritable(File file, String encoding)`
`static BitSet`	`bitwiseNegate(BitSet self)` Iterates from this number up to the given number, inclusive, incrementing by one each time.
`static Pattern`	`bitwiseNegate(CharSequence self)`
`static Pattern`	`bitwiseNegate(String self)`
`protected static Object`	`callClosureForLine(Closure closure, String line, int counter)`
`protected static Object`	`callClosureForMapEntry(Closure closure, Map.Entry entry)`
`protected static Object`	`callClosureForMapEntryAndCounter(Closure closure, Map.Entry entry, int counter)`
`static CharSequence`	`capitalize(CharSequence self)`
`static String`	`capitalize(String self)`
`static CharSequence`	`center(CharSequence self, Number numberOfChars)`
`static CharSequence`	`center(CharSequence self, Number numberOfChars, CharSequence padding)`
`static String`	`center(String self, Number numberOfChars)`
`static String`	`center(String self, Number numberOfChars, String padding)`
`static List`	`collate(List self, int size)`
`static List`	`collate(List self, int size, int step)`
`static List`	`collate(List self, int size, boolean keepRemainder)`
`static List`	`collate(List self, int size, int step, boolean keepRemainder)`
`static List`	`collect(Object self, Closure transform)` Iterates through this aggregate Object transforming each item into a new value using the `transform` closure, returning a list of transformed values.
`static Collection`	`collect(Object self)` Iterates through this aggregate Object transforming each item into a new value using the `transform` closure and adding it to the supplied `collector`.
`static Collection`	`collect(Object self, Collection collector, Closure transform)`
`static List`	`collect(Collection self, Closure transform)` 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 List`	`collect(Collection self)` Iterates through this collection transforming each value into a new value using the `transform` closure and adding it to the supplied `collector`.
`static Collection`	`collect(Collection self, Collection collector, Closure transform)`
`static Collection`	`collect(Map self, Collection collector, Closure transform)`
`static List`	`collect(Map self, Closure transform)`
`static List`	`collectAll(Collection self, Closure transform)`
`static Collection`	`collectAll(Collection self, Collection collector, Closure transform)`
`static Map`	`collectEntries(Map self, Map collector, Closure transform)`
`static Map`	`collectEntries(Map self, Closure transform)`
`static Map`	`collectEntries(Collection self, Closure transform)` A variant of collectEntries for Iterators.
`static Map`	`collectEntries(Iterator self, Closure transform)` A variant of collectEntries for Iterables.
`static Map`	`collectEntries(Iterable self, Closure transform)`
`static Map`	`collectEntries(Collection self)` A variant of collectEntries for Iterators using the identity closure as the transform.
`static Map`	`collectEntries(Iterator self)` A variant of collectEntries for Iterables using the identity closure as the transform.
`static Map`	`collectEntries(Iterable self)`
`static Map`	`collectEntries(Collection self, Map collector, Closure transform)`
`static Map`	`collectEntries(Iterator self, Map collector, Closure transform)`
`static Map`	`collectEntries(Iterable self, Map collector, Closure transform)` A variant of collectEntries for Collections using the identity closure as the transform and a supplied map as the destination of transformed entries.
`static Map`	`collectEntries(Collection self, Map 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 Map`	`collectEntries(Iterator self, Map 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 Map`	`collectEntries(Iterable self, Map collector)`
`static Map`	`collectEntries(Object[] self, Map collector, Closure transform)` A variant of collectEntries using the identity closure as the transform.
`static Map`	`collectEntries(Object[] self, Map collector)`
`static Map`	`collectEntries(Object[] self, Closure transform)` A variant of collectEntries using the identity closure as the transform.
`static Map`	`collectEntries(Object[] self)`
`static List`	`collectMany(Collection self, Closure projection)` Projects each item from a source collection to a collection and concatenates (flattens) the resulting collections into a single list.
`static Collection`	`collectMany(Collection self, Collection collector, Closure projection)`
`static Collection`	`collectMany(Map self, Collection collector, Closure projection)`
`static Collection`	`collectMany(Map self, Closure projection)`
`static List`	`collectMany(Object[] self, Closure projection)`
`static List`	`collectMany(Iterator self, Closure projection)`
`static List`	`collectNested(Collection self, Closure transform)` Deprecated alias for collectNested
`static Collection`	`collectNested(Collection self, Collection collector, Closure transform)`
`static List`	`combinations(Collection self)` Finds all non-null subsequences of a list.
`static int`	`compareTo(Character left, Number right)`
`static int`	`compareTo(Number left, Character right)`
`static int`	`compareTo(Character left, Character right)`
`static int`	`compareTo(Number left, Number right)`
`static boolean`	`contains(int[] self, Object value)` Checks whether the array contains the given value.
`static boolean`	`contains(long[] self, Object value)` Checks whether the array contains the given value.
`static boolean`	`contains(short[] self, Object value)` Returns the string representation of the given array.
`static boolean`	`contains(char[] self, Object value)` Returns the string representation of the given array.
`static boolean`	`contains(boolean[] self, Object value)` Returns the string representation of the given array.
`static boolean`	`contains(double[] self, Object value)` Returns the string representation of the given array.
`static boolean`	`contains(float[] self, Object value)`
`static boolean`	`contains(byte[] self, Object value)` Returns the string representation of the given array.
`static boolean`	`contains(Object[] self, Object value)` Returns the string representation of the given map.
`static boolean`	`contains(CharSequence self, CharSequence text)`
`static boolean`	`contains(String self, String text)`
`static boolean`	`containsAll(Collection self, Object[] items)` Modifies this collection by removing its elements that are contained within the specified object array.
`static Number`	`count(Iterator self, Object value)`
`static Number`	`count(Iterator self, Closure closure)` Counts the number of occurrences which satisfy the given closure from the items within this Iterator.
`static Number`	`count(Collection self, Object value)` Counts the number of occurrences of the given value inside this collection.
`static Number`	`count(Collection self, Closure closure)`
`static Number`	`count(Map self, Closure closure)`
`static Number`	`count(Object[] self, Object value)` Counts the number of occurrences of the given value inside this array.
`static Number`	`count(Object[] self, Closure closure)` Counts the number of occurrences of the given value inside this array.
`static Number`	`count(int[] self, Object value)` Counts the number of occurrences of the given value inside this array.
`static Number`	`count(long[] self, Object value)` Counts the number of occurrences of the given value inside this array.
`static Number`	`count(short[] self, Object value)` Counts the number of occurrences of the given value inside this array.
`static Number`	`count(char[] self, Object value)` Counts the number of occurrences of the given value inside this array.
`static Number`	`count(boolean[] self, Object value)` Counts the number of occurrences of the given value inside this array.
`static Number`	`count(double[] self, Object value)` Counts the number of occurrences of the given value inside this array.
`static Number`	`count(float[] self, Object value)` Counts the number of occurrences of the given value inside this array.
`static Number`	`count(byte[] self, Object value)`
`static int`	`count(CharSequence self, CharSequence text)`
`static int`	`count(String self, String text)`
`static Map`	`countBy(Collection self, Closure closure)` Sorts all array members into groups determined by the supplied mapping closure and counts the group size.
`static Map`	`countBy(Object[] self, Closure closure)` Sorts all iterator items into groups determined by the supplied mapping closure and counts the group size.
`static Map`	`countBy(Iterator self, Closure closure)`
`static Map`	`countBy(Map self, Closure closure)` Groups the current element according to the value
`protected static StringBufferWriter`	`createStringBufferWriter(StringBuffer self)`
`protected static StringWriter`	`createStringWriter(String self)`
`static boolean`	`deleteDir(File self)`
`static CharSequence`	`denormalize(CharSequence self)`
`static String`	`denormalize(String self)`
`static boolean`	`disjoint(Collection left, Collection right)` Compare the contents of this array to the contents of the given array.
`static Number`	`div(Character left, Number right)` Bitwise AND together two Numbers.
`static Number`	`div(Number left, Character right)` Bitwise AND together two BitSets.
`static Number`	`div(Character left, Character right)` Bitwise XOR together two BitSets.
`static void`	`downto(Number self, Number to, Closure closure)` Iterates from this number down to the given number, inclusive, decrementing by one each time.
`static void`	`downto(long self, Number to, Closure closure)`
`static void`	`downto(Long self, Number to, Closure closure)`
`static void`	`downto(float self, Number to, Closure closure)`
`static void`	`downto(Float self, Number to, Closure closure)`
`static void`	`downto(double self, Number to, Closure closure)`
`static void`	`downto(Double self, Number to, Closure closure)` Iterates from this number up to the given number using a step increment.
`static void`	`downto(BigInteger self, Number to, Closure closure)`
`static void`	`downto(BigDecimal self, Number to, Closure closure)` Get the absolute value
`static List`	`drop(List self, int num)`
`static List`	`drop(Iterable self, int num)` Drops the given number of elements from the head of this array if they are available.
`static Object[]`	`drop(Object[] self, int num)`
`static Map`	`drop(Map self, int num)`
`static Iterator`	`drop(Iterator self, int num)` Returns the longest prefix of this list where each element passed to the given closure condition evaluates to true.
`static CharSequence`	`drop(CharSequence self, int num)`
`static List`	`dropWhile(List self, Closure condition)`
`static List`	`dropWhile(Iterable self, Closure condition)` 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 Map`	`dropWhile(Map self, Closure condition)`
`static Object[]`	`dropWhile(Object[] self, Closure condition)`
`static Iterator`	`dropWhile(Iterator self, Closure condition)`
`static String`	`dump(Object self)`
`static Object`	`each(Object self, Closure closure)` Iterates through an aggregate type or data structure, passing each item to the given closure.
`static Map`	`each(Map self, Closure closure)`
`static void`	`eachByte(Byte[] self, Closure closure)`
`static void`	`eachByte(byte[] self, Closure closure)`
`static void`	`eachByte(File self, Closure closure)`
`static void`	`eachByte(File self, int bufferLen, Closure closure)`
`static void`	`eachByte(InputStream is, Closure closure)`
`static void`	`eachByte(InputStream is, int bufferLen, Closure closure)`
`static void`	`eachByte(URL url, Closure closure)`
`static void`	`eachByte(URL url, int bufferLen, Closure closure)`
`static void`	`eachDir(File self, Closure closure)`
`static void`	`eachDirMatch(File self, Object nameFilter, Closure closure)`
`static void`	`eachDirRecurse(File self, Closure closure)`
`static void`	`eachFile(File self, FileType fileType, Closure closure)`
`static void`	`eachFile(File self, Closure closure)`
`static void`	`eachFileMatch(File self, FileType fileType, Object nameFilter, Closure closure)`
`static void`	`eachFileMatch(File self, Object nameFilter, Closure closure)`
`static void`	`eachFileRecurse(File self, FileType fileType, Closure closure)`
`static void`	`eachFileRecurse(File self, Closure closure)`
`static Object`	`eachLine(CharSequence self, Closure closure)`
`static Object`	`eachLine(CharSequence self, int firstLine, Closure closure)`
`static Object`	`eachLine(String self, Closure closure)`
`static Object`	`eachLine(String self, int firstLine, Closure closure)`
`static Object`	`eachLine(File self, Closure closure)`
`static Object`	`eachLine(File self, String charset, Closure closure)`
`static Object`	`eachLine(File self, int firstLine, Closure closure)`
`static Object`	`eachLine(File self, String charset, int firstLine, Closure closure)`
`static Object`	`eachLine(InputStream stream, String charset, Closure closure)`
`static Object`	`eachLine(InputStream stream, String charset, int firstLine, Closure closure)`
`static Object`	`eachLine(InputStream stream, Closure closure)`
`static Object`	`eachLine(InputStream stream, int firstLine, Closure closure)`
`static Object`	`eachLine(URL url, Closure closure)`
`static Object`	`eachLine(URL url, int firstLine, Closure closure)`
`static Object`	`eachLine(URL url, String charset, Closure closure)`
`static Object`	`eachLine(URL url, String charset, int firstLine, Closure closure)`
`static Object`	`eachLine(Reader self, Closure closure)`
`static Object`	`eachLine(Reader self, int firstLine, Closure closure)`
`static String`	`eachMatch(CharSequence self, CharSequence regex, Closure closure)`
`static String`	`eachMatch(CharSequence self, Pattern pattern, Closure closure)`
`static String`	`eachMatch(String self, Pattern pattern, Closure closure)`
`static String`	`eachMatch(String self, String regex, Closure closure)`
`static void`	`eachObject(File self, Closure closure)`
`static void`	`eachObject(ObjectInputStream ois, Closure closure)`
`static Iterator`	`eachPermutation(Collection self, Closure closure)`
`static Object`	`eachWithIndex(Object self, Closure closure)`
`static Map`	`eachWithIndex(Map self, Closure closure)`
`static boolean`	`equals(int[] left, int[] right)` Determines if the contents of this array are equal to the contents of the given list, in the same order.
`static boolean`	`equals(Object[] left, List right)`
`static boolean`	`equals(List left, Object[] right)`
`static boolean`	`equals(List left, List right)`
`static boolean`	`equals(Set self, Set other)`
`static boolean`	`equals(Map self, Map other)` Create a Set composed of the elements of the first Set minus the elements of the given Collection.
`static boolean`	`every(Object self, Closure closure)`
`static boolean`	`every(Map self, Closure closure)`
`static boolean`	`every(Object self)`
`static Process`	`execute(String self)`
`static Process`	`execute(String self, String[] envp, File dir)`
`static Process`	`execute(String self, List envp, File dir)`
`static Process`	`execute(String[] commandArray)`
`static Process`	`execute(String[] commandArray, String[] envp, File dir)`
`static Process`	`execute(String[] commandArray, List envp, File dir)`
`static Process`	`execute(List commands)`
`static Process`	`execute(List commands, String[] envp, File dir)`
`static Process`	`execute(List commands, List envp, File dir)`
`static CharSequence`	`expand(CharSequence self)`
`static CharSequence`	`expand(CharSequence self, int tabStop)`
`static String`	`expand(String self)`
`static String`	`expand(String self, int tabStop)`
`static CharSequence`	`expandLine(CharSequence self, int tabStop)`
`static String`	`expandLine(String self, int tabStop)`
`static void`	`filterLine(Reader reader, Writer writer, Closure closure)`
`static Writable`	`filterLine(File self, Closure closure)`
`static Writable`	`filterLine(File self, String charset, Closure closure)`
`static void`	`filterLine(File self, Writer writer, Closure closure)`
`static void`	`filterLine(File self, Writer writer, String charset, Closure closure)`
`static Writable`	`filterLine(Reader reader, Closure closure)`
`static Writable`	`filterLine(InputStream self, Closure predicate)`
`static Writable`	`filterLine(InputStream self, String charset, Closure predicate)`
`static void`	`filterLine(InputStream self, Writer writer, Closure predicate)`
`static void`	`filterLine(InputStream self, Writer writer, String charset, Closure predicate)`
`static Writable`	`filterLine(URL self, Closure predicate)`
`static Writable`	`filterLine(URL self, String charset, Closure predicate)`
`static void`	`filterLine(URL self, Writer writer, Closure predicate)`
`static void`	`filterLine(URL self, Writer writer, String charset, Closure predicate)`
`static Object`	`find(Object self, Closure closure)`
`static Object`	`find(Object self)` 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 Object`	`find(Collection self, Closure closure)`
`static Object`	`find(Object[] self, Closure condition)`
`static Object`	`find(Collection self)`
`static Map.Entry`	`find(Map self, Closure closure)`
`static CharSequence`	`find(CharSequence self, CharSequence regex)`
`static CharSequence`	`find(CharSequence self, CharSequence regex, Closure closure)`
`static CharSequence`	`find(CharSequence self, Pattern pattern)`
`static CharSequence`	`find(CharSequence self, Pattern pattern, Closure closure)`
`static String`	`find(String self, Pattern pattern)`
`static String`	`find(String self, Pattern pattern, Closure closure)`
`static String`	`find(String self, String regex)`
`static String`	`find(String self, String regex, Closure closure)`
`static Collection`	`findAll(Collection self, Closure closure)` Finds all elements of the array matching the given Closure condition.
`static Collection`	`findAll(Object[] self, Closure condition)`
`static Collection`	`findAll(Collection self)` Finds the elements of the array matching the IDENTITY Closure (i.e. matching Groovy truth).
`static Collection`	`findAll(Object[] self)` Finds all items matching the closure condition.
`static Collection`	`findAll(Object self, Closure closure)`
`static Collection`	`findAll(Object self)`
`static Map`	`findAll(Map self, Closure closure)`
`static List`	`findAll(CharSequence self, CharSequence regex)`
`static List`	`findAll(CharSequence self, CharSequence regex, Closure closure)`
`static List`	`findAll(CharSequence self, Pattern pattern)`
`static List`	`findAll(CharSequence self, Pattern pattern, Closure closure)`
`static List`	`findAll(String self, Pattern pattern)`
`static List`	`findAll(String self, Pattern pattern, Closure closure)`
`static List`	`findAll(String self, String regex)`
`static List`	`findAll(String self, String regex, Closure closure)`
`static int`	`findIndexOf(Object self, Closure closure)`
`static int`	`findIndexOf(Object self, int startIndex, Closure closure)`
`static List`	`findIndexValues(Object self, Closure closure)`
`static List`	`findIndexValues(Object self, Number startIndex, Closure closure)`
`static int`	`findLastIndexOf(Object self, Closure closure)` Converts a given object to a type.
`static int`	`findLastIndexOf(Object self, int startIndex, Closure closure)`
`static Object`	`findResult(Object self, Object defaultResult, Closure closure)` 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, Closure closure)`
`static Object`	`findResult(Collection self, Object defaultResult, Closure closure)`
`static Object`	`findResult(Collection self, Closure closure)`
`static Object`	`findResult(Map self, Object defaultResult, Closure closure)`
`static Object`	`findResult(Map self, Closure closure)`
`static Collection`	`findResults(Collection self, Closure filteringTransform)`
`static Collection`	`findResults(Map self, Closure filteringTransform)`
`static Object`	`first(List self)`
`static Object`	`first(Iterable self)` Returns the first item from the array.
`static Object`	`first(Object[] self)`
`static Collection`	`flatten(Collection self)` Flatten an array.
`static Collection`	`flatten(Object[] self)`
`static Collection`	`flatten(boolean[] self)`
`static Collection`	`flatten(byte[] self)`
`static Collection`	`flatten(char[] self)`
`static Collection`	`flatten(short[] self)`
`static Collection`	`flatten(int[] self)`
`static Collection`	`flatten(long[] self)`
`static Collection`	`flatten(float[] self)` Flatten a collection.
`static Collection`	`flatten(double[] self)`
`static Collection`	`flatten(Collection self, Closure flattenUsing)` Overloads the left shift operator to provide an easy way to append objects to a Collection.
`static Object`	`get(Map map, Object key, Object defaultValue)` Support the range subscript operator for an Array
`static Object`	`getAt(Object self, String property)` Allows the subscript operator to be used to lookup dynamic property values.
`static List`	`getAt(List self, Range range)` Support the range subscript operator for a List.
`static List`	`getAt(List self, EmptyRange range)` Select a List of items from a List using a Collection to identify the indices to be selected.
`static List`	`getAt(List self, Collection indices)` Select a List of items from an Object array using a Collection to identify the indices to be selected.
`static List`	`getAt(Object[] self, Collection indices)` Creates a sub-Map containing the given keys.
`static List`	`getAt(Object[] array, Range range)` @param array an Array of Objects
`static List`	`getAt(Object[] array, IntRange range)` @param array an Array of Objects
`static List`	`getAt(Object[] array, EmptyRange range)`
`static List`	`getAt(Object[] array, ObjectRange range)`
`static Object`	`getAt(List self, int idx)`
`static Object`	`getAt(Iterator self, int idx)`
`static Object`	`getAt(Iterable self, int idx)` A helper method to allow lists to work with subscript operators.
`static Object`	`getAt(Map self, Object key)` Support the subscript operator for a Map.
`static List`	`getAt(Collection coll, String property)` A convenience method for creating an immutable map.
`static List`	`getAt(byte[] array, Range range)` Support the subscript operator with a range for an int array
`static List`	`getAt(char[] array, Range range)`
`static List`	`getAt(short[] array, Range range)`
`static List`	`getAt(int[] array, Range range)`
`static List`	`getAt(long[] array, Range range)`
`static List`	`getAt(float[] array, Range range)`
`static List`	`getAt(double[] array, Range range)`
`static List`	`getAt(boolean[] array, Range range)`
`static List`	`getAt(byte[] array, IntRange range)`
`static List`	`getAt(char[] array, IntRange range)`
`static List`	`getAt(short[] array, IntRange range)`
`static List`	`getAt(int[] array, IntRange range)`
`static List`	`getAt(long[] array, IntRange range)`
`static List`	`getAt(float[] array, IntRange range)`
`static List`	`getAt(double[] array, IntRange range)`
`static List`	`getAt(boolean[] array, IntRange range)`
`static List`	`getAt(byte[] array, ObjectRange range)`
`static List`	`getAt(char[] array, ObjectRange range)`
`static List`	`getAt(short[] array, ObjectRange range)`
`static List`	`getAt(int[] array, ObjectRange range)`
`static List`	`getAt(long[] array, ObjectRange range)`
`static List`	`getAt(float[] array, ObjectRange range)`
`static List`	`getAt(double[] array, ObjectRange range)`
`static List`	`getAt(boolean[] array, ObjectRange range)`
`static List`	`getAt(byte[] array, Collection indices)`
`static List`	`getAt(char[] array, Collection indices)`
`static List`	`getAt(short[] array, Collection indices)`
`static List`	`getAt(int[] array, Collection indices)`
`static List`	`getAt(long[] array, Collection indices)`
`static List`	`getAt(float[] array, Collection indices)`
`static List`	`getAt(double[] array, Collection indices)`
`static List`	`getAt(boolean[] array, Collection indices)`
`static boolean`	`getAt(BitSet self, int index)`
`static BitSet`	`getAt(BitSet self, IntRange range)`
`static CharSequence`	`getAt(CharSequence self, Collection indices)`
`static CharSequence`	`getAt(CharSequence text, EmptyRange range)`
`static CharSequence`	`getAt(CharSequence text, int index)`
`static CharSequence`	`getAt(CharSequence text, IntRange range)`
`static CharSequence`	`getAt(CharSequence text, Range range)`
`static List`	`getAt(Matcher self, Collection indices)`
`static Object`	`getAt(Matcher matcher, int idx)`
`static String`	`getAt(String self, Collection indices)`
`static String`	`getAt(String text, EmptyRange range)`
`static String`	`getAt(String text, int index)`
`static String`	`getAt(String text, IntRange range)`
`static String`	`getAt(String text, Range range)`
`static byte[]`	`getBytes(File file)`
`static byte[]`	`getBytes(URL url)`
`static byte[]`	`getBytes(InputStream is)`
`static char[]`	`getChars(CharSequence self)`
`static char[]`	`getChars(String self)`
`static int`	`getCount(Matcher matcher)`
`static MetaClass`	`getMetaClass(Class c)`
`static MetaClass`	`getMetaClass(Object obj)`
`static MetaClass`	`getMetaClass(GroovyObject obj)` Sets/updates the metaclass for a given object to a closure.
`static List`	`getMetaPropertyValues(Object self)` Retrieves the list of MetaProperty objects for 'self' and wraps it in a list of PropertyValue objects that additionally provide the value for each property of 'self'.
`static Map`	`getProperties(Object self)` Convenience method that calls getMetaPropertyValues(java.lang.Object)(self) and provides the data in form of simple key/value pairs, i.e.
`static ClassLoader`	`getRootLoader(ClassLoader self)` Convenience method to dynamically create a new instance of this class.
`protected static List`	`getSubList(List self, List splice)`
`static String`	`getText(File file, String charset)`
`static String`	`getText(File file)`
`static String`	`getText(URL url)`
`static String`	`getText(URL url, Map parameters)`
`static String`	`getText(URL url, String charset)`
`static String`	`getText(URL url, Map parameters, String charset)`
`static String`	`getText(InputStream is)`
`static String`	`getText(InputStream is, String charset)`
`static String`	`getText(Reader reader)`
`static String`	`getText(BufferedReader reader)`
`static Collection`	`grep(Object self, Object filter)`
`static Collection`	`grep(Collection self, Object filter)` Iterates over the collection of items and returns each item that matches the given filter - calling the `isCase(java.lang.Object, java.lang.Object)` method used by switch statements.
`static Collection`	`grep(Object[] self, Object filter)`
`static Collection`	`grep(Object self)`
`static Collection`	`grep(Collection self)`
`static Collection`	`grep(Object[] self)`
`protected static void`	`groupAnswer(Map answer, Object element, Object value)`
`static Map`	`groupBy(Collection self, Closure closure)`
`static Map`	`groupBy(Collection self, Object... closures)`
`static Map`	`groupBy(Collection self, List closures)` Sorts all collection members into (sub)groups determined by the supplied mapping closures.
`static Map`	`groupBy(Map self, Closure closure)`
`static Map`	`groupBy(Map self, Object... closures)`
`static Map`	`groupBy(Map self, List closures)` Groups the members of a map into sub maps determined by the supplied mapping closures.
`static Map`	`groupEntriesBy(Map self, Closure closure)`
`static boolean`	`hasGroup(Matcher matcher)`
`static MetaProperty`	`hasProperty(Object self, String name)`
`static Object`	`head(List self)` Returns the items from the List excluding the first item.
`static Object`	`head(Object[] self)`
`static Object`	`identity(Object self, Closure closure)`
`static Boolean`	`implies(Boolean left, Boolean right)`
`static Object`	`inject(Collection self, Closure closure)`
`static Object`	`inject(Collection self, Object initialValue, Closure closure)`
`static Object`	`inject(Map self, Object initialValue, Closure closure)`
`static Object`	`inject(Iterator self, Object initialValue, Closure closure)`
`static Object`	`inject(Object self, Closure closure)` Iterates through the given Object, passing in the initial value to the closure along with the first item.
`static Object`	`inject(Object self, Object initialValue, Closure closure)` Iterates 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 Object`	`inject(Object[] self, Closure closure)`
`static Object`	`inject(Object[] self, Object initialValue, Closure closure)` Sums the items in a collection.
`static String`	`inspect(Object self)` Inspects returns the String that matches what would be typed into a terminal to create this object.
`static Number`	`intdiv(Character left, Number right)` Bitwise NEGATE a BitSet.
`static Number`	`intdiv(Number left, Character right)` Bitwise OR together two BitSets.
`static Number`	`intdiv(Character left, Character right)` Bitwise XOR together two Numbers.
`static Number`	`intdiv(Number left, Number right)`
`static Collection`	`intersect(Collection left, Collection right)`
`static Map`	`intersect(Map left, Map right)` Returns `true` if the intersection of two collections is empty.
`static Object`	`invokeMethod(Object object, String method, Object arguments)`
`static boolean`	`is(Object self, Object other)` Identity check.
`static boolean`	`isAllWhitespace(CharSequence self)`
`static boolean`	`isAllWhitespace(String self)`
`static boolean`	`isBigDecimal(CharSequence self)`
`static boolean`	`isBigDecimal(String self)`
`static boolean`	`isBigInteger(CharSequence self)`
`static boolean`	`isBigInteger(String self)`
`static boolean`	`isCase(Object caseValue, Object switchValue)`
`static boolean`	`isCase(Class caseValue, Object switchValue)`
`static boolean`	`isCase(Collection caseValue, Object switchValue)`
`static boolean`	`isCase(Map caseValue, Object switchValue)`
`static boolean`	`isCase(Number caseValue, Number switchValue)`
`static boolean`	`isCase(CharSequence caseValue, Object switchValue)`
`static boolean`	`isCase(GString caseValue, Object switchValue)`
`static boolean`	`isCase(Pattern caseValue, Object switchValue)`
`static boolean`	`isCase(String caseValue, Object switchValue)`
`static boolean`	`isDigit(Character self)`
`static boolean`	`isDouble(CharSequence self)`
`static boolean`	`isDouble(String self)`
`static boolean`	`isFloat(CharSequence self)`
`static boolean`	`isFloat(String self)`
`static boolean`	`isInteger(CharSequence self)`
`static boolean`	`isInteger(String self)`
`static boolean`	`isLetter(Character self)` Transform a Number into a Double
`static boolean`	`isLetterOrDigit(Character self)` Transform a Number into a BigDecimal
`static boolean`	`isLong(CharSequence self)`
`static boolean`	`isLong(String self)`
`static boolean`	`isLowerCase(Character self)` Transform a Number into a Float
`static boolean`	`isNumber(CharSequence self)`
`static boolean`	`isNumber(String self)`
`static boolean`	`isUpperCase(Character self)`
`static boolean`	`isWhitespace(Character self)`
`static Iterator`	`iterator(Object[] a)`
`static Iterator`	`iterator(Object o)`
`static Iterator`	`iterator(Enumeration enumeration)`
`static Iterator`	`iterator(Iterator self)`
`static Iterator`	`iterator(Matcher matcher)`
`static Iterator`	`iterator(Reader self)`
`static Iterator`	`iterator(InputStream self)`
`static Iterator`	`iterator(DataInputStream self)`
`static String`	`join(Iterator self, String separator)` Concatenates the `toString()` representation of each item in this collection, with the given String as a separator between each item.
`static String`	`join(Collection self, String separator)`
`static String`	`join(Object[] self, String separator)`
`static Object`	`last(List self)`
`static Object`	`last(Iterable self)` Returns the last item from the array.
`static Object`	`last(Object[] self)` Returns the first item from the List.
`static Collection`	`leftShift(Collection self, Object value)` Overloads the left shift operator to provide an easy way to append Map.Entry values to a Map.
`static BlockingQueue`	`leftShift(BlockingQueue self, Object value)`
`static Map`	`leftShift(Map self, Map.Entry entry)`
`static Map`	`leftShift(Map self, Map other)` Implementation of the right shift (unsigned) operator for integral types.
`static Number`	`leftShift(Number self, Number operand)` Support the subscript operator with a range for a byte array
`static StringBuilder`	`leftShift(CharSequence self, Object value)`
`static StringBuffer`	`leftShift(String self, Object value)`
`static StringBuffer`	`leftShift(StringBuffer self, Object value)`
`static StringBuilder`	`leftShift(StringBuilder self, Object value)`
`static Writer`	`leftShift(Socket self, Object value)`
`static OutputStream`	`leftShift(Socket self, byte[] value)`
`static Writer`	`leftShift(Writer self, Object value)`
`static Writer`	`leftShift(OutputStream self, Object value)`
`static void`	`leftShift(ObjectOutputStream self, Object value)`
`static OutputStream`	`leftShift(OutputStream self, InputStream in)`
`static OutputStream`	`leftShift(OutputStream self, byte[] value)`
`static File`	`leftShift(File file, Object text)`
`static File`	`leftShift(File file, byte[] bytes)`
`static File`	`leftShift(File file, InputStream data)`
`static boolean`	`matches(CharSequence self, Pattern pattern)`
`static boolean`	`matches(String self, Pattern pattern)`
`static Map.Entry`	`max(Map self, Closure closure)`
`static Object`	`max(Collection self)`
`static Object`	`max(Iterator self)`
`static Object`	`max(Object[] self)`
`static Object`	`max(Collection self, Closure closure)`
`static Object`	`max(Iterator self, Closure closure)` Selects the maximum value found from the Object array using the closure to determine the correct ordering.
`static Object`	`max(Object[] self, Closure closure)` Selects the maximum value found in the collection using the given comparator.
`static Object`	`max(Collection self, Comparator comparator)`
`static Object`	`max(Iterator self, Comparator comparator)` Provide the standard Groovy `size()` method for `Iterator`.
`static Object`	`max(Object[] self, Comparator comparator)`
`static MetaClass`	`metaClass(Class self, Closure closure)` Allows an Enumeration to behave like an Iterator.
`static MetaClass`	`metaClass(Object self, Closure closure)` 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 Object`	`min(Collection self)` Adds min() method to Iterator objects.
`static Object`	`min(Iterator self)`
`static Object`	`min(Object[] self)`
`static Object`	`min(Collection self, Comparator comparator)`
`static Object`	`min(Iterator self, Comparator comparator)`
`static Object`	`min(Object[] self, Comparator comparator)`
`static Object`	`min(Collection self, Closure closure)`
`static Map.Entry`	`min(Map self, Closure closure)`
`static Object`	`min(Iterator self, Closure closure)` Selects the minimum value found from the Object array using the closure to determine the correct ordering.
`static Object`	`min(Object[] self, Closure closure)` Adds max() method to Collection objects.
`static Set`	`minus(Set self, Collection removeMe)` Create a Set composed of the elements of the first Set minus the elements from the given Iterable.
`static Set`	`minus(Set self, Iterable removeMe)` Create an array composed of the elements of the first array minus the elements of the given Iterable.
`static Set`	`minus(Set self, Object removeMe)` Create an array composed of the elements of the first array minus the elements of the given array.
`static Object[]`	`minus(Object[] self, Iterable removeMe)` Create a List composed of the elements of the first list minus every occurrence of elements of the given Collection.
`static Object[]`	`minus(Object[] self, Object[] removeMe)`
`static List`	`minus(List self, Collection removeMe)`
`static List`	`minus(List self, Iterable removeMe)` Create a List composed of the elements of the first list minus every occurrence of elements of the given Iterable.
`static List`	`minus(List self, Object removeMe)`
`static Object[]`	`minus(Object[] self, Object removeMe)` Flatten a collection.
`static Map`	`minus(Map self, Map removeMe)` Flatten an array.
`static Number`	`minus(Character left, Number right)`
`static Number`	`minus(Number left, Character right)` Power of a Number to a certain exponent.
`static Number`	`minus(Character left, Character right)`
`static CharSequence`	`minus(CharSequence self, Object target)`
`static String`	`minus(String self, Object target)`
`static void`	`mixin(MetaClass self, List categoryClasses)`
`static void`	`mixin(Class self, List categoryClasses)`
`static void`	`mixin(Class self, Class categoryClass)`
`static void`	`mixin(Class self, Class[] categoryClass)`
`static void`	`mixin(MetaClass self, Class categoryClass)`
`static void`	`mixin(MetaClass self, Class[] categoryClass)`
`static Number`	`mod(Number left, Number right)`
`static List`	`multiply(Collection self, Number factor)`
`static Number`	`multiply(Character left, Number right)`
`static Number`	`multiply(Number left, Character right)`
`static Number`	`multiply(Character left, Character right)` Power of an integer to an integer certain exponent.
`static Number`	`multiply(BigDecimal left, Double right)`
`static Number`	`multiply(BigDecimal left, BigInteger right)`
`static CharSequence`	`multiply(CharSequence self, Number factor)`
`static String`	`multiply(String self, Number factor)`
`static DataInputStream`	`newDataInputStream(File file)`
`static DataOutputStream`	`newDataOutputStream(File file)`
`static BufferedInputStream`	`newInputStream(File file)`
`static BufferedInputStream`	`newInputStream(URL url)`
`static BufferedInputStream`	`newInputStream(URL url, Map parameters)`
`static Object`	`newInstance(Class c)` Sets the metaclass for a given class.
`static Object`	`newInstance(Class c, Object[] args)` Sets/updates the metaclass for a given class to a closure.
`static ObjectInputStream`	`newObjectInputStream(File file)`
`static ObjectInputStream`	`newObjectInputStream(InputStream inputStream)`
`static ObjectInputStream`	`newObjectInputStream(InputStream inputStream, ClassLoader classLoader)`
`static ObjectInputStream`	`newObjectInputStream(File file, ClassLoader classLoader)`
`static ObjectOutputStream`	`newObjectOutputStream(File file)`
`static ObjectOutputStream`	`newObjectOutputStream(OutputStream outputStream)`
`static BufferedOutputStream`	`newOutputStream(File file)`
`static PrintWriter`	`newPrintWriter(File file)`
`static PrintWriter`	`newPrintWriter(File file, String charset)`
`static PrintWriter`	`newPrintWriter(Writer writer)`
`static BufferedReader`	`newReader(File file)`
`static BufferedReader`	`newReader(File file, String charset)`
`static BufferedReader`	`newReader(InputStream self)`
`static BufferedReader`	`newReader(InputStream self, String charset)`
`static BufferedReader`	`newReader(URL url)`
`static BufferedReader`	`newReader(URL url, Map parameters)`
`static BufferedReader`	`newReader(URL url, String charset)`
`static BufferedReader`	`newReader(URL url, Map parameters, String charset)`
`static BufferedWriter`	`newWriter(File file)`
`static BufferedWriter`	`newWriter(File file, boolean append)`
`static BufferedWriter`	`newWriter(File file, String charset, boolean append)`
`static BufferedWriter`	`newWriter(File file, String charset)`
`static Character`	`next(Character self)` Compare a Number and a Character.
`static Number`	`next(Number self)`
`static CharSequence`	`next(CharSequence self)`
`static String`	`next(String self)`
`static CharSequence`	`normalize(CharSequence self)`
`static String`	`normalize(String self)`
`static int`	`numberAwareCompareTo(Comparable self, Comparable other)` Provides a method that compares two comparables using Groovy's default number aware comparator.
`static Number`	`or(Number left, Number right)`
`static BitSet`	`or(BitSet left, BitSet right)`
`static Boolean`	`or(Boolean left, Boolean right)` Iterates over the elements of an iterable collection of items and returns the index of the last item that matches the condition specified in the closure.
`static CharSequence`	`padLeft(CharSequence self, Number numberOfChars)`
`static CharSequence`	`padLeft(CharSequence self, Number numberOfChars, CharSequence padding)`
`static String`	`padLeft(String self, Number numberOfChars)`
`static String`	`padLeft(String self, Number numberOfChars, String padding)`
`static CharSequence`	`padRight(CharSequence self, Number numberOfChars)`
`static CharSequence`	`padRight(CharSequence self, Number numberOfChars, CharSequence padding)`
`static String`	`padRight(String self, Number numberOfChars)`
`static String`	`padRight(String self, Number numberOfChars, String padding)`
`static Set`	`permutations(List self)`
`static Map`	`plus(Map left, Map right)` A helper method to allow maps to work with subscript operators
`static Map`	`plus(Map self, Collection entries)`
`static Object[]`	`plus(Object[] left, Object[] right)`
`static Object[]`	`plus(Object[] left, Object right)`
`static Object[]`	`plus(Object[] left, Collection right)`
`static Object[]`	`plus(Object[] left, Iterable right)`
`static Collection`	`plus(Collection left, Collection right)`
`static Collection`	`plus(Collection left, Iterable right)`
`static List`	`plus(List self, int index, Object[] items)` Creates a new List by inserting all of the elements in the given additions List to the elements from the original List at the specified index.
`static List`	`plus(List self, int index, List additions)` Creates a new List by inserting all of the elements in the given Iterable to the elements from this List at the specified index.
`static List`	`plus(List self, int index, Iterable additions)`
`static Collection`	`plus(Collection left, Object right)`
`static Number`	`plus(Character left, Number right)`
`static Number`	`plus(Number left, Character right)`
`static Number`	`plus(Character left, Character right)`
`static CharSequence`	`plus(CharSequence left, Object value)`
`static String`	`plus(Number value, String right)`
`static String`	`plus(String left, Object value)`
`static String`	`plus(StringBuffer left, String value)`
`static Object`	`pop(List self)`
`static Number`	`power(Number self, Number exponent)`
`static Number`	`power(BigDecimal self, Integer exponent)` Divide one Character by another.
`static Number`	`power(BigInteger self, Integer exponent)` Integer Divide a Character by a Number.
`static Number`	`power(Integer self, Integer exponent)` Integer Divide a Number by a Character.
`static Number`	`power(Long self, Integer exponent)` Integer Divide two Numbers.
`static Character`	`previous(Character self)`
`static Number`	`previous(Number self)` @todo maybe a double dispatch thing to handle new large numbers?
`static CharSequence`	`previous(CharSequence self)`
`static String`	`previous(String self)`
`protected static Object`	`primitiveArrayGet(Object self, int idx)`
`protected static List`	`primitiveArrayGet(Object self, Range range)`
`protected static List`	`primitiveArrayGet(Object self, Collection indices)` Checks whether the array contains the given value.
`protected static Object`	`primitiveArrayPut(Object self, int idx, Object newValue)` Checks whether the array contains the given value.
`static void`	`print(Object self, Object value)` Print a value formatted Groovy style to self if it is a Writer, otherwise to the standard output stream.
`static void`	`print(PrintWriter self, Object value)` Print a value formatted Groovy style to the print writer.
`static void`	`print(PrintStream self, Object value)`
`static void`	`print(Closure self, Object value)`
`static void`	`print(Object self, PrintWriter out)`
`static void`	`printf(Object self, String format, Object[] values)`
`static void`	`printf(Object self, String format, Object arg)`
`static void`	`println(Object self)`
`static void`	`println(Closure self)` Print a linebreak to the standard output stream.
`static void`	`println(Object self, Object value)` Print a value formatted Groovy style (followed by a newline) to self if it is a Writer, otherwise to the standard output stream.
`static void`	`println(PrintWriter self, Object value)` Print a value formatted Groovy style (followed by a newline) to the print writer.
`static void`	`println(PrintStream self, Object value)`
`static void`	`println(Closure self, Object value)`
`static void`	`println(Object self, PrintWriter out)`
`static boolean`	`push(List self, Object value)`
`static Map`	`putAll(Map self, Collection entries)`
`static void`	`putAt(Object self, String property, Object newValue)`
`static void`	`putAt(List self, int idx, Object value)` A helper method to allow lists to work with subscript operators.
`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)`
`static void`	`putAt(List self, IntRange range, Collection col)` List subscript assignment operator when given a range as the index.
`static void`	`putAt(List self, IntRange range, Object value)`
`static void`	`putAt(List self, List splice, List values)`
`static void`	`putAt(List self, List splice, Object value)`
`static Object`	`putAt(Map self, Object key, Object value)`
`static void`	`putAt(BitSet self, IntRange range, boolean value)` Support assigning a range of values with a single assignment statement.
`static void`	`putAt(BitSet self, int index, boolean value)` Converts this array to a List of the same size, with each element added to the list.
`static void`	`putAt(StringBuffer self, EmptyRange range, Object value)`
`static void`	`putAt(StringBuffer self, IntRange range, Object value)`
`static byte[]`	`readBytes(File file)`
`static String`	`readLine(Reader self)`
`static List`	`readLines(CharSequence self)`
`static List`	`readLines(String self)`
`static List`	`readLines(File file)`
`static List`	`readLines(File file, String charset)`
`static List`	`readLines(InputStream stream)`
`static List`	`readLines(InputStream stream, String charset)`
`static List`	`readLines(URL self)`
`static List`	`readLines(URL self, String charset)`
`static List`	`readLines(Reader reader)`
`static boolean`	`removeAll(Collection self, Object[] items)`
`static boolean`	`removeAll(Collection self, Closure condition)`
`static boolean`	`renameTo(File self, String newPathName)`
`static CharSequence`	`replaceAll(CharSequence self, CharSequence regex, CharSequence replacement)`
`static CharSequence`	`replaceAll(CharSequence self, CharSequence regex, Closure closure)`
`static CharSequence`	`replaceAll(CharSequence self, Pattern pattern, CharSequence replacement)`
`static String`	`replaceAll(CharSequence self, Pattern pattern, Closure closure)`
`static String`	`replaceAll(String self, Pattern pattern, Closure closure)`
`static String`	`replaceAll(String self, Pattern pattern, String replacement)`
`static String`	`replaceAll(String self, String regex, Closure closure)`
`static String`	`replaceFirst(CharSequence self, CharSequence regex, CharSequence replacement)`
`static String`	`replaceFirst(CharSequence self, CharSequence regex, Closure closure)`
`static CharSequence`	`replaceFirst(CharSequence self, Pattern pattern, CharSequence replacement)`
`static String`	`replaceFirst(CharSequence self, Pattern pattern, Closure closure)`
`static String`	`replaceFirst(String self, Pattern pattern, Closure closure)`
`static String`	`replaceFirst(String self, Pattern pattern, String replacement)`
`static String`	`replaceFirst(String self, String regex, Closure closure)`
`static List`	`respondsTo(Object self, String name, Object[] argTypes)`
`static List`	`respondsTo(Object self, String name)`
`static boolean`	`retainAll(Collection self, Object[] items)`
`static boolean`	`retainAll(Collection self, Closure condition)`
`static List`	`reverse(List self)` Reverses the elements in a list.
`static List`	`reverse(List self, boolean mutate)` Creates a new array containing items which are the same as this array but in reverse order.
`static Object[]`	`reverse(Object[] self)`
`static Object[]`	`reverse(Object[] self, boolean mutate)`
`static Iterator`	`reverse(Iterator self)`
`static CharSequence`	`reverse(CharSequence self)`
`static String`	`reverse(String self)`
`static Map`	`reverseEach(Map self, Closure closure)`
`static List`	`reverseEach(List self, Closure closure)`
`static Object[]`	`reverseEach(Object[] self, Closure closure)`
`static Number`	`rightShift(Number self, Number operand)` Support the subscript operator with a range for a char array
`static Number`	`rightShiftUnsigned(Number self, Number operand)` Support the subscript operator with a range for a short array
`static int`	`round(Float number)`
`static float`	`round(Float number, int precision)`
`static long`	`round(Double number)`
`static double`	`round(Double number, int precision)` Converts the character to uppercase.
`static TimerTask`	`runAfter(Timer timer, int delay, Closure closure)` Iterates over the elements of an iterable collection of items and returns the index values of the items that match the condition specified in the closure.
`static void`	`setBytes(File file, byte[] bytes)`
`static void`	`setBytes(OutputStream os, byte[] bytes)`
`static void`	`setIndex(Matcher matcher, int idx)`
`static void`	`setMetaClass(Class self, MetaClass metaClass)`
`static void`	`setMetaClass(Object self, MetaClass metaClass)`
`static void`	`setMetaClass(GroovyObject self, MetaClass metaClass)`
`static void`	`setText(File file, String text)`
`static void`	`setText(File file, String text, String charset)`
`static int`	`size(Iterator self)`
`static int`	`size(Object[] self)`
`static int`	`size(boolean[] array)`
`static int`	`size(byte[] array)`
`static int`	`size(char[] array)` Converts this array to a List of the same size, with each element added to the list.
`static int`	`size(short[] array)` Converts this array to a List of the same size, with each element added to the list.
`static int`	`size(int[] array)`
`static int`	`size(long[] array)`
`static int`	`size(float[] array)`
`static int`	`size(double[] array)`
`static int`	`size(CharSequence text)`
`static long`	`size(Matcher self)`
`static int`	`size(String text)`
`static int`	`size(StringBuffer buffer)`
`static long`	`size(File self)`
`static List`	`sort(Collection self)`
`static List`	`sort(Collection self, boolean mutate)` Sorts the elements from the given map into a new ordered map using the closure as a comparator to determine the ordering.
`static Map`	`sort(Map self, Closure closure)`
`static Map`	`sort(Map self, Comparator comparator)`
`static Map`	`sort(Map self)`
`static Object[]`	`sort(Object[] self)`
`static Object[]`	`sort(Object[] self, boolean mutate)` Sorts the given iterator items into a sorted iterator.
`static Iterator`	`sort(Iterator self)`
`static Iterator`	`sort(Iterator self, Comparator comparator)`
`static List`	`sort(Collection self, Comparator comparator)`
`static List`	`sort(Collection self, boolean mutate, Comparator comparator)` Sorts the given array into sorted order using the given comparator.
`static Object[]`	`sort(Object[] self, Comparator comparator)`
`static Object[]`	`sort(Object[] self, boolean mutate, Comparator comparator)` Sorts the given iterator items into a sorted iterator using the Closure to determine the correct ordering.
`static Iterator`	`sort(Iterator self, Closure closure)`
`static Object[]`	`sort(Object[] self, Closure closure)`
`static Object[]`	`sort(Object[] self, boolean mutate, Closure closure)`
`static List`	`sort(Collection self, Closure closure)`
`static List`	`sort(Collection self, boolean mutate, Closure closure)` Avoids doing unnecessary work when sorting an already sorted set (i.e. an identity function for an already sorted set).
`static SortedSet`	`sort(SortedSet self)` Removes the last item from the List.
`static SortedMap`	`sort(SortedMap self)`
`static Collection`	`split(Object self, Closure closure)`
`static Collection`	`split(Collection self, Closure closure)`
`static CharSequence[]`	`split(CharSequence self)`
`static String[]`	`split(GString self)`
`static String[]`	`split(String self)`
`static Object`	`splitEachLine(CharSequence self, CharSequence regex, Closure closure)`
`static Object`	`splitEachLine(CharSequence self, Pattern pattern, Closure closure)`
`static Object`	`splitEachLine(String self, Pattern pattern, Closure closure)`
`static Object`	`splitEachLine(String self, String regex, Closure closure)`
`static Object`	`splitEachLine(File self, String regex, Closure closure)`
`static Object`	`splitEachLine(File self, Pattern pattern, Closure closure)`
`static Object`	`splitEachLine(File self, String regex, String charset, Closure closure)`
`static Object`	`splitEachLine(File self, Pattern pattern, String charset, Closure closure)`
`static Object`	`splitEachLine(URL self, String regex, Closure closure)`
`static Object`	`splitEachLine(URL self, Pattern pattern, Closure closure)`
`static Object`	`splitEachLine(URL self, String regex, String charset, Closure closure)`
`static Object`	`splitEachLine(URL self, Pattern pattern, String charset, Closure closure)`
`static Object`	`splitEachLine(Reader self, String regex, Closure closure)`
`static Object`	`splitEachLine(Reader self, Pattern pattern, Closure closure)`
`static Object`	`splitEachLine(InputStream stream, String regex, String charset, Closure closure)`
`static Object`	`splitEachLine(InputStream stream, Pattern pattern, String charset, Closure closure)`
`static Object`	`splitEachLine(InputStream stream, String regex, Closure closure)`
`static Object`	`splitEachLine(InputStream stream, Pattern pattern, Closure closure)`
`static SpreadMap`	`spread(Map self)`
`static String`	`sprintf(Object self, String format, Object[] values)`
`static String`	`sprintf(Object self, String format, Object arg)`
`static void`	`step(Number self, Number to, Number stepNumber, Closure closure)` Get the absolute value
`static CharSequence`	`stripIndent(CharSequence self)`
`static CharSequence`	`stripIndent(CharSequence self, int numChars)`
`static String`	`stripIndent(String self)`
`static String`	`stripIndent(String self, int numChars)`
`static CharSequence`	`stripMargin(CharSequence self)`
`static CharSequence`	`stripMargin(CharSequence self, char marginChar)`
`static String`	`stripMargin(CharSequence self, CharSequence marginChar)`
`static String`	`stripMargin(String self)`
`static String`	`stripMargin(String self, char marginChar)`
`static String`	`stripMargin(String self, String marginChar)`
`static Map`	`subMap(Map map, Collection keys)` Creates a sub-Map containing the given keys.
`static Map`	`subMap(Map map, Object[] keys)` Looks up an item in a Map for the given key and returns the value - unless there is no entry for the given key in which case add the default value to the map and return that.
`static Set`	`subsequences(List self)` Finds all permutations of a collection.
`static Object`	`sum(Collection self)` Sums the items in an array.
`static Object`	`sum(Object[] self)`
`static Object`	`sum(Iterator self)`
`static Object`	`sum(Collection self, Object initialValue)`
`static Object`	`sum(Object[] self, Object initialValue)`
`static Object`	`sum(Iterator self, Object initialValue)`
`static Object`	`sum(Collection self, Closure closure)` Sums the result of apply a closure to each item of an array.
`static Object`	`sum(Object[] self, Closure closure)`
`static Object`	`sum(Iterator self, Closure closure)`
`static Object`	`sum(Collection self, Object initialValue, Closure closure)`
`static Object`	`sum(Object[] self, Object initialValue, Closure closure)`
`static Object`	`sum(Iterator self, Object initialValue, Closure closure)`
`static List`	`tail(List self)`
`static Object[]`	`tail(Object[] self)` Returns the first `num` elements from the head of this list.
`static List`	`take(List self, int num)` Returns the first `num` elements from the head of this array.
`static Object[]`	`take(Object[] self, int num)`
`static List`	`take(Iterable self, int num)` Returns a new map containing the first `num` elements from the head of this map.
`static Map`	`take(Map self, int num)`
`static Iterator`	`take(Iterator self, int num)`
`static CharSequence`	`take(CharSequence self, int num)`
`static List`	`takeWhile(List self, Closure condition)`
`static List`	`takeWhile(Iterable self, Closure condition)` Returns the longest prefix of this Map where each entry (or key/value pair) when passed to the given closure evaluates to true.
`static Map`	`takeWhile(Map self, Closure condition)` Returns the longest prefix of this array where each element passed to the given closure evaluates to true.
`static Object[]`	`takeWhile(Object[] self, Closure condition)`
`static Iterator`	`takeWhile(Iterator self, Closure condition)`
`static void`	`times(Number self, Closure closure)`
`static String`	`toArrayString(Object[] self)`
`static BigDecimal`	`toBigDecimal(Number self)` Logical implication of two boolean operators
`static BigDecimal`	`toBigDecimal(CharSequence self)`
`static BigDecimal`	`toBigDecimal(String self)`
`static BigInteger`	`toBigInteger(Number self)` Iterates over the elements of an iterable collection of items and returns the index of the first item that matches the condition specified in the closure.
`static BigInteger`	`toBigInteger(CharSequence self)`
`static BigInteger`	`toBigInteger(String self)`
`static Boolean`	`toBoolean(Boolean self)`
`static Boolean`	`toBoolean(String self)`
`static Character`	`toCharacter(String self)`
`static Double`	`toDouble(Number self)` Logical disjunction of two boolean operators
`static Double`	`toDouble(CharSequence self)`
`static Double`	`toDouble(String self)`
`static Float`	`toFloat(Number self)` Logical conjunction of two boolean operators.
`static Float`	`toFloat(CharSequence self)`
`static Float`	`toFloat(String self)`
`static Integer`	`toInteger(Number self)`
`static Integer`	`toInteger(CharSequence self)`
`static Integer`	`toInteger(String self)`
`static List`	`toList(Collection self)` Convert an iterator to a List.
`static List`	`toList(Iterator self)`
`static List`	`toList(Iterable self)` Convert an enumeration to a List.
`static List`	`toList(Enumeration self)`
`static List`	`toList(Object[] array)`
`static List`	`toList(byte[] array)` Converts this array to a Set, with each unique element added to the set.
`static List`	`toList(boolean[] array)` Converts this array to a Set, with each unique element added to the set.
`static List`	`toList(char[] array)` Converts this array to a Set, with each unique element added to the set.
`static List`	`toList(short[] array)` Converts this array to a Set, with each unique element added to the set.
`static List`	`toList(int[] array)` Converts this array to a Set, with each unique element added to the set.
`static List`	`toList(long[] array)` Converts this array to a Set, with each unique element added to the set.
`static List`	`toList(float[] array)` Converts this array to a Set, with each unique element added to the set.
`static List`	`toList(double[] array)` Converts this array to a Set, with each unique element added to the set.
`static List`	`toList(CharSequence self)`
`static List`	`toList(String self)`
`static String`	`toListString(Collection self)`
`static String`	`toListString(Collection self, int maxSize)`
`static Long`	`toLong(Number self)`
`static Long`	`toLong(CharSequence self)`
`static Long`	`toLong(String self)`
`static char`	`toLowerCase(Character self)`
`static String`	`toMapString(Map self)` Increment a Character by one.
`static String`	`toMapString(Map self, int maxSize)`
`static Set`	`toSet(byte[] array)`
`static Set`	`toSet(boolean[] array)`
`static Set`	`toSet(char[] array)`
`static Set`	`toSet(short[] array)`
`static Set`	`toSet(int[] array)` Implements the getAt(int) method for primitive type arrays.
`static Set`	`toSet(long[] array)` Implements the getAt(Range) method for primitive type arrays.
`static Set`	`toSet(float[] array)`
`static Set`	`toSet(double[] array)`
`static Set`	`toSet(Collection self)` Implements the setAt(int idx) method for primitive type arrays.
`static Set`	`toSet(Iterator self)`
`static Set`	`toSet(Enumeration self)`
`static Set`	`toSet(CharSequence self)`
`static Set`	`toSet(String self)`
`static Short`	`toShort(CharSequence self)`
`static Short`	`toShort(String self)`
`static SpreadMap`	`toSpreadMap(Map self)` Creates a spreadable map from this array.
`static SpreadMap`	`toSpreadMap(Object[] self)`
`static SpreadMap`	`toSpreadMap(List self)`
`static String`	`toString(boolean[] self)`
`static String`	`toString(byte[] self)`
`static String`	`toString(char[] self)`
`static String`	`toString(short[] self)` Returns the string representation of the given list.
`static String`	`toString(int[] self)`
`static String`	`toString(long[] self)`
`static String`	`toString(float[] self)`
`static String`	`toString(double[] self)`
`static String`	`toString(AbstractMap self)`
`static String`	`toString(AbstractCollection self)`
`static String`	`toString(Object[] self)`
`static String`	`toString(Object value)`
`static URI`	`toURI(CharSequence self)`
`static URI`	`toURI(String self)`
`static URL`	`toURL(CharSequence self)`
`static URL`	`toURL(String self)`
`static char`	`toUpperCase(Character self)`
`static List`	`tokenize(CharSequence self)`
`static List`	`tokenize(CharSequence self, Character token)`
`static List`	`tokenize(CharSequence self, CharSequence token)`
`static List`	`tokenize(String self)`
`static List`	`tokenize(String self, Character token)`
`static List`	`tokenize(String self, String token)`
`static CharSequence`	`tr(CharSequence self, CharSequence sourceSet, CharSequence replacementSet)`
`static String`	`tr(String self, String sourceSet, String replacementSet)`
`static void`	`transformChar(Reader self, Writer writer, Closure closure)`
`static void`	`transformLine(Reader reader, Writer writer, Closure closure)`
`static List`	`transpose(List self)`
`static void`	`traverse(File self, Map options, Closure closure)`
`static void`	`traverse(File self, Closure closure)`
`static void`	`traverse(File self, Map options)`
`static float`	`trunc(Float number, int precision)`
`static float`	`trunc(Float number)`
`static double`	`trunc(Double number)`
`static double`	`trunc(Double number, int precision)`
`static Number`	`unaryMinus(Number left)`
`static CharSequence`	`unexpand(CharSequence self)`
`static CharSequence`	`unexpand(CharSequence self, int tabStop)`
`static String`	`unexpand(String self)`
`static String`	`unexpand(String self, int tabStop)`
`static CharSequence`	`unexpandLine(CharSequence self, int tabStop)`
`static String`	`unexpandLine(String self, int tabStop)`
`static Iterator`	`unique(Iterator self)`
`static Collection`	`unique(Collection self)`
`static Collection`	`unique(Collection self, boolean mutate)`
`static Iterator`	`unique(Iterator self, Closure closure)`
`static Collection`	`unique(Collection self, Closure closure)`
`static Collection`	`unique(Collection self, boolean mutate, Closure closure)`
`static Iterator`	`unique(Iterator self, Comparator comparator)` Returns an iterator equivalent to this iterator with all duplicated items removed by using the supplied comparator.
`static Collection`	`unique(Collection self, Comparator comparator)`
`static Collection`	`unique(Collection self, boolean mutate, Comparator comparator)`
`static void`	`upto(Number self, Number to, Closure closure)`
`static void`	`upto(long self, Number to, Closure closure)`
`static void`	`upto(Long self, Number to, Closure closure)`
`static void`	`upto(float self, Number to, Closure closure)`
`static void`	`upto(Float self, Number to, Closure closure)` Iterates from this number up to the given number, inclusive, incrementing by one each time.
`static void`	`upto(double self, Number to, Closure closure)`
`static void`	`upto(Double self, Number to, Closure closure)` Iterates from this number down to the given number, inclusive, decrementing by one each time.
`static void`	`upto(BigInteger self, Number to, Closure closure)` Iterates from this number down to the given number, inclusive, decrementing by one each time.
`static void`	`upto(BigDecimal self, Number to, Closure closure)` Iterates from this number down to the given number, inclusive, decrementing by one each time.
`static Object`	`use(Object self, Class categoryClass, Closure closure)` Scoped use method
`static Object`	`use(Object self, List categoryClassList, Closure closure)`
`static Object`	`use(Object self, Object[] array)`
`static Object`	`with(Object self, Closure closure)`
`static Object`	`withDataInputStream(File file, Closure closure)`
`static Object`	`withDataOutputStream(File file, Closure closure)`
`static Map`	`withDefault(Map self, Closure init)` An alias for `withLazyDefault` which decorates a list allowing it to grow when called with index values outside the normal list bounds.
`static List`	`withDefault(List self, Closure init)`
`static List`	`withEagerDefault(List self, Closure init)` Sorts the Collection.
`static Object`	`withInputStream(File file, Closure closure)`
`static Object`	`withInputStream(URL url, Closure closure)`
`static List`	`withLazyDefault(List self, Closure init)`
`static Object`	`withObjectInputStream(File file, Closure closure)`
`static Object`	`withObjectInputStream(File file, ClassLoader classLoader, Closure closure)`
`static Object`	`withObjectInputStream(InputStream inputStream, Closure closure)`
`static Object`	`withObjectInputStream(InputStream inputStream, ClassLoader classLoader, Closure closure)`
`static Object`	`withObjectOutputStream(File file, Closure closure)`
`static Object`	`withObjectOutputStream(OutputStream outputStream, Closure closure)`
`static Object`	`withObjectStreams(Socket socket, Closure closure)`
`static Object`	`withOutputStream(File file, Closure closure)`
`static Object`	`withPrintWriter(File file, Closure closure)`
`static Object`	`withPrintWriter(File file, String charset, Closure closure)`
`static Object`	`withPrintWriter(Writer writer, Closure closure)`
`static Object`	`withReader(File file, Closure closure)`
`static Object`	`withReader(File file, String charset, Closure closure)`
`static Object`	`withReader(Reader reader, Closure closure)`
`static Object`	`withReader(URL url, Closure closure)`
`static Object`	`withReader(URL url, String charset, Closure closure)`
`static Object`	`withReader(InputStream in, Closure closure)`
`static Object`	`withReader(InputStream in, String charset, Closure closure)`
`static Object`	`withStream(InputStream stream, Closure closure)`
`static Object`	`withStream(OutputStream os, Closure closure)`
`static Object`	`withStreams(Socket socket, Closure closure)`
`static Object`	`withWriter(File file, Closure closure)`
`static Object`	`withWriter(File file, String charset, Closure closure)`
`static Object`	`withWriter(Writer writer, Closure closure)`
`static Object`	`withWriter(OutputStream stream, Closure closure)`
`static Object`	`withWriter(OutputStream stream, String charset, Closure closure)`
`static Object`	`withWriterAppend(File file, String charset, Closure closure)`
`static Object`	`withWriterAppend(File file, Closure closure)`
`static void`	`write(Writer self, Writable writable)`
`static void`	`write(File file, String text)`
`static void`	`write(File file, String text, String charset)`
`static void`	`writeLine(BufferedWriter writer, String line)`
`static BitSet`	`xor(BitSet left, BitSet right)`
`static Number`	`xor(Number left, Number right)`
`static Boolean`	`xor(Boolean left, Boolean right)`

Methods inherited from class DefaultGroovyMethodsSupport
cloneSimilarCollection, cloneSimilarMap, closeQuietly, closeWithWarning, createSimilarArray, createSimilarCollection, createSimilarCollection, createSimilarList, createSimilarMap, createSimilarOrDefaultCollection, createSimilarSet, normaliseIndex, sameType, subListBorders, subListBorders

Methods inherited from class Object
wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll

Field Detail

DGM_LIKE_CLASSES

public static final Class[] DGM_LIKE_CLASSES

additionals

public static final Class[] additionals

Method Detail

abs

public static int abs(Number number)

Truncate the value

Parameters:: number - a Float; precision - the number of decimal places to keep

Returns:: the Float truncated to the number of decimal places specified by precision

Since:: 1.6.0

abs

public static long abs(Long number)

Truncate the value

Parameters:: number - a Double; precision - the number of decimal places to keep

Returns:: the Double truncated to the number of decimal places specified by precision

Since:: 1.6.4

abs

public static float abs(Float number)

Determine if a Character is uppercase. Synonym for 'Character.isUpperCase(this)'.

Parameters:: self - a Character

Returns:: true if the character is uppercase

See Also:: Character.isUpperCase

Since:: 1.5.7

abs

public static double abs(Double number)

accept

@Deprecated
public static Socket accept(ServerSocket serverSocket, Closure closure)

accept

@Deprecated
public static Socket accept(ServerSocket serverSocket, boolean runInANewThread, Closure closure)

addAll

public static boolean addAll(Collection self, Object[] items)

addAll

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

Splits all items into two lists based on the closure condition. The first list contains all items matching the closure expression. The second list all those that don't.

Parameters:: self - an Object with an Iterator returning its values; closure - a closure condition

Returns:: a List whose first item is the accepted values and whose second item is the rejected values

Since:: 1.6.0

addShutdownHook

public static void addShutdownHook(Object self, Closure closure)

and

public static Number and(Number left, Number right)

and

public static BitSet and(BitSet left, BitSet right)

and

public static Boolean and(Boolean left, Boolean right)

Iterates over the elements of an iterable collection of items, starting from a specified startIndex, and returns the index of the first item that matches the condition specified in the closure.

Parameters:: self - the iteration object over which to iterate; startIndex - start matching from this index; closure - the filter to perform a match on the collection

Returns:: an integer that is the index of the first matched object or -1 if no match was found

Since:: 1.5.0

any

public static boolean any(Object self, Closure closure)

any

public static boolean any(Map self, Closure closure)

any

public static boolean any(Object self)

append

@Deprecated}
public static void append(File file, Object text)

append

@Deprecated}
public static void append(File file, byte[] bytes)

append

@Deprecated}
public static void append(File self, InputStream stream)

append

@Deprecated}
public static void append(File file, Object text, String charset)

asBoolean

public static boolean asBoolean(Object object)

Coerce a collection instance to a boolean value. A collection is coerced to false if it's empty, and to true otherwise.

assert [1,2].asBoolean() == true

assert [].asBoolean() == false

Parameters:: collection - the collection

Returns:: the boolean value

Since:: 1.7.0

asBoolean

public static boolean asBoolean(Boolean bool)

asBoolean

public static boolean asBoolean(Collection collection)

Coerce an iterator instance to a boolean value. An iterator is coerced to false if there are no more elements to iterate over, and to true otherwise.

Parameters:: iterator - the iterator

Returns:: the boolean value

Since:: 1.7.0

asBoolean

public static boolean asBoolean(Map map)

Coerce an enumeration instance to a boolean value. An enumeration is coerced to false if there are no more elements to enumerate, and to true otherwise.

Parameters:: enumeration - the enumeration

Returns:: the boolean value

Since:: 1.7.0

asBoolean

public static boolean asBoolean(Iterator iterator)

Coerce an Object array to a boolean value. An Object array is false if the array is of length 0. and to true otherwise

Parameters:: array - the array

Returns:: the boolean value

Since:: 1.7.0

asBoolean

public static boolean asBoolean(Enumeration enumeration)

Coerces a byte array to a boolean value. A byte array is false if the array is of length 0, and true otherwise.

Parameters:: array - an array

Returns:: the array's boolean value

Since:: 1.7.4

asBoolean

public static boolean asBoolean(Object[] array)

Coerces a short array to a boolean value. A short array is false if the array is of length 0, and true otherwise.

Parameters:: array - an array

Returns:: the array's boolean value

Since:: 1.7.4

asBoolean

public static boolean asBoolean(byte[] array)

Coerces an int array to a boolean value. An int array is false if the array is of length 0, and true otherwise.

Parameters:: array - an array

Returns:: the array's boolean value

Since:: 1.7.4

asBoolean

public static boolean asBoolean(short[] array)

Coerces a long array to a boolean value. A long array is false if the array is of length 0, and true otherwise.

Parameters:: array - an array

Returns:: the array's boolean value

Since:: 1.7.4

asBoolean

public static boolean asBoolean(int[] array)

Coerces a float array to a boolean value. A float array is false if the array is of length 0, and true otherwise.

Parameters:: array - an array

Returns:: the array's boolean value

Since:: 1.7.4

asBoolean

public static boolean asBoolean(long[] array)

Coerces a double array to a boolean value. A double array is false if the array is of length 0, and true otherwise.

Parameters:: array - an array

Returns:: the array's boolean value

Since:: 1.7.4

asBoolean

public static boolean asBoolean(float[] array)

Coerces a boolean array to a boolean value. A boolean array is false if the array is of length 0, and true otherwise.

Parameters:: array - an array

Returns:: the array's boolean value

Since:: 1.7.4

asBoolean

public static boolean asBoolean(double[] array)

Coerces a char array to a boolean value. A char array is false if the array is of length 0, and true otherwise.

Parameters:: array - an array

Returns:: the array's boolean value

Since:: 1.7.4

asBoolean

public static boolean asBoolean(boolean[] array)

Coerce a character to a boolean value. A character is coerced to false if it's character value is equal to 0, and to true otherwise.

Parameters:: character - the character

Returns:: the boolean value

Since:: 1.7.0

asBoolean

public static boolean asBoolean(char[] array)

Coerce a number to a boolean value. A number is coerced to false if its double value is equal to 0, and to true otherwise, and to true otherwise.

Parameters:: number - the number

Returns:: the boolean value

Since:: 1.7.0

asBoolean

public static boolean asBoolean(Character character)

asBoolean

public static boolean asBoolean(Number number)

asBoolean

@Deprecated
public static boolean asBoolean(CharSequence string)

asBoolean

@Deprecated
public static boolean asBoolean(Matcher matcher)

asImmutable

public static Map asImmutable(Map self)

A convenience method for creating an immutable sorted map.

Parameters:: self - a SortedMap

Returns:: an immutable SortedMap

See Also:: Collections.unmodifiableSortedMap

Since:: 1.0

asImmutable

public static SortedMap asImmutable(SortedMap self)

asImmutable

public static List asImmutable(List self)

asImmutable

public static Set asImmutable(Set self)

asImmutable

public static SortedSet asImmutable(SortedSet self)

asImmutable

public static Collection asImmutable(Collection self)

A convenience method for creating a synchronized SortedMap.

Parameters:: self - a SortedMap

Returns:: a synchronized SortedMap

See Also:: Collections.synchronizedSortedMap

Since:: 1.0

asList

public static List asList(Collection self)

Coerce an object instance to a boolean value. An object is coerced to true if it's not null, to false if it is null.

Parameters:: object - the object to coerce

Returns:: the boolean value

Since:: 1.7.0

asSynchronized

public static Map asSynchronized(Map self)

asSynchronized

public static SortedMap asSynchronized(SortedMap self)

asSynchronized

public static Collection asSynchronized(Collection self)

asSynchronized

public static List asSynchronized(List self)

asSynchronized

public static Set asSynchronized(Set self)

asSynchronized

public static SortedSet asSynchronized(SortedSet self)

asType

@SuppressWarnings} catch (GroovyCastException e) {
public static Object asType(Collection col, Class clazz)

asType

@SuppressWarnings}
public static Object asType(Object[] ary, Class clazz)

Converts the given array to either a List, Set, or SortedSet. If the given class is something else, the call is deferred to {link #asType(Object,Class)}.

Parameters:: ary - an array; clazz - the desired class

Returns:: the object resulting from this type conversion

See Also:: asType(java.lang.Object, java.lang.Class)

Since:: 1.5.1

asType

@SuppressWarningsif (!(clazz.isInstance(map)) && clazz.isInterface()) {
public static Object asType(Closure cl, Class clazz)

Coerces this map to the given type, using the map's keys as the public method names, and values as the implementation. Typically the value would be a closure which behaves like the method implementation.

Parameters:: map - this map; clazz - the target type

Returns:: a Proxy of the given type, which defers calls to this map's elements.

Since:: 1.0

asType

@SuppressWarnings* @since 1.0
public static Object asType(Map map, Class clazz)

asType

@SuppressWarnings* Traverse through each byte of this byte array. Alias for each.
public static Object asType(Number self, Class c)

Traverse through each byte of this Byte array. Alias for each.

Parameters:: self - a Byte array; closure - a closure

See Also:: each(java.lang.Object, groovy.lang.Closure)

Since:: 1.5.5

asType

@SuppressWarningsif (mc instanceof ExpandoMetaClass
public static Object asType(Object obj, Class type)

Adds a "metaClass" property to all class objects so you can use the syntax String.metaClass.myMethod = { println "foo" }

Parameters:: c - The java.lang.Class instance

Returns:: An MetaClass instance

Since:: 1.5.0

asType

@Deprecated
public static Object asType(CharSequence self, Class c)

asType

@Deprecated
@SuppressWarningspublic static String eachMatch(String self, String regex, Closure closure) {
public static Object asType(GString self, Class c)

asType

@Deprecatedpublic static CharSequence expand(CharSequence self) {
@SuppressWarningsreturn StringGroovyMethods.expand(self);
public static Object asType(String self, Class c)

asType

@Deprecated
public static Object asType(File f, Class c)

asWritable

@Deprecated
public static File asWritable(File file)

asWritable

@Deprecated
public static File asWritable(File file, String encoding)

bitwiseNegate

public static BitSet bitwiseNegate(BitSet self)

Iterates from this number up to the given number, inclusive, incrementing by one each time.

Parameters:: self - a long; to - the end number; closure - the code to execute for each number

Since:: 1.0

bitwiseNegate

@Deprecatedreturn StringGroovyMethods.expand(self, tabStop);
public static Pattern bitwiseNegate(CharSequence self)

bitwiseNegate

@Deprecatedreturn StringGroovyMethods.expand(self);
public static Pattern bitwiseNegate(String self)

callClosureForLine

protected static Object callClosureForLine(Closure closure, String line, int counter)

callClosureForMapEntry

protected static Object callClosureForMapEntry(Closure closure, Map.Entry entry)

callClosureForMapEntryAndCounter

protected static Object callClosureForMapEntryAndCounter(Closure closure, Map.Entry entry, int counter)

capitalize

@Deprecatedreturn StringGroovyMethods.expand(self, tabStop);
public static CharSequence capitalize(CharSequence self)

capitalize

@Deprecatedreturn StringGroovyMethods.expandLine(self, tabStop);
public static String capitalize(String self)

center

@Deprecatedreturn StringGroovyMethods.expandLine(self, tabStop);
public static CharSequence center(CharSequence self, Number numberOfChars)

center

@Deprecatedreturn StringGroovyMethods.find(self, regex);
public static CharSequence center(CharSequence self, Number numberOfChars, CharSequence padding)

center

@Deprecatedreturn StringGroovyMethods.find(self, regex, closure);
public static String center(String self, Number numberOfChars)

center

@Deprecatedreturn StringGroovyMethods.find(self, pattern);
public static String center(String self, Number numberOfChars, String padding)

collate

public static List collate(List self, int size)

collate

public static List collate(List self, int size, int step)

collate

public static List collate(List self, int size, boolean keepRemainder)

collate

public static List collate(List self, int size, int step, boolean keepRemainder)

collect

public static List collect(Object self, Closure transform)

Iterates through this aggregate Object transforming each item into a new value using the transform closure, returning a list of transformed values. Example:

def list = [1, 'a', 1.23, true ]
 def types = list.collect { it.class }
 assert types == [Integer, String, BigDecimal, Boolean]

Parameters:: self - an aggregate Object with an Iterator returning its items; transform - the closure used to transform each item of the aggregate object

Returns:: a List of the transformed values

Since:: 1.0

collect

public static Collection collect(Object self)

Iterates through this aggregate Object transforming each item into a new value using the transform closure and adding it to the supplied collector.

Parameters:: self - an aggregate Object with an Iterator returning its items; collector - the Collection to which the transformed values are added; transform - the closure used to transform each item of the aggregate object

Returns:: the collector with all transformed values added to it

Since:: 1.0

collect

public static Collection collect(Object self, Collection collector, Closure transform)

collect

public static List collect(Collection self, Closure transform)

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.

assert [1,2,3] == [1,2,3].collect()

Parameters:: self - a collection

Returns:: a List of the transformed values

See Also:: Closure.IDENTITY

Since:: 1.8.5

collect

public static List collect(Collection self)

Iterates through this collection transforming each value into a new value using the transform closure and adding it to the supplied collector.

assert [1,2,3] as HashSet == [2,4,5,6].collect(new HashSet()) { (int)(it / 2) }

Parameters:: self - a collection; collector - the Collection to which the transformed values are added; transform - the closure used to transform each item of the collection

Returns:: the collector with all transformed values added to it

Since:: 1.0

collect

public static Collection collect(Collection self, Collection collector, Closure transform)

collect

public static Collection collect(Map self, Collection collector, Closure transform)

collect

public static List collect(Map self, Closure transform)

collectAll

public static List collectAll(Collection self, Closure transform)

collectAll

public static Collection collectAll(Collection self, Collection collector, Closure transform)

collectEntries

public static Map collectEntries(Map self, Map collector, Closure transform)

collectEntries

public static Map collectEntries(Map self, Closure transform)

collectEntries

public static Map collectEntries(Collection self, Closure transform)

A variant of collectEntries for Iterators.

Parameters:: self - an Iterator; transform - the closure used for transforming, which has an item from self as the parameter and should return a Map.Entry, a Map or a two-element list containing the resulting key and value

Returns:: a Map of the transformed entries

See Also:: collectEntries(Collection, Closure)

Since:: 1.8.7

collectEntries

public static Map collectEntries(Iterator self, Closure transform)

A variant of collectEntries for Iterables.

Parameters:: self - an Iterable; transform - the closure used for transforming, which has an item from self as the parameter and should return a Map.Entry, a Map or a two-element list containing the resulting key and value

Returns:: a Map of the transformed entries

See Also:: collectEntries(Iterator, Closure)

Since:: 1.8.7

collectEntries

public static Map collectEntries(Iterable self, Closure transform)

collectEntries

public static Map collectEntries(Collection self)

A variant of collectEntries for Iterators using the identity closure as the transform.

Parameters:: self - an Iterator

Returns:: a Map of the transformed entries

See Also:: collectEntries(Collection)

Since:: 1.8.7

collectEntries

public static Map collectEntries(Iterator self)

A variant of collectEntries for Iterables using the identity closure as the transform.

Parameters:: self - an Iterable

Returns:: a Map of the transformed entries

See Also:: collectEntries(Iterator)

Since:: 1.8.7

collectEntries

public static Map collectEntries(Iterable self)

collectEntries

public static Map collectEntries(Collection self, Map collector, Closure transform)

collectEntries

public static Map collectEntries(Iterator self, Map collector, Closure transform)

collectEntries

public static Map collectEntries(Iterable self, Map collector, Closure transform)

A variant of collectEntries for Collections using the identity closure as the transform and a supplied map as the destination of transformed entries.

Parameters:: self - a Collection; collector - the Map into which the transformed entries are put

Returns:: the collector with all transformed values added to it

See Also:: collectEntries(Collection, Map, Closure)

Since:: 1.8.5

collectEntries

public static Map collectEntries(Collection self, Map collector)

A variant of collectEntries for Iterators using the identity closure as the transform and a supplied map as the destination of transformed entries.

Parameters:: self - an Iterator; collector - the Map into which the transformed entries are put

Returns:: the collector with all transformed values added to it

See Also:: collectEntries(Collection, Map)

Since:: 1.8.7

collectEntries

public static Map collectEntries(Iterator self, Map collector)

A variant of collectEntries for Iterables using the identity closure as the transform and a supplied map as the destination of transformed entries.

Parameters:: self - an Iterable; collector - the Map into which the transformed entries are put

Returns:: the collector with all transformed values added to it

See Also:: collectEntries(Iterator, Map)

Since:: 1.8.7

collectEntries

public static Map collectEntries(Iterable self, Map collector)

collectEntries

public static Map collectEntries(Object[] self, Map collector, Closure transform)

A variant of collectEntries using the identity closure as the transform.

Parameters:: self - an Object array; collector - the Map into which the transformed entries are put

Returns:: the collector with all transformed values added to it

See Also:: collectEntries(Object[], Map, Closure)

Since:: 1.8.5

collectEntries

public static Map collectEntries(Object[] self, Map collector)

collectEntries

public static Map collectEntries(Object[] self, Closure transform)

A variant of collectEntries using the identity closure as the transform.

Parameters:: self - an Object array

Returns:: the collector with all transformed values added to it

See Also:: collectEntries(Object[], Closure)

Since:: 1.8.5

collectEntries

public static Map collectEntries(Object[] self)

collectMany

public static List collectMany(Collection self, Closure projection)

Projects each item from a source collection to a collection and concatenates (flattens) the resulting collections into a single list.

 def nums = 1..10
 def squaresAndCubesOfEvens = nums.collectMany{ it % 2 ? [] : [it**2, it**3] }
 assert squaresAndCubesOfEvens == [4, 8, 16, 64, 36, 216, 64, 512, 100, 1000]

 def animals = ['CAT', 'DOG', 'ELEPHANT'] as Set
 def smallAnimals = animals.collectMany{ it.size() > 3 ? [] : [it.toLowerCase()] }
 assert smallAnimals == ['cat', 'dog']

 def orig = nums as Set
 def origPlusIncrements = orig.collectMany{ [it, it+1] }
 assert origPlusIncrements.size() == orig.size() * 2
 assert origPlusIncrements.unique().size() == orig.size() + 1

Parameters:: self - a collection; projection - a projecting Closure returning a collection of items

Returns:: a list created from the projected collections concatenated (flattened) together

See Also:: sum(java.util.Collection, groovy.lang.Closure)

Since:: 1.8.1

collectMany

public static Collection collectMany(Collection self, Collection collector, Closure projection)

collectMany

public static Collection collectMany(Map self, Collection collector, Closure projection)

collectMany

public static Collection collectMany(Map self, Closure projection)

collectMany

public static List collectMany(Object[] self, Closure projection)

collectMany

public static List collectMany(Iterator self, Closure projection)

collectNested

public static List collectNested(Collection self, Closure transform)

Deprecated alias for collectNested

deprecated:: Use collectNested instead

See Also:: collectNested(Collection, Collection, Closure)

collectNested

public static Collection collectNested(Collection self, Collection collector, Closure transform)

combinations

public static List combinations(Collection self)

Finds all non-null subsequences of a list.

Example usage:

def result = [1, 2, 3].subsequences()
 assert result == [[1, 2, 3], [1, 3], [2, 3], [1, 2], [1], [2], [3]] as Set

Parameters:: self - the List of items

Returns:: the subsequences from the list

Since:: 1.7.0

compareTo

public static int compareTo(Character left, Number right)

compareTo

public static int compareTo(Number left, Character right)

compareTo

public static int compareTo(Character left, Character right)

compareTo

public static int compareTo(Number left, Number right)

contains

public static boolean contains(int[] self, Object value)

Checks whether the array contains the given value.

Parameters:: self - the array we are searching; value - the value being searched for

Returns:: true if the array contains the value

Since:: 1.8.6

contains

public static boolean contains(long[] self, Object value)

Checks whether the array contains the given value.

Parameters:: self - the array we are searching; value - the value being searched for

Returns:: true if the array contains the value

Since:: 1.8.6

contains

public static boolean contains(short[] self, Object value)

Returns the string representation of the given array.

Parameters:: self - an array

Returns:: the string representation

Since:: 1.6.0

contains

public static boolean contains(char[] self, Object value)

Returns the string representation of the given array.

Parameters:: self - an array

Returns:: the string representation

Since:: 1.6.0

contains

public static boolean contains(boolean[] self, Object value)

Returns the string representation of the given array.

Parameters:: self - an array

Returns:: the string representation

Since:: 1.6.0

contains

public static boolean contains(double[] self, Object value)

Returns the string representation of the given array.

Parameters:: self - an array

Returns:: the string representation

Since:: 1.6.0

contains

public static boolean contains(float[] self, Object value)

contains

public static boolean contains(byte[] self, Object value)

Returns the string representation of the given array.

Parameters:: self - an array

Returns:: the string representation

Since:: 1.6.0

contains

public static boolean contains(Object[] self, Object value)

Returns the string representation of the given map.

Parameters:: self - a Map

Returns:: the string representation

See Also:: toMapString(java.util.Map)

Since:: 1.0

contains

@Deprecatedreturn StringGroovyMethods.find(self, pattern, closure);
public static boolean contains(CharSequence self, CharSequence text)

contains

@Deprecatedreturn StringGroovyMethods.find(self, pattern);
public static boolean contains(String self, String text)

containsAll

public static boolean containsAll(Collection self, Object[] items)

Modifies this collection by removing its elements that are contained within the specified object array. See also findAll and grep when wanting to produce a new list containing items which don't match some criteria while leaving the original collection unchanged.

Parameters:: self - a Collection to be modified; items - array containing elements to be removed from this collection

Returns:: true if this collection changed as a result of the call

See Also:: Collection.removeAll

Since:: 1.7.2

count

public static Number count(Iterator self, Object value)

count

public static Number count(Iterator self, Closure closure)

Counts the number of occurrences which satisfy the given closure from the items within this Iterator. The iterator will become exhausted of elements after determining the count value.

Example usage:

assert [2,4,2,1,3,5,2,4,3].toSet().iterator().count{ it % 2 == 0 } == 2

Parameters:: self - the Iterator from which we count the number of matching occurrences; closure - a closure condition

Returns:: the number of occurrences

Since:: 1.8.0

count

public static Number count(Collection self, Object value)

Counts the number of occurrences of the given value inside this collection. Comparison is done using Groovy's == operator (using compareTo(value) == 0 or equals(value) ).

Example usage:

assert [2,4,2,1,3,5,2,4,3].count(4) == 2

Parameters:: self - the collection within which we count the number of occurrences; value - the value being searched for

Returns:: the number of occurrences

Since:: 1.0

count

public static Number count(Collection self, Closure closure)