Groovy 1.7.9

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


Field Summary
static Class[] additionals

 
Method Summary
static int abs(Number number)

Get the absolute value

static long abs(Long number)

Get the absolute value

static float abs(Float number)

Get the absolute value

static double abs(Double number)

Get the absolute value

static Socket accept(ServerSocket serverSocket, Closure closure)

Accepts a connection and passes the resulting Socket to the closure which runs in a new Thread.

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

Accepts a connection and passes the resulting Socket to the closure which runs in a new Thread or the calling thread, as needed.

static boolean addAll(Collection self, T[] items)

Adds all of the elements in the specified array to this collection.

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

Inserts all of the elements in the specified array into this list at the specified position.

static void addShutdownHook(Object self, Closure closure)

Allows the usage of addShutdownHook without getting the runtime first.

static Number and(Number left, Number right)

Bitwise AND together two Numbers.

static BitSet and(BitSet left, BitSet right)

Bitwise AND together two BitSets.

static Boolean and(Boolean left, Boolean right)

Logical conjunction of two boolean operators.

static boolean any(Object self, Closure closure)

Iterates over the contents of an object or collection, and checks whether a predicate is valid for at least one element.

static boolean any(Map self, Closure closure)

Iterates over the entries of a map, and checks whether a predicate is valid for at least one entry.

static boolean any(Object self)

Iterates over the elements of a collection, and checks whether at least one element is true according to the Groovy Truth.

static void append(File file, Object text)

Append the text at the end of the File.

static void append(File file, byte[] bytes)

Append bytes to the end of a File.

static void append(File self, InputStream stream)

Append binary data to the file.

static void append(File file, Object text, String charset)

Append the text at the end of the File, using a specified encoding.

static boolean asBoolean(Object object)

Coerce an object instance to a boolean value.

static boolean asBoolean(Boolean bool)

Coerce an Boolean instance to a boolean value.

static boolean asBoolean(Matcher matcher)

Coerce a Matcher instance to a boolean value.

static boolean asBoolean(Collection collection)

Coerce a collection instance to a boolean value.

static boolean asBoolean(Map map)

Coerce a map instance to a boolean value.

static boolean asBoolean(Iterator iterator)

Coerce an iterator instance to a boolean value.

static boolean asBoolean(Enumeration enumeration)

Coerce an enumeration instance to a boolean value.

static boolean asBoolean(CharSequence string)

Coerce a string (an instance of CharSequence) to a boolean value.

static boolean asBoolean(Object[] array)

Coerce an Object array to a boolean value.

static boolean asBoolean(byte[] array)

Coerces a byte array to a boolean value.

static boolean asBoolean(short[] array)

Coerces a short array to a boolean value.

static boolean asBoolean(int[] array)

Coerces an int array to a boolean value.

static boolean asBoolean(long[] array)

Coerces a long array to a boolean value.

static boolean asBoolean(float[] array)

Coerces a float array to a boolean value.

static boolean asBoolean(double[] array)

Coerces a double array to a boolean value.

static boolean asBoolean(boolean[] array)

Coerces a boolean array to a boolean value.

static boolean asBoolean(char[] array)

Coerces a char array to a boolean value.

static boolean asBoolean(Character character)

Coerce a character to a boolean value.

static boolean asBoolean(Number number)

Coerce a number to a boolean value.

static boolean asBoolean(GroovyResultSet grs)

@deprecated use SqlGroovyMethods#asBoolean(GroovyResultSet)

static Map asImmutable(Map self)

A convenience method for creating an immutable map.

static SortedMap asImmutable(SortedMap self)

A convenience method for creating an immutable sorted map.

static List asImmutable(List self)

A convenience method for creating an immutable list

static Set asImmutable(Set self)

A convenience method for creating an immutable list.

static SortedSet asImmutable(SortedSet self)

A convenience method for creating an immutable sorted set.

static Collection asImmutable(Collection self)

A convenience method for creating an immutable Collection.

static List asList(Collection self)

Converts this Collection to a List.

static Map asSynchronized(Map self)

A convenience method for creating a synchronized Map.

static SortedMap asSynchronized(SortedMap self)

A convenience method for creating a synchronized SortedMap.

static Collection asSynchronized(Collection self)

A convenience method for creating a synchronized Collection.

static List asSynchronized(List self)

A convenience method for creating a synchronized List.

static Set asSynchronized(Set self)

A convenience method for creating a synchronized Set.

static SortedSet asSynchronized(SortedSet self)

A convenience method for creating a synchronized SortedSet.

static Object asType(Collection col, Class clazz)

Converts the given collection to another type.

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 the closure to an implementation of the given class.

static Object asType(Map map, 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(Number self, Class c)

Transform this number to a the given type, using the 'as' operator.

static Object asType(File f, Class c)

Converts this File to a Writable or delegates to default asType(java.lang.Object, java.lang.Class).

static Object asType(GString self, Class c)

Converts the GString to a File, or delegates to the default asType(java.lang.Object, java.lang.Class)

static Object asType(String self, Class c)

Provides a method to perform custom 'dynamic' type conversion to the given class using the as operator.

static Object asType(Object obj, Class type)

Converts a given object to a type.

static File asWritable(File file)

Converts this File to a Writable.

static File asWritable(File file, String encoding)

Allows a file to return a Writable implementation that can output itself to a Writer stream.

static Pattern bitwiseNegate(String self)

Turns a String into a regular expression Pattern

static BitSet bitwiseNegate(BitSet self)

Bitwise NEGATE a BitSet.

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

protected static Object callClosureForMapEntry(Closure closure, def entry)

protected static Object callClosureForMapEntryAndCounter(Closure closure, def entry, int counter)

static String capitalize(String self)

Convenience method to capitalize the first letter of a string (typically the first letter of a word).

static String center(String self, Number numberOfChars, String padding)

Pad a String to a minimum length specified by numberOfChars, appending the supplied padding String around the original as many times as needed keeping it centered.

static String center(String self, Number numberOfChars)

Pad a String to a minimum length specified by numberOfChars by adding the space character around it as many times as needed so that it remains centered.

static void clearTime(Date self)

@deprecated moved to DateGroovyMethods.clearTime

static void clearTime(def self)

@deprecated moved to DateGroovyMethods.clearTime

static void clearTime(Calendar self)

@deprecated moved to DateGroovyMethods.clearTime

static List collect(Object self, Closure closure)

Iterates through this object transforming each value into a new value using the closure as a transformer, returning a list of transformed values.

static Collection collect(Object self, Collection collection, Closure closure)

Iterates through this object transforming each object into a new value using the closure as a transformer and adding it to the collection, returning the resulting collection.

static List collect(Collection self, Closure closure)

Iterates through this collection transforming each entry into a new value using the closure as a transformer, returning a list of transformed values.

static Collection collect(Collection self, Collection collection, Closure closure)

Iterates through this collection transforming each value into a new value using the closure as a transformer, returning an initial collection plus the transformed values.

static Collection collect(Map self, Collection collection, Closure closure)

Iterates through this Map transforming each entry into a new value using the closure as a transformer, returning a list of transformed values.

static List collect(Map self, Closure closure)

Iterates through this Map transforming each entry into a new value using the closure as a transformer, returning a list of transformed values.

static List collectAll(Collection self, Closure closure)

Recursively iterates through this collection transforming each non-Collection value into a new value using the closure as a transformer.

static Collection collectAll(Collection self, Collection collection, Closure closure)

Recursively iterates through this collection transforming each non-Collection value into a new value using the closure as a transformer.

static Map collectEntries(Map self, Map result, Closure closure)

Iterates through this Map transforming each entry using the closure as a transformer, returning a map of the transformed entries.

static Map collectEntries(Map self, Closure closure)

Iterates through this Map transforming each entry using the closure as a transformer, returning a map of the transformed entries.

static Map collectEntries(Collection self, Map result, Closure closure)

Iterates through this Collection transforming each item using the closure as a transformer into a map entry, returning a map of the transformed entries.

static Map collectEntries(Object[] self, Map result, Closure closure)

Iterates through this array transforming each item using the closure as a transformer into a map entry, returning a map of the transformed entries.

static Map collectEntries(Collection self, Closure closure)

Iterates through this Collection transforming each item using the closure as a transformer into a map entry, returning a map of the transformed entries.

static Map collectEntries(Object[] self, Closure closure)

Iterates through this array transforming each item using the closure as a transformer into a map entry, returning a map of the transformed entries.

static List combinations(Collection self)

Adds GroovyCollections#combinations(Collection) as a method on collections.

static int compareTo(Character left, Number right)

Compare a Character and a Number.

static int compareTo(Number left, Character right)

Compare a Number and a Character.

static int compareTo(Character left, Character right)

Compare two Characters.

static int compareTo(Number left, Number right)

Compare two Numbers.

static Thread consumeProcessErrorStream(Process self, OutputStream err)

@deprecated use ProcessGroovyMethods#consumeProcessErrorStream(Process, OutputStream)

static Thread consumeProcessErrorStream(Process self, StringBuffer error)

@deprecated use ProcessGroovyMethods#consumeProcessErrorStream(Process, Appendable)

static Thread consumeProcessErrorStream(Process self, Writer err)

@deprecated use ProcessGroovyMethods#consumeProcessErrorStream(Process, Appendable)

static void consumeProcessOutput(Process self)

@deprecated use ProcessGroovyMethods#consumeProcessOutput(Process)

static void consumeProcessOutput(Process self, StringBuffer output, StringBuffer error)

@deprecated use ProcessGroovyMethods#consumeProcessOutput(Process, Appendable, Appendable)

static void consumeProcessOutput(Process self, OutputStream output, OutputStream error)

@deprecated use ProcessGroovyMethods#consumeProcessOutput(Process, OutputStream, OutputStream)

static Thread consumeProcessOutputStream(Process self, StringBuffer output)

@deprecated use ProcessGroovyMethods#consumeProcessOutputStream(Process, Appendable)

static Thread consumeProcessOutputStream(Process self, Writer output)

@deprecated use ProcessGroovyMethods#consumeProcessOutputStream(Process, Appendable)

static Thread consumeProcessOutputStream(Process self, OutputStream output)

@deprecated use ProcessGroovyMethods#consumeProcessOutputStream(Process, OutputStream)

static boolean contains(String self, String text)

Provide an implementation of contains() like Collection.contains to make Strings more polymorphic.

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

Returns true if this collection contains all of the elements in the specified array.

static Number count(Iterator self, Object value)

Counts the number of occurrences of the given value 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(Object[] self, Object value)

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)

Counts the number of occurrences of the given value inside this array.

static int count(String self, String text)

Count the number of occurencies of a substring.

protected static StringBufferWriter createStringBufferWriter(StringBuffer self)

protected static StringWriter createStringWriter(String self)

static byte[] decodeBase64(String value)

@deprecated moved to EncodingGroovyMethods.decodeBase64

static boolean deleteDir(File self)

Deletes a directory with all contained files and subdirectories.

static String denormalize(String self)

Return a String with lines (separated by LF, CR/LF, or CR) terminated by the platform specific line separator.

static boolean disjoint(Collection left, Collection right)

Returns true if the intersection of two collections is empty.

static Number div(Character left, Number right)

Divide a Character by a Number.

static Number div(Number left, Character right)

Divide a Number by a Character.

static Number div(Character left, Character right)

Divide one Character by another.

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)

Iterates from this number down to the given number, inclusive, decrementing by one each time.

static void downto(Long self, Number to, Closure closure)

Iterates from this number down to the given number, inclusive, decrementing by one each time.

static void downto(float self, Number to, Closure closure)

Iterates from this number down to the given number, inclusive, decrementing by one each time.

static void downto(Float self, Number to, Closure closure)

Iterates from this number down to the given number, inclusive, decrementing by one each time.

static void downto(double self, Number to, Closure closure)

Iterates from this number down to the given number, inclusive, decrementing by one each time.

static void downto(Double self, Number to, Closure closure)

Iterates from this number down to the given number, inclusive, decrementing by one each time.

static void downto(BigInteger self, Number to, Closure closure)

Iterates from this number down to the given number, inclusive, decrementing by one each time.

static void downto(BigDecimal self, Number to, Closure closure)

Iterates from this number down to the given number, inclusive, decrementing by one each time.

static String dump(Object self)

Generates a detailed dump string of an object showing its class, hashCode and fields.

static T each(T 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)

Allows a Map to be iterated through using a closure.

static void eachByte(File self, Closure closure)

Traverse through each byte of this File

static void eachByte(File self, int bufferLen, Closure closure)

Traverse through the bytes of this File, bufferLen bytes at a time.

static void eachByte(Byte[] self, Closure closure)

Traverse through each byte of this Byte array.

static void eachByte(byte[] self, Closure closure)

Traverse through each byte of this byte array.

static void eachByte(InputStream is, Closure closure)

Traverse through each byte of the specified stream.

static void eachByte(InputStream is, int bufferLen, Closure closure)

Traverse through each the specified stream reading bytes into a buffer and calling the 2 parameter closure with this buffer and the number of bytes.

static void eachByte(URL url, Closure closure)

Reads the InputStream from this URL, passing each byte to the given closure.

static void eachByte(URL url, int bufferLen, Closure closure)

Reads the InputStream from this URL, passing a byte[] and a number of bytes to the given closure.

static void eachDir(File self, Closure closure)

Invokes the closure for each subdirectory in this directory, ignoring regular files.

static void eachDirMatch(File self, Object nameFilter, Closure closure)

Invokes the closure for each subdirectory whose name (dir.name) matches the given nameFilter in the given directory - calling the isCase(java.lang.Object, java.lang.Object) method to determine if a match occurs.

static void eachDirRecurse(File self, Closure closure)

Invokes the closure for each descendant directory of this directory.

static void eachFile(File self, FileType fileType, Closure closure)

Invokes the closure for each 'child' file in this 'parent' folder/directory.

static void eachFile(File self, Closure closure)

Invokes the closure for each 'child' file in this 'parent' folder/directory.

static void eachFileMatch(File self, FileType fileType, Object nameFilter, Closure closure)

Invokes the closure for each file whose name (file.name) matches the given nameFilter in the given directory - calling the isCase(java.lang.Object, java.lang.Object) method to determine if a match occurs.

static void eachFileMatch(File self, Object nameFilter, Closure closure)

Invokes the closure for each file whose name (file.name) matches the given nameFilter in the given directory - calling the isCase(java.lang.Object, java.lang.Object) method to determine if a match occurs.

static void eachFileRecurse(File self, FileType fileType, Closure closure)

Invokes the closure for each descendant file in this directory.

static void eachFileRecurse(File self, Closure closure)

Invokes the closure for each descendant file in this directory.

static Object eachLine(String self, Closure closure)

Iterates through this String line by line.

static Object eachLine(String self, int firstLine, Closure closure)

Iterates through this String line by line.

static Object eachLine(File self, Closure closure)

Iterates through this file line by line.

static Object eachLine(File self, String charset, Closure closure)

Iterates through this file line by line.

static Object eachLine(File self, int firstLine, Closure closure)

Iterates through this file line by line.

static Object eachLine(File self, String charset, int firstLine, Closure closure)

Iterates through this file line by line.

static Object eachLine(InputStream stream, String charset, Closure closure)

Iterates through this stream reading with the provided charset, passing each line to the given 1 or 2 arg closure.

static Object eachLine(InputStream stream, String charset, int firstLine, Closure closure)

Iterates through this stream reading with the provided charset, passing each line to the given 1 or 2 arg closure.

static Object eachLine(InputStream stream, Closure closure)

Iterates through this stream, passing each line to the given 1 or 2 arg closure.

static Object eachLine(InputStream stream, int firstLine, Closure closure)

Iterates through this stream, passing each line to the given 1 or 2 arg closure.

static Object eachLine(URL url, Closure closure)

Iterates through the lines read from the URL's associated input stream passing each line to the given 1 or 2 arg closure.

static Object eachLine(URL url, int firstLine, Closure closure)

Iterates through the lines read from the URL's associated input stream passing each line to the given 1 or 2 arg closure.

static Object eachLine(URL url, String charset, Closure closure)

Iterates through the lines read from the URL's associated input stream passing each line to the given 1 or 2 arg closure.

static Object eachLine(URL url, String charset, int firstLine, Closure closure)

Iterates through the lines read from the URL's associated input stream passing each line to the given 1 or 2 arg closure.

static Object eachLine(Reader self, Closure closure)

Iterates through the given reader line by line.

static Object eachLine(Reader self, int firstLine, Closure closure)

Iterates through the given reader line by line.

static String eachMatch(String self, String regex, Closure closure)

Process each regex group matched substring of the given string.

static String eachMatch(String self, Pattern pattern, Closure closure)

Process each regex group matched substring of the given pattern.

static void eachObject(File self, Closure closure)

Iterates through the given file object by object.

static void eachObject(ObjectInputStream ois, Closure closure)

Iterates through the given object stream object by object.

static Iterator eachPermutation(Collection self, Closure closure)

Iterates over all permutations of a collection, running a closure for each iteration.

static Object eachWithIndex(Object self, Closure closure)

Iterates through an aggregate type or data structure, passing each item and the item's index (a counter starting at zero) to the given closure.

static Map eachWithIndex(Map self, Closure closure)

Allows a Map to be iterated through using a closure.

static Writable encodeBase64(Byte[] data, boolean chunked)

@deprecated moved to EncodingGroovyMethods.encodeBase64

static Writable encodeBase64(Byte[] data)

@deprecated moved to EncodingGroovyMethods.encodeBase64

static Writable encodeBase64(byte[] data, boolean chunked)

@deprecated moved to EncodingGroovyMethods.encodeBase64

static Writable encodeBase64(byte[] data)

@deprecated moved to EncodingGroovyMethods.encodeBase64

static boolean equals(int[] left, int[] right)

Compare the contents of this array to the contents of the given array.

static boolean equals(Object[] left, List right)

Determines if the contents of this array are equal to the contents of the given list, in the same order.

static boolean equals(List left, Object[] right)

Determines if the contents of this list are equal to the contents of the given array in the same order.

static boolean equals(List left, List right)

Compare the contents of two Lists.

static boolean every(Object self, Closure closure)

Used to determine if the given predicate closure is valid (i.e.

static boolean every(Map self, Closure closure)

Iterates over the entries of a map, and checks whether a predicate is valid for all entries.

static boolean every(Object self)

Iterates over every element of a collection, and checks whether all elements are true according to the Groovy Truth.

static Process execute(String self)

Executes the command specified by self as a command-line process.

static Process execute(String self, String[] envp, File dir)

Executes the command specified by self with environment defined by envp and under the working directory dir.

static Process execute(String self, List envp, File dir)

Executes the command specified by self with environment defined by envp and under the working directory dir.

static Process execute(String[] commandArray)

Executes the command specified by the given String array.

static Process execute(String[] commandArray, String[] envp, File dir)

Executes the command specified by the String array given in the first parameter, with the environment defined by envp and under the working directory dir.

static Process execute(String[] commandArray, List envp, File dir)

Executes the command specified by the String array given in the first parameter, with the environment defined by envp and under the working directory dir.

static Process execute(List commands)

Executes the command specified by the given list.

static Process execute(List commands, String[] envp, File dir)

Executes the command specified by the given list, with the environment defined by envp and under the working directory dir.

static Process execute(List commands, List envp, File dir)

Executes the command specified by the given list, with the environment defined by envp and under the working directory dir.

static String expand(String self)

Expands all tabs into spaces with tabStops of size 8.

static String expand(String self, int tabStop)

Expands all tabs into spaces.

static String expandLine(String self, int tabStop)

Expands all tabs into spaces.

static void filterLine(Reader reader, Writer writer, Closure closure)

Filter the lines from a reader and write them on the writer, according to a closure which returns true if the line should be included.

static Writable filterLine(File self, Closure closure)

Filters the lines of a File and creates a Writeable in return to stream the filtered lines.

static Writable filterLine(File self, String charset, Closure closure)

Filters the lines of a File and creates a Writeable in return to stream the filtered lines.

static void filterLine(File self, Writer writer, Closure closure)

Filter the lines from this File, and write them to the given writer based on the given closure predicate.

static void filterLine(File self, Writer writer, String charset, Closure closure)

Filter the lines from this File, and write them to the given writer based on the given closure predicate.

static Writable filterLine(Reader reader, Closure closure)

Filter the lines from this Reader, and return a Writable which can be used to stream the filtered lines to a destination.

static Writable filterLine(InputStream self, Closure predicate)

Filter lines from an input stream using a closure predicate.

static Writable filterLine(InputStream self, String charset, Closure predicate)

Filter lines from an input stream using a closure predicate.

static void filterLine(InputStream self, Writer writer, Closure predicate)

Uses a closure to filter lines from this InputStream and pass them to the given writer.

static void filterLine(InputStream self, Writer writer, String charset, Closure predicate)

Uses a closure to filter lines from this InputStream and pass them to the given writer.

static Writable filterLine(URL self, Closure predicate)

Filter lines from a URL using a closure predicate.

static Writable filterLine(URL self, String charset, Closure predicate)

Filter lines from a URL using a closure predicate.

static void filterLine(URL self, Writer writer, Closure predicate)

Uses a closure to filter lines from this URL and pass them to the given writer.

static void filterLine(URL self, Writer writer, String charset, Closure predicate)

Uses a closure to filter lines from this URL and pass them to the given writer.

static Object find(Object self, Closure closure)

Finds the first value matching the closure condition

static T find(Collection self, Closure closure)

Finds the first value matching the closure condition.

static def find(Map self, Closure closure)

Finds the first entry matching the closure condition.

static String find(String self, String regex)

Finds the first occurrence of a regular expression String within a String.

static String find(String self, Pattern pattern)

Finds the first occurrence of a compiled regular expression Pattern within a String.

static String find(String self, String regex, Closure closure)

Finds the first occurrence of a regular expression String within a String.

static String find(String self, Pattern pattern, Closure closure)

Finds the first occurrence of a compiled regular expression Pattern within a String.

static Collection findAll(Collection self, Closure closure)

Finds all values matching the closure condition.

static Collection findAll(Object self, Closure closure)

Finds all items matching the closure condition.

static Map findAll(Map self, Closure closure)

Finds all entries matching the closure condition.

static List findAll(String self, String regex)

Finds all occurrences of a regular expression string within a String.

static List findAll(String self, Pattern pattern)

Finds all occurrences of a regular expression Pattern within a String.

static List findAll(String self, String regex, Closure closure)

Finds all occurrences of a regular expression string within a String.

static List findAll(String self, Pattern pattern, Closure closure)

Finds all occurrences of a compiled regular expression Pattern within a String.

static int findIndexOf(Object self, Closure closure)

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 int findIndexOf(Object self, int startIndex, Closure closure)

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 List findIndexValues(Object self, 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 List findIndexValues(Object self, Number startIndex, Closure closure)

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

static int findLastIndexOf(Object self, Closure closure)

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 int findLastIndexOf(Object self, int startIndex, Closure closure)

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

static Object findResult(Object self, Object defaultResult, Closure closure)

Iterates through the object and returns the first non-null result from the closure, otherwise returns the defaultResult

static Object findResult(Object self, Closure closure)

Iterates through the object and returns the first non-null result from the closure

static Object findResult(Collection self, Object defaultResult, Closure closure)

Iterates through the object and returns the first non-null result from the closure, if all are null, it returns the defaultResult.

static Object findResult(Collection self, Closure closure)

Iterates through the object and returns the first non-null result from the closure.

static Object findResult(Map self, Object defaultResult, Closure closure)

Returns the first non-null closure result by passing each map entry to the closure, otherwise it returns the defaultResult.

static Object findResult(Map self, Closure closure)

Returns the first non-null closure result by passing each map entry to the closure.

static T first(List self)

Returns the first item from the List.

static T first(T[] self)

Returns the first item from the Object array.

static Collection flatten(Collection self)

Flatten a collection.

static Collection flatten(Object[] self)

Flatten an array.

static Collection flatten(boolean[] self)

Flatten an array.

static Collection flatten(byte[] self)

Flatten an array.

static Collection flatten(char[] self)

Flatten an array.

static Collection flatten(short[] self)

Flatten an array.

static Collection flatten(int[] self)

Flatten an array.

static Collection flatten(long[] self)

Flatten an array.

static Collection flatten(float[] self)

Flatten an array.

static Collection flatten(double[] self)

Flatten an array.

static Collection flatten(Collection self, Closure flattenUsing)

Flatten a collection.

static String format(Date self, String format)

@deprecated moved to DateGroovyMethods.format

static String format(Calendar self, String pattern)

@deprecated moved to DateGroovyMethods.format

static V get(Map map, K key, V defaultValue)

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 Object getAt(Object self, String property)

Allows the subscript operator to be used to lookup dynamic property values.

static CharSequence getAt(CharSequence text, int index)

Support the subscript operator for CharSequence.

static String getAt(String text, int index)

Support the subscript operator for String.

static CharSequence getAt(CharSequence text, Range range)

Support the range subscript operator for CharSequence

static CharSequence getAt(CharSequence text, IntRange range)

Support the range subscript operator for CharSequence or StringBuffer with IntRange

static CharSequence getAt(CharSequence text, EmptyRange range)

Support the range subscript operator for CharSequence or StringBuffer with EmptyRange

static String getAt(String text, IntRange range)

Support the range subscript operator for String with IntRange

static String getAt(String text, EmptyRange range)

Support the range subscript operator for String with EmptyRange

static String getAt(String text, Range range)

Support the range subscript operator for String

static Object getAt(Matcher matcher, int idx)

Support the subscript operator, e.g.

static List getAt(List self, Range range)

Support the range subscript operator for a List

def list = [1, "a", 4.5, true]
 assert list[1..2] == ["a", 4.5]

static List getAt(List self, EmptyRange range)

Support the range subscript operator for a List

def list = [true, 1, 3.4]
 assert list[0..<0] == []

static List getAt(List self, Collection indices)

Select a List of items from a List using a Collection to identify the indices to be selected.

static List getAt(T[] self, Collection indices)

Select a List of items from an Object array using a Collection to identify the indices to be selected.

static CharSequence getAt(CharSequence self, Collection indices)

Select a List of characters from a CharSequence using a Collection to identify the indices to be selected.

static String getAt(String self, Collection indices)

Select a List of characters from a String using a Collection to identify the indices to be selected.

static List getAt(Matcher self, Collection indices)

Select a List of values from a Matcher using a Collection to identify the indices to be selected.

static List getAt(T[] array, Range range)

Support the range subscript operator for an Array

static List getAt(T[] array, IntRange range)

@param array an Array of Objects

static List getAt(T[] array, EmptyRange range)

@param array an Array of Objects

static List getAt(T[] array, ObjectRange range)

@param array an Array of Objects

static T getAt(List self, int idx)

Support the subscript operator for a List.

static T getAt(Iterator self, int idx)

Support the subscript operator for an Iterator.

static V getAt(Map self, K key)

Support the subscript operator for a Map.

static List getAt(Collection coll, String property)

Support the subscript operator for List

assert [String, Long, Integer] == ["a",5L,2]["class"]

static List getAt(byte[] array, Range range)

Support the subscript operator with a range for a byte array

static List getAt(char[] array, Range range)

Support the subscript operator with a range for a char array

static List getAt(short[] array, Range range)

Support the subscript operator with a range for a short array

static List getAt(int[] array, Range range)

Support the subscript operator with a range for an int array

static List getAt(long[] array, Range range)

Support the subscript operator with a range for a long array

static List getAt(float[] array, Range range)

Support the subscript operator with a range for a float array

static List getAt(double[] array, Range range)

Support the subscript operator with a range for a double array

static List getAt(boolean[] array, Range range)

Support the subscript operator with a range for a boolean array

static List getAt(byte[] array, IntRange range)

Support the subscript operator with an IntRange for a byte array

static List getAt(char[] array, IntRange range)

Support the subscript operator with an IntRange for a char array

static List getAt(short[] array, IntRange range)

Support the subscript operator with an IntRange for a short array

static List getAt(int[] array, IntRange range)

Support the subscript operator with an IntRange for an int array

static List getAt(long[] array, IntRange range)

Support the subscript operator with an IntRange for a long array

static List getAt(float[] array, IntRange range)

Support the subscript operator with an IntRange for a float array

static List getAt(double[] array, IntRange range)

Support the subscript operator with an IntRange for a double array

static List getAt(boolean[] array, IntRange range)

Support the subscript operator with an IntRange for a boolean array

static List getAt(byte[] array, ObjectRange range)

Support the subscript operator with an ObjectRange for a byte array

static List getAt(char[] array, ObjectRange range)

Support the subscript operator with an ObjectRange for a char array

static List getAt(short[] array, ObjectRange range)

Support the subscript operator with an ObjectRange for a short array

static List getAt(int[] array, ObjectRange range)

Support the subscript operator with an ObjectRange for an int array

static List getAt(long[] array, ObjectRange range)

Support the subscript operator with an ObjectRange for a long array

static List getAt(float[] array, ObjectRange range)

Support the subscript operator with an ObjectRange for a float array

static List getAt(double[] array, ObjectRange range)

Support the subscript operator with an ObjectRange for a double array

static List getAt(boolean[] array, ObjectRange range)

Support the subscript operator with an ObjectRange for a byte array

static List getAt(byte[] array, Collection indices)

Support the subscript operator with a collection for a byte array

static List getAt(char[] array, Collection indices)

Support the subscript operator with a collection for a char array

static List getAt(short[] array, Collection indices)

Support the subscript operator with a collection for a short array

static List getAt(int[] array, Collection indices)

Support the subscript operator with a collection for an int array

static List getAt(long[] array, Collection indices)

Support the subscript operator with a collection for a long array

static List getAt(float[] array, Collection indices)

Support the subscript operator with a collection for a float array

static List getAt(double[] array, Collection indices)

Support the subscript operator with a collection for a double array

static List getAt(boolean[] array, Collection indices)

Support the subscript operator with a collection for a boolean array

static boolean getAt(BitSet self, int index)

Support the subscript operator for a Bitset

static BitSet getAt(BitSet self, IntRange range)

Support retrieving a subset of a BitSet using a Range

static int getAt(Date self, int field)

@deprecated moved to DateGroovyMethods.getAt

static byte[] getBytes(File file)

Read the content of the File and returns it as a byte[].

static byte[] getBytes(URL url)

Read the content of this URL and returns it as a byte[].

static byte[] getBytes(InputStream is)

Read the content of this InputStream and return it as a byte[].

static char[] getChars(String self)

Converts the given String into an array of characters.

static int getCount(Matcher matcher)

Find the number of Strings matched to the given Matcher.

static String getDateString(Date self)

@deprecated moved to DateGroovyMethods.getDateString

static String getDateTimeString(Date self)

@deprecated moved to DateGroovyMethods.getDateTimeString

static InputStream getErr(Process self)

@deprecated use ProcessGroovyMethods#getErr(Process)

static InputStream getIn(Process self)

@deprecated use ProcessGroovyMethods#getIn(Process)

static MetaClass getMetaClass(Class c)

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

static MetaClass getMetaClass(Object obj)

Obtains a MetaClass for an object either from the registry or in the case of a GroovyObject from the object itself.

static MetaClass getMetaClass(GroovyObject obj)

Obtains a MetaClass for an object either from the registry or in the case of a GroovyObject from the object itself.

static 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 OutputStream getOut(Process self)

@deprecated use ProcessGroovyMethods#getOut(Process)

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)

Iterates through the classloader parents until it finds a loader with a class named "org.codehaus.groovy.tools.RootLoader".

protected static List getSubList(List self, List splice)

static String getText(File file, String charset)

Read the content of the File using the specified encoding and return it as a String.

static String getText(File file)

Read the content of the File and returns it as a String.

static String getText(URL url)

Read the content of this URL and returns it as a String.

static String getText(URL url, String charset)

Read the data from this URL and return it as a String.

static String getText(InputStream is)

Read the content of this InputStream and return it as a String.

static String getText(InputStream is, String charset)

Read the content of this InputStream using specified charset and return it as a String.

static String getText(Reader reader)

Read the content of the Reader and return it as a String.

static String getText(BufferedReader reader)

Read the content of the BufferedReader and return it as a String.

static String getText(Process self)

@deprecated use ProcessGroovyMethods#getText(Process)

static String getTimeString(Date self)

@deprecated moved to DateGroovyMethods.getTimeString

static Collection grep(Object self, Object filter)

Iterates over every element of the collection and returns each item that matches the given filter - calling the isCase(java.lang.Object, java.lang.Object) method used by switch statements.

protected static void groupAnswer(Map answer, T element, Object value)

Groups the current element according to the value

static Map groupBy(Collection self, Closure closure)

Sorts all collection members into groups determined by the supplied mapping closure.

static Map groupBy(Map self, Closure closure)

Groups the members of a map into sub maps determined by the supplied mapping closure.

static Map groupEntriesBy(Map self, Closure closure)

Groups all map entries into groups determined by the supplied mapping closure.

static boolean hasGroup(Matcher matcher)

Check whether a Matcher contains a group or not.

static MetaProperty hasProperty(Object self, String name)

Returns true of the implementing MetaClass has a property of the given name

static T head(List self)

Returns the first item from the List.

static T head(T[] self)

Returns the first item from the Object array.

static Object identity(Object self, Closure closure)

Allows the closure to be called for the object reference self synonym for 'with()'.

static Object inject(Collection self, Object value, Closure closure)

Iterates through the given Collection, passing in the initial value to the 2-arg closure along with the first item.

static Object inject(Iterator self, Object value, Closure closure)

Iterates through the given Iterator, passing in the initial value to the closure along with the first item.

static Object inject(Object self, Object value, 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, passing in the initial value to the closure along with the first item.

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)

Integer Divide a Character by a Number.

static Number intdiv(Number left, Character right)

Integer Divide a Number by a Character.

static Number intdiv(Character left, Character right)

Integer Divide two Characters.

static Number intdiv(Number left, Number right)

Integer Divide two Numbers.

static Collection intersect(Collection left, Collection right)

Create a Collection composed of the intersection of both collections.

static Map intersect(Map left, Map right)

Create a Map composed of the intersection of both maps.

static Object invokeMethod(Object object, String method, Object arguments)

Provide a dynamic method invocation method which can be overloaded in classes to implement dynamic proxies easily.

static boolean is(Object self, Object other)

Identity check.

static boolean isAllWhitespace(String self)

True if a String only contains whitespace characters.

static boolean isBigDecimal(String self)

Determine if a String can be parsed into a BigDecimal.

static boolean isBigInteger(String self)

Determine if a String can be parsed into a BigInteger.

static boolean isCase(Object caseValue, Object switchValue)

Method for overloading the behavior of the 'case' method in switch statements.

static boolean isCase(String caseValue, Object switchValue)

'Case' implementation for a String, which uses String#equals(Object) in order to allow Strings to be used in switch statements.

static boolean isCase(GString caseValue, Object switchValue)

'Case' implementation for a GString, which simply calls the equivalet method for String.

static boolean isCase(Class caseValue, Object switchValue)

Special 'Case' implementation for Class, which allows testing for a certain class in a switch statement.

static boolean isCase(Collection caseValue, Object switchValue)

'Case' implementation for collections which tests if the 'switch' operand is contained in any of the 'case' values.

static boolean isCase(Map caseValue, Object switchValue)

'Case' implementation for maps which tests the groovy truth value obtained using the 'switch' operand as key.

static boolean isCase(Pattern caseValue, Object switchValue)

'Case' implementation for the Pattern class, which allows testing a String against a number of regular expressions.

static boolean isCase(Number caseValue, Number switchValue)

Special 'case' implementation for all numbers, which delegates to the compareTo() method for comparing numbers of different types.

static boolean isDigit(Character self)

Determines if a character is a digit.

static boolean isDouble(String self)

Determine if a String can be parsed into a Double.

static boolean isFloat(String self)

Determine if a String can be parsed into a Float.

static boolean isInteger(String self)

Determine if a String can be parsed into an Integer.

static boolean isLetter(Character self)

Determines if a character is a letter.

static boolean isLetterOrDigit(Character self)

Determines if a character is a letter or digit.

static boolean isLong(String self)

Determine if a String can be parsed into a Long.

static boolean isLowerCase(Character self)

Determine if a Character is lowercase.

static boolean isNumber(String self)

Determine if a String can be parsed into a Number.

static boolean isUpperCase(Character self)

Determine if a Character is uppercase.

static boolean isWhitespace(Character self)

Determines if a character is a whitespace character.

static Iterator iterator(T[] a)

Attempts to create an Iterator for the given object by first converting it to a Collection.

static Iterator iterator(Object o)

Attempts to create an Iterator for the given object by first converting it to a Collection.

static Iterator iterator(Enumeration enumeration)

Allows an Enumeration to behave like an Iterator.

static Iterator iterator(Matcher matcher)

Returns an Iterator which traverses each match.

static Iterator iterator(Reader self)

Creates an iterator which will traverse through the reader a line at a time.

static Iterator iterator(InputStream self)

Standard iterator for a input stream which iterates through the stream content in a byte-based fashion.

static Iterator iterator(DataInputStream self)

Standard iterator for a data input stream which iterates through the stream content a Byte at a time.

static Iterator iterator(File self)

Just throws a DeprecationException.

static Iterator iterator(Iterator self)

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 Iterator iterator(def nodeList)

@deprecated moved to XmlGroovyMethods.iterator

static String join(Iterator self, String separator)

Concatenates the toString() representation of each item from the iterator, with the given String as a separator between each item.

static String join(Collection 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(Object[] self, String separator)

Concatenates the toString() representation of each items in this array, with the given String as a separator between each item.

static T last(List self)

Returns the last item from the List.

static T last(T[] self)

Returns the last item from the Object array.

static Collection leftShift(Collection self, T value)

Overloads the left shift operator to provide an easy way to append objects to a Collection.

static BlockingQueue leftShift(BlockingQueue self, T value)

Overloads the left shift operator to provide an easy way to append objects to a BlockingQueue.

static Map leftShift(Map self, def entry)

Overloads the left shift operator to provide an easy way to append Map.Entry values to a Map.

static Map leftShift(Map self, Map other)

Overloads the left shift operator to provide an easy way to put one maps entries into another map.

static StringBuffer leftShift(String self, Object value)

Overloads the left shift operator to provide an easy way to append multiple objects as string representations to a String.

static StringBuffer leftShift(StringBuffer self, Object value)

Overloads the left shift operator to provide an easy way to append multiple objects as string representations to a StringBuffer.

static Writer leftShift(Writer self, Object value)

Overloads the left shift operator to provide a mechanism to append values to a writer.

static Number leftShift(Number self, Number operand)

Implementation of the left shift operator for integral types.

static Writer leftShift(OutputStream self, Object value)

Overloads the leftShift operator to provide an append mechanism to add values to a stream.

static void leftShift(ObjectOutputStream self, Object value)

Overloads the leftShift operator to add objects to an ObjectOutputStream.

static OutputStream leftShift(OutputStream self, InputStream in)

Pipe an InputStream into an OutputStream for efficient stream copying.

static OutputStream leftShift(OutputStream self, byte[] value)

Overloads the leftShift operator to provide an append mechanism to add bytes to a stream.

static File leftShift(File file, Object text)

Write the text to the File.

static File leftShift(File file, byte[] bytes)

Write bytes to a File.

static File leftShift(File file, InputStream data)

Append binary data to the file.

static Writer leftShift(Socket self, Object value)

Overloads the left shift operator to provide an append mechanism to add things to the output stream of a socket

static OutputStream leftShift(Socket self, byte[] value)

Overloads the left shift operator to provide an append mechanism to add bytes to the output stream of a socket

static Writer leftShift(Process self, Object value)

@deprecated use ProcessGroovyMethods#leftShift(Process, Object)

static OutputStream leftShift(Process self, byte[] value)

@deprecated use ProcessGroovyMethods#leftShift(Process, byte[])

static boolean matches(String self, Pattern pattern)

Tells whether or not self matches the given compiled regular expression Pattern.

static def max(Map self, Closure closure)

Selects an entry in the map having the maximum calculated value as determined by the supplied closure.

static T max(Collection self)

Adds max() method to Collection objects.

static T max(Iterator self)

Adds max() method to Iterator objects.

static T max(T[] self)

Adds max() method to Object arrays.

static T max(Collection self, Closure closure)

Selects an item in the collection having the maximum value as determined by the supplied closure.

static T max(Iterator self, Closure closure)

Selects the maximum value found from the Iterator using the closure to determine the correct ordering.

static T max(T[] self, Closure closure)

Selects the maximum value found from the Object array using the closure to determine the correct ordering.

static T max(Collection self, Comparator comparator)

Selects the maximum value found in the collection using the given comparator.

static T max(Iterator self, Comparator comparator)

Selects the maximum value found from the Iterator using the given comparator.

static T max(T[] self, Comparator comparator)

Selects the maximum value found from the Object array using the given comparator.

static MetaClass metaClass(Class self, Closure closure)

Sets/updates the metaclass for a given class to a closure.

static MetaClass metaClass(Object self, Closure closure)

Sets/updates the metaclass for a given object to a closure.

static T min(Collection self)

Adds min() method to Collection objects.

static T min(Iterator self)

Adds min() method to Iterator objects.

static T min(T[] self)

Adds min() method to Object arrays.

static T min(Collection self, Comparator comparator)

Selects the minimum value found in the collection using the given comparator.

static T min(Iterator self, Comparator comparator)

Selects the minimum value found from the Iterator using the given comparator.

static T min(T[] self, Comparator comparator)

Selects the minimum value found from the Object array using the given comparator.

static T min(Collection self, Closure closure)

Selects an item in the collection having the minimum value as determined by the supplied closure.

static def min(Map self, Closure closure)

Selects an entry in the map having the minimum calculated value as determined by the supplied closure.

static T min(Iterator self, Closure closure)

Selects the minimum value found from the Iterator using the closure to determine the correct ordering.

static T min(T[] self, Closure closure)

Selects the minimum value found from the Object array using the closure to determine the correct ordering.

static Set minus(Set self, Collection operands)

Compare the contents of two Sets for equality using Groovy's coercion rules.

static Set minus(Set self, Object operand)

Create a Set composed of the elements of the first set minus the operand.

static T[] minus(T[] self, Collection removeMe)

Create an array composed of the elements of the first array minus the elements of the given collection.

static T[] minus(T[] self, T[] removeMe)

Create an array composed of the elements of the first array minus the elements of the given array.

static List minus(List self, Collection removeMe)

Create a List composed of the elements of the first list minus every occurrence of elements of the given collection.

static List minus(List self, Object operand)

Create a new List composed of the elements of the first list minus every occurrence of the operand.

static T[] minus(T[] self, Object operand)

Create a new object array composed of the elements of the first array minus the operand.

static Map minus(Map self, Map operands)

Create a Map composed of the entries of the first map minus the entries of the given map.

static String minus(String self, Object target)

Remove a part of a String.

static Number minus(Character left, Number right)

@todo maybe a double dispatch thing to handle new large numbers?

static Number minus(Number left, Character right)

Subtract a Character from a Number.

static Number minus(Character left, Character right)

Subtract one Character from another.

static Date minus(Date self, int days)

@deprecated moved to DateGroovyMethods.minus

static def minus(def self, int days)

@deprecated moved to DateGroovyMethods.minus

static int minus(Calendar self, Calendar then)

@deprecated moved to DateGroovyMethods.minus

static int minus(Date self, Date then)

@deprecated moved to DateGroovyMethods.minus

static void mixin(MetaClass self, List categoryClasses)

Extend object with category methods.

static void mixin(Class self, List categoryClasses)

Extend class globally with category methods.

static void mixin(Class self, Class categoryClass)

Extend class globally with category methods.

static void mixin(Class self, Class[] categoryClass)

Extend class globally with category methods.

static void mixin(MetaClass self, Class categoryClass)

Extend class globally with category methods.

static void mixin(MetaClass self, Class[] categoryClass)

Extend class globally with category methods.

static Number mod(Number left, Number right)

Performs a division modulus operation.

static List multiply(Collection self, Number factor)

Create a List composed of the elements of this list, repeated a certain number of times.

static String multiply(String self, Number factor)

Repeat a String a certain number of times.

static Number multiply(Character left, Number right)

Multiply a Character by a Number.

static Number multiply(Number left, Character right)

Multiply a Number by a Character.

static Number multiply(Character left, Character right)

Multiply two Characters.

static Number multiply(BigDecimal left, Double right)

Multiply a BigDecimal and a Double.

static Number multiply(BigDecimal left, BigInteger right)

Multiply a BigDecimal and a BigInteger.

static DataInputStream newDataInputStream(File file)

Create a data input stream for this file

static DataOutputStream newDataOutputStream(File file)

Creates a new data output stream for this file.

static BufferedInputStream newInputStream(File file)

Creates a buffered input stream for this file.

static BufferedInputStream newInputStream(URL url)

Creates a buffered input stream for this URL.

static T newInstance(Class c)

Convenience method to dynamically create a new instance of this class.

static T newInstance(Class c, Object[] args)

Helper to construct a new instance from the given arguments.

static ObjectInputStream newObjectInputStream(File file)

Create an object input stream for this file.

static ObjectInputStream newObjectInputStream(InputStream inputStream)

Create an object input stream for this input stream.

static ObjectInputStream newObjectInputStream(InputStream inputStream, ClassLoader classLoader)

Create an object input stream for this input stream using the given class loader.

static ObjectInputStream newObjectInputStream(File file, ClassLoader classLoader)

Create an object input stream for this file using the given class loader.

static ObjectOutputStream newObjectOutputStream(File file)

Create an object output stream for this file.

static ObjectOutputStream newObjectOutputStream(OutputStream outputStream)

Create an object output stream for this output stream.

static BufferedOutputStream newOutputStream(File file)

Create a buffered output stream for this file.

static PrintWriter newPrintWriter(File file)

Create a new PrintWriter for this file.

static PrintWriter newPrintWriter(File file, String charset)

Create a new PrintWriter for this file, using specified charset.

static PrintWriter newPrintWriter(Writer writer)

Create a new PrintWriter for this file, using specified charset.

static BufferedReader newReader(File file)

Create a buffered reader for this file.

static BufferedReader newReader(File file, String charset)

Create a buffered reader for this file, using the specified charset as the encoding.

static BufferedReader newReader(InputStream self)

Creates a reader for this input stream.

static BufferedReader newReader(InputStream self, String charset)

Creates a reader for this input stream, using the specified charset as the encoding.

static BufferedReader newReader(URL url)

Creates a buffered reader for this URL.

static BufferedReader newReader(URL url, String charset)

Creates a buffered reader for this URL using the given encoding.

static BufferedWriter newWriter(File file)

Create a buffered writer for this file.

static BufferedWriter newWriter(File file, boolean append)

Creates a buffered writer for this file, optionally appending to the existing file content.

static BufferedWriter newWriter(File file, String charset, boolean append)

Helper method to create a buffered writer for a file.

static BufferedWriter newWriter(File file, String charset)

Creates a buffered writer for this file, writing data using the given encoding.

static String next(String self)

This method is called by the ++ operator for the class String.

static Character next(Character self)

Increment a Character by one.

static Number next(Number self)

Increment a Number by one.

static Date next(Date self)

@deprecated moved to DateGroovyMethods.next

static def next(def self)

@deprecated moved to DateGroovyMethods.next

static String normalize(String self)

Return a String with linefeeds and carriage returns normalized to linefeeds.

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)

Bitwise OR together two numbers.

static BitSet or(BitSet left, BitSet right)

Bitwise OR together two BitSets.

static Boolean or(Boolean left, Boolean right)

Logical disjunction of two boolean operators

static Process or(Process left, Process right)

@deprecated use ProcessGroovyMethods#or(Process, Process)

static String padLeft(String self, Number numberOfChars, String padding)

Pad a String to a minimum length specified by numberOfChars, adding the supplied padding String as many times as needed to the left.

static String padLeft(String self, Number numberOfChars)

Pad a String to a minimum length specified by numberOfChars by adding the space character to the left as many times as needed.

static String padRight(String self, Number numberOfChars, String padding)

Pad a String to a minimum length specified by numberOfChars, adding the supplied padding String as many times as needed to the right.

static String padRight(String self, Number numberOfChars)

Pad a String to a minimum length specified by numberOfChars by adding the space character to the right as many times as needed.

static Set permutations(List self)

Finds all permutations of a collection.

static Process pipeTo(Process left, Process right)

@deprecated use ProcessGroovyMethods#pipeTo(Process, Process)

static Map plus(Map left, Map right)

Returns a new Map containing all entries from left and right, giving precedence to right.

static Map plus(Map self, Collection entries)

Returns a new Map containing all entries from self and entries, giving precedence to entries.

static Collection plus(Collection left, Collection right)

Create a Collection as a union of two collections.

static Collection plus(Collection left, T right)

Create a collection as a union of a Collection and an Object.

static String plus(String left, Object value)

Appends the String representation of the given operand to this string.

static String plus(Number value, String right)

Appends a String to the string representation of this number.

static String plus(StringBuffer left, String value)

Appends a String to this StringBuffer.

static Number plus(Character left, Number right)

Add a Character and a Number.

static Number plus(Number left, Character right)

Add a Number and a Character.

static Number plus(Character left, Character right)

Add one Character to another.

static Date plus(Date self, int days)

@deprecated moved to DateGroovyMethods.plus

static def plus(def self, int days)

@deprecated moved to DateGroovyMethods.plus

static T pop(List self)

Removes the last item from the List.

static Number power(Number self, Number exponent)

Power of a Number to a certain exponent.

static Number power(BigDecimal self, Integer exponent)

Power of a BigDecimal to an integer certain exponent.

static Number power(BigInteger self, Integer exponent)

Power of a BigInteger to an integer certain exponent.

static Number power(Integer self, Integer exponent)

Power of an integer to an integer certain exponent.

static Number power(Long self, Integer exponent)

Power of a long to an integer certain exponent.

static String previous(String self)

This method is called by the -- operator for the class String.

static Character previous(Character self)

Decrement a Character by one.

static Number previous(Number self)

Decrement a Number by one.

static Date previous(Date self)

@deprecated moved to DateGroovyMethods.previous

static def previous(def self)

@deprecated moved to DateGroovyMethods.previous

protected static Object primitiveArrayGet(Object self, int idx)

Implements the getAt(int) method for primitve type arrays.

protected static List primitiveArrayGet(Object self, Range range)

Implements the getAt(Range) method for primitve type arrays.

protected static List primitiveArrayGet(Object self, Collection indices)

Implements the getAt(Collection) method for primitve type arrays.

protected static Object primitiveArrayPut(Object self, int idx, Object newValue)

Implements the setAt(int idx) method for primitve type arrays.

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)

Print a value formatted Groovy style to the print stream.

static void print(Closure self, Object value)

Print a value to the standard output stream.

static void print(Object self, PrintWriter out)

Print to a console in interactive format.

static void printf(Object self, String format, Object[] values)

Printf to a console (Only works with JDK1.5 or later).

static void printf(Object self, String format, Object arg)

Prints a formatted string using the specified format string and arguments.

static void println(Object self)

Print a linebreak to the standard output stream.

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)

Print a value formatted Groovy style (followed by a newline) to the print stream.

static void println(Closure self, Object value)

Print a value (followed by a newline) to the standard output stream.

static void println(Object self, PrintWriter out)

Print to a console in interactive format.

static boolean push(List self, T value)

Appends an item to the List.

static Map putAll(Map self, Collection entries)

Provides an easy way to append multiple Map.Entry values to a Map.

static void putAt(Object self, String property, Object newValue)

Allows the subscript operator to be used to set dynamically named property values.

static void putAt(List self, int idx, T value)

A helper method to allow lists to work with subscript operators.

static void putAt(StringBuffer self, IntRange range, Object value)

Support the range subscript operator for StringBuffer.

static void putAt(StringBuffer self, EmptyRange range, Object value)

Support the range subscript operator for StringBuffer.

static void putAt(List self, EmptyRange range, Object value)

A helper method to allow lists to work with subscript operators.

static void putAt(List self, EmptyRange range, Collection value)

A helper method to allow lists to work with subscript operators.

static void putAt(List self, IntRange range, Collection col)

List subscript assignment operator when given a range as the index and the assignment operand is a collection.

static void putAt(List self, IntRange range, Object value)

List subscript assignment operator when given a range as the index.

static void putAt(List self, List splice, List values)

A helper method to allow lists to work with subscript operators.

static void putAt(List self, List splice, Object value)

A helper method to allow lists to work with subscript operators.

static V putAt(Map self, K key, V value)

A helper method to allow lists to work with subscript operators

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)

Support subscript-style assignment for a BitSet.

static byte[] readBytes(File file)

Reads the content of the file into a byte array.

static String readLine(Reader self)

Read a single, whole line from the given Reader.

static List readLines(String self)

Return the lines of a String as a List of Strings.

static List readLines(File file)

Reads the file into a list of Strings, with one item for each line.

static List readLines(File file, String charset)

Reads the file into a list of Strings, with one item for each line.

static List readLines(InputStream stream)

Reads the stream into a list, with one element for each line.

static List readLines(InputStream stream, String charset)

Reads the stream into a list, with one element for each line.

static List readLines(URL self)

Reads the URL contents into a list, with one element for each line.

static List readLines(URL self, String charset)

Reads the URL contents into a list, with one element for each line.

static List readLines(Reader reader)

Reads the reader into a list of Strings, with one entry for each line.

static boolean removeAll(Collection self, T[] items)

Removes all of this collection's elements that are also contained in the specified array.

static boolean removeAll(Collection self, Closure closure)

Removes the elements in this collection that are matched according to the specified closure condition.

static boolean renameTo(File self, String newPathName)

Renames the file.

static String replaceAll(String self, Pattern pattern, String replacement)

Replaces all substrings of a String that match the given compiled regular expression with the given replacement.

static String replaceAll(String self, String regex, Closure closure)

Replaces all occurrences of a captured group by the result of a closure on that text.

static String replaceAll(String self, Pattern pattern, Closure closure)

Replaces all occurrences of a captured group by the result of a closure call on that text.

static String replaceFirst(String self, Pattern pattern, String replacement)

Replaces the first substring of a String that matches the given compiled regular expression with the given replacement.

static String replaceFirst(String self, String regex, Closure closure)

Replaces the first occurrence of a captured group by the result of a closure call on that text.

static String replaceFirst(String self, Pattern pattern, Closure closure)

Replaces the first occurrence of a captured group by the result of a closure call on that text.

static List respondsTo(Object self, String name, Object[] argTypes)

Returns an object satisfying Groovy truth if the implementing MetaClass responds to a method with the given name and arguments types.

static List respondsTo(Object self, String name)

Returns an object satisfying Groovy truth if the implementing MetaClass responds to a method with the given name regardless of the arguments.

static boolean retainAll(Collection self, T[] items)

Retains only the elements in this collection that are contained in the specified array.

static boolean retainAll(Collection self, Closure closure)

Retains only the elements in this collection that are matched according to the specified closure condition.

static T[] reverse(T[] self)

Reverse the items in an Object array.

static String reverse(String self)

Creates a new string which is the reverse (backwards) of this string

static List reverse(List self)

Reverses the list.

static Iterator reverse(Iterator self)

Reverses the iterator.

static Map reverseEach(Map self, Closure closure)

Allows a Map to be iterated through in reverse order using a closure.

static List reverseEach(List self, Closure closure)

Iterate over each element of the list in the reverse order.

static T[] reverseEach(T[] self, Closure closure)

Iterate over each element of the array in the reverse order.

static Number rightShift(Number self, Number operand)

Implementation of the right shift operator for integral types.

static Number rightShiftUnsigned(Number self, Number operand)

Implementation of the right shift (unsigned) operator for integral types.

static int round(Float number)

Round the value

static float round(Float number, int precision)

Round the value

static long round(Double number)

Round the value

static double round(Double number, int precision)

Round the value

static TimerTask runAfter(Timer timer, int delay, Closure closure)

Allows a simple syntax for using timers.

static void setBytes(File file, byte[] bytes)

Write the bytes from the byte array to the File.

static void setBytes(OutputStream os, byte[] bytes)

Write the byte[] to the output stream.

static void setIndex(Matcher matcher, int idx)

Set the position of the given Matcher to the given index.

static void setMetaClass(Class self, MetaClass metaClass)

Sets the metaclass for a given class.

static void setMetaClass(Object self, MetaClass metaClass)

Set the metaclass for an object

static void setText(File file, String text)

Synonym for write(text) allowing file.text = 'foo'.

static void setText(File file, String text, String charset)

Synonym for write(text, charset) allowing:

 myFile.setText('some text', charset)
 
or with some help from ExpandoMetaClass, you could do something like:
 myFile.metaClass.setText = { String s -> delegate.setText(s, 'UTF-8') }
 myfile.text = 'some text'
 

static int size(Iterator self)

Provide the standard Groovy size() method for Iterator.

static int size(String text)

Provide the standard Groovy size() method for String.

static int size(StringBuffer buffer)

Provide the standard Groovy size() method for StringBuffer.

static long size(File self)

Provide the standard Groovy size() method for File.

static long size(Matcher self)

Provide the standard Groovy size() method for Matcher.

static int size(Object[] self)

Provide the standard Groovy size() method for an array.

static int size(boolean[] array)

Allows arrays to behave similar to collections.

static int size(byte[] array)

Allows arrays to behave similar to collections.

static int size(char[] array)

Allows arrays to behave similar to collections.

static int size(short[] array)

Allows arrays to behave similar to collections.

static int size(int[] array)

Allows arrays to behave similar to collections.

static int size(long[] array)

Allows arrays to behave similar to collections.

static int size(float[] array)

Allows arrays to behave similar to collections.

static int size(double[] array)

Allows arrays to behave similar to collections.

static List sort(Collection self)

Sorts the given collection into a sorted list.

static Map sort(Map self, Closure closure)

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, Comparator comparator)

Sorts the elements from the given map into a new ordered Map using the specified key comparator to determine the ordering.

static Map sort(Map self)

Sorts the elements from the given map into a new ordered Map using the natural ordering of the keys to determine the ordering.

static T[] sort(T[] self)

Sorts the given Object array into sorted order.

static Iterator sort(Iterator self)

Sorts the given iterator items into a sorted iterator.

static Iterator sort(Iterator self, Comparator comparator)

Sorts the given iterator items into a sorted iterator using the comparator.

static List sort(Collection self, Comparator comparator)

Sorts the Collection using the given comparator.

static T[] sort(T[] self, Comparator comparator)

Sorts the given Object array into sorted order using the given comparator.

static Iterator sort(Iterator self, Closure closure)

Sorts the given iterator items into a sorted iterator using the Closure to determine the correct ordering.

static T[] sort(T[] self, Closure closure)

Sorts the given Object array into a newly created array using the Closure to determine the correct ordering.

static List sort(Collection self, Closure closure)

Sorts this Collection using the closure to determine the correct ordering.

static SortedSet sort(SortedSet self)

Avoids doing unnecessary work when sorting an already sorted set.

static Collection split(Object self, Closure closure)

Splits all items into two lists based on the closure condition.

static Collection split(Collection self, Closure closure)

Splits all items into two collections based on the closure condition.

static String[] split(String self)

Convenience method to split a string (with whitespace as delimiter) Like tokenize, but returns an Array of Strings instead of a List

static String[] split(GString self)

Convenience method to split a GString (with whitespace as delimiter).

static Object splitEachLine(File self, String regex, Closure closure)

Iterates through this file line by line, splitting each line using the given regex separator.

static Object splitEachLine(File self, Pattern pattern, Closure closure)

Iterates through this file line by line, splitting each line using the given separator Pattern.

static Object splitEachLine(File self, String regex, String charset, Closure closure)

Iterates through this file line by line, splitting each line using the given regex separator.

static Object splitEachLine(File self, Pattern pattern, String charset, Closure closure)

Iterates through this file line by line, splitting each line using the given regex separator Pattern.

static Object splitEachLine(URL self, String regex, Closure closure)

Iterates through the input stream associated with this URL line by line, splitting each line using the given regex separator.

static Object splitEachLine(URL self, Pattern pattern, Closure closure)

Iterates through the input stream associated with this URL line by line, splitting each line using the given regex separator Pattern.

static Object splitEachLine(URL self, String regex, String charset, Closure closure)

Iterates through the input stream associated with this URL line by line, splitting each line using the given regex separator.

static Object splitEachLine(URL self, Pattern pattern, String charset, Closure closure)

Iterates through the input stream associated with this URL line by line, splitting each line using the given regex separator Pattern.

static Object splitEachLine(Reader self, String regex, Closure closure)

Iterates through the given reader line by line, splitting each line using the given regex separator.

static Object splitEachLine(Reader self, Pattern pattern, Closure closure)

Iterates through the given reader line by line, splitting each line using the given regex separator Pattern.

static Object splitEachLine(InputStream stream, String regex, String charset, Closure closure)

Iterates through the given InputStream line by line using the specified encoding, splitting each line using the given separator.

static Object splitEachLine(InputStream stream, Pattern pattern, String charset, Closure closure)

Iterates through the given InputStream line by line using the specified encoding, splitting each line using the given separator Pattern.

static Object splitEachLine(InputStream stream, String regex, Closure closure)

Iterates through the given InputStream line by line, splitting each line using the given separator.

static Object splitEachLine(InputStream stream, Pattern pattern, Closure closure)

Iterates through the given InputStream line by line, splitting each line using the given separator Pattern.

static Object splitEachLine(String self, String regex, Closure closure)

Iterates through the given String line by line, splitting each line using the given separator.

static Object splitEachLine(String self, Pattern pattern, Closure closure)

Iterates through the given String line by line, splitting each line using the given separator Pattern.

static SpreadMap spread(Map self)

Synonym for toSpreadMap(java.util.Map).

static String sprintf(Object self, String format, Object[] values)

Sprintf to a string (Only works with JDK1.5 or later).

static String sprintf(Object self, String format, Object arg)

Returns a formatted string using the specified format string and arguments.

static void step(Number self, Number to, Number stepNumber, Closure closure)

Iterates from this number up to the given number using a step increment.

static String stripIndent(String self)

Strip leading spaces from every line in a String.

static String stripIndent(String self, int numChars)

Strip numChar leading characters from every line in a String.

static String stripMargin(String self)

Strip leading whitespace/control characters followed by '|' from every line in a String.

static String stripMargin(String self, String marginChar)

Strip leading whitespace/control characters followed by marginChar from every line in a String.

static String stripMargin(String self, char marginChar)

Strip leading whitespace/control characters followed by marginChar from every line in a String.

static Map subMap(Map map, Collection keys)

Creates a sub-Map containing the given keys.

static Set subsequences(List self)

Finds all non-null subsequences of a list.

static Object sum(Collection self)

Sums the items in a collection.

static Object sum(Object[] self)

Sums the items in an array.

static Object sum(Iterator self)

Sums the items from an Iterator.

static Object sum(Collection self, Object initialValue)

Sums the items in a collection, adding the result to some initial value.

static Object sum(Object[] self, Object initialValue)

Sums the items in an array, adding the result to some initial value.

static Object sum(Iterator self, Object initialValue)

Sums the items from an Iterator, adding the result to some initial value.

static Object sum(Collection self, Closure closure)

Sums the result of apply a closure to each item of a collection.

static Object sum(Object[] self, Closure closure)

Sums the result of apply a closure to each item of an array.

static Object sum(Iterator self, Closure closure)

Sums the result of apply a closure to each item returned from an iterator.

static Object sum(Collection self, Object initialValue, Closure closure)

Sums the result of applying a closure to each item of a collection to some initial value.

static Object sum(Object[] self, Object initialValue, Closure closure)

Sums the result of applying a closure to each item of an array to some initial value.

static Object sum(Iterator self, Object initialValue, Closure closure)

Sums the result of applying a closure to each item of an Iterator to some initial value.

static List tail(List self)

Returns the items from the List excluding the first item.

static T[] tail(T[] self)

Returns the items from the Object array excluding the first item.

static void times(Number self, Closure closure)

Executes the closure this many times, starting from zero.

static String toArrayString(Object[] self)

Returns the string representation of the given array.

static BigDecimal toBigDecimal(String self)

Parse a String into a BigDecimal

static BigDecimal toBigDecimal(Number self)

Transform a Number into a BigDecimal

static BigInteger toBigInteger(String self)

Parse a String into a BigInteger

static BigInteger toBigInteger(Number self)

Transform this Number into a BigInteger.

static Boolean toBoolean(String self)

Converts the given string into a Boolean object.

static Boolean toBoolean(Boolean self)

Identity conversion which returns Boolean.TRUE for a true Boolean and Boolean.FALSE for a false Boolean.

static Character toCharacter(String self)

Converts the given string into a Character object using the first character in the string.

static Double toDouble(String self)

Parse a String into a Double

static Double toDouble(Number self)

Transform a Number into a Double

static Float toFloat(String self)

Parse a String into a Float

static Float toFloat(Number self)

Transform a Number into a Float

static Integer toInteger(String self)

Parse a String into an Integer

static Integer toInteger(Number self)

Transform a Number into an Integer

static List toList(Collection self)

Convert a Collection to a List.

static List toList(Iterator self)

Convert an iterator to a List.

static List toList(Enumeration self)

Convert an enumeration to a List.

static List toList(T[] array)

Allows conversion of arrays into a mutable List.

static List toList(byte[] array)

Converts this array to a List of the same size, with each element added to the list.

static List toList(boolean[] array)

Converts this array to a List of the same size, with each element added to the list.

static List toList(char[] array)

Converts this array to a List of the same size, with each element added to the list.

static List toList(short[] array)

Converts this array to a List of the same size, with each element added to the list.

static List toList(int[] array)

Converts this array to a List of the same size, with each element added to the list.

static List toList(long[] array)

Converts this array to a List of the same size, with each element added to the list.

static List toList(float[] array)

Converts this array to a List of the same size, with each element added to the list.

static List toList(double[] array)

Converts this array to a List of the same size, with each element added to the list.

static List toList(String self)

Converts the given String into a List of strings of one character.

static String toListString(Collection self)

Returns the string representation of the given list.

static String toListString(Collection self, int maxSize)

Returns the string representation of the given list.

static Long toLong(String self)

Parse a String into a Long

static Long toLong(Number self)

Transform a Number into a Long

static char toLowerCase(Character self)

Converts the character to lowercase.

static String toMapString(Map self)

Returns the string representation of this map.

static String toMapString(Map self, int maxSize)

Returns the string representation of this map.

static def toRowResult(def rs)

@deprecated moved to SqlGroovyMethods.toRowResult

static Short toShort(String self)

Parse a String into a Short

static SpreadMap toSpreadMap(Map self)

Returns a new SpreadMap from this map.

static SpreadMap toSpreadMap(Object[] self)

Creates a spreadable map from this array.

static String toString(boolean[] self)

Returns the string representation of the given array.

static String toString(byte[] self)

Returns the string representation of the given array.

static String toString(char[] self)

Returns the string representation of the given array.

static String toString(short[] self)

Returns the string representation of the given array.

static String toString(int[] self)

Returns the string representation of the given array.

static String toString(long[] self)

Returns the string representation of the given array.

static String toString(float[] self)

Returns the string representation of the given array.

static String toString(double[] self)

Returns the string representation of the given array.

static String toString(AbstractMap self)

Returns the string representation of the given map.

static String toString(AbstractCollection self)

Returns the string representation of the given collection.

static String toString(Object[] self)

Returns the string representation of this array's contents.

static String toString(Object value)

Create a String representation of this object.

static URI toURI(String self)

Transforms a String representing a URI into a URI object.

static URL toURL(String self)

Transforms a String representing a URL into a URL object.

static char toUpperCase(Character self)

Converts the character to uppercase.

static List tokenize(String self, String token)

Tokenize a String based on the given string delimiter.

static List tokenize(String self, Character token)

Tokenize a String based on the given character delimiter.

static List tokenize(String self)

Tokenize a String (with a whitespace as the delimiter).

static String tr(String self, String sourceSet, String replacementSet)

Translates a string by replacing characters from the sourceSet with characters from replacementSet.

static void transformChar(Reader self, Writer writer, Closure closure)

Transforms each character from this reader by passing it to the given closure.

static void transformLine(Reader reader, Writer writer, Closure closure)

Transforms the lines from a reader with a Closure and write them to a writer.

static List transpose(List self)

Adds GroovyCollections#transpose(List) as a method on lists.

static void traverse(File self, Map options, Closure closure)

Invokes closure for each descendant file in this directory tree.

static void traverse(File self, Closure closure)

Invokes the closure for each descendant file in this directory tree.

static void traverse(File self, Map options)

Invokes the closure specified with key 'visit' in the options Map for each descendant file in this directory tree.

static float trunc(Float number, int precision)

Truncate the value

static float trunc(Float number)

Truncate the value

static double trunc(Double number)

Truncate the value

static double trunc(Double number, int precision)

Truncate the value

static Number unaryMinus(Number left)

Negates the number.

static String unexpand(String self)

Replaces sequences of whitespaces with tabs using tabStops of size 8.

static String unexpand(String self, int tabStop)

Replaces sequences of whitespaces with tabs.

static String unexpandLine(String self, int tabStop)

Replaces sequences of whitespaces with tabs within a line.

static Iterator unique(Iterator self)

Returns an iterator equivalent to this iterator all duplicated items removed by using the default comparator.

static Collection unique(Collection self)

Modifies this collection to remove all duplicated items, using the default comparator.

static Iterator unique(Iterator self, Closure closure)

Returns an iterator equivalent to this iterator but with all duplicated items removed by using a Closure to determine duplicate (equal) items.

static Collection unique(Collection self, Closure closure)

A convenience method for making a collection unique using a Closure to determine duplicate (equal) items.

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)

Remove all duplicates from a given Collection.

static void upto(Number self, Number to, Closure closure)

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

static void upto(long self, Number to, Closure closure)

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

static void upto(Long self, Number to, Closure closure)

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

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(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)

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

static void upto(Double self, Number to, Closure closure)

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

static void upto(BigInteger self, Number to, Closure closure)

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

static void upto(BigDecimal self, Number to, Closure closure)

Iterates from this number up to the given number, inclusive, incrementing 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)

Scoped use method with list of categories.

static Object use(Object self, Object[] array)

Allows you to use a list of categories, specifying the list as varargs.

static void waitForOrKill(Process self, long numberOfMillis)

@deprecated use ProcessGroovyMethods#waitForOrKill(Process, long)

static void waitForProcessOutput(Process self)

@deprecated use ProcessGroovyMethods#waitForProcessOutput(Process)

static void waitForProcessOutput(Process self, StringBuffer output, StringBuffer error)

@deprecated use #waitForProcessOutput(Process, Appendable, Appendable)

static void waitForProcessOutput(Process self, OutputStream output, OutputStream error)

@deprecated use ProcessGroovyMethods#waitForProcessOutput(Process, OutputStream, OutputStream)

static Object with(Object self, Closure closure)

Allows the closure to be called for the object reference self

static Object withDataInputStream(File file, Closure closure)

Create a new DataInputStream for this file and passes it into the closure.

static Object withDataOutputStream(File file, Closure closure)

Create a new DataOutputStream for this file and passes it into the closure.

static Map withDefault(Map self, Closure init)

Wraps a map using the delegate pattern with a wrapper that intercepts all calls to get(key).

static Object withInputStream(File file, Closure closure)

Create a new InputStream for this file and passes it into the closure.

static Object withInputStream(URL url, Closure closure)

Creates a new InputStream for this URL and passes it into the closure.

static Object withObjectInputStream(File file, Closure closure)

Create a new ObjectInputStream for this file and pass it to the closure.

static Object withObjectInputStream(File file, ClassLoader classLoader, Closure closure)

Create a new ObjectInputStream for this file associated with the given class loader and pass it to the closure.

static Object withObjectInputStream(InputStream inputStream, Closure closure)

Create a new ObjectInputStream for this file and pass it to the closure.

static Object withObjectInputStream(InputStream inputStream, ClassLoader classLoader, Closure closure)

Create a new ObjectInputStream for this file and pass it to the closure.

static Object withObjectOutputStream(File file, Closure closure)

Create a new ObjectOutputStream for this file and then pass it to the closure.

static Object withObjectOutputStream(OutputStream outputStream, Closure closure)

Create a new ObjectOutputStream for this output stream and then pass it to the closure.

static Object withObjectStreams(Socket socket, Closure closure)

Creates an InputObjectStream and an OutputObjectStream from a Socket, and passes them to the closure.

static Object withOutputStream(File file, Closure closure)

Creates a new OutputStream for this file and passes it into the closure.

static void withOutputStream(Process self, Closure closure)

@deprecated use ProcessGroovyMethods#withOutputStream(Process, Closure)

static Object withPrintWriter(File file, Closure closure)

Create a new PrintWriter for this file which is then passed it into the given closure.

static Object withPrintWriter(File file, String charset, Closure closure)

Create a new PrintWriter with a specified charset for this file.

static Object withPrintWriter(Writer writer, Closure closure)

Create a new PrintWriter with a specified charset for this file.

static Object withReader(File file, Closure closure)

Create a new BufferedReader for this file and then passes it into the closure, ensuring the reader is closed after the closure returns.

static Object withReader(File file, String charset, Closure closure)

Create a new BufferedReader for this file using the specified charset and then passes it into the closure, ensuring the reader is closed after the closure returns.

static Object withReader(Reader reader, Closure closure)

Allows this reader to be used within the closure, ensuring that it is closed before this method returns.

static Object withReader(URL url, Closure closure)

Helper method to create a new BufferedReader for a URL and then passes it to the closure.

static Object withReader(URL url, String charset, Closure closure)

Helper method to create a new Reader for a URL and then passes it to the closure.

static Object withReader(InputStream in, Closure closure)

Helper method to create a new Reader for a stream and then passes it into the closure.

static Object withReader(InputStream in, String charset, Closure closure)

Helper method to create a new Reader for a stream and then passes it into the closure.

static Object withStream(InputStream stream, Closure closure)

Allows this input stream to be used within the closure, ensuring that it is flushed and closed before this method returns.

static Object withStream(OutputStream os, Closure closure)

Passes this OutputStream to the closure, ensuring that the stream is closed after the closure returns, regardless of errors.

static Object withStreams(Socket socket, Closure closure)

Passes the Socket's InputStream and OutputStream to the closure.

static Object withWriter(File file, Closure closure)

Creates a new BufferedWriter for this file, passes it to the closure, and ensures the stream is flushed and closed after the closure returns.

static Object withWriter(File file, String charset, Closure closure)

Creates a new BufferedWriter for this file, passes it to the closure, and ensures the stream is flushed and closed after the closure returns.

static Object withWriter(Writer writer, Closure closure)

Allows this writer to be used within the closure, ensuring that it is flushed and closed before this method returns.

static Object withWriter(OutputStream stream, Closure closure)

Creates a writer from this stream, passing it to the given closure.

static Object withWriter(OutputStream stream, String charset, Closure closure)

Creates a writer from this stream, passing it to the given closure.

static void withWriter(Process self, Closure closure)

@deprecated use ProcessGroovyMethods#withWriter(Process, Closure)

static Object withWriterAppend(File file, String charset, Closure closure)

Create a new BufferedWriter which will append to this file.

static Object withWriterAppend(File file, Closure closure)

Create a new BufferedWriter for this file in append mode.

static void write(Writer self, Writable writable)

A helper method so that dynamic dispatch of the writer.write(object) method will always use the more efficient Writable.writeTo(writer) mechanism if the object implements the Writable interface.

static void write(File file, String text)

Write the text to the File.

static void write(File file, String text, String charset)

Write the text to the File, using the specified encoding.

static void writeLine(BufferedWriter writer, String line)

Write the text and append a newline (using the platform's line-ending).

static BitSet xor(BitSet left, BitSet right)

Bitwise XOR together two BitSets.

static Number xor(Number left, Number right)

Bitwise XOR together two Numbers.

static Boolean xor(Boolean left, Boolean right)

Exclusive disjunction of two boolean operators

 
Methods inherited from class DefaultGroovyMethodsSupport
cloneSimilarCollection, cloneSimilarMap, closeQuietly, closeWithWarning, 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

additionals

public static final Class[] additionals


 
Method Detail

abs

public static int abs(Number number)
Get the absolute value
Parameters:
number - a Number
Returns:
the absolute value of that Number
Since:
1.0


abs

public static long abs(Long number)
Get the absolute value
Parameters:
number - a Long
Returns:
the absolute value of that Long
Since:
1.0


abs

public static float abs(Float number)
Get the absolute value
Parameters:
number - a Float
Returns:
the absolute value of that Float
Since:
1.0


abs

public static double abs(Double number)
Get the absolute value
Parameters:
number - a Double
Returns:
the absolute value of that Double
Since:
1.0


accept

public static Socket accept(ServerSocket serverSocket, Closure closure)
Accepts a connection and passes the resulting Socket to the closure which runs in a new Thread.
throws:
IOException if an IOException occurs.
Parameters:
serverSocket - a ServerSocket
closure - a Closure
Returns:
a Socket
See Also:
ServerSocket.accept
Since:
1.0


accept

public static Socket accept(ServerSocket serverSocket, boolean runInANewThread, Closure closure)
Accepts a connection and passes the resulting Socket to the closure which runs in a new Thread or the calling thread, as needed.
throws:
IOException if an IOException occurs.
Parameters:
serverSocket - a ServerSocket
runInANewThread - This flag should be true, if the closure should be invoked in a new thread, else false.
closure - a Closure
Returns:
a Socket
See Also:
ServerSocket.accept
Since:
1.7.6


addAll

public static boolean addAll(Collection self, T[] items)
Adds all of the elements in the specified array to this collection. The behavior of this operation is undefined if the specified array is modified while the operation is in progress.
Parameters:
items - array containing elements to be added to this collection
Returns:
true if this collection changed as a result of the call
See Also:
Collection.addAll
Since:
1.7.2


addAll

public static boolean addAll(List self, int index, T[] items)
Inserts all of the elements in the specified array into this list at the specified position. Shifts the element currently at that position (if any) and any subsequent elements to the right (increases their indices). The new elements will appear in this list in the order that they occur in the array. The behavior of this operation is undefined if the specified array is modified while the operation is in progress.
Parameters:
items - array containing elements to be added to this collection
index - index at which to insert the first element from the specified array
Returns:
true if this collection changed as a result of the call
See Also:
List.addAll
Since:
1.7.2


addShutdownHook

public static void addShutdownHook(Object self, Closure closure)
Allows the usage of addShutdownHook without getting the runtime first.
Parameters:
self - the object the method is called on (ignored)
closure - the shutdown hook action
Since:
1.5.0


and

public static Number and(Number left, Number right)
Bitwise AND together two Numbers.
Parameters:
left - a Number
right - another Number to bitwise AND
Returns:
the bitwise AND of both Numbers
Since:
1.0


and

public static BitSet and(BitSet left, BitSet right)
Bitwise AND together two BitSets.
Parameters:
left - a BitSet
right - another BitSet to bitwise AND
Returns:
the bitwise AND of both BitSets
Since:
1.5.0


and

public static Boolean and(Boolean left, Boolean right)
Logical conjunction of two boolean operators.
Parameters:
left - left operator
right - right operator
Returns:
result of logical conjunction
Since:
1.0


any

public static boolean any(Object self, Closure closure)
Iterates over the contents of an object or collection, and checks whether a predicate is valid for at least one element.
Parameters:
self - the object over which we iterate
closure - the closure predicate used for matching
Returns:
true if any iteration for the object matches the closure predicate
Since:
1.0


any

public static boolean any(Map self, Closure closure)
Iterates over the entries of a map, and checks whether a predicate is valid for at least one entry. If the closure takes one parameter then it will be passed the Map.Entry otherwise if the closure takes two parameters then it will be passed the key and the value.
assert [2:3, 4:5, 5:10].any { key, value -> key * 2 == value }
 assert ![2:3, 4:5, 5:10].any { entry -> entry.key == entry.value * 2 }
Parameters:
self - the map over which we iterate
closure - the 1 or 2 arg closure predicate used for matching
Returns:
true if any entry in the map matches the closure predicate
Since:
1.5.0


any

public static boolean any(Object self)
Iterates over the elements of a collection, and checks whether at least one element is true according to the Groovy Truth. Equivalent to self.any({element -> element})
Parameters:
self - the object over which we iterate
Returns:
true if any item in the collection matches the closure predicate
Since:
1.5.0


append

public static void append(File file, Object text)
Append the text at the end of the File.
throws:
IOException if an IOException occurs.
Parameters:
file - a File
text - the text to append at the end of the File
Since:
1.0


append

public static void append(File file, byte[] bytes)
Append bytes to the end of a File.
throws:
IOException if an IOException occurs.
Parameters:
file - a File
bytes - the byte array to append to the end of the File
Since:
1.5.1


append

public static void append(File self, InputStream stream)
Append binary data to the file. It will not be interpreted as text.
throws:
IOException if an IOException occurs.
Parameters:
self - a File
stream - stream to read data from.
Since:
1.5.0


append

public static void append(File file, Object text, String charset)
Append the text at the end of the File, using a specified encoding.
throws:
IOException if an IOException occurs.
Parameters:
file - a File
text - the text to append at the end of the File
charset - the charset used
Since:
1.0


asBoolean

public static boolean asBoolean(Object object)
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


asBoolean

public static boolean asBoolean(Boolean bool)
Coerce an Boolean instance to a boolean value.
Parameters:
bool - the Boolean
Returns:
the boolean value
Since:
1.7.0


asBoolean

public static boolean asBoolean(Matcher matcher)
Coerce a Matcher instance to a boolean value.
Parameters:
matcher - the matcher
Returns:
the boolean value
Since:
1.7.0


asBoolean

public static boolean asBoolean(Collection collection)
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(Map map)
Coerce a map instance to a boolean value. A map is coerced to false if it's empty, and to true otherwise.
assert [:] as Boolean == false
 assert [a:2] as Boolean == true
Parameters:
map - the map
Returns:
the boolean value
Since:
1.7.0


asBoolean

public static boolean asBoolean(Iterator iterator)
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(Enumeration enumeration)
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(CharSequence string)
Coerce a string (an instance of CharSequence) to a boolean value. A string is coerced to false if it is of length 0, and to true otherwise.
Parameters:
string - the character sequence
Returns:
the boolean value
Since:
1.7.0


asBoolean

public static boolean asBoolean(Object[] array)
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(byte[] array)
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(short[] 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(int[] 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(long[] 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(float[] 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(double[] 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(boolean[] 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(char[] 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(Character character)
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(Number number)
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

@Deprecated
public static boolean asBoolean(GroovyResultSet grs)
deprecated:
use SqlGroovyMethods#asBoolean(GroovyResultSet)


asImmutable

public static Map asImmutable(Map self)
A convenience method for creating an immutable map.
Parameters:
self - a Map
Returns:
an immutable Map
See Also:
Collections.unmodifiableMap
Since:
1.0


asImmutable

public static SortedMap asImmutable(SortedMap 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 List asImmutable(List self)
A convenience method for creating an immutable list
Parameters:
self - a List
Returns:
an immutable List
See Also:
Collections.unmodifiableList
Since:
1.0


asImmutable

public static Set asImmutable(Set self)
A convenience method for creating an immutable list.
Parameters:
self - a Set
Returns:
an immutable Set
See Also:
Collections.unmodifiableSet
Since:
1.0


asImmutable

public static SortedSet asImmutable(SortedSet self)
A convenience method for creating an immutable sorted set.
Parameters:
self - a SortedSet
Returns:
an immutable SortedSet
See Also:
Collections.unmodifiableSortedSet
Since:
1.0


asImmutable

public static Collection asImmutable(Collection self)
A convenience method for creating an immutable Collection.
def mutable = [1,2,3]
 def immutable = mutable.asImmutable()
 mutable << 4
 try {
   immutable << 4
   assert false
 } catch (UnsupportedOperationException) {
   assert true
 }
Parameters:
self - a Collection
Returns:
an immutable Collection
See Also:
Collections.unmodifiableCollection
Since:
1.5.0


asList

public static List asList(Collection self)
Converts this Collection to a List. Returns the original Collection if it is already a List.

Example usage:

assert new HashSet().asList() instanceof List
Parameters:
self - a collection to be converted into a List
Returns:
a newly created List if this collection is not already a List
Since:
1.0


asSynchronized

public static Map asSynchronized(Map self)
A convenience method for creating a synchronized Map.
Parameters:
self - a Map
Returns:
a synchronized Map
See Also:
Collections.synchronizedMap
Since:
1.0


asSynchronized

public static SortedMap asSynchronized(SortedMap self)
A convenience method for creating a synchronized SortedMap.
Parameters:
self - a SortedMap
Returns:
a synchronized SortedMap
See Also:
Collections.synchronizedSortedMap
Since:
1.0


asSynchronized

public static Collection asSynchronized(Collection self)
A convenience method for creating a synchronized Collection.
Parameters:
self - a Collection
Returns:
a synchronized Collection
See Also:
Collections.synchronizedCollection
Since:
1.0


asSynchronized

public static List asSynchronized(List self)
A convenience method for creating a synchronized List.
Parameters:
self - a List
Returns:
a synchronized List
See Also:
Collections.synchronizedList
Since:
1.0


asSynchronized

public static Set asSynchronized(Set self)
A convenience method for creating a synchronized Set.
Parameters:
self - a Set
Returns:
a synchronized Set
See Also:
Collections.synchronizedSet
Since:
1.0


asSynchronized

public static SortedSet asSynchronized(SortedSet self)
A convenience method for creating a synchronized SortedSet.
Parameters:
self - a SortedSet
Returns:
a synchronized SortedSet
See Also:
Collections.synchronizedSortedSet
Since:
1.0


asType

public static Object asType(Collection col, Class clazz)
Converts the given collection to another type. A default concrete type is used for List, Set, or SortedSet. If the given type has a constructor taking a collection, that is used. Otherwise, the call is deferred to {link #asType(Object,Class)}. If this collection is already of the given type, the same instance is returned.
Parameters:
col - a collection
clazz - the desired class
Returns:
the object resulting from this type conversion
See Also:
asType(java.lang.Object, java.lang.Class)
Since:
1.0


asType

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

public static Object asType(Closure cl, Class clazz)
Coerces the closure to an implementation of the given class. The class is assumed to be an interface or class with a single method definition. The closure is used as the implementation of that single method.
Parameters:
cl - the implementation of the single method
clazz - the target type
Returns:
a Proxy of the given type which wraps this closure.
Since:
1.0


asType

public static Object asType(Map map, 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

public static Object asType(Number self, Class c)
Transform this number to a the given type, using the 'as' operator. The following types are supported in addition to the default asType(java.lang.Object, java.lang.Class):
Parameters:
self - this number
c - the desired type of the transformed result
Returns:
an instance of the given type
Since:
1.0


asType

public static Object asType(File f, Class c)
Converts this File to a Writable or delegates to default asType(java.lang.Object, java.lang.Class).
Parameters:
f - a File
c - the desired class
Returns:
the converted object
Since:
1.0


asType

public static Object asType(GString self, Class c)
Converts the GString to a File, or delegates to the default asType(java.lang.Object, java.lang.Class)
Parameters:
self - a GString
c - the desired class
Returns:
the converted object
Since:
1.5.0


asType

public static Object asType(String self, Class c)

Provides a method to perform custom 'dynamic' type conversion to the given class using the as operator.

Example: '123' as Double

By default, the following types are supported:

If any other type is given, the call is delegated to asType(java.lang.Object, java.lang.Class).
Parameters:
self - a String
c - the desired class
Returns:
the converted object
Since:
1.0


asType

public static Object asType(Object obj, Class type)
Converts a given object to a type. This method is used through the "as" operator and is overloadable as any other operator.
Parameters:
obj - the object to convert
type - the goal type
Returns:
the resulting object
Since:
1.0


asWritable

public static File asWritable(File file)
Converts this File to a Writable.
Parameters:
file - a File
Returns:
a File which wraps the input file and which implements Writable
Since:
1.0


asWritable

public static File asWritable(File file, String encoding)
Allows a file to return a Writable implementation that can output itself to a Writer stream.
Parameters:
file - a File
encoding - the encoding to be used when reading the file's contents
Returns:
File which wraps the input file and which implements Writable
Since:
1.0


bitwiseNegate

public static Pattern bitwiseNegate(String self)
Turns a String into a regular expression Pattern
Parameters:
self - a String to convert into a regular expression
Returns:
the regular expression pattern
Since:
1.5.0


bitwiseNegate

public static BitSet bitwiseNegate(BitSet self)
Bitwise NEGATE a BitSet.
Parameters:
self - a BitSet
Returns:
the bitwise NEGATE of the BitSet
Since:
1.5.0


callClosureForLine

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


callClosureForMapEntry

protected static Object callClosureForMapEntry(Closure closure, def entry)


callClosureForMapEntryAndCounter

protected static Object callClosureForMapEntryAndCounter(Closure closure, def entry, int counter)


capitalize

public static String capitalize(String self)
Convenience method to capitalize the first letter of a string (typically the first letter of a word). Example usage:
 assert 'h'.capitalize() == 'H'
 assert 'hello'.capitalize() == 'Hello'
 assert 'hello world'.capitalize() == 'Hello world'
 assert 'Hello World' ==
     'hello world'.split(' ').collect{ it.capitalize() }.join(' ')
 
Parameters:
self - The string to capitalize
Returns:
String The capitalized String result of split
Since:
1.7.3


center

public static String center(String self, Number numberOfChars, String padding)
Pad a String to a minimum length specified by numberOfChars, appending the supplied padding String around the original as many times as needed keeping it centered. If the String is already the same size or bigger than the target numberOfChars, then the original String is returned. An example:
 ['A', 'BB', 'CCC', 'DDDD'].each{ println '|' + it.center(6, '+') + '|' }
 
will produce output like:
 |++A+++|
 |++BB++|
 |+CCC++|
 |+DDDD+|
 
Parameters:
self - a String object
numberOfChars - the total minimum number of characters of the resulting string
padding - the charaters used for padding
Returns:
the String centered with padded characters around it
Since:
1.0


center

public static String center(String self, Number numberOfChars)
Pad a String to a minimum length specified by numberOfChars by adding the space character around it as many times as needed so that it remains centered. If the String is already the same size or bigger than the target numberOfChars, then the original String is returned. An example:
 ['A', 'BB', 'CCC', 'DDDD'].each{ println '|' + it.center(6) + '|' }
 
will produce output like:
 |  A   |
 |  BB  |
 | CCC  |
 | DDDD |
 
Parameters:
self - a String object
numberOfChars - the total minimum number of characters of the resulting string
Returns:
the String centered with padded characters around it
See Also:
center(String, Number, String)
Since:
1.0


clearTime

@Deprecated
public static void clearTime(Date self)
deprecated:
moved to DateGroovyMethods.clearTime


clearTime

@Deprecated
public static void clearTime(def self)
deprecated:
moved to DateGroovyMethods.clearTime


clearTime

@Deprecated
public static void clearTime(Calendar self)
deprecated:
moved to DateGroovyMethods.clearTime


collect

public static List collect(Object self, Closure closure)
Iterates through this object transforming each value into a new value using the closure as a transformer, 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 - the values of the object to transform
closure - the closure used to transform each element of the collection
Returns:
a List of the transformed values
Since:
1.0


collect

public static Collection collect(Object self, Collection collection, Closure closure)
Iterates through this object transforming each object into a new value using the closure as a transformer and adding it to the collection, returning the resulting collection.
Parameters:
self - the values of the object to transform
collection - the Collection to which the transformed values are added
closure - the closure used to map each element of the collection
Returns:
the given collection after the transformed values are added
Since:
1.0


collect

public static List collect(Collection self, Closure closure)
Iterates through this collection transforming each entry into a new value using the closure as a transformer, returning a list of transformed values.
assert [2,4,6] == [1,2,3].collect { it * 2 }
Parameters:
self - a collection
closure - the closure used for mapping
Returns:
a List of the transformed values
Since:
1.0


collect

public static Collection collect(Collection self, Collection collection, Closure closure)
Iterates through this collection transforming each value into a new value using the closure as a transformer, returning an initial collection plus the transformed values.
assert [1,2,3] as HashSet == [2,4,5,6].collect(new HashSet()) { (int)(it / 2) }
Parameters:
self - a collection
collection - an initial Collection to which the transformed values are added
closure - the closure used to transform each element of the collection
Returns:
the resulting collection of transformed values
Since:
1.0


collect

public static Collection collect(Map self, Collection collection, Closure closure)
Iterates through this Map transforming each entry into a new value using the closure as a transformer, returning a list of transformed values.
assert [a:1, b:2].collect( [] as HashSet ) { key, value -> key*value } == ["a", "bb"] as Set
 assert [3:20, 2:30].collect( [] as HashSet ) { entry -> entry.key * entry.value } == [60] as Set
Parameters:
self - a Map
collection - the Collection to which the mapped values are added
closure - the closure used for mapping, which can take one (Map.Entry) or two (key, value) parameters
Returns:
a List of the mapped values
Since:
1.0


collect

public static List collect(Map self, Closure closure)
Iterates through this Map transforming each entry into a new value using the closure as a transformer, returning a list of transformed values.
assert [a:1, b:2].collect { key, value -> key*value } == ["a", "bb"]
 assert [3:20, 2:30].collect { entry -> entry.key * entry.value } == [60, 60]
Parameters:
self - a Map
closure - the closure used to map each element of the collection
Returns:
the resultant collection
Since:
1.0


collectAll

public static List collectAll(Collection self, Closure closure)
Recursively iterates through this collection transforming each non-Collection value into a new value using the closure as a transformer. Returns a potentially nested list of transformed values.
assert [2,[4,6],[8],[]] == [1,[2,3],[4],[]].collectAll { it * 2 }
Parameters:
self - a collection
closure - the closure used to transform each element of the collection
Returns:
the resultant collection
Since:
1.5.2


collectAll

public static Collection collectAll(Collection self, Collection collection, Closure closure)
Recursively iterates through this collection transforming each non-Collection value into a new value using the closure as a transformer. Returns a potentially nested collection of transformed values.
def x = [1,[2,3],[4],[]].collectAll(new Vector()) { it * 2 }
 assert x == [2,[4,6],[8],[]]
 assert x instanceof Vector
Parameters:
self - a collection
collection - an initial Collection to which the transformed values are added
closure - the closure used to transform each element of the collection
Returns:
the resultant collection
Since:
1.5.2


collectEntries

public static Map collectEntries(Map self, Map result, Closure closure)
Iterates through this Map transforming each entry using the closure as a transformer, returning a map of the transformed entries.
 assert [a:1, b:2].collectEntries( [:] ) { k, v -> [v, k] } == [1:'a', 2:'b']
 assert [a:1, b:2].collectEntries( [30:'C'] ) { key, value ->
     [(value*10): key.toUpperCase()] } == [10:'A', 20:'B', 30:'C']
 
Parameters:
self - a Map
result - the Map into which the mapped entries are put
closure - the closure used for mapping, which can take one (Map.Entry) or two (key, value) parameters 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:
collect(Map, Collection, Closure)
Since:
1.7.9


collectEntries

public static Map collectEntries(Map self, Closure closure)
Iterates through this Map transforming each entry using the closure as a transformer, returning a map of the transformed entries.
 assert [a:1, b:2].collectEntries { key, value -> [value, key] } == [1:'a', 2:'b']
 assert [a:1, b:2].collectEntries { key, value ->
     [(value*10): key.toUpperCase()] } == [10:'A', 20:'B']
 
Parameters:
self - a Map
closure - the closure used for mapping, which can take one (Map.Entry) or two (key, value) parameters 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:
collect(Map, Collection, Closure)
Since:
1.7.9


collectEntries

public static Map collectEntries(Collection self, Map result, Closure closure)
Iterates through this Collection transforming each item using the closure as a transformer into a map entry, returning a map of the transformed entries.
 def letters = "abc"
 // collect letters with index
 assert (0..2).collectEntries( [:] ) { index -> [index, letters[index]] } == [0:'a', 1:'b', 2:'c']
 assert (0..2).collectEntries( [4:'d'] ) { index ->
     [(index+1): letters[index]] } == [1:'a', 2:'b', 3:'c', 4:'d']
 
Parameters:
self - a Collection
result - the Map into which the collected entries are put
closure - the closure used for mapping, 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:
collect(Map, Collection, Closure)
Since:
1.7.9


collectEntries

public static Map collectEntries(Object[] self, Map result, Closure closure)
Iterates through this array transforming each item using the closure as a transformer into a map entry, returning a map of the transformed entries.
 def letters = "abc"
 def nums = [0, 1, 2] as Integer[]
 // collect letters with index
 assert nums.collectEntries( [:] ) { index -> [index, letters[index]] } == [0:'a', 1:'b', 2:'c']
 assert nums.collectEntries( [4:'d'] ) { index ->
     [(index+1): letters[index]] } == [1:'a', 2:'b', 3:'c', 4:'d']
 
Parameters:
self - a Collection
result - the Map into which the collected entries are put
closure - the closure used for mapping, 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:
collect(Map, Collection, Closure)
Since:
1.7.9


collectEntries

public static Map collectEntries(Collection self, Closure closure)
Iterates through this Collection transforming each item using the closure as a transformer into a map entry, returning a map of the transformed entries.
 def letters = "abc"
 // collect letters with index using list style
 assert (0..2).collectEntries { index -> [index, letters[index]] } == [0:'a', 1:'b', 2:'c']
 // collect letters with index using map style
 assert (0..2).collectEntries { index -> [(index): letters[index]] } == [0:'a', 1:'b', 2:'c']
 
Parameters:
self - a Collection
closure - the closure used for mapping, 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, Map, Closure)
Since:
1.7.9


collectEntries

public static Map collectEntries(Object[] self, Closure closure)
Iterates through this array transforming each item using the closure as a transformer into a map entry, returning a map of the transformed entries.
 def letters = "abc"
 def nums = [0, 1, 2] as Integer[]
 // collect letters with index using list style
 assert nums.collectEntries { index -> [index, letters[index]] } == [0:'a', 1:'b', 2:'c']
 // collect letters with index using map style
 assert nums.collectEntries { index -> [(index): letters[index]] } == [0:'a', 1:'b', 2:'c']
 
Parameters:
self - a Collection
closure - the closure used for mapping, 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, Map, Closure)
Since:
1.7.9


combinations

public static List combinations(Collection self)
Adds GroovyCollections#combinations(Collection) as a method on collections.
assert [['a', 'b'],[1, 2, 3]].combinations() == [['a', 1], ['b', 1], ['a', 2], ['b', 2], ['a', 3], ['b', 3]]
Parameters:
self - a Collection of lists
Returns:
a List of the combinations found
See Also:
GroovyCollections.combinations
Since:
1.5.0


compareTo

public static int compareTo(Character left, Number right)
Compare a Character and a Number. The ordinal value of the Character is used in the comparison (the ordinal value is the unicode value which for simple character sets is the ASCII value).
Parameters:
left - a Character
right - a Number
Returns:
the result of the comparison
Since:
1.0


compareTo

public static int compareTo(Number left, Character right)
Compare a Number and a Character. The ordinal value of the Character is used in the comparison (the ordinal value is the unicode value which for simple character sets is the ASCII value).
Parameters:
left - a Number
right - a Character
Returns:
the result of the comparison
Since:
1.0


compareTo

public static int compareTo(Character left, Character right)
Compare two Characters. The ordinal values of the Characters are compared (the ordinal value is the unicode value which for simple character sets is the ASCII value).
Parameters:
left - a Character
right - a Character
Returns:
the result of the comparison
Since:
1.0


compareTo

public static int compareTo(Number left, Number right)
Compare two Numbers. Equality (==) for numbers dispatches to this.
Parameters:
left - a Number
right - another Number to compare to
Returns:
the comparision of both numbers
Since:
1.0


consumeProcessErrorStream

@Deprecated
public static Thread consumeProcessErrorStream(Process self, OutputStream err)
deprecated:
use ProcessGroovyMethods#consumeProcessErrorStream(Process, OutputStream)


consumeProcessErrorStream

@Deprecated
public static Thread consumeProcessErrorStream(Process self, StringBuffer error)
deprecated:
use ProcessGroovyMethods#consumeProcessErrorStream(Process, Appendable)


consumeProcessErrorStream

@Deprecated
public static Thread consumeProcessErrorStream(Process self, Writer err)
deprecated:
use ProcessGroovyMethods#consumeProcessErrorStream(Process, Appendable)


consumeProcessOutput

@Deprecated
public static void consumeProcessOutput(Process self)
deprecated:
use ProcessGroovyMethods#consumeProcessOutput(Process)


consumeProcessOutput

@Deprecated
public static void consumeProcessOutput(Process self, StringBuffer output, StringBuffer error)
deprecated:
use ProcessGroovyMethods#consumeProcessOutput(Process, Appendable, Appendable)


consumeProcessOutput

@Deprecated
public static void consumeProcessOutput(Process self, OutputStream output, OutputStream error)
deprecated:
use ProcessGroovyMethods#consumeProcessOutput(Process, OutputStream, OutputStream)


consumeProcessOutputStream

@Deprecated
public static Thread consumeProcessOutputStream(Process self, StringBuffer output)
deprecated:
use ProcessGroovyMethods#consumeProcessOutputStream(Process, Appendable)


consumeProcessOutputStream

@Deprecated
public static Thread consumeProcessOutputStream(Process self, Writer output)
deprecated:
use ProcessGroovyMethods#consumeProcessOutputStream(Process, Appendable)


consumeProcessOutputStream

@Deprecated
public static Thread consumeProcessOutputStream(Process self, OutputStream output)
deprecated:
use ProcessGroovyMethods#consumeProcessOutputStream(Process, OutputStream)


contains

public static boolean contains(String self, String text)
Provide an implementation of contains() like Collection.contains to make Strings more polymorphic. This method is not required on JDK 1.5 onwards
Parameters:
self - a String
text - a String to look for
Returns:
true if this string contains the given text
Since:
1.0


containsAll

public static boolean containsAll(Collection self, Object[] items)
Returns true if this collection contains all of the elements in the specified array.
Parameters:
items - array to be checked for containment in this collection
Returns:
true if this collection contains all of the elements in the specified array
See Also:
Collection.containsAll
Since:
1.7.2


count

public static Number count(Iterator self, Object value)
Counts the number of occurrences of the given value from the items within this Iterator. Comparison is done using Groovy's == operator (using compareTo(value) == 0 or equals(value) ). The iterator will become exhausted of elements after determining the count value.
Parameters:
self - the Iterator from which we count the number of matching occurrences
value - the value being searched for
Returns:
the number of occurrences
Since:
1.5.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) ).
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(Object[] self, Object value)
Counts the number of occurrences of the given value inside this array. Comparison is done using Groovy's == operator (using compareTo(value) == 0 or equals(value) ).
Parameters:
self - the array within which we count the number of occurrences
value - the value being searched for
Returns:
the number of occurrences
Since:
1.6.4


count

public static Number count(int[] self, Object value)
Counts the number of occurrences of the given value inside this array. Comparison is done using Groovy's == operator (using compareTo(value) == 0 or equals(value) ).
Parameters:
self - the array within which we count the number of occurrences
value - the value being searched for
Returns:
the number of occurrences
Since:
1.6.4


count

public static Number count(long[] self, Object value)
Counts the number of occurrences of the given value inside this array. Comparison is done using Groovy's == operator (using compareTo(value) == 0 or equals(value) ).
Parameters:
self - the array within which we count the number of occurrences
value - the value being searched for
Returns:
the number of occurrences
Since:
1.6.4


count

public static Number count(short[] self, Object value)
Counts the number of occurrences of the given value inside this array. Comparison is done using Groovy's == operator (using compareTo(value) == 0 or equals(value) ).
Parameters:
self - the array within which we count the number of occurrences
value - the value being searched for
Returns:
the number of occurrences
Since:
1.6.4


count

public static Number count(char[] self, Object value)
Counts the number of occurrences of the given value inside this array. Comparison is done using Groovy's == operator (using compareTo(value) == 0 or equals(value) ).
Parameters:
self - the array within which we count the number of occurrences
value - the value being searched for
Returns:
the number of occurrences
Since:
1.6.4


count

public static Number count(boolean[] self, Object value)
Counts the number of occurrences of the given value inside this array. Comparison is done using Groovy's == operator (using compareTo(value) == 0 or equals(value) ).
Parameters:
self - the array within which we count the number of occurrences
value - the value being searched for
Returns:
the number of occurrences
Since:
1.6.4


count

public static Number count(double[] self, Object value)
Counts the number of occurrences of the given value inside this array. Comparison is done using Groovy's == operator (using compareTo(value) == 0 or equals(value) ).
Parameters:
self - the array within which we count the number of occurrences
value - the value being searched for
Returns:
the number of occurrences
Since:
1.6.4


count

public static Number count(float[] self, Object value)
Counts the number of occurrences of the given value inside this array. Comparison is done using Groovy's == operator (using compareTo(value) == 0 or equals(value) ).
Parameters:
self - the array within which we count the number of occurrences
value - the value being searched for
Returns:
the number of occurrences
Since:
1.6.4


count

public static Number count(byte[] self, Object value)
Counts the number of occurrences of the given value inside this array. Comparison is done using Groovy's == operator (using compareTo(value) == 0 or equals(value) ).
Parameters:
self - the array within which we count the number of occurrences
value - the value being searched for
Returns:
the number of occurrences
Since:
1.6.4


count

public static int count(String self, String text)
Count the number of occurencies of a substring.
Parameters:
self - a String
text - a substring
Returns:
the number of occurrencies of the given string inside this String
Since:
1.0


createStringBufferWriter

protected static StringBufferWriter createStringBufferWriter(StringBuffer self)


createStringWriter

protected static StringWriter createStringWriter(String self)


decodeBase64

@Deprecated
public static byte[] decodeBase64(String value)
deprecated:
moved to EncodingGroovyMethods.decodeBase64


deleteDir

public static boolean deleteDir(File self)
Deletes a directory with all contained files and subdirectories.

The method returns

Parameters:
self - a File
Returns:
true if the file doesn't exist or deletion was successful
Since:
1.6.0


denormalize

public static String denormalize(String self)
Return a String with lines (separated by LF, CR/LF, or CR) terminated by the platform specific line separator.
Parameters:
self - a String object
Returns:
the denormalized string
Since:
1.6.0


disjoint

public static boolean disjoint(Collection left, Collection right)
Returns true if the intersection of two collections is empty.
assert [1,2,3].disjoint([3,4,5]) == false
assert [1,2].disjoint([3,4]) == true
Parameters:
left - a Collection
right - a Collection
Returns:
boolean true if the intersection of two collections is empty, false otherwise.
Since:
1.0


div

public static Number div(Character left, Number right)
Divide a Character by a Number. The ordinal value of the Character is used in the division (the ordinal value is the unicode value which for simple character sets is the ASCII value).
Parameters:
left - a Character
right - a Number
Returns:
the Number corresponding to the division of left by right
Since:
1.0


div

public static Number div(Number left, Character right)
Divide a Number by a Character. The ordinal value of the Character is used in the division (the ordinal value is the unicode value which for simple character sets is the ASCII value).
Parameters:
left - a Number
right - a Character
Returns:
the Number corresponding to the division of left by right
Since:
1.0


div

public static Number div(Character left, Character right)
Divide one Character by another. The ordinal values of the Characters are used in the division (the ordinal value is the unicode value which for simple character sets is the ASCII value).
Parameters:
left - a Character
right - another Character
Returns:
the Number corresponding to the division of left by right
Since:
1.0


downto

public static void downto(Number self, Number to, Closure closure)
Iterates from this number down to the given number, inclusive, decrementing by one each time.
Parameters:
self - a Number
to - another Number to go down to
closure - the closure to call
Since:
1.0


downto

public static void downto(long self, Number to, Closure closure)
Iterates from this number down to the given number, inclusive, decrementing by one each time.
Parameters:
self - a long
to - the end number
closure - the code to execute for each number
Since:
1.0


downto

public static void downto(Long self, Number to, Closure closure)
Iterates from this number down to the given number, inclusive, decrementing by one each time.
Parameters:
self - a Long
to - the end number
closure - the code to execute for each number
Since:
1.0


downto

public static void downto(float self, Number to, Closure closure)
Iterates from this number down to the given number, inclusive, decrementing by one each time.
Parameters:
self - a float
to - the end number
closure - the code to execute for each number
Since:
1.0


downto

public static void downto(Float self, Number to, Closure closure)
Iterates from this number down to the given number, inclusive, decrementing by one each time.
Parameters:
self - a Float
to - the end number
closure - the code to execute for each number
Since:
1.0


downto

public static void downto(double self, Number to, Closure closure)
Iterates from this number down to the given number, inclusive, decrementing by one each time.
Parameters:
self - a double
to - the end number
closure - the code to execute for each number
Since:
1.0


downto

public static void downto(Double self, Number to, Closure closure)
Iterates from this number down to the given number, inclusive, decrementing by one each time.
Parameters:
self - a Double
to - the end number
closure - the code to execute for each number
Since:
1.0


downto

public static void downto(BigInteger self, Number to, Closure closure)
Iterates from this number down to the given number, inclusive, decrementing by one each time.
Parameters:
self - a BigInteger
to - the end number
closure - the code to execute for each number
Since:
1.0


downto

public static void downto(BigDecimal self, Number to, Closure closure)
Iterates from this number down to the given number, inclusive, decrementing by one each time. Each number is passed to the closure. Example:
10.5.downto(0) {
   println it
 }
Prints numbers 10.5, 9.5 ... to 0.5.
Parameters:
self - a BigDecimal
to - the end number
closure - the code to execute for each number
Since:
1.0


dump

public static String dump(Object self)
Generates a detailed dump string of an object showing its class, hashCode and fields.
Parameters:
self - an object
Returns:
the dump representation
Since:
1.0


each

public static T each(T self, Closure closure)
Iterates through an aggregate type or data structure, passing each item to the given closure. Custom types may utilize this method by simply providing an "iterator()" method. The items returned from the resulting iterator will be passed to the closure.
Parameters:
self - the object over which we iterate
closure - the closure applied on each element found
Returns:
the self Object
Since:
1.0


each

public static Map each(Map self, Closure closure)
Allows a Map to be iterated through using a closure. If the closure takes one parameter then it will be passed the Map.Entry otherwise if the closure takes two parameters then it will be passed the key and the value.
def result = ""
 [a:1, b:3].each { key, value -> result += "$key$value" }
 assert result == "a1b3"
def result = ""
 [a:1, b:3].each { entry -> result += entry }
 assert result == "a=1b=3"
In general, the order in which the map contents are processed cannot be guaranteed. In practise, specialized forms of Map, e.g. a TreeMap will have its contents processed according to the natural ordering of the map.
Parameters:
self - the map over which we iterate
closure - the 1 or 2 arg closure applied on each entry of the map
Returns:
returns the self parameter
Since:
1.5.0


eachByte

public static void eachByte(File self, Closure closure)
Traverse through each byte of this File
throws:
IOException if an IOException occurs.
Parameters:
self - a File
closure - a closure
See Also:
eachByte(java.io.InputStream, groovy.lang.Closure)
Since:
1.0


eachByte

public static void eachByte(File self, int bufferLen, Closure closure)
Traverse through the bytes of this File, bufferLen bytes at a time.
throws:
IOException if an IOException occurs.
Parameters:
self - a File
bufferLen - the length of the buffer to use.
closure - a 2 parameter closure which is passed the byte[] and a number of bytes successfully read.
See Also:
eachByte(java.io.InputStream, int, groovy.lang.Closure)
Since:
1.7.4


eachByte

public static void eachByte(Byte[] self, Closure closure)
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


eachByte

public static void eachByte(byte[] self, Closure closure)
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


eachByte

public static void eachByte(InputStream is, Closure closure)
Traverse through each byte of the specified stream. The stream is closed after the closure returns.
throws:
IOException if an IOException occurs.
Parameters:
is - stream to iterate over, closed after the method call
closure - closure to apply to each byte
Since:
1.0


eachByte

public static void eachByte(InputStream is, int bufferLen, Closure closure)
Traverse through each the specified stream reading bytes into a buffer and calling the 2 parameter closure with this buffer and the number of bytes.
throws:
IOException if an IOException occurs.
Parameters:
is - stream to iterate over, closed after the method call.
bufferLen - the length of the buffer to use.
closure - a 2 parameter closure which is passed the byte[] and a number of bytes successfully read.
Since:
1.7.4


eachByte

public static void eachByte(URL url, Closure closure)
Reads the InputStream from this URL, passing each byte to the given closure. The URL stream will be closed before this method returns.
throws:
IOException if an IOException occurs.
Parameters:
url - url to iterate over
closure - closure to apply to each byte
See Also:
eachByte(java.io.InputStream, groovy.lang.Closure)
Since:
1.0


eachByte

public static void eachByte(URL url, int bufferLen, Closure closure)
Reads the InputStream from this URL, passing a byte[] and a number of bytes to the given closure. The URL stream will be closed before this method returns.
throws:
IOException if an IOException occurs.
Parameters:
url - url to iterate over
bufferLen - the length of the buffer to use.
closure - a 2 parameter closure which is passed the byte[] and a number of bytes successfully read.
See Also:
eachByte(java.io.InputStream, int, groovy.lang.Closure)
Since:
1.7.4


eachDir

public static void eachDir(File self, Closure closure)
Invokes the closure for each subdirectory in this directory, ignoring regular files.
throws:
FileNotFoundException if the given directory does not exist
throws:
IllegalArgumentException if the provided File object does not represent a directory
Parameters:
self - a File (that happens to be a folder/directory)
closure - a closure (first parameter is the subdirectory file)
See Also:
File.listFiles
eachFile(java.io.File, groovy.io.FileType, groovy.lang.Closure)
Since:
1.0


eachDirMatch

public static void eachDirMatch(File self, Object nameFilter, Closure closure)
Invokes the closure for each subdirectory whose name (dir.name) matches the given nameFilter in the given directory - calling the isCase(java.lang.Object, java.lang.Object) method to determine if a match occurs. This method can be used with different kinds of filters like regular expressions, classes, ranges etc. Only subdirectories are matched; regular files are ignored.
throws:
FileNotFoundException if the given directory does not exist
throws:
IllegalArgumentException if the provided File object does not represent a directory
Parameters:
self - a file
nameFilter - the nameFilter to perform on the name of the directory (using the isCase(java.lang.Object, java.lang.Object) method)
closure - the closure to invoke
See Also:
eachFileMatch(java.io.File, groovy.io.FileType, java.lang.Object, groovy.lang.Closure)
Since:
1.5.0


eachDirRecurse

public static void eachDirRecurse(File self, Closure closure)
Invokes the closure for each descendant directory of this directory. Sub-directories are recursively searched in a depth-first fashion. Only subdirectories are passed to the closure; regular files are ignored.
throws:
FileNotFoundException if the given directory does not exist
throws:
IllegalArgumentException if the provided File object does not represent a directory
Parameters:
self - a directory
closure - a closure
See Also:
eachFileRecurse(java.io.File, groovy.io.FileType, groovy.lang.Closure)
Since:
1.5.0


eachFile

public static void eachFile(File self, FileType fileType, Closure closure)
Invokes the closure for each 'child' file in this 'parent' folder/directory. Both regular files and subfolders/subdirectories can be processed depending on the fileType enum value.
throws:
FileNotFoundException if the given directory does not exist
throws:
IllegalArgumentException if the provided File object does not represent a directory
Parameters:
self - a file object
fileType - if normal files or directories or both should be processed
closure - the closure to invoke
Since:
1.7.1


eachFile

public static void eachFile(File self, Closure closure)
Invokes the closure for each 'child' file in this 'parent' folder/directory. Both regular files and subfolders/subdirectories are processed.
throws:
FileNotFoundException if the given directory does not exist
throws:
IllegalArgumentException if the provided File object does not represent a directory
Parameters:
self - a File (that happens to be a folder/directory)
closure - a closure (first parameter is the 'child' file)
See Also:
File.listFiles
eachFile(java.io.File, groovy.io.FileType, groovy.lang.Closure)
Since:
1.5.0


eachFileMatch

public static void eachFileMatch(File self, FileType fileType, Object nameFilter, Closure closure)
Invokes the closure for each file whose name (file.name) matches the given nameFilter in the given directory - calling the isCase(java.lang.Object, java.lang.Object) method to determine if a match occurs. This method can be used with different kinds of filters like regular expressions, classes, ranges etc. Both regular files and subdirectories may be candidates for matching depending on the value of fileType.
 // collect names of files in baseDir matching supplied regex pattern
 import static groovy.io.FileType.*
 def names = []
 baseDir.eachFileMatch FILES, ~/foo\d\.txt/, { names << it.name }
 assert names == ['foo1.txt', 'foo2.txt']

 // remove all *.bak files in baseDir
 baseDir.eachFileMatch FILES, ~/.*\.bak/, { File bak -> bak.delete() }

 // print out files > 4K in size from baseDir
 baseDir.eachFileMatch FILES, { new File(baseDir, it).size() > 4096 }, { println "$it.name ${it.size()}" }
 
throws:
FileNotFoundException if the given directory does not exist
throws:
IllegalArgumentException if the provided File object does not represent a directory
Parameters:
self - a file
fileType - whether normal files or directories or both should be processed
nameFilter - the filter to perform on the name of the file/directory (using the isCase(java.lang.Object, java.lang.Object) method)
closure - the closure to invoke
Since:
1.7.1


eachFileMatch

public static void eachFileMatch(File self, Object nameFilter, Closure closure)
Invokes the closure for each file whose name (file.name) matches the given nameFilter in the given directory - calling the isCase(java.lang.Object, java.lang.Object) method to determine if a match occurs. This method can be used with different kinds of filters like regular expressions, classes, ranges etc. Both regular files and subdirectories are matched.
throws:
FileNotFoundException if the given directory does not exist
throws:
IllegalArgumentException if the provided File object does not represent a directory
Parameters:
self - a file
nameFilter - the nameFilter to perform on the name of the file (using the isCase(java.lang.Object, java.lang.Object) method)
closure - the closure to invoke
See Also:
eachFileMatch(java.io.File, groovy.io.FileType, java.lang.Object, groovy.lang.Closure)
Since:
1.5.0


eachFileRecurse

public static void eachFileRecurse(File self, FileType fileType, Closure closure)
Invokes the closure for each descendant file in this directory. Sub-directories are recursively searched in a depth-first fashion. Both regular files and subdirectories may be passed to the closure depending on the value of fileType.
throws:
FileNotFoundException if the given directory does not exist
throws:
IllegalArgumentException if the provided File object does not represent a directory
Parameters:
self - a file object
fileType - if normal files or directories or both should be processed
closure - the closure to invoke on each file
Since:
1.7.1


eachFileRecurse

public static void eachFileRecurse(File self, Closure closure)
Invokes the closure for each descendant file in this directory. Sub-directories are recursively searched in a depth-first fashion. Both regular files and subdirectories are passed to the closure.
throws:
FileNotFoundException if the given directory does not exist
throws:
IllegalArgumentException if the provided File object does not represent a directory
Parameters:
self - a File
closure - a closure
See Also:
eachFileRecurse(java.io.File, groovy.io.FileType, groovy.lang.Closure)
Since:
1.0


eachLine

public static Object eachLine(String self, Closure closure)
Iterates through this String line by line. Each line is passed to the given 1 or 2 arg closure. If a 2 arg closure is found the line count is passed as the second argument.
throws:
java.io.IOException if an error occurs
Parameters:
self - a String
closure - a closure
Returns:
the last value returned by the closure
See Also:
eachLine(java.lang.String, int, groovy.lang.Closure)
Since:
1.5.5


eachLine

public static Object eachLine(String self, int firstLine, Closure closure)
Iterates through this String line by line. Each line is passed to the given 1 or 2 arg closure. If a 2 arg closure is found the line count is passed as the second argument.
throws:
java.io.IOException if an error occurs
Parameters:
self - a String
firstLine - the line number value used for the first line (default is 1, set to 0 to start counting from 0)
closure - a closure (arg 1 is line, optional arg 2 is line number)
Returns:
the last value returned by the closure
Since:
1.5.7


eachLine

public static Object eachLine(File self, Closure closure)
Iterates through this file line by line. Each line is passed to the given 1 or 2 arg closure. The file is read using a reader which is closed before this method returns.
throws:
IOException if an IOException occurs.
Parameters:
self - a File
closure - a closure (arg 1 is line, optional arg 2 is line number starting at line 1)
Returns:
the last value returned by the closure
See Also:
eachLine(java.io.File, int, groovy.lang.Closure)
Since:
1.5.5


eachLine

public static Object eachLine(File self, String charset, Closure closure)
Iterates through this file line by line. Each line is passed to the given 1 or 2 arg closure. The file is read using a reader which is closed before this method returns.
throws:
IOException if an IOException occurs.
Parameters:
self - a File
charset - opens the file with a specified charset
closure - a closure (arg 1 is line, optional arg 2 is line number starting at line 1)
Returns:
the last value returned by the closure
See Also:
eachLine(java.io.File, java.lang.String, int, groovy.lang.Closure)
Since:
1.6.8


eachLine

public static Object eachLine(File self, int firstLine, Closure closure)
Iterates through this file line by line. Each line is passed to the given 1 or 2 arg closure. The file is read using a reader which is closed before this method returns.
throws:
IOException if an IOException occurs.
Parameters:
self - a File
firstLine - the line number value used for the first line (default is 1, set to 0 to start counting from 0)
closure - a closure (arg 1 is line, optional arg 2 is line number)
Returns:
the last value returned by the closure
See Also:
eachLine(java.io.Reader, int, groovy.lang.Closure)
Since:
1.5.7


eachLine

public static Object eachLine(File self, String charset, int firstLine, Closure closure)
Iterates through this file line by line. Each line is passed to the given 1 or 2 arg closure. The file is read using a reader which is closed before this method returns.
throws:
IOException if an IOException occurs.
Parameters:
self - a File
charset - opens the file with a specified charset
firstLine - the line number value used for the first line (default is 1, set to 0 to start counting from 0)
closure - a closure (arg 1 is line, optional arg 2 is line number)
Returns:
the last value returned by the closure
See Also:
eachLine(java.io.Reader, int, groovy.lang.Closure)
Since:
1.6.8


eachLine

public static Object eachLine(InputStream stream, String charset, Closure closure)
Iterates through this stream reading with the provided charset, passing each line to the given 1 or 2 arg closure. The stream is closed before this method returns.
throws:
IOException if an IOException occurs.
Parameters:
stream - a stream
charset - opens the stream with a specified charset
closure - a closure (arg 1 is line, optional arg 2 is line number starting at line 1)
Returns:
the last value returned by the closure
See Also:
eachLine(java.io.InputStream, java.lang.String, int, groovy.lang.Closure)
Since:
1.5.5


eachLine

public static Object eachLine(InputStream stream, String charset, int firstLine, Closure closure)
Iterates through this stream reading with the provided charset, passing each line to the given 1 or 2 arg closure. The stream is closed after this method returns.
throws:
IOException if an IOException occurs.
Parameters:
stream - a stream
charset - opens the stream with a specified charset
firstLine - the line number value used for the first line (default is 1, set to 0 to start counting from 0)
closure - a closure (arg 1 is line, optional arg 2 is line number)
Returns:
the last value returned by the closure
See Also:
eachLine(java.io.Reader, int, groovy.lang.Closure)
Since:
1.5.7


eachLine

public static Object eachLine(InputStream stream, Closure closure)
Iterates through this stream, passing each line to the given 1 or 2 arg closure. The stream is closed before this method returns.
throws:
IOException if an IOException occurs.
Parameters:
stream - a stream
closure - a closure (arg 1 is line, optional arg 2 is line number starting at line 1)
Returns:
the last value returned by the closure
See Also:
eachLine(java.io.InputStream, int, groovy.lang.Closure)
Since:
1.5.6


eachLine

public static Object eachLine(InputStream stream, int firstLine, Closure closure)
Iterates through this stream, passing each line to the given 1 or 2 arg closure. The stream is closed before this method returns.
throws:
IOException if an IOException occurs.
Parameters:
stream - a stream
firstLine - the line number value used for the first line (default is 1, set to 0 to start counting from 0)
closure - a closure (arg 1 is line, optional arg 2 is line number)
Returns:
the last value returned by the closure
See Also:
eachLine(java.io.Reader, int, groovy.lang.Closure)
Since:
1.5.7


eachLine

public static Object eachLine(URL url, Closure closure)
Iterates through the lines read from the URL's associated input stream passing each line to the given 1 or 2 arg closure. The stream is closed before this method returns.
throws:
IOException if an IOException occurs.
Parameters:
url - a URL to open and read
closure - a closure to apply on each line (arg 1 is line, optional arg 2 is line number starting at line 1)
Returns:
the last value returned by the closure
See Also:
eachLine(java.net.URL, int, groovy.lang.Closure)
Since:
1.5.6


eachLine

public static Object eachLine(URL url, int firstLine, Closure closure)
Iterates through the lines read from the URL's associated input stream passing each line to the given 1 or 2 arg closure. The stream is closed before this method returns.
throws:
IOException if an IOException occurs.
Parameters:
url - a URL to open and read
firstLine - the line number value used for the first line (default is 1, set to 0 to start counting from 0)
closure - a closure to apply on each line (arg 1 is line, optional arg 2 is line number)
Returns:
the last value returned by the closure
See Also:
eachLine(java.io.InputStream, int, groovy.lang.Closure)
Since:
1.5.7


eachLine

public static Object eachLine(URL url, String charset, Closure closure)
Iterates through the lines read from the URL's associated input stream passing each line to the given 1 or 2 arg closure. The stream is closed before this method returns.
throws:
IOException if an IOException occurs.
Parameters:
url - a URL to open and read
charset - opens the stream with a specified charset
closure - a closure to apply on each line (arg 1 is line, optional arg 2 is line number starting at line 1)
Returns:
the last value returned by the closure
See Also:
eachLine(java.net.URL, java.lang.String, int, groovy.lang.Closure)
Since:
1.5.6


eachLine

public static Object eachLine(URL url, String charset, int firstLine, Closure closure)
Iterates through the lines read from the URL's associated input stream passing each line to the given 1 or 2 arg closure. The stream is closed before this method returns.
throws:
IOException if an IOException occurs.
Parameters:
url - a URL to open and read
charset - opens the stream with a specified charset
firstLine - the line number value used for the first line (default is 1, set to 0 to start counting from 0)
closure - a closure to apply on each line (arg 1 is line, optional arg 2 is line number)
Returns:
the last value returned by the closure
See Also:
eachLine(java.io.Reader, int, groovy.lang.Closure)
Since:
1.5.7


eachLine

public static Object eachLine(Reader self, Closure closure)
Iterates through the given reader line by line. Each line is passed to the given 1 or 2 arg closure. If the closure has two arguments, the line count is passed as the second argument. The Reader is closed before this method returns.
throws:
IOException if an IOException occurs.
Parameters:
self - a Reader, closed after the method returns
closure - a closure (arg 1 is line, optional arg 2 is line number starting at line 1)
Returns:
the last value returned by the closure
See Also:
eachLine(java.io.Reader, int, groovy.lang.Closure)
Since:
1.5.6


eachLine

public static Object eachLine(Reader self, int firstLine, Closure closure)
Iterates through the given reader line by line. Each line is passed to the given 1 or 2 arg closure. If the closure has two arguments, the line count is passed as the second argument. The Reader is closed before this method returns.
throws:
IOException if an IOException occurs.
Parameters:
self - a Reader, closed after the method returns
firstLine - the line number value used for the first line (default is 1, set to 0 to start counting from 0)
closure - a closure which will be passed each line (or for 2 arg closures the line and line count)
Returns:
the last value returned by the closure
Since:
1.5.7


eachMatch

public static String eachMatch(String self, String regex, Closure closure)
Process each regex group matched substring of the given string. If the closure parameter takes one argument, an array with all match groups is passed to it. If the closure takes as many arguments as there are match groups, then each parameter will be one match group.
Parameters:
self - the source string
regex - a Regex string
closure - a closure with one parameter or as much parameters as groups
Returns:
the source string
Since:
1.6.0


eachMatch

public static String eachMatch(String self, Pattern pattern, Closure closure)
Process each regex group matched substring of the given pattern. If the closure parameter takes one argument, an array with all match groups is passed to it. If the closure takes as many arguments as there are match groups, then each parameter will be one match group.
Parameters:
self - the source string
pattern - a regex Pattern
closure - a closure with one parameter or as much parameters as groups
Returns:
the source string
Since:
1.6.1


eachObject

public static void eachObject(File self, Closure closure)
Iterates through the given file object by object.
throws:
IOException if an IOException occurs.
throws:
ClassNotFoundException if the class is not found.
Parameters:
self - a File
closure - a closure
See Also:
eachObject(java.io.ObjectInputStream, groovy.lang.Closure)
Since:
1.0


eachObject

public static void eachObject(ObjectInputStream ois, Closure closure)
Iterates through the given object stream object by object. The ObjectInputStream is closed afterwards.
throws:
IOException if an IOException occurs.
throws:
ClassNotFoundException if the class is not found.
Parameters:
ois - an ObjectInputStream, closed after the operation
closure - a closure
Since:
1.0


eachPermutation

public static Iterator eachPermutation(Collection self, Closure closure)
Iterates over all permutations of a collection, running a closure for each iteration.
def permutations = []
 [1, 2, 3].eachPermutation{ permutations << it }
 assert permutations == [[1, 2, 3], [1, 3, 2], [2, 1, 3], [2, 3, 1], [3, 1, 2], [3, 2, 1]]
Parameters:
self - the Collection of items
closure - the closure to call for each permutation
Returns:
the permutations from the list
Since:
1.7.0


eachWithIndex

public static Object eachWithIndex(Object self, Closure closure)
Iterates through an aggregate type or data structure, passing each item and the item's index (a counter starting at zero) to the given closure.
Parameters:
self - an Object
closure - a Closure to operate on each item
Returns:
the self Object
Since:
1.0


eachWithIndex

public static Map eachWithIndex(Map self, Closure closure)
Allows a Map to be iterated through using a closure. If the closure takes two parameters then it will be passed the Map.Entry and the item's index (a counter starting at zero) otherwise if the closure takes three parameters then it will be passed the key, the value, and the index.
def result = ""
 [a:1, b:3].eachWithIndex { key, value, index -> result += "$index($key$value)" }
 assert result == "0(a1)1(b3)"
def result = ""
 [a:1, b:3].eachWithIndex { entry, index -> result += "$index($entry)" }
 assert result == "0(a=1)1(b=3)"
Parameters:
self - the map over which we iterate
closure - a 2 or 3 arg Closure to operate on each item
Returns:
the self Object
Since:
1.5.0


encodeBase64

@Deprecated
public static Writable encodeBase64(Byte[] data, boolean chunked)
deprecated:
moved to EncodingGroovyMethods.encodeBase64


encodeBase64

@Deprecated
public static Writable encodeBase64(Byte[] data)
deprecated:
moved to EncodingGroovyMethods.encodeBase64


encodeBase64

@Deprecated
public static Writable encodeBase64(byte[] data, boolean chunked)
deprecated:
moved to EncodingGroovyMethods.encodeBase64


encodeBase64

@Deprecated
public static Writable encodeBase64(byte[] data)
deprecated:
moved to EncodingGroovyMethods.encodeBase64


equals

public static boolean equals(int[] left, int[] right)
Compare the contents of this array to the contents of the given array.
Parameters:
left - an int array
right - the operand array.
Returns:
true if the contents of both arrays are equal.
Since:
1.5.0


equals

public static boolean equals(Object[] left, List right)
Determines if the contents of this array are equal to the contents of the given list, in the same order. This returns false if either collection is null.
Parameters:
left - this array
right - the list being compared
Returns:
true if the contents of both collections are equal
Since:
1.5.0


equals

public static boolean equals(List left, Object[] right)
Determines if the contents of this list are equal to the contents of the given array in the same order. This returns false if either collection is null.
assert [1, "a"].equals( [ 1, "a" ] as Object[] )
Parameters:
left - this List
right - this Object[] being compared to
Returns:
true if the contents of both collections are equal
Since:
1.5.0


equals

public static boolean equals(List left, List right)
Compare the contents of two Lists. Order matters. If numbers exist in the Lists, then they are compared as numbers, for example 2 == 2L. If both lists are null, the result is true; otherwise if either list is null, the result is false.
assert ["a", 2].equals(["a", 2])
 assert ![2, "a"].equals("a", 2)
 assert [2.0, "a"].equals(2L, "a") // number comparison at work
Parameters:
left - this List
right - the List being compared to.
Returns:
boolean true if the contents of both lists are identical, false otherwise.
Since:
1.0


every

public static boolean every(Object self, Closure closure)
Used to determine if the given predicate closure is valid (i.e.&nsbp;returns true for all items in this data structure). A simple example for a list:
def list = [3,4,5]
 def greaterThanTwo = list.every { it > 2 }
 
Parameters:
self - the object over which we iterate
closure - the closure predicate used for matching
Returns:
true if every iteration of the object matches the closure predicate
Since:
1.0


every

public static boolean every(Map self, Closure closure)
Iterates over the entries of a map, and checks whether a predicate is valid for all entries. If the closure takes one parameter then it will be passed the Map.Entry otherwise if the closure takes two parameters then it will be passed the key and the value.
def map = [a:1, b:2.0, c:2L]
 assert !map.every { key, value -> value instanceof Integer }
 assert map.every { entry -> entry.value instanceof Number }
Parameters:
self - the map over which we iterate
closure - the 1 or 2 arg Closure predicate used for matching
Returns:
true if every entry of the map matches the closure predicate
Since:
1.5.0


every

public static boolean every(Object self)
Iterates over every element of a collection, and checks whether all elements are true according to the Groovy Truth. Equivalent to self.every({element -> element})
Parameters:
self - the object over which we iterate
Returns:
true if every item in the collection matches the closure predicate
Since:
1.5.0


execute

public static Process execute(String self)
Executes the command specified by self as a command-line process.

For more control over Process construction you can use java.lang.ProcessBuilder (JDK 1.5+).

throws:
IOException if an IOException occurs.
Parameters:
self - a command line String
Returns:
the Process which has just started for this command line representation
Since:
1.0


execute

public static Process execute(String self, String[] envp, File dir)
Executes the command specified by self with environment defined by envp and under the working directory dir.

For more control over Process construction you can use java.lang.ProcessBuilder (JDK 1.5+).

throws:
IOException if an IOException occurs.
Parameters:
self - a command line String to be executed.
envp - an array of Strings, each element of which has environment variable settings in the format name=value, or null if the subprocess should inherit the environment of the current process.
dir - the working directory of the subprocess, or null if the subprocess should inherit the working directory of the current process.
Returns:
the Process which has just started for this command line representation.
Since:
1.0


execute

public static Process execute(String self, List envp, File dir)
Executes the command specified by self with environment defined by envp and under the working directory dir.

For more control over Process construction you can use java.lang.ProcessBuilder (JDK 1.5+).

throws:
IOException if an IOException occurs.
Parameters:
self - a command line String to be executed.
envp - a List of Objects (converted to Strings using toString), each member of which has environment variable settings in the format name=value, or null if the subprocess should inherit the environment of the current process.
dir - the working directory of the subprocess, or null if the subprocess should inherit the working directory of the current process.
Returns:
the Process which has just started for this command line representation.
Since:
1.0


execute

public static Process execute(String[] commandArray)
Executes the command specified by the given String array. The first item in the array is the command; the others are the parameters.

For more control over Process construction you can use java.lang.ProcessBuilder (JDK 1.5+).

throws:
IOException if an IOException occurs.
Parameters:
commandArray - an array of String containing the command name and parameters as separate items in the array.
Returns:
the Process which has just started for this command line representation.
Since:
1.0


execute

public static Process execute(String[] commandArray, String[] envp, File dir)
Executes the command specified by the String array given in the first parameter, with the environment defined by envp and under the working directory dir. The first item in the array is the command; the others are the parameters.

For more control over Process construction you can use java.lang.ProcessBuilder (JDK 1.5+).

throws:
IOException if an IOException occurs.
Parameters:
commandArray - an array of String containing the command name and parameters as separate items in the array.
envp - an array of Strings, each member of which has environment variable settings in the format name=value, or null if the subprocess should inherit the environment of the current process.
dir - the working directory of the subprocess, or null if the subprocess should inherit the working directory of the current process.
Returns:
the Process which has just started for this command line representation.
Since:
1.7.1


execute

public static Process execute(String[] commandArray, List envp, File dir)
Executes the command specified by the String array given in the first parameter, with the environment defined by envp and under the working directory dir. The first item in the array is the command; the others are the parameters.

For more control over Process construction you can use java.lang.ProcessBuilder (JDK 1.5+).

throws:
IOException if an IOException occurs.
Parameters:
commandArray - an array of String containing the command name and parameters as separate items in the array.
envp - a List of Objects (converted to Strings using toString), each member of which has environment variable settings in the format name=value, or null if the subprocess should inherit the environment of the current process.
dir - the working directory of the subprocess, or null if the subprocess should inherit the working directory of the current process.
Returns:
the Process which has just started for this command line representation.
Since:
1.7.1


execute

public static Process execute(List commands)
Executes the command specified by the given list. The toString() method is called for each item in the list to convert into a resulting String. The first item in the list is the command the others are the parameters.

For more control over Process construction you can use java.lang.ProcessBuilder (JDK 1.5+).

throws:
IOException if an IOException occurs.
Parameters:
commands - a list containing the command name and parameters as separate items in the list.
Returns:
the Process which has just started for this command line representation.
Since:
1.0


execute

public static Process execute(List commands, String[] envp, File dir)
Executes the command specified by the given list, with the environment defined by envp and under the working directory dir. The first item in the list is the command; the others are the parameters. The toString() method is called on items in the list to convert them to Strings.

For more control over Process construction you can use java.lang.ProcessBuilder (JDK 1.5+).

throws:
IOException if an IOException occurs.
Parameters:
commands - a List containing the command name and parameters as separate items in the list.
envp - an array of Strings, each member of which has environment variable settings in the format name=value, or null if the subprocess should inherit the environment of the current process.
dir - the working directory of the subprocess, or null if the subprocess should inherit the working directory of the current process.
Returns:
the Process which has just started for this command line representation.
Since:
1.7.1


execute

public static Process execute(List commands, List envp, File dir)
Executes the command specified by the given list, with the environment defined by envp and under the working directory dir. The first item in the list is the command; the others are the parameters. The toString() method is called on items in the list to convert them to Strings.

For more control over Process construction you can use java.lang.ProcessBuilder (JDK 1.5+).

throws:
IOException if an IOException occurs.
Parameters:
commands - a List containing the command name and parameters as separate items in the list.
envp - a List of Objects (converted to Strings using toString), each member of which has environment variable settings in the format name=value, or null if the subprocess should inherit the environment of the current process.
dir - the working directory of the subprocess, or null if the subprocess should inherit the working directory of the current process.
Returns:
the Process which has just started for this command line representation.
Since:
1.7.1


expand

public static String expand(String self)
Expands all tabs into spaces with tabStops of size 8.
Parameters:
self - A String to expand
Returns:
The expanded String
See Also:
expand(java.lang.String, int)
Since:
1.7.3


expand

public static String expand(String self, int tabStop)
Expands all tabs into spaces.
Parameters:
self - A String to expand
tabStop - The number of spaces a tab represents
Returns:
The expanded String
Since:
1.7.3


expandLine

public static String expandLine(String self, int tabStop)
Expands all tabs into spaces.
Parameters:
self - A line to expand
tabStop - The number of spaces a tab represents
Returns:
The expanded String
Since:
1.7.3


filterLine

public static void filterLine(Reader reader, Writer writer, Closure closure)
Filter the lines from a reader and write them on the writer, according to a closure which returns true if the line should be included. Both Reader and Writer are closed after the operation.
throws:
IOException if an IOException occurs.
Parameters:
reader - a reader, closed after the call
writer - a writer, closed after the call
closure - the closure which returns booleans
Since:
1.0


filterLine

public static Writable filterLine(File self, Closure closure)
Filters the lines of a File and creates a Writeable in return to stream the filtered lines.
throws:
IOException if self is not readable
Parameters:
self - a File
closure - a closure which returns a boolean indicating to filter the line or not
Returns:
a Writable closure
See Also:
filterLine(java.io.Reader, groovy.lang.Closure)
Since:
1.0


filterLine

public static Writable filterLine(File self, String charset, Closure closure)
Filters the lines of a File and creates a Writeable in return to stream the filtered lines.
throws:
IOException if an IOException occurs
Parameters:
self - a File
charset - opens the file with a specified charset
closure - a closure which returns a boolean indicating to filter the line or not
Returns:
a Writable closure
See Also:
filterLine(java.io.Reader, groovy.lang.Closure)
Since:
1.6.8


filterLine

public static void filterLine(File self, Writer writer, Closure closure)
Filter the lines from this File, and write them to the given writer based on the given closure predicate.
throws:
IOException if self is not readable
Parameters:
self - a File
writer - a writer destination to write filtered lines to
closure - a closure which takes each line as a parameter and returns true if the line should be written to this writer.
See Also:
filterLine(java.io.Reader, java.io.Writer, groovy.lang.Closure)
Since:
1.0


filterLine

public static void filterLine(File self, Writer writer, String charset, Closure closure)
Filter the lines from this File, and write them to the given writer based on the given closure predicate.
throws:
IOException if an IO error occurs
Parameters:
self - a File
writer - a writer destination to write filtered lines to
charset - opens the file with a specified charset
closure - a closure which takes each line as a parameter and returns true if the line should be written to this writer.
See Also:
filterLine(java.io.Reader, java.io.Writer, groovy.lang.Closure)
Since:
1.6.8


filterLine

public static Writable filterLine(Reader reader, Closure closure)
Filter the lines from this Reader, and return a Writable which can be used to stream the filtered lines to a destination. The closure should return true if the line should be passed to the writer.
Parameters:
reader - this reader
closure - a closure used for filtering
Returns:
a Writable which will use the closure to filter each line from the reader when the Writable#writeTo(Writer) is called.
Since:
1.0


filterLine

public static Writable filterLine(InputStream self, Closure predicate)
Filter lines from an input stream using a closure predicate. The closure will be passed each line as a String, and it should return true if the line should be passed to the writer.
Parameters:
self - an input stream
predicate - a closure which returns boolean and takes a line
Returns:
a writable which writes out the filtered lines
See Also:
filterLine(java.io.Reader, groovy.lang.Closure)
Since:
1.0


filterLine

public static Writable filterLine(InputStream self, String charset, Closure predicate)
Filter lines from an input stream using a closure predicate. The closure will be passed each line as a String, and it should return true if the line should be passed to the writer.
throws:
UnsupportedEncodingException if the encoding specified is not supported
Parameters:
self - an input stream
charset - opens the stream with a specified charset
predicate - a closure which returns boolean and takes a line
Returns:
a writable which writes out the filtered lines
See Also:
filterLine(java.io.Reader, groovy.lang.Closure)
Since:
1.6.8


filterLine

public static void filterLine(InputStream self, Writer writer, Closure predicate)
Uses a closure to filter lines from this InputStream and pass them to the given writer. The closure will be passed each line as a String, and it should return true if the line should be passed to the writer.
throws:
IOException if an IOException occurs.
Parameters:
self - the InputStream
writer - a writer to write output to
predicate - a closure which returns true if a line should be accepted
See Also:
filterLine(java.io.Reader, java.io.Writer, groovy.lang.Closure)
Since:
1.0


filterLine

public static void filterLine(InputStream self, Writer writer, String charset, Closure predicate)
Uses a closure to filter lines from this InputStream and pass them to the given writer. The closure will be passed each line as a String, and it should return true if the line should be passed to the writer.
throws:
IOException if an IOException occurs.
Parameters:
self - the InputStream
writer - a writer to write output to
charset - opens the stream with a specified charset
predicate - a closure which returns true if a line should be accepted
See Also:
filterLine(java.io.Reader, java.io.Writer, groovy.lang.Closure)
Since:
1.6.8


filterLine

public static Writable filterLine(URL self, Closure predicate)
Filter lines from a URL using a closure predicate. The closure will be passed each line as a String, and it should return true if the line should be passed to the writer.
throws:
IOException if an IO exception occurs
Parameters:
self - a URL
predicate - a closure which returns boolean and takes a line
Returns:
a writable which writes out the filtered lines
See Also:
filterLine(java.io.Reader, groovy.lang.Closure)
Since:
1.6.8


filterLine

public static Writable filterLine(URL self, String charset, Closure predicate)
Filter lines from a URL using a closure predicate. The closure will be passed each line as a String, and it should return true if the line should be passed to the writer.
throws:
IOException if an IO exception occurs
Parameters:
self - the URL
charset - opens the URL with a specified charset
predicate - a closure which returns boolean and takes a line
Returns:
a writable which writes out the filtered lines
See Also:
filterLine(java.io.Reader, groovy.lang.Closure)
Since:
1.6.8


filterLine

public static void filterLine(URL self, Writer writer, Closure predicate)
Uses a closure to filter lines from this URL and pass them to the given writer. The closure will be passed each line as a String, and it should return true if the line should be passed to the writer.
throws:
IOException if an IOException occurs.
Parameters:
self - the URL
writer - a writer to write output to
predicate - a closure which returns true if a line should be accepted
See Also:
filterLine(java.io.Reader, java.io.Writer, groovy.lang.Closure)
Since:
1.6.8


filterLine

public static void filterLine(URL self, Writer writer, String charset, Closure predicate)
Uses a closure to filter lines from this URL and pass them to the given writer. The closure will be passed each line as a String, and it should return true if the line should be passed to the writer.
throws:
IOException if an IOException occurs.
Parameters:
self - the URL
writer - a writer to write output to
charset - opens the URL with a specified charset
predicate - a closure which returns true if a line should be accepted
See Also:
filterLine(java.io.Reader, java.io.Writer, groovy.lang.Closure)
Since:
1.6.8


find

public static Object find(Object self, Closure closure)
Finds the first value matching the closure condition
Parameters:
self - an Object with an iterator returning its values
closure - a closure condition
Returns:
the first Object found
Since:
1.0


find

public static T find(Collection self, Closure closure)
Finds the first value matching the closure condition. Example:
def list = [1,2,3]
 assert 2 == list.find { it > 1 }
 
Parameters:
self - a Collection
closure - a closure condition
Returns:
the first Object found
Since:
1.0


find

public static def find(Map self, Closure closure)
Finds the first entry matching the closure condition. If the closure takes two parameters, the entry key and value are passed. If the closure takes one parameter, the Map.Entry object is passed.
assert [a:1, b:3].find { it.value == 3 }.key == "b"
Parameters:
self - a Map
closure - a 1 or 2 arg Closure condition
Returns:
the first Object found
Since:
1.0


find

public static String find(String self, String regex)
Finds the first occurrence of a regular expression String within a String. If the regex doesn't match, null will be returned.

For example, if the regex doesn't match the result is null:

     assert null == "New York, NY".find(/\d{5}/)
 

If it does match, we get the matching string back:

      assert "10292" == "New York, NY 10292-0098".find(/\d{5}/)
 

If we have capture groups in our expression, we still get back the full match

      assert "10292-0098" == "New York, NY 10292-0098".find(/(\d{5})-?(\d{4})/)
 

Parameters:
self - a String
regex - the capturing regex
Returns:
a String containing the matched portion, or null if the regex doesn't match
Since:
1.6.1


find

public static String find(String self, Pattern pattern)
Finds the first occurrence of a compiled regular expression Pattern within a String. If the pattern doesn't match, null will be returned.

For example, if the pattern doesn't match the result is null:

     assert null == "New York, NY".find(~/\d{5}/)
 

If it does match, we get the matching string back:

      assert "10292" == "New York, NY 10292-0098".find(~/\d{5}/)
 

If we have capture groups in our expression, the groups are ignored and we get back the full match:

      assert "10292-0098" == "New York, NY 10292-0098".find(~/(\d{5})-?(\d{4})/)
 
If you need to work with capture groups, then use the closure version of this method or use Groovy's matcher operators or use eachMatch.

Parameters:
self - a String
pattern - the compiled regex Pattern
Returns:
a String containing the matched portion, or null if the regex pattern doesn't match
Since:
1.6.1


find

public static String find(String self, String regex, Closure closure)
Finds the first occurrence of a regular expression String within a String. If the regex doesn't match, the closure will not be called and find will return null.

For example, if the regex doesn't match, the result is null:

     assert null == "New York, NY".find(~/\d{5}/) { match -> return "-$match-"}
 

If it does match and we don't have any capture groups in our regex, there is a single parameter on the closure that the match gets passed to:

      assert "-10292-" == "New York, NY 10292-0098".find(~/\d{5}/) { match -> return "-$match-"}
 

If we have capture groups in our expression, our closure has one parameter for the match, followed by one for each of the capture groups:

      assert "10292" == "New York, NY 10292-0098".find(~/(\d{5})-?(\d{4})/) { match, zip, plusFour ->
          assert match == "10292-0098"
          assert zip == "10292"
          assert plusFour == "0098"
          return zip
      }
 

If we have capture groups in our expression, and our closure has one parameter, the closure will be passed an array with the first element corresponding to the whole match, followed by an element for each of the capture groups:

      assert "10292" == "New York, NY 10292-0098".find(~/(\d{5})-?(\d{4})/) { match, zip, plusFour ->
          assert array[0] == "10292-0098"
          assert array[1] == "10292"
          assert array[2] == "0098"
          return array[1]
      }
 

If a capture group is optional, and doesn't match, then the corresponding value for that capture group passed to the closure will be null as illustrated here:

      assert "2339999" == "adsf 233-9999 adsf".find(~/(\d{3})?-?(\d{3})-(\d{4})/) { match, areaCode, exchange, stationNumber ->
          assert "233-9999" == match
          assert null == areaCode
          assert "233" == exchange
          assert "9999" == stationNumber
          return "$exchange$stationNumber"
      }
 

Parameters:
self - a String
regex - the capturing regex string
closure - the closure that will be passed the full match, plus each of the capturing groups
Returns:
a String containing the result of the closure, or null if the regex pattern doesn't match
Since:
1.6.1


find

public static String find(String self, Pattern pattern, Closure closure)
Finds the first occurrence of a compiled regular expression Pattern within a String. If the pattern doesn't match, the closure will not be called and find will return null.

For example, if the pattern doesn't match, the result is null:

     assert null == "New York, NY".find(~/\d{5}/) { match -> return "-$match-"}
 

If it does match and we don't have any capture groups in our regex, there is a single parameter on the closure that the match gets passed to:

      assert "-10292-" == "New York, NY 10292-0098".find(~/\d{5}/) { match -> return "-$match-"}
 

If we have capture groups in our expression, our closure has one parameter for the match, followed by one for each of the capture groups:

      assert "10292" == "New York, NY 10292-0098".find(~/(\d{5})-?(\d{4})/) { match, zip, plusFour ->
          assert match == "10292-0098"
          assert zip == "10292"
          assert plusFour == "0098"
          return zip
      }
 

If we have capture groups in our expression, and our closure has one parameter, the closure will be passed an array with the first element corresponding to the whole match, followed by an element for each of the capture groups:

      assert "10292" == "New York, NY 10292-0098".find(~/(\d{5})-?(\d{4})/) { match, zip, plusFour ->
          assert array[0] == "10292-0098"
          assert array[1] == "10292"
          assert array[2] == "0098"
          return array[1]
      }
 

If a capture group is optional, and doesn't match, then the corresponding value for that capture group passed to the closure will be null as illustrated here:

      assert "2339999" == "adsf 233-9999 adsf".find(~/(\d{3})?-?(\d{3})-(\d{4})/) { match, areaCode, exchange, stationNumber ->
          assert "233-9999" == match
          assert null == areaCode
          assert "233" == exchange
          assert "9999" == stationNumber
          return "$exchange$stationNumber"
      }
 

Parameters:
self - a String
pattern - the compiled regex Pattern
closure - the closure that will be passed the full match, plus each of the capturing groups
Returns:
a String containing the result of the closure, or null if the regex pattern doesn't match
Since:
1.6.1


findAll

public static Collection findAll(Collection self, Closure closure)
Finds all values matching the closure condition.
assert [2,4] == [1,2,3,4].findAll { it % 2 == 0 }
Parameters:
self - a Collection
closure - a closure condition
Returns:
a Collection of matching values
Since:
1.5.6


findAll

public static Collection findAll(Object self, Closure closure)
Finds all items matching the closure condition.
Parameters:
self - an Object with an Iterator returning its values
closure - a closure condition
Returns:
a List of the values found
Since:
1.6.0


findAll

public static Map findAll(Map self, Closure closure)
Finds all entries matching the closure condition. If the closure takes one parameter then it will be passed the Map.Entry. Otherwise if the closure should take two parameters, which will be the key and the value.

If the self map is one of TreeMap, LinkedHashMap, Hashtable or Properties, the returned Map will preserve that type, otherwise a HashMap will be returned.

def result = [a:1, b:2, c:4, d:5].findAll { it.value % 2 == 0 }
 assert result.every { it instanceof Map.Entry }
 assert result*.key == ["b", "c"]
 assert result*.value == [2, 4]
Parameters:
self - a Map
closure - a 1 or 2 arg Closure condition applying on the entries
Returns:
a new subMap
Since:
1.0


findAll

public static List findAll(String self, String regex)
Finds all occurrences of a regular expression string within a String. A List is returned containing all full matches or an empty list if there are no matches within the string.

For example, if the regex doesn't match, it returns an empty list:

 assert [] == "foo".findAll(/(\w*) Fish/)
 

Any regular expression matches are returned in a list, and all regex capture groupings are ignored, only the full match is returned:

 def expected = ["One Fish", "Two Fish", "Red Fish", "Blue Fish"]
 assert expected == "One Fish, Two Fish, Red Fish, Blue Fish".findAll(/(\w*) Fish/)
 
If you need to work with capture groups, then use the closure version of this method or use Groovy's matcher operators or use eachMatch.

Parameters:
self - a String
regex - the capturing regex String
Returns:
a List containing all full matches of the regex within the string, an empty list will be returned if there are no matches
Since:
1.6.1


findAll

public static List findAll(String self, Pattern pattern)
Finds all occurrences of a regular expression Pattern within a String. A List is returned containing all full matches or an empty list if there are no matches within the string.

For example, if the pattern doesn't match, it returns an empty list:

 assert [] == "foo".findAll(~/(\w*) Fish/)
 

Any regular expression matches are returned in a list, and all regex capture groupings are ignored, only the full match is returned:

 def expected = ["One Fish", "Two Fish", "Red Fish", "Blue Fish"]
 assert expected == "One Fish, Two Fish, Red Fish, Blue Fish".findAll(~/(\w*) Fish/)
 
Parameters:
self - a String
pattern - the compiled regex Pattern
Returns:
a List containing all full matches of the Pattern within the string, an empty list will be returned if there are no matches
Since:
1.6.1


findAll

public static List findAll(String self, String regex, Closure closure)
Finds all occurrences of a regular expression string within a String. Any matches are passed to the specified closure. The closure is expected to have the full match in the first parameter. If there are any capture groups, they will be placed in subsequent parameters.

If there are no matches, the closure will not be called, and an empty List will be returned.

For example, if the regex doesn't match, it returns an empty list:

 assert [] == "foo".findAll(/(\w*) Fish/) { match, firstWord -> return firstWord }
 

Any regular expression matches are passed to the closure, if there are no capture groups, there will be one parameter for the match:

 assert ["couldn't", "wouldn't"] == "I could not, would not, with a fox.".findAll(/.ould/) { match -> "${match}n't"}
 

If there are capture groups, the first parameter will be the match followed by one parameter for each capture group:

 def orig = "There's a Wocket in my Pocket"
 assert ["W > Wocket", "P > Pocket"] == orig.findAll(/(.)ocket/) { match, firstLetter -> "$firstLetter > $match" }
 
Parameters:
self - a String
regex - the capturing regex String
closure - will be passed the full match plus each of the capturing groups
Returns:
a List containing all full matches of the regex within the string, an empty list will be returned if there are no matches
Since:
1.6.1


findAll

public static List findAll(String self, Pattern pattern, Closure closure)
Finds all occurrences of a compiled regular expression Pattern within a String. Any matches are passed to the specified closure. The closure is expected to have the full match in the first parameter. If there are any capture groups, they will be placed in subsequent parameters.

If there are no matches, the closure will not be called, and an empty List will be returned.

For example, if the pattern doesn't match, it returns an empty list:

 assert [] == "foo".findAll(~/(\w*) Fish/) { match, firstWord -> return firstWord }
 

Any regular expression matches are passed to the closure, if there are no capture groups, there will be one parameter for the match:

 assert ["couldn't", "wouldn't"] == "I could not, would not, with a fox.".findAll(~/.ould/) { match -> "${match}n't"}
 

If there are capture groups, the first parameter will be the match followed by one parameter for each capture group:

 def orig = "There's a Wocket in my Pocket"
 assert ["W > Wocket", "P > Pocket"] == orig.findAll(~/(.)ocket/) { match, firstLetter -> "$firstLetter > $match" }
 
Parameters:
self - a String
pattern - the compiled regex Pattern
closure - will be passed the full match plus each of the capturing groups
Returns:
a List containing all full matches of the regex Pattern within the string, an empty list will be returned if there are no matches
Since:
1.6.1


findIndexOf

public static int findIndexOf(Object self, Closure closure)
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.
Parameters:
self - the iteration object over which to iterate
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.0


findIndexOf

public static int findIndexOf(Object self, int startIndex, Closure closure)
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


findIndexValues

public static List findIndexValues(Object self, 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.
Parameters:
self - the iteration object over which to iterate
closure - the filter to perform a match on the collection
Returns:
a list of numbers corresponding to the index values of all matched objects
Since:
1.5.2


findIndexValues

public static List findIndexValues(Object self, Number startIndex, Closure closure)
Iterates over the elements of an iterable collection of items, starting from a specified startIndex, and returns the index values of the items that match 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:
a list of numbers corresponding to the index values of all matched objects
Since:
1.5.2


findLastIndexOf

public static int findLastIndexOf(Object self, Closure closure)
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.
Parameters:
self - the iteration object over which to iterate
closure - the filter to perform a match on the collection
Returns:
an integer that is the index of the last matched object or -1 if no match was found
Since:
1.5.2


findLastIndexOf

public static int findLastIndexOf(Object self, int startIndex, Closure closure)
Iterates over the elements of an iterable collection of items, starting from a specified startIndex, and returns the index of the last 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 last matched object or -1 if no match was found
Since:
1.5.2


findResult

public static Object findResult(Object self, Object defaultResult, Closure closure)
Iterates through the object and returns the first non-null result from the closure, otherwise returns the defaultResult
Parameters:
self - an Object with an iterator returning its values
defaultResult - an Object that should be returned if all closure results are null
closure - a closure that returns a non-null value when processing should stop
Returns:
the first non-null result of the closure, otherwise the default value
Since:
1.7.5


findResult

public static Object findResult(Object self, Closure closure)
Iterates through the object and returns the first non-null result from the closure
Parameters:
self - an Object with an iterator returning its values
closure - a closure that returns a non-null value when processing should stop
Returns:
the first non-null result of the closure
Since:
1.7.5


findResult

public static Object findResult(Collection self, Object defaultResult, Closure closure)
Iterates through the object and returns the first non-null result from the closure, if all are null, it returns the defaultResult. Examples:
def list = [1,2,3]
 assert "Found 2" == list.findResult("default") { it > 1 ? "Found $it" : null }

 assert "default" == list.findResult("default") { it > 3 ? "Found $it" : null }
 
Parameters:
self - a Collection
defaultResult - an Object that should be returned if all closure results are null
closure - a closure that returns a non-null value when processing should stop and a value should be returned
Returns:
the first non-null result of the closure
Since:
1.7.5


findResult

public static Object findResult(Collection self, Closure closure)
Iterates through the object and returns the first non-null result from the closure. Example:
def list = [1,2,3]
 assert "Found 2" == list.findResult { it > 1 ? "Found $it" : null }
 
Parameters:
self - a Collection
closure - a closure that returns a non-null value when processing should stop and a value should be returned
Returns:
the first non-null result of the closure
Since:
1.7.5


findResult

public static Object findResult(Map self, Object defaultResult, Closure closure)
Returns the first non-null closure result by passing each map entry to the closure, otherwise it returns the defaultResult. If the closure takes two parameters, the entry key and value are passed. If the closure takes one parameter, the Map.Entry object is passed.
     assert "Found b:3" == [a:1, b:3].findResult("default") { if (it.value == 3) return "Found ${it.key}:${it.value}" }

     assert "default" == [a:1, b:3].findResult("default") { if (it.value == 9) return "Found ${it.key}:${it.value}" }
 
Parameters:
self - a Map
defaultResult - an Object that should be returned if all closure results are null
closure - a 1 or 2 arg Closure that returns a non-null value when processing should stop and a value should be returned
Returns:
a Map.Entry where the key is the key of the first non-null result of the closure and the value is that result
Since:
1.7.5


findResult

public static Object findResult(Map self, Closure closure)
Returns the first non-null closure result by passing each map entry to the closure. If the closure takes two parameters, the entry key and value are passed. If the closure takes one parameter, the Map.Entry object is passed.
     assert "Found b:3" == [a:1, b:3].findResult { if (it.value == 3) return "Found ${it.key}:${it.value}" }
 
Parameters:
self - a Map
closure - a 1 or 2 arg Closure that returns a non-null value when processing should stop and a value should be returned
Returns:
a Map.Entry where the key is the key of the first non-null result of the closure and the value is that result
Since:
1.7.5


first

public static T first(List self)
Returns the first item from the List.
def list = [3, 4, 2]
 assert list.first() == 3
 assert list == [3, 4, 2]
throws:
NoSuchElementException if the list is empty and you try to access the first() item.
Parameters:
self - a List
Returns:
the first item from the List
Since:
1.5.5


first

public static T first(T[] self)
Returns the first item from the Object array.
def array = [3, 4, 2].toArray()
 assert array.first() == 3
throws:
NoSuchElementException if the array is empty and you try to access the first() item.
Parameters:
self - an Object array
Returns:
the first item from the Object array
Since:
1.7.3


flatten

public static Collection flatten(Collection self)
Flatten a collection. This collection and any nested arrays or collections have their contents (recursively) added to the new collection.
assert [1,2,3,4,5] == [1,[2,3],[[4]],[],5].flatten()
Parameters:
self - a Collection to flatten
Returns:
a flattened Collection
Since:
1.6.0


flatten

public static Collection flatten(Object[] self)
Flatten an array. This array and any nested arrays or collections have their contents (recursively) added to the new collection.
Parameters:
self - an Array to flatten
Returns:
a flattened Collection
Since:
1.6.0


flatten

public static Collection flatten(boolean[] self)
Flatten an array. This array and any nested arrays or collections have their contents (recursively) added to the new collection.
Parameters:
self - a boolean Array to flatten
Returns:
a flattened Collection
Since:
1.6.0


flatten

public static Collection flatten(byte[] self)
Flatten an array. This array and any nested arrays or collections have their contents (recursively) added to the new collection.
Parameters:
self - a byte Array to flatten
Returns:
a flattened Collection
Since:
1.6.0


flatten

public static Collection flatten(char[] self)
Flatten an array. This array and any nested arrays or collections have their contents (recursively) added to the new collection.
Parameters:
self - a char Array to flatten
Returns:
a flattened Collection
Since:
1.6.0


flatten

public static Collection flatten(short[] self)
Flatten an array. This array and any nested arrays or collections have their contents (recursively) added to the new collection.
Parameters:
self - a short Array to flatten
Returns:
a flattened Collection
Since:
1.6.0


flatten

public static Collection flatten(int[] self)
Flatten an array. This array and any nested arrays or collections have their contents (recursively) added to the new collection.
Parameters:
self - an int Array to flatten
Returns:
a flattened Collection
Since:
1.6.0


flatten

public static Collection flatten(long[] self)
Flatten an array. This array and any nested arrays or collections have their contents (recursively) added to the new collection.
Parameters:
self - a long Array to flatten
Returns:
a flattened Collection
Since:
1.6.0


flatten

public static Collection flatten(float[] self)
Flatten an array. This array and any nested arrays or collections have their contents (recursively) added to the new collection.
Parameters:
self - a float Array to flatten
Returns:
a flattened Collection
Since:
1.6.0


flatten

public static Collection flatten(double[] self)
Flatten an array. This array and any nested arrays or collections have their contents (recursively) added to the new collection.
Parameters:
self - a double Array to flatten
Returns:
a flattened Collection
Since:
1.6.0


flatten

public static Collection flatten(Collection self, Closure flattenUsing)
Flatten a collection. This collection and any nested arrays or collections have their contents (recursively) added to the new collection. For any non-Array, non-Collection object which represents some sort of collective type, the supplied closure should yield the contained items; otherwise, the closure should just return any element which corresponds to a leaf.
Parameters:
self - a Collection
flattenUsing - a closure to determine how to flatten non-Array, non-Collection elements
Returns:
a flattened Collection
Since:
1.6.0


format

@Deprecated
public static String format(Date self, String format)
deprecated:
moved to DateGroovyMethods.format


format

@Deprecated
public static String format(Calendar self, String pattern)
deprecated:
moved to DateGroovyMethods.format


get

public static V get(Map map, K key, V defaultValue)
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.
def map=[:]
 map.get("a", []) << 5
 assert map == [a:[5]]
Parameters:
map - a Map
key - the key to lookup the value of
defaultValue - the value to return and add to the map for this key if there is no entry for the given key
Returns:
the value of the given key or the default value, added to the map if the key did not exist
Since:
1.0


getAt

public static Object getAt(Object self, String property)
Allows the subscript operator to be used to lookup dynamic property values. bean[somePropertyNameExpression]. The normal property notation of groovy is neater and more concise but only works with compile-time known property names.
Parameters:
self - the object to act upon
property - the property name of interest
Returns:
the property value
Since:
1.0


getAt

public static CharSequence getAt(CharSequence text, int index)
Support the subscript operator for CharSequence.
Parameters:
text - a CharSequence
index - the index of the Character to get
Returns:
the Character at the given index
Since:
1.0


getAt

public static String getAt(String text, int index)
Support the subscript operator for String.
Parameters:
text - a String
index - the index of the Character to get
Returns:
the Character at the given index
Since:
1.0


getAt

public static CharSequence getAt(CharSequence text, Range range)
Support the range subscript operator for CharSequence
Parameters:
text - a CharSequence
range - a Range
Returns:
the subsequence CharSequence
Since:
1.0


getAt

public static CharSequence getAt(CharSequence text, IntRange range)
Support the range subscript operator for CharSequence or StringBuffer with IntRange
Parameters:
text - a CharSequence
range - an IntRange
Returns:
the subsequence CharSequence
Since:
1.0


getAt

public static CharSequence getAt(CharSequence text, EmptyRange range)
Support the range subscript operator for CharSequence or StringBuffer with EmptyRange
Parameters:
text - a CharSequence
range - an EmptyRange
Returns:
the subsequence CharSequence
Since:
1.5.0


getAt

public static String getAt(String text, IntRange range)
Support the range subscript operator for String with IntRange
Parameters:
text - a String
range - an IntRange
Returns:
the resulting String
Since:
1.0


getAt

public static String getAt(String text, EmptyRange range)
Support the range subscript operator for String with EmptyRange
Parameters:
text - a String
range - an EmptyRange
Returns:
the resulting String
Since:
1.5.0


getAt

public static String getAt(String text, Range range)
Support the range subscript operator for String
Parameters:
text - a String
range - a Range
Returns:
a substring corresponding to the Range
Since:
1.0


getAt

public static Object getAt(Matcher matcher, int idx)
Support the subscript operator, e.g. matcher[index], for a regex Matcher.

For an example using no group match,

    def p = /ab[d|f]/
    def m = "abcabdabeabf" =~ p
    assert 2 == m.count
    assert 2 == m.size() // synonym for m.getCount()
    assert ! m.hasGroup()
    assert 0 == m.groupCount()
    def matches = ["abd", "abf"]
    for (i in 0..<m.count) {
      assert m[i] == matches[i]
    }
 

For an example using group matches,

    def p = /(?:ab([c|d|e|f]))/
    def m = "abcabdabeabf" =~ p
    assert 4 == m.count
    assert m.hasGroup()
    assert 1 == m.groupCount()
    def matches = [["abc", "c"], ["abd", "d"], ["abe", "e"], ["abf", "f"]]
    for (i in 0..<m.count) {
      assert m[i] == matches[i]
    }
 

For another example using group matches,

    def m = "abcabdabeabfabxyzabx" =~ /(?:ab([d|x-z]+))/
    assert 3 == m.count
    assert m.hasGroup()
    assert 1 == m.groupCount()
    def matches = [["abd", "d"], ["abxyz", "xyz"], ["abx", "x"]]
    for (i in 0..<m.count) {
      assert m[i] == matches[i]
    }
 
Parameters:
matcher - a Matcher
idx - an index
Returns:
object a matched String if no groups matched, list of matched groups otherwise.
Since:
1.0


getAt

public static List getAt(List self, Range range)
Support the range subscript operator for a List
def list = [1, "a", 4.5, true]
 assert list[1..2] == ["a", 4.5]
Parameters:
self - a List
range - a Range indicating the items to get
Returns:
a sublist based on range borders or a new list if range is reversed
See Also:
List.subList
Since:
1.0


getAt

public static List getAt(List self, EmptyRange range)
Support the range subscript operator for a List
def list = [true, 1, 3.4]
 assert list[0..<0] == []
Parameters:
self - a List
range - a Range indicating the items to get
Returns:
a sublist based on range borders or a new list if range is reversed
See Also:
List.subList
Since:
1.0


getAt

public static List getAt(List self, Collection indices)
Select a List of items from a List using a Collection to identify the indices to be selected.
def list = [true, 1, 3.4, false]
 assert list[1,0,2] == [1, true, 3.4]
Parameters:
self - a List
indices - a Collection of indices
Returns:
a new list of the values at the given indices
Since:
1.0


getAt

public static List getAt(T[] self, Collection indices)
Select a List of items from an Object array using a Collection to identify the indices to be selected.
Parameters:
self - an Array of Objects
indices - a Collection of indices
Returns:
a new list of the values at the given indices
Since:
1.0


getAt

public static CharSequence getAt(CharSequence self, Collection indices)
Select a List of characters from a CharSequence using a Collection to identify the indices to be selected.
Parameters:
self - a CharSequence
indices - a Collection of indices
Returns:
a CharSequence consisting of the characters at the given indices
Since:
1.0


getAt

public static String getAt(String self, Collection indices)
Select a List of characters from a String using a Collection to identify the indices to be selected.
Parameters:
self - a String
indices - a Collection of indices
Returns:
a String consisting of the characters at the given indices
Since:
1.0


getAt

public static List getAt(Matcher self, Collection indices)
Select a List of values from a Matcher using a Collection to identify the indices to be selected.
Parameters:
self - a Matcher
indices - a Collection of indices
Returns:
a String of the values at the given indices
Since:
1.6.0


getAt

public static List getAt(T[] array, Range range)
Support the range subscript operator for an Array
Parameters:
array - an Array of Objects
range - a Range
Returns:
a range of a list from the range's from index up to but not including the range's to value
Since:
1.0


getAt

public static List getAt(T[] array, IntRange range)
Parameters:
array - an Array of Objects
range - an IntRange
Returns:
a range of a list from the range's from index up to but not including the range's to value
Since:
1.0


getAt

public static List getAt(T[] array, EmptyRange range)
Parameters:
array - an Array of Objects
range - an EmptyRange
Returns:
an empty Range
Since:
1.5.0


getAt

public static List getAt(T[] array, ObjectRange range)
Parameters:
array - an Array of Objects
range - an ObjectRange
Returns:
a range of a list from the range's from index up to but not including the range's to value
Since:
1.0


getAt

public static T getAt(List self, int idx)
Support the subscript operator for a List.
def list = [2, "a", 5.3]
 assert list[1] == "a"
Parameters:
self - a List
idx - an index
Returns:
the value at the given index
Since:
1.0


getAt

public static T getAt(Iterator self, int idx)
Support the subscript operator for an Iterator. The iterator will be partially exhausted up until the idx entry after returning if a +ve or 0 idx is used, or fully exhausted if a -ve idx is used or no corresponding entry was found. Typical usage:
 def iter = [2, "a", 5.3].iterator()
 assert iter[1] == "a"
 
A more elaborate example:
 def items = [2, "a", 5.3]
 def iter = items.iterator()
 assert iter[-1] == 5.3
 // iter exhausted, so reset
 iter = items.iterator()
 assert iter[1] == "a"
 // iter partially exhausted so now idx starts after "a"
 assert iter[0] == 5.3
 
Parameters:
self - an Iterator
idx - an index value (-self.size() <= idx < self.size())
Returns:
the value at the given index (after normalisation) or null if no corresponding value was found
Since:
1.7.2


getAt

public static V getAt(Map self, K key)
Support the subscript operator for a Map.
def map = [a:10]
 assert map["a"] == 10
Parameters:
self - a Map
key - an Object as a key for the map
Returns:
the value corresponding to the given key
Since:
1.0


getAt

public static List getAt(Collection coll, String property)
Support the subscript operator for List
assert [String, Long, Integer] == ["a",5L,2]["class"]
Parameters:
coll - a Collection
property - a String
Returns:
a List
Since:
1.0


getAt

@SuppressWarnings("unchecked")
public static List getAt(byte[] array, Range range)
Support the subscript operator with a range for a byte array
Parameters:
array - a byte array
range - a range indicating the indices for the items to retrieve
Returns:
list of the retrieved bytes
Since:
1.0


getAt

@SuppressWarnings("unchecked")
public static List getAt(char[] array, Range range)
Support the subscript operator with a range for a char array
Parameters:
array - a char array
range - a range indicating the indices for the items to retrieve
Returns:
list of the retrieved chars
Since:
1.5.0


getAt

@SuppressWarnings("unchecked")
public static List getAt(short[] array, Range range)
Support the subscript operator with a range for a short array
Parameters:
array - a short array
range - a range indicating the indices for the items to retrieve
Returns:
list of the retrieved shorts
Since:
1.0


getAt

@SuppressWarnings("unchecked")
public static List getAt(int[] array, Range range)
Support the subscript operator with a range for an int array
Parameters:
array - an int array
range - a range indicating the indices for the items to retrieve
Returns:
list of the ints at the given indices
Since:
1.0


getAt

@SuppressWarnings("unchecked")
public static List getAt(long[] array, Range range)
Support the subscript operator with a range for a long array
Parameters:
array - a long array
range - a range indicating the indices for the items to retrieve
Returns:
list of the retrieved longs
Since:
1.0


getAt

@SuppressWarnings("unchecked")
public static List getAt(float[] array, Range range)
Support the subscript operator with a range for a float array
Parameters:
array - a float array
range - a range indicating the indices for the items to retrieve
Returns:
list of the retrieved floats
Since:
1.0


getAt

@SuppressWarnings("unchecked")
public static List getAt(double[] array, Range range)
Support the subscript operator with a range for a double array
Parameters:
array - a double array
range - a range indicating the indices for the items to retrieve
Returns:
list of the retrieved doubles
Since:
1.0


getAt

@SuppressWarnings("unchecked")
public static List getAt(boolean[] array, Range range)
Support the subscript operator with a range for a boolean array
Parameters:
array - a boolean array
range - a range indicating the indices for the items to retrieve
Returns:
list of the retrieved booleans
Since:
1.0


getAt

@SuppressWarnings("unchecked")
public static List getAt(byte[] array, IntRange range)
Support the subscript operator with an IntRange for a byte array
Parameters:
array - a byte array
range - an IntRange indicating the indices for the items to retrieve
Returns:
list of the retrieved bytes
Since:
1.0


getAt

@SuppressWarnings("unchecked")
public static List getAt(char[] array, IntRange range)
Support the subscript operator with an IntRange for a char array
Parameters:
array - a char array
range - an IntRange indicating the indices for the items to retrieve
Returns:
list of the retrieved chars
Since:
1.0


getAt

@SuppressWarnings("unchecked")
public static List getAt(short[] array, IntRange range)
Support the subscript operator with an IntRange for a short array
Parameters:
array - a short array
range - an IntRange indicating the indices for the items to retrieve
Returns:
list of the retrieved shorts
Since:
1.0


getAt

@SuppressWarnings("unchecked")
public static List getAt(int[] array, IntRange range)
Support the subscript operator with an IntRange for an int array
Parameters:
array - an int array
range - an IntRange indicating the indices for the items to retrieve
Returns:
list of the retrieved ints
Since:
1.0


getAt

@SuppressWarnings("unchecked")
public static List getAt(long[] array, IntRange range)
Support the subscript operator with an IntRange for a long array
Parameters:
array - a long array
range - an IntRange indicating the indices for the items to retrieve
Returns:
list of the retrieved longs
Since:
1.0


getAt

@SuppressWarnings("unchecked")
public static List getAt(float[] array, IntRange range)
Support the subscript operator with an IntRange for a float array
Parameters:
array - a float array
range - an IntRange indicating the indices for the items to retrieve
Returns:
list of the retrieved floats
Since:
1.0


getAt

@SuppressWarnings("unchecked")
public static List getAt(double[] array, IntRange range)
Support the subscript operator with an IntRange for a double array
Parameters:
array - a double array
range - an IntRange indicating the indices for the items to retrieve
Returns:
list of the retrieved doubles
Since:
1.0


getAt

@SuppressWarnings("unchecked")
public static List getAt(boolean[] array, IntRange range)
Support the subscript operator with an IntRange for a boolean array
Parameters:
array - a boolean array
range - an IntRange indicating the indices for the items to retrieve
Returns:
list of the retrieved booleans
Since:
1.0


getAt

@SuppressWarnings("unchecked")
public static List getAt(byte[] array, ObjectRange range)
Support the subscript operator with an ObjectRange for a byte array
Parameters:
array - a byte array
range - an ObjectRange indicating the indices for the items to retrieve
Returns:
list of the retrieved bytes
Since:
1.0


getAt

@SuppressWarnings("unchecked")
public static List getAt(char[] array, ObjectRange range)
Support the subscript operator with an ObjectRange for a char array
Parameters:
array - a char array
range - an ObjectRange indicating the indices for the items to retrieve
Returns:
list of the retrieved chars
Since:
1.0


getAt

@SuppressWarnings("unchecked")
public static List getAt(short[] array, ObjectRange range)
Support the subscript operator with an ObjectRange for a short array
Parameters:
array - a short array
range - an ObjectRange indicating the indices for the items to retrieve
Returns:
list of the retrieved shorts
Since:
1.0


getAt

@SuppressWarnings("unchecked")
public static List getAt(int[] array, ObjectRange range)
Support the subscript operator with an ObjectRange for an int array
Parameters:
array - an int array
range - an ObjectRange indicating the indices for the items to retrieve
Returns:
list of the retrieved ints
Since:
1.0


getAt

@SuppressWarnings("unchecked")
public static List getAt(long[] array, ObjectRange range)
Support the subscript operator with an ObjectRange for a long array
Parameters:
array - a long array
range - an ObjectRange indicating the indices for the items to retrieve
Returns:
list of the retrieved longs
Since:
1.0


getAt

@SuppressWarnings("unchecked")
public static List getAt(float[] array, ObjectRange range)
Support the subscript operator with an ObjectRange for a float array
Parameters:
array - a float array
range - an ObjectRange indicating the indices for the items to retrieve
Returns:
list of the retrieved floats
Since:
1.0


getAt

@SuppressWarnings("unchecked")
public static List getAt(double[] array, ObjectRange range)
Support the subscript operator with an ObjectRange for a double array
Parameters:
array - a double array
range - an ObjectRange indicating the indices for the items to retrieve
Returns:
list of the retrieved doubles
Since:
1.0


getAt

@SuppressWarnings("unchecked")
public static List getAt(boolean[] array, ObjectRange range)
Support the subscript operator with an ObjectRange for a byte array
Parameters:
array - a byte array
range - an ObjectRange indicating the indices for the items to retrieve
Returns:
list of the retrieved bytes
Since:
1.0


getAt

@SuppressWarnings("unchecked")
public static List getAt(byte[] array, Collection indices)
Support the subscript operator with a collection for a byte array
Parameters:
array - a byte array
indices - a collection of indices for the items to retrieve
Returns:
list of the bytes at the given indices
Since:
1.0


getAt

@SuppressWarnings("unchecked")
public static List getAt(char[] array, Collection indices)
Support the subscript operator with a collection for a char array
Parameters:
array - a char array
indices - a collection of indices for the items to retrieve
Returns:
list of the chars at the given indices
Since:
1.0


getAt

@SuppressWarnings("unchecked")
public static List getAt(short[] array, Collection indices)
Support the subscript operator with a collection for a short array
Parameters:
array - a short array
indices - a collection of indices for the items to retrieve
Returns:
list of the shorts at the given indices
Since:
1.0


getAt

@SuppressWarnings("unchecked")
public static List getAt(int[] array, Collection indices)
Support the subscript operator with a collection for an int array
Parameters:
array - an int array
indices - a collection of indices for the items to retrieve
Returns:
list of the ints at the given indices
Since:
1.0


getAt

@SuppressWarnings("unchecked")
public static List getAt(long[] array, Collection indices)
Support the subscript operator with a collection for a long array
Parameters:
array - a long array
indices - a collection of indices for the items to retrieve
Returns:
list of the longs at the given indices
Since:
1.0


getAt

@SuppressWarnings("unchecked")
public static List getAt(float[] array, Collection indices)
Support the subscript operator with a collection for a float array
Parameters:
array - a float array
indices - a collection of indices for the items to retrieve
Returns:
list of the floats at the given indices
Since:
1.0


getAt

@SuppressWarnings("unchecked")
public static List getAt(double[] array, Collection indices)
Support the subscript operator with a collection for a double array
Parameters:
array - a double array
indices - a collection of indices for the items to retrieve
Returns:
list of the doubles at the given indices
Since:
1.0


getAt

@SuppressWarnings("unchecked")
public static List getAt(boolean[] array, Collection indices)
Support the subscript operator with a collection for a boolean array
Parameters:
array - a boolean array
indices - a collection of indices for the items to retrieve
Returns:
list of the booleans at the given indices
Since:
1.0


getAt

public static boolean getAt(BitSet self, int index)
Support the subscript operator for a Bitset
Parameters:
self - a BitSet
index - index to retrieve
Returns:
value of the bit at the given index
See Also:
BitSet
Since:
1.5.0


getAt

public static BitSet getAt(BitSet self, IntRange range)
Support retrieving a subset of a BitSet using a Range
Parameters:
self - a BitSet
range - a Range defining the desired subset
Returns:
a new BitSet that represents the requested subset
See Also:
BitSet
IntRange
Since:
1.5.0


getAt

@Deprecated
public static int getAt(Date self, int field)
deprecated:
moved to DateGroovyMethods.getAt


getBytes

public static byte[] getBytes(File file)
Read the content of the File and returns it as a byte[].
throws:
IOException if an IOException occurs.
Parameters:
file - the file whose content we want to read
Returns:
a String containing the content of the file
Since:
1.7.1


getBytes

public static byte[] getBytes(URL url)
Read the content of this URL and returns it as a byte[].
throws:
IOException if an IOException occurs.
Parameters:
url - URL to read content from
Returns:
the byte[] from that URL
Since:
1.7.1


getBytes

public static byte[] getBytes(InputStream is)
Read the content of this InputStream and return it as a byte[]. The stream is closed before this method returns.
throws:
IOException if an IOException occurs.
Parameters:
is - an input stream
Returns:
the byte[] from that InputStream
Since:
1.7.1


getChars

public static char[] getChars(String self)
Converts the given String into an array of characters. Alias for toCharArray.
Parameters:
self - a String
Returns:
an array of characters
See Also:
String.toCharArray
Since:
1.6.0


getCount

public static int getCount(Matcher matcher)
Find the number of Strings matched to the given Matcher.
Parameters:
matcher - a Matcher
Returns:
int the number of Strings matched to the given matcher.
Since:
1.0


getDateString

@Deprecated
public static String getDateString(Date self)
deprecated:
moved to DateGroovyMethods.getDateString


getDateTimeString

@Deprecated
public static String getDateTimeString(Date self)
deprecated:
moved to DateGroovyMethods.getDateTimeString


getErr

@Deprecated
public static InputStream getErr(Process self)
deprecated:
use ProcessGroovyMethods#getErr(Process)


getIn

@Deprecated
public static InputStream getIn(Process self)
deprecated:
use ProcessGroovyMethods#getIn(Process)


getMetaClass

public static MetaClass getMetaClass(Class c)
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


getMetaClass

public static MetaClass getMetaClass(Object obj)
Obtains a MetaClass for an object either from the registry or in the case of a GroovyObject from the object itself.
Parameters:
obj - The object in question
Returns:
The MetaClass
Since:
1.5.0


getMetaClass

public static MetaClass getMetaClass(GroovyObject obj)
Obtains a MetaClass for an object either from the registry or in the case of a GroovyObject from the object itself.
Parameters:
obj - The object in question
Returns:
The MetaClass
Since:
1.6.0


getMetaPropertyValues

public 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'.
Parameters:
self - the receiver object
Returns:
list of PropertyValue objects
See Also:
Expando.getMetaPropertyValues
Since:
1.0


getOut

@Deprecated
public static OutputStream getOut(Process self)
deprecated:
use ProcessGroovyMethods#getOut(Process)


getProperties

public 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.&nsbp;without type() information.
Parameters:
self - the receiver object
Returns:
meta properties as Map of key/value pairs
Since:
1.0


getRootLoader

public static ClassLoader getRootLoader(ClassLoader self)
Iterates through the classloader parents until it finds a loader with a class named "org.codehaus.groovy.tools.RootLoader". If there is no such class null will be returned. The name is used for comparison because a direct comparison using == may fail as the class may be loaded through different classloaders.
Parameters:
self - a ClassLoader
Returns:
the rootLoader for the ClassLoader
See Also:
RootLoader
Since:
1.5.0


getSubList

protected static List getSubList(List self, List splice)


getText

public static String getText(File file, String charset)
Read the content of the File using the specified encoding and return it as a String.
throws:
IOException if an IOException occurs.
Parameters:
file - the file whose content we want to read
charset - the charset used to read the content of the file
Returns:
a String containing the content of the file
Since:
1.0


getText

public static String getText(File file)
Read the content of the File and returns it as a String.
throws:
IOException if an IOException occurs.
Parameters:
file - the file whose content we want to read
Returns:
a String containing the content of the file
Since:
1.0


getText

public static String getText(URL url)
Read the content of this URL and returns it as a String.
throws:
IOException if an IOException occurs.
Parameters:
url - URL to read content from
Returns:
the text from that URL
Since:
1.0


getText

public static String getText(URL url, String charset)
Read the data from this URL and return it as a String. The connection stream is closed before this method returns.
throws:
IOException if an IOException occurs.
Parameters:
url - URL to read content from
charset - opens the stream with a specified charset
Returns:
the text from that URL
See Also:
URLConnection.getInputStream
Since:
1.0


getText

public static String getText(InputStream is)
Read the content of this InputStream and return it as a String. The stream is closed before this method returns.
throws:
IOException if an IOException occurs.
Parameters:
is - an input stream
Returns:
the text from that URL
Since:
1.0


getText

public static String getText(InputStream is, String charset)
Read the content of this InputStream using specified charset and return it as a String. The stream is closed before this method returns.
throws:
IOException if an IOException occurs.
Parameters:
is - an input stream
charset - opens the stream with a specified charset
Returns:
the text from that URL
Since:
1.0


getText

public static String getText(Reader reader)
Read the content of the Reader and return it as a String. The reader is closed before this method returns.
throws:
IOException if an IOException occurs.
Parameters:
reader - a Reader whose content we want to read
Returns:
a String containing the content of the buffered reader
See Also:
getText(java.io.BufferedReader)
Since:
1.0


getText

public static String getText(BufferedReader reader)
Read the content of the BufferedReader and return it as a String. The BufferedReader is closed afterwards.
throws:
IOException if an IOException occurs.
Parameters:
reader - a BufferedReader whose content we want to read
Returns:
a String containing the content of the buffered reader
Since:
1.0


getText

@Deprecated
public static String getText(Process self)
deprecated:
use ProcessGroovyMethods#getText(Process)


getTimeString

@Deprecated
public static String getTimeString(Date self)
deprecated:
moved to DateGroovyMethods.getTimeString


grep

public static Collection grep(Object self, Object filter)
Iterates over every element of the collection and returns each item that matches the given filter - calling the isCase(java.lang.Object, java.lang.Object) method used by switch statements. This method can be used with different kinds of filters like regular expressions, classes, ranges etc. Example:
def list = ['a', 'b', 'aa', 'bc' ]
 def filtered = list.grep( ~/a+/ ) //contains 'a' and 'aa'
 
Parameters:
self - the object over which we iterate
filter - the filter to perform on the object (using the isCase(java.lang.Object, java.lang.Object) method)
Returns:
a collection of objects which match the filter
Since:
1.5.6


groupAnswer

protected static void groupAnswer(Map answer, T element, Object value)
Groups the current element according to the value
Parameters:
answer - the map containing the results
element - the element to be placed
value - the value according to which the element will be placed
Since:
1.5.0


groupBy

public static Map groupBy(Collection self, Closure closure)
Sorts all collection members into groups determined by the supplied mapping closure. The closure should return the key that this item should be grouped by. The returned LinkedHashMap will have an entry for each distinct key returned from the closure, with each value being a list of items for that group.
assert [0:[2,4,6], 1:[1,3,5]] == [1,2,3,4,5,6].groupBy { it % 2 }
Parameters:
self - a collection to group
closure - a closure mapping entries on keys
Returns:
a new Map grouped by keys
Since:
1.0


groupBy

public static Map groupBy(Map self, Closure closure)
Groups the members of a map into sub maps determined by the supplied mapping closure. The closure will be passed a Map.Entry or key and value (depending on the number of parameters the closure accepts) and should return the key that each item should be grouped under. The resulting map will have an entry for each 'group' key returned by the closure, with values being the map members from the original map that belong to each group. (If instead of a map, you want a list of map entries use {code}groupEntriesBy{code}.)

If the self map is one of TreeMap, Hashtable or Properties, the returned Map will preserve that type, otherwise a LinkedHashMap will be returned.

def result = [a:1,b:2,c:3,d:4,e:5,f:6].groupBy { it.value % 2 }
 assert result == [0:[b:2, d:4, f:6], 1:[a:1, c:3, e:5]]
Parameters:
self - a map to group
closure - a closure mapping entries on keys
Returns:
a new Map grouped by keys
Since:
1.0


groupEntriesBy

public static Map groupEntriesBy(Map self, Closure closure)
Groups all map entries into groups determined by the supplied mapping closure. The closure will be passed a Map.Entry or key and value (depending on the number of parameters the closure accepts) and should return the key that each item should be grouped under. The resulting map will have an entry for each 'group' key returned by the closure, with values being the list of map entries that belong to each group. (If instead of a list of map entries, you want an actual map use {code}groupBy{code}.)
def result = [a:1,b:2,c:3,d:4,e:5,f:6].groupEntriesBy { it.value % 2 }
 assert result[0]*.key == ["b", "d", "f"]
 assert result[1]*.value == [1, 3, 5]
Parameters:
self - a map to group
closure - a 1 or 2 arg Closure mapping entries on keys
Returns:
a new Map grouped by keys
Since:
1.5.2


hasGroup

public static boolean hasGroup(Matcher matcher)
Check whether a Matcher contains a group or not.
Parameters:
matcher - a Matcher
Returns:
boolean true if matcher contains at least one group.
Since:
1.0


hasProperty

public static MetaProperty hasProperty(Object self, String name)

Returns true of the implementing MetaClass has a property of the given name

Note that this method will only return true for realised properties and does not take into account implementation of getProperty or propertyMissing

Parameters:
self - The object to inspect
name - The name of the property of interest
Returns:
The found MetaProperty or null if it doesn't exist
See Also:
MetaObjectProtocol.hasProperty
Since:
1.6.1


head

public static T head(List self)
Returns the first item from the List.
def list = [3, 4, 2]
 assert list.head() == 3
 assert list == [3, 4, 2]
throws:
NoSuchElementException if the list is empty and you try to access the head() item.
Parameters:
self - a List
Returns:
the first item from the List
Since:
1.5.5


head

public static T head(T[] self)
Returns the first item from the Object array.
def array = [3, 4, 2].toArray()
 assert array.head() == 3
throws:
NoSuchElementException if the array is empty and you try to access the head() item.
Parameters:
self - an Object array
Returns:
the first item from the Object array
Since:
1.7.3


identity

public static Object identity(Object self, Closure closure)
Allows the closure to be called for the object reference self synonym for 'with()'.
Parameters:
self - the object to have a closure act upon
closure - the closure to call on the object
Returns:
result of calling the closure
Since:
1.0


inject

public static Object inject(Collection self, Object value, Closure closure)
Iterates through the given Collection, passing in the initial value to the 2-arg closure along with the first item. The result is passed back (injected) into the closure along with the second item. The new result is injected back into the closure along with the third item and so on until the entire collection has been used. Also known as foldLeft in functional parlance.
Parameters:
self - a Collection
value - a value
closure - a closure
Returns:
the last value of the last iteration
Since:
1.0


inject

public static Object inject(Iterator self, Object value, Closure closure)
Iterates through the given Iterator, passing in the initial value to the closure along with the first item. The result is passed back (injected) into the closure along with the second item. The new result is injected back into the closure along with the third item and so on until the Iterator has been expired of values. Also known as foldLeft in functional parlance.
Parameters:
self - a Collection
value - a value
closure - a closure
Returns:
the last value of the last iteration
Since:
1.5.0


inject

public static Object inject(Object self, Object value, Closure closure)
Iterates through the given Object, passing in the initial value to the closure along with the first item. The result is passed back (injected) into the closure along with the second item. The new result is injected back into the closure along with the third item and so on until further iteration of the object is not possible. Also known as foldLeft in functional parlance.
Parameters:
self - a Collection
value - a value
closure - a closure
Returns:
the last value of the last iteration
Since:
1.5.0


inject

public static Object inject(Object[] self, Object initialValue, Closure closure)
Iterates through the given array, passing in the initial value to the closure along with the first item. The result is passed back (injected) into the closure along with the second item. The new result is injected back into the closure along with the third item and so on until all elements of the array have been used. Also known as foldLeft in functional parlance.
Parameters:
self - an Object[]
initialValue - an initialValue
closure - a closure
Returns:
the last value of the last iteration
Since:
1.5.0


inspect

public static String inspect(Object self)
Inspects returns the String that matches what would be typed into a terminal to create this object.
Parameters:
self - any Object
Returns:
a String that matches what would be typed into a terminal to create this object. e.g. [1, 'hello'].inspect() -> [1, "hello"]
Since:
1.0


intdiv

public static Number intdiv(Character left, Number right)
Integer Divide a Character by a Number. The ordinal value of the Character is used in the division (the ordinal value is the unicode value which for simple character sets is the ASCII value).
Parameters:
left - a Character
right - a Number
Returns:
a Number (an Integer) resulting from the integer division operation
Since:
1.0


intdiv

public static Number intdiv(Number left, Character right)
Integer Divide a Number by a Character. The ordinal value of the Character is used in the division (the ordinal value is the unicode value which for simple character sets is the ASCII value).
Parameters:
left - a Number
right - a Character
Returns:
a Number (an Integer) resulting from the integer division operation
Since:
1.0


intdiv

public static Number intdiv(Character left, Character right)
Integer Divide two Characters. The ordinal values of the Characters are used in the division (the ordinal value is the unicode value which for simple character sets is the ASCII value).
Parameters:
left - a Character
right - another Character
Returns:
a Number (an Integer) resulting from the integer division operation
Since:
1.0


intdiv

public static Number intdiv(Number left, Number right)
Integer Divide two Numbers.
Parameters:
left - a Number
right - another Number
Returns:
a Number (an Integer) resulting from the integer division operation
Since:
1.0


intersect

public static Collection intersect(Collection left, Collection right)
Create a Collection composed of the intersection of both collections. Any elements that exist in both collections are added to the resultant collection.
assert [4,5] == [1,2,3,4,5].intersect([4,5,6,7,8])
Parameters:
left - a Collection
right - a Collection
Returns:
a Collection as an intersection of both collections
Since:
1.5.6


intersect

public static Map intersect(Map left, Map right)
Create a Map composed of the intersection of both maps. Any entries that exist in both maps are added to the resultant map.
assert [4:4,5:5] == [1:1,2:2,3:3,4:4,5:5].intersect([4:4,5:5,6:6,7:7,8:8])
assert [1: 1, 2: 2, 3: 3, 4: 4].intersect( [1: 1.0, 2: 2, 5: 5] ) == [1:1, 2:2]
Parameters:
left - a map
right - a map
Returns:
a Map as an intersection of both maps
Since:
1.7.4


invokeMethod

public static Object invokeMethod(Object object, String method, Object arguments)
Provide a dynamic method invocation method which can be overloaded in classes to implement dynamic proxies easily.
Parameters:
object - any Object
method - the name of the method to call
arguments - the arguments to use
Returns:
the result of the method call
Since:
1.0


is

public static boolean is(Object self, Object other)
Identity check. Since == is overridden in Groovy with the meaning of equality we need some fallback to check for object identity. Invoke using the 'is' method, like so: def same = this.is(that)
Parameters:
self - an object
other - an object to compare identity with
Returns:
true if self and other are both references to the same instance, false otherwise
Since:
1.0


isAllWhitespace

public static boolean isAllWhitespace(String self)
True if a String only contains whitespace characters.
Parameters:
self - The String to check the characters in
Returns:
true If all characters are whitespace characters
See Also:
Character.isWhitespace


isBigDecimal

public static boolean isBigDecimal(String self)
Determine if a String can be parsed into a BigDecimal.
Parameters:
self - a String
Returns:
true if the string can be parsed
Since:
1.5.0


isBigInteger

public static boolean isBigInteger(String self)
Determine if a String can be parsed into a BigInteger.
Parameters:
self - a String
Returns:
true if the string can be parsed
Since:
1.5.0


isCase

public static boolean isCase(Object caseValue, Object switchValue)
Method for overloading the behavior of the 'case' method in switch statements. The default implementation handles arrays types but otherwise simply delegates to Object#equals, but this may be overridden for other types. In this example:
 switch( a ) {
   case b: //some code
 }
"some code" is called when b.isCase( a ) returns true.
Parameters:
caseValue - the case value
switchValue - the switch value
Returns:
true if the switchValue is deemed to be equal to the caseValue
Since:
1.0


isCase

public static boolean isCase(String caseValue, Object switchValue)
'Case' implementation for a String, which uses String#equals(Object) in order to allow Strings to be used in switch statements. For example:
switch( str ) {
   case 'one' :
   // etc...
 }
Note that this returns true for the case where both the 'switch' and 'case' operand is null.
Parameters:
caseValue - the case value
switchValue - the switch value
Returns:
true if the switchValue's toString() equals the caseValue
Since:
1.0


isCase

public static boolean isCase(GString caseValue, Object switchValue)
'Case' implementation for a GString, which simply calls the equivalet method for String.
Parameters:
caseValue - the case value
switchValue - the switch value
Returns:
true if the switchValue's toString() equals the caseValue
Since:
1.6.0


isCase

public static boolean isCase(Class caseValue, Object switchValue)
Special 'Case' implementation for Class, which allows testing for a certain class in a switch statement. For example:
switch( obj ) {
   case List :
     // obj is a list
     break;
   case Set :
     // etc
 }
     
Parameters:
caseValue - the case value
switchValue - the switch value
Returns:
true if the switchValue is deemed to be assignable from the given class
Since:
1.0


isCase

public static boolean isCase(Collection caseValue, Object switchValue)
'Case' implementation for collections which tests if the 'switch' operand is contained in any of the 'case' values. For example:
switch( 3 ) {
   case [1,3,5]:
     assert true
     break
   default:
     assert false
 }
Parameters:
caseValue - the case value
switchValue - the switch value
Returns:
true if the caseValue is deemed to contain the switchValue
See Also:
Collection.contains
Since:
1.0


isCase

public static boolean isCase(Map caseValue, Object switchValue)
'Case' implementation for maps which tests the groovy truth value obtained using the 'switch' operand as key. For example:
switch( 'foo' ) {
   case [foo:true, bar:false]:
     assert true
     break
   default:
     assert false
 }
Parameters:
caseValue - the case value
switchValue - the switch value
Returns:
the groovy truth value from caseValue corresponding to the switchValue key
Since:
1.7.6


isCase

public static boolean isCase(Pattern caseValue, Object switchValue)
'Case' implementation for the Pattern class, which allows testing a String against a number of regular expressions. For example:
switch( str ) {
   case ~/one/ :
     // the regex 'one' matches the value of str
 }
 
Note that this returns true for the case where both the pattern and the 'switch' values are null.
Parameters:
caseValue - the case value
switchValue - the switch value
Returns:
true if the switchValue is deemed to match the caseValue
Since:
1.0


isCase

public static boolean isCase(Number caseValue, Number switchValue)
Special 'case' implementation for all numbers, which delegates to the compareTo() method for comparing numbers of different types.
Parameters:
caseValue - the case value
switchValue - the switch value
Returns:
true if the numbers are deemed equal
Since:
1.5.0


isDigit

public static boolean isDigit(Character self)
Determines if a character is a digit. Synonym for 'Character.isDigit(this)'.
Parameters:
self - a Character
Returns:
true if the character is a digit
See Also:
Character.isDigit
Since:
1.5.7


isDouble

public static boolean isDouble(String self)
Determine if a String can be parsed into a Double.
Parameters:
self - a String
Returns:
true if the string can be parsed
Since:
1.5.0


isFloat

public static boolean isFloat(String self)
Determine if a String can be parsed into a Float.
Parameters:
self - a String
Returns:
true if the string can be parsed
Since:
1.5.0


isInteger

public static boolean isInteger(String self)
Determine if a String can be parsed into an Integer.
Parameters:
self - a String
Returns:
true if the string can be parsed
Since:
1.5.0


isLetter

public static boolean isLetter(Character self)
Determines if a character is a letter. Synonym for 'Character.isLetter(this)'.
Parameters:
self - a Character
Returns:
true if the character is a letter
See Also:
Character.isLetter
Since:
1.5.7


isLetterOrDigit

public static boolean isLetterOrDigit(Character self)
Determines if a character is a letter or digit. Synonym for 'Character.isLetterOrDigit(this)'.
Parameters:
self - a Character
Returns:
true if the character is a letter or digit
See Also:
Character.isLetterOrDigit
Since:
1.5.7


isLong

public static boolean isLong(String self)
Determine if a String can be parsed into a Long.
Parameters:
self - a String
Returns:
true if the string can be parsed
Since:
1.5.0


isLowerCase

public static boolean isLowerCase(Character self)
Determine if a Character is lowercase. Synonym for 'Character.isLowerCase(this)'.
Parameters:
self - a Character
Returns:
true if the character is lowercase
See Also:
Character.isLowerCase
Since:
1.5.7


isNumber

public static boolean isNumber(String self)
Determine if a String can be parsed into a Number. Synonym for 'isBigDecimal()'.
Parameters:
self - a String
Returns:
true if the string can be parsed
See Also:
isBigDecimal(java.lang.String)
Since:
1.5.0


isUpperCase

public static boolean isUpperCase(Character self)
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


isWhitespace

public static boolean isWhitespace(Character self)
Determines if a character is a whitespace character. Synonym for 'Character.isWhitespace(this)'.
Parameters:
self - a Character
Returns:
true if the character is a whitespace character
See Also:
Character.isWhitespace
Since:
1.5.7


iterator

public static Iterator iterator(T[] a)
Attempts to create an Iterator for the given object by first converting it to a Collection.
Parameters:
a - an array
Returns:
an Iterator for the given Array.
See Also:
DefaultTypeTransformation.asCollection
Since:
1.6.4


iterator

public static Iterator iterator(Object o)
Attempts to create an Iterator for the given object by first converting it to a Collection.
Parameters:
o - an object
Returns:
an Iterator for the given Object.
See Also:
DefaultTypeTransformation.asCollection
Since:
1.0


iterator

public static Iterator iterator(Enumeration enumeration)
Allows an Enumeration to behave like an Iterator. Note that the Iterator.remove method is unsupported since the underlying Enumeration does not provide a mechanism for removing items.
Parameters:
enumeration - an Enumeration object
Returns:
an Iterator for the given Enumeration
Since:
1.0


iterator

public static Iterator iterator(Matcher matcher)
Returns an Iterator which traverses each match.
Parameters:
matcher - a Matcher object
Returns:
an Iterator for a Matcher
See Also:
Matcher.group
Since:
1.0


iterator

public static Iterator iterator(Reader self)
Creates an iterator which will traverse through the reader a line at a time.
Parameters:
self - a Reader object
Returns:
an Iterator for the Reader
See Also:
BufferedReader.readLine
Since:
1.5.0


iterator

public static Iterator iterator(InputStream self)
Standard iterator for a input stream which iterates through the stream content in a byte-based fashion.
Parameters:
self - an InputStream object
Returns:
an Iterator for the InputStream
Since:
1.5.0


iterator

public static Iterator iterator(DataInputStream self)
Standard iterator for a data input stream which iterates through the stream content a Byte at a time.
Parameters:
self - a DataInputStream object
Returns:
an Iterator for the DataInputStream
Since:
1.5.0


iterator

public static Iterator iterator(File self)
Just throws a DeprecationException. DO NOT USE. It used to provide an iterator for text file content one line at a time.
throws:
IOException if there is a problem processing the file (e.g. file is not found)
deprecated:
use File#eachLine instead please
Parameters:
self - a file object
Returns:
a line-based iterator
Since:
1.5.0


iterator

public static Iterator iterator(Iterator self)
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.
Parameters:
self - an iterator object
Returns:
itself
Since:
1.5.0


iterator

@Deprecated
public static Iterator iterator(def nodeList)
deprecated:
moved to XmlGroovyMethods.iterator


join

public static String join(Iterator self, String separator)
Concatenates the toString() representation of each item from the iterator, with the given String as a separator between each item. The iterator will become exhausted of elements after determining the resulting conjoined value.
Parameters:
self - an Iterator of items
separator - a String separator
Returns:
the joined String
Since:
1.5.5


join

public static String join(Collection self, String separator)
Concatenates the toString() representation of each item in this collection, with the given String as a separator between each item.
assert "1, 2, 3" == [1,2,3].join(", ")
Parameters:
self - a Collection of objects
separator - a String separator
Returns:
the joined String
Since:
1.0


join

public static String join(Object[] self, String separator)
Concatenates the toString() representation of each items in this array, with the given String as a separator between each item.
Parameters:
self - an array of Object
separator - a String separator
Returns:
the joined String
Since:
1.0


last

public static T last(List self)
Returns the last item from the List.
def list = [3, 4, 2]
 assert list.last() == 2
 assert list == [3, 4, 2]
throws:
NoSuchElementException if the list is empty and you try to access the last() item.
Parameters:
self - a List
Returns:
the last item from the List
Since:
1.5.5


last

public static T last(T[] self)
Returns the last item from the Object array.
def array = [3, 4, 2].toArray()
 assert array.last() == 2
throws:
NoSuchElementException if the array is empty and you try to access the last() item.
Parameters:
self - an ObjectArray
Returns:
the last item from the Object array
Since:
1.7.3


leftShift

public static Collection leftShift(Collection self, T value)
Overloads the left shift operator to provide an easy way to append objects to a Collection.
def list = [1,2]
 list << 3
 assert list == [1,2,3]
Parameters:
self - a Collection
value - an Object to be added to the collection.
Returns:
same collection, after the value was added to it.
Since:
1.0


leftShift

public static BlockingQueue leftShift(BlockingQueue self, T value)
Overloads the left shift operator to provide an easy way to append objects to a BlockingQueue. In case of bounded queue the method will block till space in the queue become available
def list = new java.util.concurrent.LinkedBlockingQueue ()
 list << 3 << 2 << 1
 assert list.iterator().collect{it} == [3,2,1]
Parameters:
self - a Collection
value - an Object to be added to the collection.
Returns:
same collection, after the value was added to it.
Since:
1.7.1


leftShift

public static Map leftShift(Map self, def entry)
Overloads the left shift operator to provide an easy way to append Map.Entry values to a Map.
Parameters:
self - a Map
entry - a Map.Entry to be added to the Map.
Returns:
same map, after the value has been added to it.
Since:
1.6.0


leftShift

public static Map leftShift(Map self, Map other)
Overloads the left shift operator to provide an easy way to put one maps entries into another map. This allows the compact syntax map1 << map2; otherwise it's just a synonym for putAll though it returns the original map rather than being a void method. Example usage:
def map = [a:1, b:2]
 map << [c:3, d:4]
 assert map == [a:1, b:2, c:3, d:4]
Parameters:
self - a Map
other - another Map whose entries should be added to the original Map.
Returns:
same map, after the values have been added to it.
Since:
1.7.2


leftShift

public static StringBuffer leftShift(String self, Object value)
Overloads the left shift operator to provide an easy way to append multiple objects as string representations to a String.
Parameters:
self - a String
value - an Obect
Returns:
a StringBuffer built from this string
Since:
1.0


leftShift

public static StringBuffer leftShift(StringBuffer self, Object value)
Overloads the left shift operator to provide an easy way to append multiple objects as string representations to a StringBuffer.
Parameters:
self - a StringBuffer
value - a value to append
Returns:
the StringBuffer on which this operation was invoked
Since:
1.0


leftShift

public static Writer leftShift(Writer self, Object value)
Overloads the left shift operator to provide a mechanism to append values to a writer.
throws:
IOException if an I/O error occurs.
Parameters:
self - a Writer
value - a value to append
Returns:
the writer on which this operation was invoked
Since:
1.0


leftShift

public static Number leftShift(Number self, Number operand)
Implementation of the left shift operator for integral types. Non integral Number types throw UnsupportedOperationException.
Parameters:
self - a Number object
operand - the shift distance by which to left shift the number
Returns:
the resulting number
Since:
1.5.0


leftShift

public static Writer leftShift(OutputStream self, Object value)
Overloads the leftShift operator to provide an append mechanism to add values to a stream.
throws:
IOException if an I/O error occurs.
Parameters:
self - an OutputStream
value - a value to append
Returns:
a Writer
Since:
1.0


leftShift

public static void leftShift(ObjectOutputStream self, Object value)
Overloads the leftShift operator to add objects to an ObjectOutputStream.
throws:
IOException if an I/O error occurs.
Parameters:
self - an ObjectOutputStream
value - an object to write to the stream
Since:
1.5.0


leftShift

public static OutputStream leftShift(OutputStream self, InputStream in)
Pipe an InputStream into an OutputStream for efficient stream copying.
throws:
IOException if an I/O error occurs.
Parameters:
self - stream on which to write
in - stream to read from
Returns:
the outputstream itself
Since:
1.0


leftShift

public static OutputStream leftShift(OutputStream self, byte[] value)
Overloads the leftShift operator to provide an append mechanism to add bytes to a stream.
throws:
IOException if an I/O error occurs.
Parameters:
self - an OutputStream
value - a value to append
Returns:
an OutputStream
Since:
1.0


leftShift

public static File leftShift(File file, Object text)
Write the text to the File.
throws:
IOException if an IOException occurs.
Parameters:
file - a File
text - the text to write to the File
Returns:
the original file
Since:
1.0


leftShift

public static File leftShift(File file, byte[] bytes)
Write bytes to a File.
throws:
IOException if an IOException occurs.
Parameters:
file - a File
bytes - the byte array to append to the end of the File
Returns:
the original file
Since:
1.5.0


leftShift

public static File leftShift(File file, InputStream data)
Append binary data to the file. See append(java.io.File, java.io.InputStream)
throws:
IOException if an IOException occurs.
Parameters:
file - a File
data - an InputStream of data to write to the file
Returns:
the file
Since:
1.5.0


leftShift

public static Writer leftShift(Socket self, Object value)
Overloads the left shift operator to provide an append mechanism to add things to the output stream of a socket
throws:
IOException if an IOException occurs.
Parameters:
self - a Socket
value - a value to append
Returns:
a Writer
Since:
1.0


leftShift

public static OutputStream leftShift(Socket self, byte[] value)
Overloads the left shift operator to provide an append mechanism to add bytes to the output stream of a socket
throws:
IOException if an IOException occurs.
Parameters:
self - a Socket
value - a value to append
Returns:
an OutputStream
Since:
1.0


leftShift

@Deprecated
public static Writer leftShift(Process self, Object value)
deprecated:
use ProcessGroovyMethods#leftShift(Process, Object)


leftShift

@Deprecated
public static OutputStream leftShift(Process self, byte[] value)
deprecated:
use ProcessGroovyMethods#leftShift(Process, byte[])


matches

public static boolean matches(String self, Pattern pattern)
Tells whether or not self matches the given compiled regular expression Pattern.
Parameters:
self - the string that is to be matched
pattern - the regex Pattern to which the string of interest is to be matched
Returns:
The resulting String
See Also:
String.matches
Since:
1.6.1


max

public static def max(Map self, Closure closure)
Selects an entry in the map having the maximum calculated value as determined by the supplied closure. If more than one entry has the maximum value, an arbitrary choice is made between the entries having the maximum value.

If the closure has two parameters it is used like a traditional Comparator. I.e. it should compare its two parameters for order, returning a negative integer, zero, or a positive integer when the first parameter is less than, equal to, or greater than the second respectively. Otherwise, the Closure is assumed to take a single parameter and return a Comparable (typically an Integer) which is then used for further comparison. An example:
 def zoo = [monkeys:6, lions:5, tigers:7]
 def mostCommonEntry = zoo.max{ it.value }
 assert mostCommonEntry.value == 7
 def leastCommonEntry = zoo.max{ a, b -> b.value <=> a.value } // double negative!
 assert leastCommonEntry.value == 5
 
Edge case for multiple max values:
 def zoo = [monkeys:6, lions:5, tigers:7]
 def lengthOfNamePlusNumber = { e -> e.key.size() + e.value }
 def ans = zoo.max(lengthOfNamePlusNumber) // one of [monkeys:6, tigers:7]
 assert lengthOfNamePlusNumber(ans) == 13
 
Parameters:
self - a Map
closure - a 1 or 2 arg Closure used to determine the correct ordering
Returns:
the Map.Entry having the maximum value as determined by the closure
Since:
1.7.6


max

public static T max(Collection self)
Adds max() method to Collection objects.
assert 5 == [2,3,1,5,4].max()
Parameters:
self - a Collection
Returns:
the maximum value
See Also:
GroovyCollections.max
Since:
1.0


max

public static T max(Iterator self)
Adds max() method to Iterator objects. The iterator will become exhausted of elements after determining the maximum value.
Parameters:
self - an Iterator
Returns:
the maximum value
See Also:
GroovyCollections.max
Since:
1.5.5


max

public static T max(T[] self)
Adds max() method to Object arrays.
Parameters:
self - an Object array
Returns:
the maximum value
See Also:
max(java.util.Collection)
Since:
1.5.5


max

public static T max(Collection self, Closure closure)
Selects an item in the collection having the maximum value as determined by the supplied closure. If more than one item has the maximum value, an arbitrary choice is made between the items having the maximum value.

If the closure has two parameters it is used like a traditional Comparator. I.e. it should compare its two parameters for order, returning a negative integer, zero, or a positive integer when the first parameter is less than, equal to, or greater than the second respectively. Otherwise, the Closure is assumed to take a single parameter and return a Comparable (typically an Integer) which is then used for further comparison.
assert "hello" == ["hello","hi","hey"].max { it.length() }
assert "hello" == ["hello","hi","hey"].max { a, b -> a.length() <=> b.length() }
 def pets = ['dog', 'elephant', 'anaconda']
 def longestName = pets.max{ it.size() } // one of 'elephant' or 'anaconda'
 assert longestName.size() == 8
 
Parameters:
self - a Collection
closure - a 1 or 2 arg Closure used to determine the correct ordering
Returns:
the maximum value
Since:
1.0


max

public static T max(Iterator self, Closure closure)
Selects the maximum value found from the Iterator using the closure to determine the correct ordering. The iterator will become exhausted of elements after this operation.

If the closure has two parameters it is used like a traditional Comparator. I.e. it should compare its two parameters for order, returning a negative integer, zero, or a positive integer when the first parameter is less than, equal to, or greater than the second respectively. Otherwise, the Closure is assumed to take a single parameter and return a Comparable (typically an Integer) which is then used for further comparison.
Parameters:
self - an Iterator
closure - a Closure used to determine the correct ordering
Returns:
the maximum value
See Also:
max(java.util.Collection, groovy.lang.Closure)
Since:
1.5.5


max

public static T max(T[] self, Closure closure)
Selects the maximum value found from the Object array using the closure to determine the correct ordering.

If the closure has two parameters it is used like a traditional Comparator. I.e. it should compare its two parameters for order, returning a negative integer, zero, or a positive integer when the first parameter is less than, equal to, or greater than the second respectively. Otherwise, the Closure is assumed to take a single parameter and return a Comparable (typically an Integer) which is then used for further comparison.
Parameters:
self - an Object array
closure - a Closure used to determine the correct ordering
Returns:
the maximum value
See Also:
max(java.util.Collection, groovy.lang.Closure)
Since:
1.5.5


max

public static T max(Collection self, Comparator comparator)
Selects the maximum value found in the collection using the given comparator.
assert "hello" == ["hello","hi","hey"].max( { a, b -> a.length() <=> b.length() } as Comparator )
Parameters:
self - a Collection
comparator - a Comparator
Returns:
the maximum value
Since:
1.0


max

public static T max(Iterator self, Comparator comparator)
Selects the maximum value found from the Iterator using the given comparator.
Parameters:
self - an Iterator
comparator - a Comparator
Returns:
the maximum value
Since:
1.5.5


max

public static T max(T[] self, Comparator comparator)
Selects the maximum value found from the Object array using the given comparator.
Parameters:
self - an Object array
comparator - a Comparator
Returns:
the maximum value
Since:
1.5.5


metaClass

public static MetaClass metaClass(Class self, Closure closure)
Sets/updates the metaclass for a given class to a closure.
throws:
GroovyRuntimeException if the metaclass can't be set for this class
Parameters:
self - the class whose metaclass we wish to update
closure - the closure representing the new metaclass
Returns:
the new metaclass value
Since:
1.6.0


metaClass

public static MetaClass metaClass(Object self, Closure closure)
Sets/updates the metaclass for a given object to a closure.
throws:
GroovyRuntimeException if the metaclass can't be set for this object
Parameters:
self - the object whose metaclass we wish to update
closure - the closure representing the new metaclass
Returns:
the new metaclass value
Since:
1.6.0


min

public static T min(Collection self)
Adds min() method to Collection objects.
assert 2 == [4,2,5].min()
Parameters:
self - a Collection
Returns:
the minimum value
See Also:
GroovyCollections.min
Since:
1.0


min

public static T min(Iterator self)
Adds min() method to Iterator objects. The iterator will become exhausted of elements after determining the minimum value.
Parameters:
self - an Iterator
Returns:
the minimum value
See Also:
min(java.util.Collection)
Since:
1.5.5


min

public static T min(T[] self)
Adds min() method to Object arrays.
Parameters:
self - an Object array
Returns:
the minimum value
See Also:
min(java.util.Collection)
Since:
1.5.5


min

public static T min(Collection self, Comparator comparator)
Selects the minimum value found in the collection using the given comparator.
assert "hi" == ["hello","hi","hey"].min( { a, b -> a.length() <=> b.length() } as Comparator )
Parameters:
self - a Collection
comparator - a Comparator
Returns:
the minimum value
Since:
1.0


min

public static T min(Iterator self, Comparator comparator)
Selects the minimum value found from the Iterator using the given comparator.
Parameters:
self - an Iterator
comparator - a Comparator
Returns:
the minimum value
See Also:
min(java.util.Collection, java.util.Comparator)
Since:
1.5.5


min

public static T min(T[] self, Comparator comparator)
Selects the minimum value found from the Object array using the given comparator.
Parameters:
self - an Object array
comparator - a Comparator
Returns:
the minimum value
See Also:
min(java.util.Collection, java.util.Comparator)
Since:
1.5.5


min

public static T min(Collection self, Closure closure)
Selects an item in the collection having the minimum value as determined by the supplied closure. If more than one item has the minimum value, an arbitrary choice is made between the items having the minimum value.

If the closure has two parameters it is used like a traditional Comparator. I.e. it should compare its two parameters for order, returning a negative integer, zero, or a positive integer when the first parameter is less than, equal to, or greater than the second respectively. Otherwise, the Closure is assumed to take a single parameter and return a Comparable (typically an Integer) which is then used for further comparison.
 assert "hi" == ["hello","hi","hey"].min { it.length() }
 
 def lastDigit = { a, b -> a % 10 <=> b % 10 }
 assert [19, 55, 91].min(lastDigit) == 91
 
 def pets = ['dog', 'cat', 'anaconda']
 def shortestName = pets.min{ it.size() } // one of 'dog' or 'cat'
 assert shortestName.size() == 3
 
Parameters:
self - a Collection
closure - a 1 or 2 arg Closure used to determine the correct ordering
Returns:
the minimum value
Since:
1.0


min

public static def min(Map self, Closure closure)
Selects an entry in the map having the minimum calculated value as determined by the supplied closure. If more than one entry has the minimum value, an arbitrary choice is made between the entries having the minimum value.

If the closure has two parameters it is used like a traditional Comparator. I.e. it should compare its two parameters for order, returning a negative integer, zero, or a positive integer when the first parameter is less than, equal to, or greater than the second respectively. Otherwise, the Closure is assumed to take a single parameter and return a Comparable (typically an Integer) which is then used for further comparison.
 def zoo = [monkeys:6, lions:5, tigers:7]
 def leastCommonEntry = zoo.min{ it.value }
 assert leastCommonEntry.value == 5
 def mostCommonEntry = zoo.min{ a, b -> b.value <=> a.value } // double negative!
 assert mostCommonEntry.value == 7
 
Edge case for multiple min values:
 def zoo = [monkeys:6, lions:5, tigers:7]
 def lastCharOfName = { e -> e.key[-1] }
 def ans = zoo.min(lastCharOfName) // some random entry
 assert lastCharOfName(ans) == 's'
 
Parameters:
self - a Map
closure - a 1 or 2 arg Closure used to determine the correct ordering
Returns:
the Map.Entry having the minimum value as determined by the closure
Since:
1.7.6


min

public static T min(Iterator self, Closure closure)
Selects the minimum value found from the Iterator using the closure to determine the correct ordering. The iterator will become exhausted of elements after this operation.

If the closure has two parameters it is used like a traditional Comparator. I.e. it should compare its two parameters for order, returning a negative integer, zero, or a positive integer when the first parameter is less than, equal to, or greater than the second respectively. Otherwise, the Closure is assumed to take a single parameter and return a Comparable (typically an Integer) which is then used for further comparison.
Parameters:
self - an Iterator
closure - a Closure used to determine the correct ordering
Returns:
the minimum value
See Also:
min(java.util.Collection, groovy.lang.Closure)
Since:
1.5.5


min

public static T min(T[] self, Closure closure)
Selects the minimum value found from the Object array using the closure to determine the correct ordering.

If the closure has two parameters it is used like a traditional Comparator. I.e. it should compare its two parameters for order, returning a negative integer, zero, or a positive integer when the first parameter is less than, equal to, or greater than the second respectively. Otherwise, the Closure is assumed to take a single parameter and return a Comparable (typically an Integer) which is then used for further comparison.
Parameters:
self - an Object array
closure - a Closure used to determine the correct ordering
Returns:
the minimum value
See Also:
min(java.util.Collection, groovy.lang.Closure)
Since:
1.5.5


minus

public static Set minus(Set self, Collection operands)
Compare the contents of two Sets for equality using Groovy's coercion rules.

Returns true if the two sets have the same size, and every member of the specified set is contained in this set (or equivalently, every member of this set is contained in the specified set). If numbers exist in the sets, then they are compared as numbers, for example 2 == 2L. If both sets are null, the result is true; otherwise if either set is null, the result is false. Example usage:

Set s1 = ["a", 2]
 def s2 = [2, 'a'] as Set
 Set s3 = [3, 'a']
 def s4 = [2.0, 'a'] as Set
 def s5 = [2L, 'a'] as Set
 assert s1.equals(s2)
 assert !s1.equals(s3)
 assert s1.equals(s4)
 assert s1.equals(s5)
Parameters:
self - this Set
other - the Set being compared to
Returns:
true if the contents of both sets are identical


minus

public static Set minus(Set self, Object operand)
Create a Set composed of the elements of the first set minus the operand.
Parameters:
self - a set object
operand - the operand to remove from the set
Returns:
the resulting set
Since:
1.5.0


minus

@SuppressWarnings("unchecked")
public static T[] minus(T[] self, Collection removeMe)
Create an array composed of the elements of the first array minus the elements of the given collection.
Parameters:
self - an object array
removeMe - a Collection of elements to remove
Returns:
an array with the supplied elements removed
Since:
1.5.5


minus

@SuppressWarnings("unchecked")
public static T[] minus(T[] self, T[] removeMe)
Create an array composed of the elements of the first array minus the elements of the given array.
Parameters:
self - an object array
removeMe - an array of elements to remove
Returns:
an array with the supplied elements removed
Since:
1.5.5


minus

public static List minus(List self, Collection removeMe)
Create a List composed of the elements of the first list minus every occurrence of elements of the given collection.
assert [1, "a", true, true, false, 5.3] - [true, 5.3] == [1, "a", false]
Parameters:
self - a List
removeMe - a Collection of elements to remove
Returns:
a List with the supplied elements removed
Since:
1.0


minus

public static List minus(List self, Object operand)
Create a new List composed of the elements of the first list minus every occurrence of the operand.
assert ["a", 5, 5, true] - 5 == ["a", true]
Parameters:
self - a List object
operand - an element to remove from the list
Returns:
the resulting List with the operand removed
Since:
1.0


minus

public static T[] minus(T[] self, Object operand)
Create a new object array composed of the elements of the first array minus the operand.
Parameters:
self - an object array
operand - an element to remove from the array
Returns:
a new array with the operand removed
Since:
1.5.5


minus

public static Map minus(Map self, Map operands)
Create a Map composed of the entries of the first map minus the entries of the given map.
Parameters:
self - a map object
operands - the entries to remove from the map
Returns:
the resulting map
Since:
1.7.4


minus

public static String minus(String self, Object target)
Remove a part of a String. This replaces the first occurrence of target within self with '' and returns the result. If target is a regex Pattern, the first occurrence of that pattern will be removed (using regex matching), otherwise the first occurrence of target.toString() will be removed.
Parameters:
self - a String
target - an object representing the part to remove
Returns:
a String minus the part to be removed
Since:
1.0


minus

public static Number minus(Character left, Number right)
todo:
maybe a double dispatch thing to handle new large numbers?


minus

public static Number minus(Number left, Character right)
Subtract a Character from a Number. The ordinal value of the Character is used in the subtraction (the ordinal value is the unicode value which for simple character sets is the ASCII value).
Parameters:
left - a Number
right - a Character
Returns:
the Number corresponding to the subtraction of right from left
Since:
1.0


minus

public static Number minus(Character left, Character right)
Subtract one Character from another. The ordinal values of the Characters is used in the comparison (the ordinal value is the unicode value which for simple character sets is the ASCII value).
Parameters:
left - a Character
right - a Character
Returns:
the Number corresponding to the subtraction of right from left
Since:
1.0


minus

@Deprecated
public static Date minus(Date self, int days)
deprecated:
moved to DateGroovyMethods.minus


minus

@Deprecated
public static def minus(def self, int days)
deprecated:
moved to DateGroovyMethods.minus


minus

@Deprecated
public static int minus(Calendar self, Calendar then)
deprecated:
moved to DateGroovyMethods.minus


minus

@Deprecated
public static int minus(Date self, Date then)
deprecated:
moved to DateGroovyMethods.minus


mixin

public static void mixin(MetaClass self, List categoryClasses)
Extend object with category methods. All methods for given class and all super classes will be added to the object.
Parameters:
self - any Class
categoryClasses - a category classes to use
Since:
1.6.0


mixin

public static void mixin(Class self, List categoryClasses)
Extend class globally with category methods. All methods for given class and all super classes will be added to the class.
Parameters:
self - any Class
categoryClasses - a category classes to use
Since:
1.6.0


mixin

public static void mixin(Class self, Class categoryClass)
Extend class globally with category methods.
Parameters:
self - any Class
categoryClass - a category class to use
Since:
1.6.0


mixin

public static void mixin(Class self, Class[] categoryClass)
Extend class globally with category methods.
Parameters:
self - any Class
categoryClass - a category class to use
Since:
1.6.0


mixin

public static void mixin(MetaClass self, Class categoryClass)
Extend class globally with category methods.
Parameters:
self - any Class
categoryClass - a category class to use
Since:
1.6.0


mixin

public static void mixin(MetaClass self, Class[] categoryClass)
Extend class globally with category methods.
Parameters:
self - any Class
categoryClass - a category class to use
Since:
1.6.0


mod

public static Number mod(Number left, Number right)
Performs a division modulus operation. Called by the '%' operator.
Parameters:
left - a Number
right - another Number to mod
Returns:
the modulus result
Since:
1.0


multiply

public static List multiply(Collection self, Number factor)
Create a List composed of the elements of this list, repeated a certain number of times. Note that for non-primitive elements, multiple references to the same instance will be added.
assert [1,2,3,1,2,3] == [1,2,3] * 2
Parameters:
self - a Collection
factor - the number of times to append
Returns:
the multiplied list
Since:
1.0


multiply

public static String multiply(String self, Number factor)
Repeat a String a certain number of times.
throws:
IllegalArgumentException if the number of repetitions is < 0
Parameters:
self - a String to be repeated
factor - the number of times the String should be repeated
Returns:
a String composed of a repetition
Since:
1.0


multiply

public static Number multiply(Character left, Number right)
Multiply a Character by a Number. The ordinal value of the Character is used in the multiplcation (the ordinal value is the unicode value which for simple character sets is the ASCII value).
Parameters:
left - a Character
right - a Number
Returns:
the Number corresponding to the multiplication of left by right
Since:
1.0


multiply

public static Number multiply(Number left, Character right)
Multiply a Number by a Character. The ordinal value of the Character is used in the multiplication (the ordinal value is the unicode value which for simple character sets is the ASCII value).
Parameters:
left - a Number
right - a Character
Returns:
the multiplication of left by right
Since:
1.0


multiply

public static Number multiply(Character left, Character right)
Multiply two Characters. The ordinal values of the Characters are used in the multiplication (the ordinal value is the unicode value which for simple character sets is the ASCII value).
Parameters:
left - a Character
right - another Character
Returns:
the Number corresponding to the multiplication of left by right
Since:
1.0


multiply

public static Number multiply(BigDecimal left, Double right)
Multiply a BigDecimal and a Double. Note: This method was added to enforce the Groovy rule of BigDecimal*Double == Double. Without this method, the multiply(BigDecimal) method in BigDecimal would respond and return a BigDecimal instead. Since BigDecimal is preferred over Number, the Number*Number method is not chosen as in older versions of Groovy.
Parameters:
left - a BigDecimal
right - a Double
Returns:
the multiplication of left by right
Since:
1.0


multiply

public static Number multiply(BigDecimal left, BigInteger right)
Multiply a BigDecimal and a BigInteger. Note: This method was added to enforce the Groovy rule of BigDecimal*long == long. Without this method, the multiply(BigDecimal) method in BigDecimal would respond and return a BigDecimal instead. Since BigDecimal is preferred over Number, the Number*Number method is not chosen as in older versions of Groovy. BigInteger is the fallback for all integer types in Groovy
Parameters:
left - a BigDecimal
right - a BigInteger
Returns:
the multiplication of left by right
Since:
1.0


newDataInputStream

public static DataInputStream newDataInputStream(File file)
Create a data input stream for this file
throws:
FileNotFoundException if the file is not found.
Parameters:
file - a File
Returns:
a DataInputStream of the file
Since:
1.5.0


newDataOutputStream

public static DataOutputStream newDataOutputStream(File file)
Creates a new data output stream for this file.
throws:
IOException if an IOException occurs.
Parameters:
file - a file object
Returns:
the created DataOutputStream
Since:
1.5.0


newInputStream

public static BufferedInputStream newInputStream(File file)
Creates a buffered input stream for this file.
throws:
FileNotFoundException if the file is not found.
Parameters:
file - a File
Returns:
a BufferedInputStream of the file
Since:
1.0


newInputStream

public static BufferedInputStream newInputStream(URL url)
Creates a buffered input stream for this URL.
throws:
MalformedURLException is thrown if the URL is not well formed
throws:
IOException if an I/O error occurs while creating the input stream
Parameters:
url - a URL
Returns:
a BufferedInputStream for the URL
Since:
1.5.2


newInstance

public static T newInstance(Class c)
Convenience method to dynamically create a new instance of this class. Calls the default constructor.
Parameters:
c - a class
Returns:
a new instance of this class
Since:
1.0


newInstance

public static T newInstance(Class c, Object[] args)
Helper to construct a new instance from the given arguments. The constructor is called based on the number and types in the args array. Use newInstance(null) or simply newInstance() for the default (no-arg) constructor.
Parameters:
c - a class
args - the constructor arguments
Returns:
a new instance of this class.
Since:
1.0


newObjectInputStream

public static ObjectInputStream newObjectInputStream(File file)
Create an object input stream for this file.
throws:
IOException if an IOException occurs.
Parameters:
file - a file
Returns:
an object input stream
Since:
1.5.0


newObjectInputStream

public static ObjectInputStream newObjectInputStream(InputStream inputStream)
Create an object input stream for this input stream.
throws:
IOException if an IOException occurs.
Parameters:
inputStream - an input stream
Returns:
an object input stream
Since:
1.5.0


newObjectInputStream

public static ObjectInputStream newObjectInputStream(InputStream inputStream, ClassLoader classLoader)
Create an object input stream for this input stream using the given class loader.
throws:
IOException if an IOException occurs.
Parameters:
inputStream - an input stream
classLoader - the class loader to use when loading the class
Returns:
an object input stream
Since:
1.5.0


newObjectInputStream

public static ObjectInputStream newObjectInputStream(File file, ClassLoader classLoader)
Create an object input stream for this file using the given class loader.
throws:
IOException if an IOException occurs.
Parameters:
file - a file
classLoader - the class loader to use when loading the class
Returns:
an object input stream
Since:
1.5.0


newObjectOutputStream

public static ObjectOutputStream newObjectOutputStream(File file)
Create an object output stream for this file.
throws:
IOException if an IOException occurs.
Parameters:
file - a file
Returns:
an object output stream
Since:
1.5.0


newObjectOutputStream

public static ObjectOutputStream newObjectOutputStream(OutputStream outputStream)
Create an object output stream for this output stream.
throws:
IOException if an IOException occurs.
Parameters:
outputStream - an output stream
Returns:
an object output stream
Since:
1.5.0


newOutputStream

public static BufferedOutputStream newOutputStream(File file)
Create a buffered output stream for this file.
throws:
IOException if an IOException occurs.
Parameters:
file - a file object
Returns:
the created OutputStream
Since:
1.0


newPrintWriter

public static PrintWriter newPrintWriter(File file)
Create a new PrintWriter for this file.
throws:
IOException if an IOException occurs.
Parameters:
file - a File
Returns:
the created PrintWriter
Since:
1.0


newPrintWriter

public static PrintWriter newPrintWriter(File file, String charset)
Create a new PrintWriter for this file, using specified charset.
throws:
IOException if an IOException occurs.
Parameters:
file - a File
charset - the charset
Returns:
a PrintWriter
Since:
1.0


newPrintWriter

public static PrintWriter newPrintWriter(Writer writer)
Create a new PrintWriter for this file, using specified charset.
Parameters:
writer - a writer
Returns:
a PrintWriter
Since:
1.6.0


newReader

public static BufferedReader newReader(File file)
Create a buffered reader for this file.
throws:
IOException if an IOException occurs.
Parameters:
file - a File
Returns:
a BufferedReader
Since:
1.0


newReader

public static BufferedReader newReader(File file, String charset)
Create a buffered reader for this file, using the specified charset as the encoding.
throws:
FileNotFoundException if the File was not found
throws:
UnsupportedEncodingException if the encoding specified is not supported
Parameters:
file - a File
charset - the charset for this File
Returns:
a BufferedReader
Since:
1.0


newReader

public static BufferedReader newReader(InputStream self)
Creates a reader for this input stream.
Parameters:
self - an input stream
Returns:
a reader
Since:
1.0


newReader

public static BufferedReader newReader(InputStream self, String charset)
Creates a reader for this input stream, using the specified charset as the encoding.
throws:
UnsupportedEncodingException if the encoding specified is not supported
Parameters:
self - an input stream
charset - the charset for this input stream
Returns:
a reader
Since:
1.6.0


newReader

public static BufferedReader newReader(URL url)
Creates a buffered reader for this URL.
throws:
MalformedURLException is thrown if the URL is not well formed
throws:
IOException if an I/O error occurs while creating the input stream
Parameters:
url - a URL
Returns:
a BufferedReader for the URL
Since:
1.5.5


newReader

public static BufferedReader newReader(URL url, String charset)
Creates a buffered reader for this URL using the given encoding.
throws:
MalformedURLException is thrown if the URL is not well formed
throws:
IOException if an I/O error occurs while creating the input stream
Parameters:
url - a URL
charset - opens the stream with a specified charset
Returns:
a BufferedReader for the URL
Since:
1.5.5


newWriter

public static BufferedWriter newWriter(File file)
Create a buffered writer for this file.
throws:
IOException if an IOException occurs.
Parameters:
file - a File
Returns:
a BufferedWriter
Since:
1.0


newWriter

public static BufferedWriter newWriter(File file, boolean append)
Creates a buffered writer for this file, optionally appending to the existing file content.
throws:
IOException if an IOException occurs.
Parameters:
file - a File
append - true if data should be appended to the file
Returns:
a BufferedWriter
Since:
1.0


newWriter

public static BufferedWriter newWriter(File file, String charset, boolean append)
Helper method to create a buffered writer for a file. If the given charset is "UTF-16BE" or "UTF-16LE", the requisite byte order mark is written to the stream before the writer is returned.
throws:
IOException if an IOException occurs.
Parameters:
file - a File
charset - the name of the encoding used to write in this file
append - true if in append mode
Returns:
a BufferedWriter
Since:
1.0


newWriter

public static BufferedWriter newWriter(File file, String charset)
Creates a buffered writer for this file, writing data using the given encoding.
throws:
IOException if an IOException occurs.
Parameters:
file - a File
charset - the name of the encoding used to write in this file
Returns:
a BufferedWriter
Since:
1.0


next

public static String next(String self)
This method is called by the ++ operator for the class String. It increments the last character in the given string. If the character in the string is Character.MAX_VALUE a Character.MIN_VALUE will be appended. The empty string is incremented to a string consisting of the character Character.MIN_VALUE.
Parameters:
self - a String
Returns:
an incremented String
Since:
1.0


next

public static Character next(Character self)
Increment a Character by one.
Parameters:
self - a Character
Returns:
an incremented Character
Since:
1.5.7


next

public static Number next(Number self)
Increment a Number by one.
Parameters:
self - a Number
Returns:
an incremented Number
Since:
1.0


next

@Deprecated
public static Date next(Date self)
deprecated:
moved to DateGroovyMethods.next


next

@Deprecated
public static def next(def self)
deprecated:
moved to DateGroovyMethods.next


normalize

public static String normalize(String self)
Return a String with linefeeds and carriage returns normalized to linefeeds.
Parameters:
self - a String object
Returns:
the normalized string
Since:
1.6.0


numberAwareCompareTo

public static int numberAwareCompareTo(Comparable self, Comparable other)
Provides a method that compares two comparables using Groovy's default number aware comparator.
Parameters:
self - a Comparable
other - another Comparable
Returns:
a -ve number, 0 or a +ve number according to Groovy's compareTo contract
Since:
1.6.0


or

public static Number or(Number left, Number right)
Bitwise OR together two numbers.
Parameters:
left - a Number
right - another Number to bitwise OR
Returns:
the bitwise OR of both Numbers
Since:
1.0


or

public static BitSet or(BitSet left, BitSet right)
Bitwise OR together two BitSets. Called when the '|' operator is used between two bit sets.
Parameters:
left - a BitSet
right - another BitSet to bitwise AND
Returns:
the bitwise OR of both BitSets
Since:
1.5.0


or

public static Boolean or(Boolean left, Boolean right)
Logical disjunction of two boolean operators
Parameters:
left - left operator
right - right operator
Returns:
result of logical disjunction
Since:
1.0


or

@Deprecated
public static Process or(Process left, Process right)
deprecated:
use ProcessGroovyMethods#or(Process, Process)


padLeft

public static String padLeft(String self, Number numberOfChars, String padding)
Pad a String to a minimum length specified by numberOfChars, adding the supplied padding String as many times as needed to the left. If the String is already the same size or bigger than the target numberOfChars, then the original String is returned. An example:
 println 'Numbers:'
 [1, 10, 100, 1000].each{ println it.toString().padLeft(5, '*') }
 [2, 20, 200, 2000].each{ println it.toString().padLeft(5, '*_') }
 
will produce output like:
 Numbers:
 ****1
 ***10
 **100
 *1000
 *_*_2
 *_*20
 *_200
 *2000
 
Parameters:
self - a String object
numberOfChars - the total minimum number of characters of the resulting string
padding - the charaters used for padding
Returns:
the String padded to the left
Since:
1.0


padLeft

public static String padLeft(String self, Number numberOfChars)
Pad a String to a minimum length specified by numberOfChars by adding the space character to the left as many times as needed. If the String is already the same size or bigger than the target numberOfChars, then the original String is returned. An example:
 println 'Numbers:'
 [1, 10, 100, 1000].each{ println it.toString().padLeft(5) }
 
will produce output like:
 Numbers:
     1
    10
   100
  1000
 
Parameters:
self - a String object
numberOfChars - the total minimum number of characters of the resulting string
Returns:
the String padded to the left
See Also:
padLeft(String, Number, String)
Since:
1.0


padRight

public static String padRight(String self, Number numberOfChars, String padding)
Pad a String to a minimum length specified by numberOfChars, adding the supplied padding String as many times as needed to the right. If the String is already the same size or bigger than the target numberOfChars, then the original String is returned. An example:
 ['A', 'BB', 'CCC', 'DDDD'].each{ println it.padRight(5, '#') + it.size() }
 
will produce output like:
 A####1
 BB###2
 CCC##3
 DDDD#4
 
Parameters:
self - a String object
numberOfChars - the total minimum number of characters of the resulting string
padding - the charaters used for padding
Returns:
the String padded to the right
Since:
1.0


padRight

public static String padRight(String self, Number numberOfChars)
Pad a String to a minimum length specified by numberOfChars by adding the space character to the right as many times as needed. If the String is already the same size or bigger than the target numberOfChars, then the original String is returned. An example:
 ['A', 'BB', 'CCC', 'DDDD'].each{ println it.padRight(5) + it.size() }
 
will produce output like:
 A    1
 BB   2
 CCC  3
 DDDD 4
 
Parameters:
self - a String object
numberOfChars - the total minimum number of characters of the resulting string
Returns:
the String padded to the right
Since:
1.0


permutations

public static Set permutations(List self)
Finds all permutations of a collection. E.g.
def result = [1, 2, 3].permutations()
 assert result == [[3, 2, 1], [3, 1, 2], [1, 3, 2], [2, 3, 1], [2, 1, 3], [1, 2, 3]] as Set
Parameters:
self - the Collection of items
Returns:
the permutations from the list
Since:
1.7.0


pipeTo

@Deprecated
public static Process pipeTo(Process left, Process right)
deprecated:
use ProcessGroovyMethods#pipeTo(Process, Process)


plus

public static Map plus(Map left, Map right)
Returns a new Map containing all entries from left and right, giving precedence to right. Any keys appearing in both Maps will appear in the resultant map with values from the right operand. If the left map is one of TreeMap, LinkedHashMap, Hashtable or Properties, the returned Map will preserve that type, otherwise a HashMap will be returned.

Roughly equivalent to Map m = new HashMap(); m.putAll(left); m.putAll(right); return m; but with some additional logic to preserve the left Map type for common cases as described above.

assert [a:10, b:20] + [a:5, c:7] == [a:5, b:20, c:7]
Parameters:
left - a Map
right - a Map
Returns:
a new Map containing all entries from left and right
Since:
1.5.0


plus

public static Map plus(Map self, Collection entries)
Returns a new Map containing all entries from self and entries, giving precedence to entries. Any keys appearing in both Maps will appear in the resultant map with values from the entries operand. If self map is one of TreeMap, LinkedHashMap, Hashtable or Properties, the returned Map will preserve that type, otherwise a HashMap will be returned.

Parameters:
self - a Map
entries - a Collection of Map.Entry items to be added to the Map.
Returns:
a new Map containing all key, value pairs from self and entries
Since:
1.6.1


plus

public static Collection plus(Collection left, Collection right)
Create a Collection as a union of two collections. If the left collection is a Set, then the returned collection will be a Set otherwise a List. This operation will always create a new object for the result, while the operands remain unchanged.
assert [1,2,3,4] == [1,2] + [3,4]
Parameters:
left - the left Collection
right - the right Collection
Returns:
the merged Collection
Since:
1.5.0


plus

public static Collection plus(Collection left, T right)
Create a collection as a union of a Collection and an Object. If the collection is a Set, then the returned collection will be a Set otherwise a List. This operation will always create a new object for the result, while the operands remain unchanged.
assert [1,2,3] == [1,2] + 3
Parameters:
left - a Collection
right - an object to add/append
Returns:
the resulting Collection
Since:
1.5.0


plus

public static String plus(String left, Object value)
Appends the String representation of the given operand to this string.
Parameters:
left - a String
value - any Object
Returns:
the new string with the object appended
Since:
1.0


plus

public static String plus(Number value, String right)
Appends a String to the string representation of this number.
Parameters:
value - a Number
right - a String
Returns:
a String
Since:
1.0


plus

public static String plus(StringBuffer left, String value)
Appends a String to this StringBuffer.
Parameters:
left - a StringBuffer
value - a String
Returns:
a String
Since:
1.0


plus

public static Number plus(Character left, Number right)
Add a Character and a Number. The ordinal value of the Character is used in the addition (the ordinal value is the unicode value which for simple character sets is the ASCII value). This operation will always create a new object for the result, while the operands remain unchanged.
Parameters:
left - a Character
right - a Number
Returns:
the Number corresponding to the addition of left and right
See Also:
Integer.valueOf
Since:
1.0


plus

public static Number plus(Number left, Character right)
Add a Number and a Character. The ordinal value of the Character is used in the addition (the ordinal value is the unicode value which for simple character sets is the ASCII value).
Parameters:
left - a Number
right - a Character
Returns:
The Number corresponding to the addition of left and right
See Also:
Integer.valueOf
Since:
1.0


plus

public static Number plus(Character left, Character right)
Add one Character to another. The ordinal values of the Characters are used in the addition (the ordinal value is the unicode value which for simple character sets is the ASCII value). This operation will always create a new object for the result, while the operands remain unchanged.
Parameters:
left - a Character
right - a Character
Returns:
the Number corresponding to the addition of left and right
See Also:
plus(java.lang.Number, java.lang.Character)
Since:
1.0


plus

@Deprecated
public static Date plus(Date self, int days)
deprecated:
moved to DateGroovyMethods.plus


plus

@Deprecated
public static def plus(def self, int days)
deprecated:
moved to DateGroovyMethods.plus


pop

public static T pop(List self)
Removes the last item from the List. Using add() and pop() is similar to push and pop on a Stack.
def list = ["a", false, 2]
 assert list.pop() == 2
 assert list == ["a", false]
throws:
NoSuchElementException if the list is empty and you try to pop() it.
Parameters:
self - a List
Returns:
the item removed from the List
Since:
1.0


power

public static Number power(Number self, Number exponent)
Power of a Number to a certain exponent. Called by the '**' operator.
Parameters:
self - a Number
exponent - a Number exponent
Returns:
a Number to the power of a certain exponent
Since:
1.0


power

public static Number power(BigDecimal self, Integer exponent)
Power of a BigDecimal to an integer certain exponent. If the exponent is positive, call the BigDecimal.pow(int) method to maintain precision. Called by the '**' operator.
Parameters:
self - a BigDecimal
exponent - an Integer exponent
Returns:
a Number to the power of a the exponent


power

public static Number power(BigInteger self, Integer exponent)
Power of a BigInteger to an integer certain exponent. If the exponent is positive, call the BigInteger.pow(int) method to maintain precision. Called by the '**' operator.
Parameters:
self - a BigInteger
exponent - an Integer exponent
Returns:
a Number to the power of a the exponent


power

public static Number power(Integer self, Integer exponent)
Power of an integer to an integer certain exponent. If the exponent is positive, convert to a BigInteger and call BigInteger.pow(int) method to maintain precision. Called by the '**' operator.
Parameters:
self - an Integer
exponent - an Integer exponent
Returns:
a Number to the power of a the exponent


power

public static Number power(Long self, Integer exponent)
Power of a long to an integer certain exponent. If the exponent is positive, convert to a BigInteger and call BigInteger.pow(int) method to maintain precision. Called by the '**' operator.
Parameters:
self - a Long
exponent - an Integer exponent
Returns:
a Number to the power of a the exponent


previous

public static String previous(String self)
This method is called by the -- operator for the class String. It decrements the last character in the given string. If the character in the string is Character.MIN_VALUE it will be deleted. The empty string can't be decremented.
Parameters:
self - a String
Returns:
a String with a decremented digit at the end
Since:
1.0


previous

public static Character previous(Character self)
Decrement a Character by one.
Parameters:
self - a Character
Returns:
a decremented Character
Since:
1.5.7


previous

public static Number previous(Number self)
Decrement a Number by one.
Parameters:
self - a Number
Returns:
a decremented Number
Since:
1.0


previous

@Deprecated
public static Date previous(Date self)
deprecated:
moved to DateGroovyMethods.previous


previous

@Deprecated
public static def previous(def self)
deprecated:
moved to DateGroovyMethods.previous


primitiveArrayGet

protected static Object primitiveArrayGet(Object self, int idx)
Implements the getAt(int) method for primitve type arrays.
Parameters:
self - an array object
idx - the index of interest
Returns:
the returned value from the array
Since:
1.5.0


primitiveArrayGet

protected static List primitiveArrayGet(Object self, Range range)
Implements the getAt(Range) method for primitve type arrays.
Parameters:
self - an array object
range - the range of indices of interest
Returns:
the returned values from the array corresponding to the range
Since:
1.5.0


primitiveArrayGet

protected static List primitiveArrayGet(Object self, Collection indices)
Implements the getAt(Collection) method for primitve type arrays. Each value in the collection argument is assumed to be a valid array index. The value at each index is then added to a list which is returned.
Parameters:
self - an array object
indices - the indices of interest
Returns:
the returned values from the array
Since:
1.0


primitiveArrayPut

protected static Object primitiveArrayPut(Object self, int idx, Object newValue)
Implements the setAt(int idx) method for primitve type arrays.
Parameters:
self - an object
idx - the index of interest
newValue - the new value to be put into the index of interest
Returns:
the added value
Since:
1.5.0


print

public 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.
Parameters:
self - any Object
value - the value to print
Since:
1.0


print

public static void print(PrintWriter self, Object value)
Print a value formatted Groovy style to the print writer.
Parameters:
self - a PrintWriter
value - the value to print
Since:
1.0


print

public static void print(PrintStream self, Object value)
Print a value formatted Groovy style to the print stream.
Parameters:
self - a PrintStream
value - the value to print
Since:
1.6.0


print

public static void print(Closure self, Object value)
Print a value to the standard output stream. This method delegates to the owner to execute the method.
Parameters:
self - a generated closure
value - the value to print
Since:
1.0


print

public static void print(Object self, PrintWriter out)
Print to a console in interactive format.
Parameters:
self - any Object
out - the PrintWriter used for printing
Since:
1.0


printf

public static void printf(Object self, String format, Object[] values)
Printf to a console (Only works with JDK1.5 or later).
Parameters:
self - any Object
format - a format string
values - values referenced by the format specifiers in the format string.
Since:
1.0


printf

public static void printf(Object self, String format, Object arg)
Prints a formatted string using the specified format string and arguments.

For examples,

     printf ( "Hello, %s!\n" , [ "world" ] as String[] )
     printf ( "Hello, %s!\n" , [ "Groovy" ])
     printf ( "%d + %d = %d\n" , [ 1 , 2 , 1+2 ] as Integer[] )
     printf ( "%d + %d = %d\n" , [ 3 , 3 , 3+3 ])
 

( 1..5 ).each { printf ( "-- %d\n" , [ it ] as Integer[] ) } ( 1..5 ).each { printf ( "-- %d\n" , [ it ] as int[] ) } ( 0x41..0x45 ).each { printf ( "-- %c\n" , [ it ] as char[] ) } ( 07..011 ).each { printf ( "-- %d\n" , [ it ] as byte[] ) } ( 7..11 ).each { printf ( "-- %d\n" , [ it ] as short[] ) } ( 7..11 ).each { printf ( "-- %d\n" , [ it ] as long[] ) } ( 7..11 ).each { printf ( "-- %5.2f\n" , [ it ] as float[] ) } ( 7..11 ).each { printf ( "-- %5.2g\n" , [ it ] as double[] ) }

Parameters:
self - any Object
format - A format string
arg - Argument which is referenced by the format specifiers in the format string. The type of arg should be one of Object[], List, int[], short[], byte[], char[], boolean[], long[], float[], or double[].
Since:
1.0


println

public static void println(Object self)
Print a linebreak to the standard output stream.
Parameters:
self - any Object
Since:
1.0


println

public static void println(Closure self)
Print a linebreak to the standard output stream. This method delegates to the owner to execute the method.
Parameters:
self - a closure
Since:
1.0


println

public 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.
Parameters:
self - any Object
value - the value to print
Since:
1.0


println

public static void println(PrintWriter self, Object value)
Print a value formatted Groovy style (followed by a newline) to the print writer.
Parameters:
self - a PrintWriter
value - the value to print
Since:
1.0


println

public static void println(PrintStream self, Object value)
Print a value formatted Groovy style (followed by a newline) to the print stream.
Parameters:
self - any Object
value - the value to print
Since:
1.6.0


println

public static void println(Closure self, Object value)
Print a value (followed by a newline) to the standard output stream. This method delegates to the owner to execute the method.
Parameters:
self - a closure
value - the value to print
Since:
1.0


println

public static void println(Object self, PrintWriter out)
Print to a console in interactive format.
Parameters:
self - any Object
out - the PrintWriter used for printing
Since:
1.0


push

public static boolean push(List self, T value)
Appends an item to the List. Synonym for add().
def list = [3, 4, 2]
 list.push("x")
 assert list == [3, 4, 2, "x"]
throws:
NoSuchElementException if the list is empty and you try to pop() it.
Parameters:
self - a List
value - element to be appended to this list.
Returns:
true (as per the general contract of the Collection.add method).
Since:
1.5.5


putAll

public static Map putAll(Map self, Collection entries)
Provides an easy way to append multiple Map.Entry values to a Map.
Parameters:
self - a Map
entries - a Collection of Map.Entry items to be added to the Map.
Returns:
the same map, after the items have been added to it.
Since:
1.6.1


putAt

public static void putAt(Object self, String property, Object newValue)
Allows the subscript operator to be used to set dynamically named property values. bean[somePropertyNameExpression] = foo. The normal property notation of groovy is neater and more concise but only works with property names which are known at compile time.
Parameters:
self - the object to act upon
property - the name of the property to set
newValue - the value to set
Since:
1.0


putAt

public static void putAt(List self, int idx, T value)
A helper method to allow lists to work with subscript operators.
def list = [2, 3]
 list[0] = 1
 assert list == [1, 3]
Parameters:
self - a List
idx - an index
value - the value to put at the given index
Since:
1.0


putAt

public static void putAt(StringBuffer self, IntRange range, Object value)
Support the range subscript operator for StringBuffer. Index values are treated as characters within the buffer.
Parameters:
self - a StringBuffer
range - a Range
value - the object that's toString() will be inserted
Since:
1.0


putAt

public static void putAt(StringBuffer self, EmptyRange range, Object value)
Support the range subscript operator for StringBuffer.
Parameters:
self - a StringBuffer
range - a Range
value - the object that's toString() will be inserted
Since:
1.0


putAt

public static void putAt(List self, EmptyRange range, Object value)
A helper method to allow lists to work with subscript operators.
def list = ["a", true]
 list[1..<1] = 5
 assert list == ["a", 5, true]
Parameters:
self - a List
range - the (in this case empty) subset of the list to set
value - the values to put at the given sublist or a Collection of values
Since:
1.0


putAt

public static void putAt(List self, EmptyRange range, Collection value)
A helper method to allow lists to work with subscript operators.
def list = ["a", true]
 list[1..<1] = [4, 3, 2]
 assert list == ["a", 4, 3, 2, true]
Parameters:
self - a List
range - the (in this case empty) subset of the list to set
value - the Collection of values
See Also:
putAt(java.util.List, groovy.lang.EmptyRange, java.lang.Object)
Since:
1.0


putAt

public static void putAt(List self, IntRange range, Collection col)
List subscript assignment operator when given a range as the index and the assignment operand is a collection. Example:
def myList = [4, 3, 5, 1, 2, 8, 10]
 myList[3..5] = ["a", true]
 assert myList == [4, 3, 5, "a", true, 10]
Items in the given range are relaced with items from the collection.
Parameters:
self - a List
range - the subset of the list to set
col - the collection of values to put at the given sublist
Since:
1.5.0


putAt

public static void putAt(List self, IntRange range, Object value)
List subscript assignment operator when given a range as the index. Example:
def myList = [4, 3, 5, 1, 2, 8, 10]
 myList[3..5] = "b"
 assert myList == [4, 3, 5, "b", 10]
Items in the given range are relaced with the operand. The value operand is always treated as a single value.
Parameters:
self - a List
range - the subset of the list to set
value - the value to put at the given sublist
Since:
1.0


putAt

public static void putAt(List self, List splice, List values)
A helper method to allow lists to work with subscript operators.
def list = ["a", true, 42, 9.4]
 list[1, 4] = ["x", false]
 assert list == ["a", "x", 42, 9.4, false]
Parameters:
self - a List
splice - the subset of the list to set
values - the value to put at the given sublist
Since:
1.0


putAt

public static void putAt(List self, List splice, Object value)
A helper method to allow lists to work with subscript operators.
def list = ["a", true, 42, 9.4]
 list[1, 3] = 5
 assert list == ["a", 5, 42, 5]
Parameters:
self - a List
splice - the subset of the list to set
value - the value to put at the given sublist
Since:
1.0


putAt

public static V putAt(Map self, K key, V value)
A helper method to allow lists to work with subscript operators
Parameters:
self - a Map
key - an Object as a key for the map
value - the value to put into the map
Returns:
the value corresponding to the given key
Since:
1.0


putAt

public static void putAt(BitSet self, IntRange range, boolean value)
Support assigning a range of values with a single assignment statement.
Parameters:
self - a BitSet
range - the range of values to set
value - value
See Also:
BitSet
Range
Since:
1.5.0


putAt

public static void putAt(BitSet self, int index, boolean value)
Support subscript-style assignment for a BitSet.
Parameters:
self - a BitSet
index - index of the entry to set
value - value
See Also:
BitSet
Since:
1.5.0


readBytes

public static byte[] readBytes(File file)
Reads the content of the file into a byte array.
throws:
IOException if an IOException occurs.
Parameters:
file - a File
Returns:
a byte array with the contents of the file.
Since:
1.0


readLine

public static String readLine(Reader self)
Read a single, whole line from the given Reader.
throws:
IOException if an IOException occurs.
Parameters:
self - a Reader
Returns:
a line
Since:
1.0


readLines

public static List readLines(String self)
Return the lines of a String as a List of Strings.
throws:
java.io.IOException if an error occurs
Parameters:
self - a String object
Returns:
a list of lines
Since:
1.5.5


readLines

public static List readLines(File file)
Reads the file into a list of Strings, with one item for each line.
throws:
IOException if an IOException occurs.
Parameters:
file - a File
Returns:
a List of lines
See Also:
readLines(java.io.Reader)
Since:
1.0


readLines

public static List readLines(File file, String charset)
Reads the file into a list of Strings, with one item for each line.
throws:
IOException if an IOException occurs.
Parameters:
file - a File
charset - opens the file with a specified charset
Returns:
a List of lines
See Also:
readLines(java.io.Reader)
Since:
1.6.8


readLines

public static List readLines(InputStream stream)
Reads the stream into a list, with one element for each line.
throws:
IOException if an IOException occurs.
Parameters:
stream - a stream
Returns:
a List of lines
See Also:
readLines(java.io.Reader)
Since:
1.0


readLines

public static List readLines(InputStream stream, String charset)
Reads the stream into a list, with one element for each line.
throws:
IOException if an IOException occurs.
Parameters:
stream - a stream
charset - opens the stream with a specified charset
Returns:
a List of lines
See Also:
readLines(java.io.Reader)
Since:
1.6.8


readLines

public static List readLines(URL self)
Reads the URL contents into a list, with one element for each line.
throws:
IOException if an IOException occurs.
Parameters:
self - a URL
Returns:
a List of lines
See Also:
readLines(java.io.Reader)
Since:
1.6.8


readLines

public static List readLines(URL self, String charset)
Reads the URL contents into a list, with one element for each line.
throws:
IOException if an IOException occurs.
Parameters:
self - a URL
charset - opens the URL with a specified charset
Returns:
a List of lines
See Also:
readLines(java.io.Reader)
Since:
1.6.8


readLines

public static List readLines(Reader reader)
Reads the reader into a list of Strings, with one entry for each line. The reader is closed before this method returns.
throws:
IOException if an IOException occurs.
Parameters:
reader - a Reader
Returns:
a List of lines
Since:
1.0


removeAll

public static boolean removeAll(Collection self, T[] items)
Removes all of this collection's elements that are also contained in the specified array. After this call returns, this collection will contain no elements in common with the specified array.
Parameters:
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


removeAll

public static boolean removeAll(Collection self, Closure closure)
Removes the elements in this collection that are matched according to the specified closure condition.
Parameters:
self - a Collection to be modified
closure - a closure condition
Returns:
true if this collection changed as a result of the call
See Also:
Iterator.remove
Since:
1.7.2


renameTo

public static boolean renameTo(File self, String newPathName)
Renames the file. It's a shortcut for File.renameTo
Parameters:
self - a File
newPathName - The new pathname for the named file
Returns:
true if and only if the renaming succeeded; false otherwise
Since:
1.7.4


replaceAll

public static String replaceAll(String self, Pattern pattern, String replacement)
Replaces all substrings of a String that match the given compiled regular expression with the given replacement.

Note that backslashes (\) and dollar signs ($) in the replacement string may cause the results to be different than if it were being treated as a literal replacement string; see Matcher.replaceAll. Use Matcher.quoteReplacement to suppress the special meaning of these characters, if desired.

Parameters:
self - the string that is to be matched
pattern - the regex Pattern to which the string of interest is to be matched
replacement - the string to be substituted for the first match
Returns:
The resulting String
See Also:
String.replaceAll
Since:
1.6.1


replaceAll

public static String replaceAll(String self, String regex, Closure closure)
Replaces all occurrences of a captured group by the result of a closure on that text.

For examples,

     assert "hellO wOrld" == "hello world".replaceAll("(o)") { it[0].toUpperCase() }
 

assert "FOOBAR-FOOBAR-" == "foobar-FooBar-".replaceAll("(([fF][oO]{2})[bB]ar)", { Object[] it -> it[0].toUpperCase() })

Here, it[0] is the global string of the matched group it[1] is the first string in the matched group it[2] is the second string in the matched group

assert "FOO-FOO-" == "foobar-FooBar-".replaceAll("(([fF][oO]{2})[bB]ar)", { x, y, z -> z.toUpperCase() })

Here, x is the global string of the matched group y is the first string in the matched group z is the second string in the matched group

Note that unlike String.replaceAll(String regex, String replacement), where the replacement string treats '$' and '\' specially (for group substitution), the result of the closure is converted to a string and that value is used literally for the replacement.

throws:
java.util.regex.PatternSyntaxException if the regular expression's syntax is invalid
Parameters:
self - a String
regex - the capturing regex
closure - the closure to apply on each captured group
Returns:
a String with replaced content
See Also:
Matcher.quoteReplacement
replaceAll(String, Pattern, Closure)
Since:
1.0


replaceAll

public static String replaceAll(String self, Pattern pattern, Closure closure)
Replaces all occurrences of a captured group by the result of a closure call on that text.

For examples,

     assert "hellO wOrld" == "hello world".replaceAll(~"(o)") { it[0].toUpperCase() }
 

assert "FOOBAR-FOOBAR-" == "foobar-FooBar-".replaceAll(~"(([fF][oO]{2})[bB]ar)", { it[0].toUpperCase() })

Here, it[0] is the global string of the matched group it[1] is the first string in the matched group it[2] is the second string in the matched group

assert "FOOBAR-FOOBAR-" == "foobar-FooBar-".replaceAll(~"(([fF][oO]{2})[bB]ar)", { Object[] it -> it[0].toUpperCase() })

Here, it[0] is the global string of the matched group it[1] is the first string in the matched group it[2] is the second string in the matched group

assert "FOO-FOO-" == "foobar-FooBar-".replaceAll("(([fF][oO]{2})[bB]ar)", { x, y, z -> z.toUpperCase() })

Here, x is the global string of the matched group y is the first string in the matched group z is the second string in the matched group

Note that unlike String.replaceAll(String regex, String replacement), where the replacement string treats '$' and '\' specially (for group substitution), the result of the closure is converted to a string and that value is used literally for the replacement.

Parameters:
self - a String
pattern - the capturing regex Pattern
closure - the closure to apply on each captured group
Returns:
a String with replaced content
See Also:
Matcher.quoteReplacement
Since:
1.6.8


replaceFirst

public static String replaceFirst(String self, Pattern pattern, String replacement)
Replaces the first substring of a String that matches the given compiled regular expression with the given replacement.

Note that backslashes (\) and dollar signs ($) in the replacement string may cause the results to be different than if it were being treated as a literal replacement string; see Matcher.replaceFirst. Use Matcher.quoteReplacement to suppress the special meaning of these characters, if desired.

Parameters:
self - the string that is to be matched
pattern - the regex Pattern to which the string of interest is to be matched
replacement - the string to be substituted for the first match
Returns:
The resulting String
See Also:
String.replaceFirst
Since:
1.6.1


replaceFirst

public static String replaceFirst(String self, String regex, Closure closure)
Replaces the first occurrence of a captured group by the result of a closure call on that text.

For example (with some replaceAll variants thrown in for comparison purposes),

 assert "hellO world" == "hello world".replaceFirst("(o)") { it[0].toUpperCase() } // first match
 assert "hellO wOrld" == "hello world".replaceAll("(o)") { it[0].toUpperCase() }   // all matches
 

assert '1-FISH, two fish' == "one fish, two fish".replaceFirst(/([a-z]{3})\s([a-z]{4})/) { [one:1, two:2][it[1]] + '-' + it[2].toUpperCase() } assert '1-FISH, 2-FISH' == "one fish, two fish".replaceAll(/([a-z]{3})\s([a-z]{4})/) { [one:1, two:2][it[1]] + '-' + it[2].toUpperCase() }

throws:
java.util.regex.PatternSyntaxException if the regular expression's syntax is invalid
Parameters:
self - a String
regex - the capturing regex
closure - the closure to apply on the first captured group
Returns:
a String with replaced content
See Also:
Matcher.quoteReplacement
replaceFirst(String, Pattern, Closure)
Since:
1.7.7


replaceFirst

public static String replaceFirst(String self, Pattern pattern, Closure closure)
Replaces the first occurrence of a captured group by the result of a closure call on that text.

For example (with some replaceAll variants thrown in for comparison purposes),

 assert "hellO world" == "hello world".replaceFirst(~"(o)") { it[0].toUpperCase() } // first match
 assert "hellO wOrld" == "hello world".replaceAll(~"(o)") { it[0].toUpperCase() }   // all matches
 

assert '1-FISH, two fish' == "one fish, two fish".replaceFirst(~/([a-z]{3})\s([a-z]{4})/) { [one:1, two:2][it[1]] + '-' + it[2].toUpperCase() } assert '1-FISH, 2-FISH' == "one fish, two fish".replaceAll(~/([a-z]{3})\s([a-z]{4})/) { [one:1, two:2][it[1]] + '-' + it[2].toUpperCase() }

Parameters:
self - a String
pattern - the capturing regex Pattern
closure - the closure to apply on the first captured group
Returns:
a String with replaced content
See Also:
replaceAll(String, Pattern, Closure)
Since:
1.7.7


respondsTo

public static List respondsTo(Object self, String name, Object[] argTypes)

Returns an object satisfying Groovy truth if the implementing MetaClass responds to a method with the given name and arguments types.

Note that this method's return value is based on realised methods and does not take into account objects or classes that implement invokeMethod or methodMissing

This method is "safe" in that it will always return a value and never throw an exception

Parameters:
self - The object to inspect
name - The name of the method of interest
argTypes - The argument types to match against
Returns:
A List of MetaMethods matching the argument types which will be empty if no matching methods exist
See Also:
MetaObjectProtocol.respondsTo
Since:
1.6.0


respondsTo

public static List respondsTo(Object self, String name)

Returns an object satisfying Groovy truth if the implementing MetaClass responds to a method with the given name regardless of the arguments.

Note that this method's return value is based on realised methods and does not take into account objects or classes that implement invokeMethod or methodMissing

This method is "safe" in that it will always return a value and never throw an exception

Parameters:
self - The object to inspect
name - The name of the method of interest
Returns:
A List of MetaMethods matching the given name or an empty list if no matching methods exist
See Also:
MetaObjectProtocol.respondsTo
Since:
1.6.1


retainAll

public static boolean retainAll(Collection self, T[] items)
Retains only the elements in this collection that are contained in the specified array. In other words, removes from this collection all of its elements that are not contained in the specified array.
Parameters:
items - array containing elements to be retained from this collection
Returns:
true if this collection changed as a result of the call
See Also:
Collection.retainAll
Since:
1.7.2


retainAll

public static boolean retainAll(Collection self, Closure closure)
Retains only the elements in this collection that are matched according to the specified closure condition. In other words, removes from this collection all of its elements that don't match.
Parameters:
self - a Collection to be modified
closure - a closure condition
Returns:
true if this collection changed as a result of the call
See Also:
Iterator.remove
Since:
1.7.2


reverse

@SuppressWarnings("unchecked")
public static T[] reverse(T[] self)
Reverse the items in an Object array.
Parameters:
self - an Object array
Returns:
an array containing the reversed items
Since:
1.5.5


reverse

public static String reverse(String self)
Creates a new string which is the reverse (backwards) of this string
Parameters:
self - a String
Returns:
a new string with all the characters reversed.
See Also:
StringBuilder.reverse
Since:
1.0


reverse

public static List reverse(List self)
Reverses the list. The result is a new List with the identical contents in reverse order.
def list = ["a", 4, false]
 assert list.reverse() == [false, 4, "a"]
 assert list == ["a", 4, false]
Parameters:
self - a List
Returns:
a reversed List
Since:
1.0


reverse

public static Iterator reverse(Iterator self)
Reverses the iterator. The original iterator will become exhausted of elements after determining the reversed values. A new iterator for iterating through the reversed values is returned.
Parameters:
self - an Iterator
Returns:
a reversed Iterator
Since:
1.5.5


reverseEach

public static Map reverseEach(Map self, Closure closure)
Allows a Map to be iterated through in reverse order using a closure. In general, the order in which the map contents are processed cannot be guaranteed. In practise, specialized forms of Map, e.g. a TreeMap will have its contents processed according to the reverse of the natural ordering of the map.
Parameters:
self - the map over which we iterate
closure - the 1 or 2 arg closure applied on each entry of the map
Returns:
returns the self parameter
See Also:
each(Map, Closure)
Since:
1.7.2


reverseEach

public static List reverseEach(List self, Closure closure)
Iterate over each element of the list in the reverse order.
def result = []
 [1,2,3].reverseEach { result << it }
 assert result == [3,2,1]
Parameters:
self - a List
closure - a closure to which each item is passed.
Returns:
the original list
Since:
1.5.0


reverseEach

public static T[] reverseEach(T[] self, Closure closure)
Iterate over each element of the array in the reverse order.
Parameters:
self - an Object array
closure - a closure to which each item is passed
Returns:
the original array
Since:
1.5.2


rightShift

public static Number rightShift(Number self, Number operand)
Implementation of the right shift operator for integral types. Non integral Number types throw UnsupportedOperationException.
Parameters:
self - a Number object
operand - the shift distance by which to right shift the number
Returns:
the resulting number
Since:
1.5.0


rightShiftUnsigned

public static Number rightShiftUnsigned(Number self, Number operand)
Implementation of the right shift (unsigned) operator for integral types. Non integral Number types throw UnsupportedOperationException.
Parameters:
self - a Number object
operand - the shift distance by which to right shift (unsigned) the number
Returns:
the resulting number
Since:
1.5.0


round

public static int round(Float number)
Round the value
Parameters:
number - a Float
Returns:
the rounded value of that Float
Since:
1.0


round

public static float round(Float number, int precision)
Round the value
Parameters:
number - a Float
precision - the number of decimal places to keep
Returns:
the Float rounded to the number of decimal places specified by precision
Since:
1.6.0


round

public static long round(Double number)
Round the value
Parameters:
number - a Double
Returns:
the rounded value of that Double
Since:
1.0


round

public static double round(Double number, int precision)
Round the value
Parameters:
number - a Double
precision - the number of decimal places to keep
Returns:
the Double rounded to the number of decimal places specified by precision
Since:
1.6.4


runAfter

public static TimerTask runAfter(Timer timer, int delay, Closure closure)
Allows a simple syntax for using timers. This timer will execute the given closure after the given delay.
Parameters:
timer - a timer object
delay - the delay in milliseconds before running the closure code
closure - the closure to invoke
Returns:
The timer task which has been scheduled.
Since:
1.5.0


setBytes

public static void setBytes(File file, byte[] bytes)
Write the bytes from the byte array to the File.
throws:
IOException if an IOException occurs.
Parameters:
file - the file to write to
bytes - the byte[] to write to the file
Since:
1.7.1


setBytes

public static void setBytes(OutputStream os, byte[] bytes)
Write the byte[] to the output stream. The stream is closed before this method returns.
throws:
IOException if an IOException occurs.
Parameters:
os - an output stream
bytes - the byte[] to write to the output stream
Since:
1.7.1


setIndex

public static void setIndex(Matcher matcher, int idx)
Set the position of the given Matcher to the given index.
Parameters:
matcher - a Matcher
idx - the index number
Since:
1.0


setMetaClass

public static void setMetaClass(Class self, MetaClass metaClass)
Sets the metaclass for a given class.
Parameters:
self - the class whose metaclass we wish to set
metaClass - the new MetaClass
Since:
1.6.0


setMetaClass

public static void setMetaClass(Object self, MetaClass metaClass)
Set the metaclass for an object
Parameters:
self - the object whose metaclass we want to set
metaClass - the new metaclass value
Since:
1.6.0


setText

public static void setText(File file, String text)
Synonym for write(text) allowing file.text = 'foo'.
throws:
IOException if an IOException occurs.
Parameters:
file - a File
text - the text to write to the File
See Also:
write(java.io.File, java.lang.String)
Since:
1.5.1


setText

public static void setText(File file, String text, String charset)
Synonym for write(text, charset) allowing:
 myFile.setText('some text', charset)
 
or with some help from ExpandoMetaClass, you could do something like:
 myFile.metaClass.setText = { String s -> delegate.setText(s, 'UTF-8') }
 myfile.text = 'some text'
 
throws:
IOException if an IOException occurs.
Parameters:
file - A File
charset - The charset used when writing to the file
text - The text to write to the File
See Also:
write(java.io.File, java.lang.String, java.lang.String)
Since:
1.7.3


size

public static int size(Iterator self)
Provide the standard Groovy size() method for Iterator. The iterator will become exhausted of elements after determining the size value.
Parameters:
self - an Iterator
Returns:
the length of the Iterator
Since:
1.5.5


size

public static int size(String text)
Provide the standard Groovy size() method for String.
Parameters:
text - a String
Returns:
the length of the String
Since:
1.0


size

public static int size(StringBuffer buffer)
Provide the standard Groovy size() method for StringBuffer.
Parameters:
buffer - a StringBuffer
Returns:
the length of the StringBuffer
Since:
1.0


size

public static long size(File self)
Provide the standard Groovy size() method for File.
Parameters:
self - a file object
Returns:
the file's size (length)
Since:
1.5.0


size

public static long size(Matcher self)
Provide the standard Groovy size() method for Matcher.
Parameters:
self - a matcher object
Returns:
the matcher's size (count)
Since:
1.5.0


size

public static int size(Object[] self)
Provide the standard Groovy size() method for an array.
Parameters:
self - an Array of objects
Returns:
the size (length) of the Array
Since:
1.0


size

public static int size(boolean[] array)
Allows arrays to behave similar to collections.
Parameters:
array - a boolean array
Returns:
the length of the array
See Also:
Array.getLength
Since:
1.5.0


size

public static int size(byte[] array)
Allows arrays to behave similar to collections.
Parameters:
array - a byte array
Returns:
the length of the array
See Also:
Array.getLength
Since:
1.0


size

public static int size(char[] array)
Allows arrays to behave similar to collections.
Parameters:
array - a char array
Returns:
the length of the array
See Also:
Array.getLength
Since:
1.0


size

public static int size(short[] array)
Allows arrays to behave similar to collections.
Parameters:
array - a short array
Returns:
the length of the array
See Also:
Array.getLength
Since:
1.0


size

public static int size(int[] array)
Allows arrays to behave similar to collections.
Parameters:
array - an int array
Returns:
the length of the array
See Also:
Array.getLength
Since:
1.0


size

public static int size(long[] array)
Allows arrays to behave similar to collections.
Parameters:
array - a long array
Returns:
the length of the array
See Also:
Array.getLength
Since:
1.0


size

public static int size(float[] array)
Allows arrays to behave similar to collections.
Parameters:
array - a float array
Returns:
the length of the array
See Also:
Array.getLength
Since:
1.0


size

public static int size(double[] array)
Allows arrays to behave similar to collections.
Parameters:
array - a double array
Returns:
the length of the array
See Also:
Array.getLength
Since:
1.0


sort

public static List sort(Collection self)
Sorts the given collection into a sorted list. The collection items are assumed to be comparable.
assert [1,2,3] == [3,1,2].sort()
Parameters:
self - the collection to be sorted
Returns:
the sorted collection as a List
Since:
1.0


sort

public static Map sort(Map self, Closure closure)
Sorts the elements from the given map into a new ordered map using the closure as a comparator to determine the ordering.
def map = [a:5, b:3, c:6, d:4].sort { a, b -> a.value <=> b.value }
 assert map == [b:3, d:4, a:5, c:6]
Parameters:
self - the map to be sorted
closure - a Closure used as a comparator
Returns:
the sorted map
Since:
1.6.0


sort

public static Map sort(Map self, Comparator comparator)
Sorts the elements from the given map into a new ordered Map using the specified key comparator to determine the ordering.
def map = [ba:3, cz:6, ab:5].sort({ a, b -> a[-1] <=> b[-1] } as Comparator)
 assert map*.value == [3, 5, 6]
Parameters:
self - the map to be sorted
comparator - a Comparator
Returns:
the sorted map
Since:
1.7.2


sort

public static Map sort(Map self)
Sorts the elements from the given map into a new ordered Map using the natural ordering of the keys to determine the ordering.
map = [ba:3, cz:6, ab:5].sort()
 assert map*.value == [5, 3, 6]
 
Parameters:
self - the map to be sorted
Returns:
the sorted map
Since:
1.7.2


sort

public static T[] sort(T[] self)
Sorts the given Object array into sorted order. The array items are assumed to be comparable.
Parameters:
self - the array to be sorted
Returns:
the sorted array
Since:
1.5.5


sort

public static Iterator sort(Iterator self)
Sorts the given iterator items into a sorted iterator. The items are assumed to be comparable. The original iterator will become exhausted of elements after completing this method call. A new iterator is produced that traverses the items in sorted order.
Parameters:
self - the Iterator to be sorted
Returns:
the sorted items as an Iterator
Since:
1.5.5


sort

public static Iterator sort(Iterator self, Comparator comparator)
Sorts the given iterator items into a sorted iterator using the comparator.
Parameters:
self - the Iterator to be sorted
comparator - a Comparator used for comparing items
Returns:
the sorted items as an Iterator
Since:
1.5.5


sort

public static List sort(Collection self, Comparator comparator)
Sorts the Collection using the given comparator. The elements are sorted into a new list, and the existing collection is unchanged.
assert ["hi","hey","hello"] == ["hello","hi","hey"].sort( { a, b -> a.length() <=> b.length() } as Comparator )
assert ["hello","Hey","hi"] == ["hello","hi","Hey"].sort(String.CASE_INSENSITIVE_ORDER)
Parameters:
self - a collection to be sorted
comparator - a Comparator used for the comparison
Returns:
a newly created sorted List
Since:
1.0


sort

public static T[] sort(T[] self, Comparator comparator)
Sorts the given Object array into sorted order using the given comparator.
Parameters:
self - the array to be sorted
comparator - a Comparator used for the comparison
Returns:
the sorted array
Since:
1.5.5


sort

public static Iterator sort(Iterator self, Closure closure)
Sorts the given iterator items into a sorted iterator using the Closure to determine the correct ordering. The original iterator will be fully processed after the method call.

If the closure has two parameters it is used like a traditional Comparator. I.e. it should compare its two parameters for order, returning a negative integer, zero, or a positive integer when the first parameter is less than, equal to, or greater than the second respectively. Otherwise, the Closure is assumed to take a single parameter and return a Comparable (typically an Integer) which is then used for further comparison.
Parameters:
self - the Iterator to be sorted
closure - a Closure used to determine the correct ordering
Returns:
the sorted items as an Iterator
Since:
1.5.5


sort

@SuppressWarnings("unchecked")
public static T[] sort(T[] self, Closure closure)
Sorts the given Object array into a newly created array using the Closure to determine the correct ordering.

If the closure has two parameters it is used like a traditional Comparator. I.e. it should compare its two parameters for order, returning a negative integer, zero, or a positive integer when the first parameter is less than, equal to, or greater than the second respectively. Otherwise, the Closure is assumed to take a single parameter and return a Comparable (typically an Integer) which is then used for further comparison.
Parameters:
self - the array to be sorted
closure - a Closure used to determine the correct ordering
Returns:
the sorted array
Since:
1.5.5


sort

public static List sort(Collection self, Closure closure)
Sorts this Collection using the closure to determine the correct ordering.

If the closure has two parameters it is used like a traditional Comparator. I.e. it should compare its two parameters for order, returning a negative integer, zero, or a positive integer when the first parameter is less than, equal to, or greater than the second respectively. Otherwise, the Closure is assumed to take a single parameter and return a Comparable (typically an Integer) which is then used for further comparison.
assert ["hi","hey","hello"] == ["hello","hi","hey"].sort { it.length() }
assert ["hi","hey","hello"] == ["hello","hi","hey"].sort { a, b -> a.length() <=> b.length() }
Parameters:
self - a Collection to be sorted
closure - a 1 or 2 arg Closure used to determine the correct ordering
Returns:
a newly created sorted List
Since:
1.0


sort

public static SortedSet sort(SortedSet self)
Avoids doing unnecessary work when sorting an already sorted set.
Parameters:
self - an identity function for an already sorted set
Returns:
the sorted set
Since:
1.0


split

public static Collection split(Object self, Closure closure)
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 containing whose first item is the accepted values and whose second item is the rejected values
Since:
1.6.0


split

public static Collection split(Collection self, Closure closure)
Splits all items into two collections based on the closure condition. The first list contains all items which match the closure expression. The second list all those that don't.
assert [[2,4],[1,3]] == [1,2,3,4].split { it % 2 == 0 }
Parameters:
self - a Collection of values
closure - a closure condition
Returns:
a List containing whose first item is the accepted values and whose second item is the rejected values
Since:
1.6.0


split

public static String[] split(String self)
Convenience method to split a string (with whitespace as delimiter) Like tokenize, but returns an Array of Strings instead of a List
Parameters:
self - the string to split
Returns:
String[] result of split
Since:
1.5.0


split

public static String[] split(GString self)
Convenience method to split a GString (with whitespace as delimiter).
Parameters:
self - the GString to split
Returns:
String[] result of split
See Also:
split(java.lang.String)
Since:
1.6.1


splitEachLine

public static Object splitEachLine(File self, String regex, Closure closure)
Iterates through this file line by line, splitting each line using the given regex separator. For each line, the given closure is called with a single parameter being the list of strings computed by splitting the line around matches of the given regular expression. Finally the resources used for processing the file are closed.
throws:
IOException if an IOException occurs.
throws:
java.util.regex.PatternSyntaxException if the regular expression's syntax is invalid
Parameters:
self - a File
regex - the delimiting regular expression
closure - a closure
Returns:
the last value returned by the closure
See Also:
splitEachLine(java.io.Reader, java.lang.String, groovy.lang.Closure)
Since:
1.5.5


splitEachLine

public static Object splitEachLine(File self, Pattern pattern, Closure closure)
Iterates through this file line by line, splitting each line using the given separator Pattern. For each line, the given closure is called with a single parameter being the list of strings computed by splitting the line around matches of the given regular expression Pattern. Finally the resources used for processing the file are closed.
throws:
IOException if an IOException occurs.
Parameters:
self - a File
pattern - the regular expression Pattern for the delimiter
closure - a closure
Returns:
the last value returned by the closure
See Also:
splitEachLine(java.io.Reader, java.util.regex.Pattern, groovy.lang.Closure)
Since:
1.6.8


splitEachLine

public static Object splitEachLine(File self, String regex, String charset, Closure closure)
Iterates through this file line by line, splitting each line using the given regex separator. For each line, the given closure is called with a single parameter being the list of strings computed by splitting the line around matches of the given regular expression. Finally the resources used for processing the file are closed.
throws:
IOException if an IOException occurs.
throws:
java.util.regex.PatternSyntaxException if the regular expression's syntax is invalid
Parameters:
self - a File
regex - the delimiting regular expression
charset - opens the file with a specified charset
closure - a closure
Returns:
the last value returned by the closure
See Also:
splitEachLine(java.io.Reader, java.lang.String, groovy.lang.Closure)
Since:
1.6.8


splitEachLine

public static Object splitEachLine(File self, Pattern pattern, String charset, Closure closure)
Iterates through this file line by line, splitting each line using the given regex separator Pattern. For each line, the given closure is called with a single parameter being the list of strings computed by splitting the line around matches of the given regular expression. Finally the resources used for processing the file are closed.
throws:
IOException if an IOException occurs.
Parameters:
self - a File
pattern - the regular expression Pattern for the delimiter
charset - opens the file with a specified charset
closure - a closure
Returns:
the last value returned by the closure
See Also:
splitEachLine(java.io.Reader, java.util.regex.Pattern, groovy.lang.Closure)
Since:
1.6.8


splitEachLine

public static Object splitEachLine(URL self, String regex, Closure closure)
Iterates through the input stream associated with this URL line by line, splitting each line using the given regex separator. For each line, the given closure is called with a single parameter being the list of strings computed by splitting the line around matches of the given regular expression. Finally the resources used for processing the URL are closed.
throws:
IOException if an IOException occurs.
throws:
java.util.regex.PatternSyntaxException if the regular expression's syntax is invalid
Parameters:
self - a URL to open and read
regex - the delimiting regular expression
closure - a closure
Returns:
the last value returned by the closure
See Also:
splitEachLine(java.io.Reader, java.lang.String, groovy.lang.Closure)
Since:
1.6.8


splitEachLine

public static Object splitEachLine(URL self, Pattern pattern, Closure closure)
Iterates through the input stream associated with this URL line by line, splitting each line using the given regex separator Pattern. For each line, the given closure is called with a single parameter being the list of strings computed by splitting the line around matches of the given regular expression. Finally the resources used for processing the URL are closed.
throws:
IOException if an IOException occurs.
Parameters:
self - a URL to open and read
pattern - the regular expression Pattern for the delimiter
closure - a closure
Returns:
the last value returned by the closure
See Also:
splitEachLine(java.io.Reader, java.util.regex.Pattern, groovy.lang.Closure)
Since:
1.6.8


splitEachLine

public static Object splitEachLine(URL self, String regex, String charset, Closure closure)
Iterates through the input stream associated with this URL line by line, splitting each line using the given regex separator. For each line, the given closure is called with a single parameter being the list of strings computed by splitting the line around matches of the given regular expression. Finally the resources used for processing the URL are closed.
throws:
IOException if an IOException occurs.
throws:
java.util.regex.PatternSyntaxException if the regular expression's syntax is invalid
Parameters:
self - a URL to open and read
regex - the delimiting regular expression
charset - opens the file with a specified charset
closure - a closure
Returns:
the last value returned by the closure
See Also:
splitEachLine(java.io.Reader, java.lang.String, groovy.lang.Closure)
Since:
1.6.8


splitEachLine

public static Object splitEachLine(URL self, Pattern pattern, String charset, Closure closure)
Iterates through the input stream associated with this URL line by line, splitting each line using the given regex separator Pattern. For each line, the given closure is called with a single parameter being the list of strings computed by splitting the line around matches of the given regular expression. Finally the resources used for processing the URL are closed.
throws:
IOException if an IOException occurs.
Parameters:
self - a URL to open and read
pattern - the regular expression Pattern for the delimiter
charset - opens the file with a specified charset
closure - a closure
Returns:
the last value returned by the closure
See Also:
splitEachLine(java.io.Reader, java.util.regex.Pattern, groovy.lang.Closure)
Since:
1.6.8


splitEachLine

public static Object splitEachLine(Reader self, String regex, Closure closure)
Iterates through the given reader line by line, splitting each line using the given regex separator. For each line, the given closure is called with a single parameter being the list of strings computed by splitting the line around matches of the given regular expression. The Reader is closed afterwards.

Here is an example:

 def s = 'The 3 quick\nbrown 4 fox'
 def result = ''
 new StringReader(s).splitEachLine(/\d/){ parts ->
     result += "${parts[0]}_${parts[1]}|"
 }
 assert result == 'The _ quick|brown _ fox|'
 
throws:
IOException if an IOException occurs.
throws:
java.util.regex.PatternSyntaxException if the regular expression's syntax is invalid
Parameters:
self - a Reader, closed after the method returns
regex - the delimiting regular expression
closure - a closure
Returns:
the last value returned by the closure
See Also:
String.split
Since:
1.5.5


splitEachLine

public static Object splitEachLine(Reader self, Pattern pattern, Closure closure)
Iterates through the given reader line by line, splitting each line using the given regex separator Pattern. For each line, the given closure is called with a single parameter being the list of strings computed by splitting the line around matches of the given regular expression. The Reader is closed afterwards.

Here is an example:

 def s = 'The 3 quick\nbrown 4 fox'
 def result = ''
 new StringReader(s).splitEachLine(~/\d/){ parts ->
     result += "${parts[0]}_${parts[1]}|"
 }
 assert result == 'The _ quick|brown _ fox|'
 
throws:
IOException if an IOException occurs.
throws:
java.util.regex.PatternSyntaxException if the regular expression's syntax is invalid
Parameters:
self - a Reader, closed after the method returns
pattern - the regular expression Pattern for the delimiter
closure - a closure
Returns:
the last value returned by the closure
See Also:
String.split
Since:
1.6.8


splitEachLine

public static Object splitEachLine(InputStream stream, String regex, String charset, Closure closure)
Iterates through the given InputStream line by line using the specified encoding, splitting each line using the given separator. The list of tokens for each line is then passed to the given closure. Finally, the stream is closed.
throws:
IOException if an IOException occurs.
throws:
java.util.regex.PatternSyntaxException if the regular expression's syntax is invalid
Parameters:
stream - an InputStream
regex - the delimiting regular expression
charset - opens the stream with a specified charset
closure - a closure
Returns:
the last value returned by the closure
See Also:
splitEachLine(java.io.Reader, java.lang.String, groovy.lang.Closure)
Since:
1.5.5


splitEachLine

public static Object splitEachLine(InputStream stream, Pattern pattern, String charset, Closure closure)
Iterates through the given InputStream line by line using the specified encoding, splitting each line using the given separator Pattern. The list of tokens for each line is then passed to the given closure. Finally, the stream is closed.
throws:
IOException if an IOException occurs.
Parameters:
stream - an InputStream
pattern - the regular expression Pattern for the delimiter
charset - opens the stream with a specified charset
closure - a closure
Returns:
the last value returned by the closure
See Also:
splitEachLine(java.io.Reader, java.util.regex.Pattern, groovy.lang.Closure)
Since:
1.6.8


splitEachLine

public static Object splitEachLine(InputStream stream, String regex, Closure closure)
Iterates through the given InputStream line by line, splitting each line using the given separator. The list of tokens for each line is then passed to the given closure. The stream is closed before the method returns.
throws:
IOException if an IOException occurs.
throws:
java.util.regex.PatternSyntaxException if the regular expression's syntax is invalid
Parameters:
stream - an InputStream
regex - the delimiting regular expression
closure - a closure
Returns:
the last value returned by the closure
See Also:
splitEachLine(java.io.Reader, java.lang.String, groovy.lang.Closure)
Since:
1.5.6


splitEachLine

public static Object splitEachLine(InputStream stream, Pattern pattern, Closure closure)
Iterates through the given InputStream line by line, splitting each line using the given separator Pattern. The list of tokens for each line is then passed to the given closure. The stream is closed before the method returns.
throws:
IOException if an IOException occurs.
Parameters:
stream - an InputStream
pattern - the regular expression Pattern for the delimiter
closure - a closure
Returns:
the last value returned by the closure
See Also:
splitEachLine(java.io.Reader, java.util.regex.Pattern, groovy.lang.Closure)
Since:
1.6.8


splitEachLine

public static Object splitEachLine(String self, String regex, Closure closure)
Iterates through the given String line by line, splitting each line using the given separator. The list of tokens for each line is then passed to the given closure.
throws:
java.io.IOException if an error occurs
throws:
java.util.regex.PatternSyntaxException if the regular expression's syntax is invalid
Parameters:
self - a String
regex - the delimiting regular expression
closure - a closure
Returns:
the last value returned by the closure
See Also:
String.split
Since:
1.5.5


splitEachLine

public static Object splitEachLine(String self, Pattern pattern, Closure closure)
Iterates through the given String line by line, splitting each line using the given separator Pattern. The list of tokens for each line is then passed to the given closure.
throws:
java.io.IOException if an error occurs
Parameters:
self - a String
pattern - the regular expression Pattern for the delimiter
closure - a closure
Returns:
the last value returned by the closure
See Also:
Pattern.split
Since:
1.6.8


spread

public static SpreadMap spread(Map self)
Synonym for toSpreadMap(java.util.Map).
Parameters:
self - a map
Returns:
a newly created Spreadmap
Since:
1.0


sprintf

public static String sprintf(Object self, String format, Object[] values)
Sprintf to a string (Only works with JDK1.5 or later).
Parameters:
self - any Object
format - a format string
values - values referenced by the format specifiers in the format string.
Returns:
the resulting formatted string
Since:
1.5.0


sprintf

public static String sprintf(Object self, String format, Object arg)
Returns a formatted string using the specified format string and arguments.

Parameters:
self - any Object
format - A format string
arg - Argument which is referenced by the format specifiers in the format string. The type of arg should be one of Object[], List, int[], short[], byte[], char[], boolean[], long[], float[], or double[].
Returns:
the resulting printf'd string
Since:
1.5.0


step

public static void step(Number self, Number to, Number stepNumber, Closure closure)
Iterates from this number up to the given number using a step increment. Each intermediate number is passed to the given closure. Example:
0.step( 10, 2 ) {
   println it
 }
Prints even numbers 0 through 8.
Parameters:
self - a Number to start with
to - a Number to go up to, exclusive
stepNumber - a Number representing the step increment
closure - the closure to call
Since:
1.0


stripIndent

public static String stripIndent(String self)

Strip leading spaces from every line in a String. The line with the least number of leading spaces determines the number to remove. Lines only containing whitespace are ignored when calculating the number of leading spaces to strip.

 assert '  A\n B\nC' == '   A\n  B\n C'.stripIndent()
 
Parameters:
self - The String to strip the leading spaces from
See Also:
stripIndent(String, int)
Since:
1.7.3


stripIndent

public static String stripIndent(String self, int numChars)

Strip numChar leading characters from every line in a String.

 assert 'DEF\n456' == '''ABCDEF\n123456'''.stripIndent(3)
 
Parameters:
self - The String to strip the characters from
numChars - The number of characters to strip
Since:
1.7.3


stripMargin

public static String stripMargin(String self)

Strip leading whitespace/control characters followed by '|' from every line in a String.

 assert 'ABC\n123\n456' == '''ABC
                             |123
                             |456'''.stripMargin()
 
Parameters:
self - The String to strip the margin from
See Also:
stripMargin(String, char)
Since:
1.7.3


stripMargin

public static String stripMargin(String self, String marginChar)

Strip leading whitespace/control characters followed by marginChar from every line in a String.

Parameters:
self - The String to strip the margin from
marginChar - Any character that serves as margin delimiter
See Also:
stripMargin(String, char)
Since:
1.7.3


stripMargin

public static String stripMargin(String self, char marginChar)

Strip leading whitespace/control characters followed by marginChar from every line in a String.

 assert 'ABC\n123\n456' == '''ABC
                             *123
                             *456'''.stripMargin('*')
 
Parameters:
self - The String to strip the margin from
marginChar - Any character that serves as margin delimiter
Since:
1.7.3


subMap

public static Map subMap(Map map, Collection keys)
Creates a sub-Map containing the given keys. This method is similar to List.subList() but uses keys rather than index ranges.
assert [1:10, 2:20, 4:40].subMap( [2, 4] ) == [2:20, 4:40]
Parameters:
map - a Map
keys - a Collection of keys
Returns:
a new Map containing the given keys
Since:
1.0


subsequences

public static Set subsequences(List self)
Finds all non-null subsequences of a list. E.g.
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


sum

public static Object sum(Collection self)
Sums the items in a collection. This is equivalent to invoking the "plus" method on all items in the collection.
assert 1+2+3+4 == [1,2,3,4].sum()
Parameters:
self - Collection of values to add together
Returns:
The sum of all of the items
Since:
1.0


sum

public static Object sum(Object[] self)
Sums the items in an array. This is equivalent to invoking the "plus" method on all items in the array.
Parameters:
self - The array of values to add together
Returns:
The sum of all of the items
See Also:
sum(java.util.Collection)
Since:
1.7.1


sum

public static Object sum(Iterator self)
Sums the items from an Iterator. This is equivalent to invoking the "plus" method on all items from the Iterator. The iterator will become exhausted of elements after determining the sum value.
Parameters:
self - an Iterator for the values to add together
Returns:
The sum of all of the items
Since:
1.5.5


sum

public static Object sum(Collection self, Object initialValue)
Sums the items in a collection, adding the result to some initial value.
assert 5+1+2+3+4 == [1,2,3,4].sum(5)
Parameters:
self - a collection of values to sum
initialValue - the items in the collection will be summed to this initial value
Returns:
The sum of all of the items.
Since:
1.5.0


sum

public static Object sum(Object[] self, Object initialValue)
Sums the items in an array, adding the result to some initial value.
Parameters:
self - an array of values to sum
initialValue - the items in the array will be summed to this initial value
Returns:
The sum of all of the items.
Since:
1.7.1


sum

public static Object sum(Iterator self, Object initialValue)
Sums the items from an Iterator, adding the result to some initial value. This is equivalent to invoking the "plus" method on all items from the Iterator. The iterator will become exhausted of elements after determining the sum value.
Parameters:
self - an Iterator for the values to add together
initialValue - the items in the collection will be summed to this initial value
Returns:
The sum of all of the items
Since:
1.5.5


sum

public static Object sum(Collection self, Closure closure)
Sums the result of apply a closure to each item of a collection. coll.sum(closure) is equivalent to: coll.collect(closure).sum().
assert 4+6+10+12 == [2,3,5,6].sum() { it * 2 }
Parameters:
self - a Collection
closure - a single parameter closure that returns a numeric value.
Returns:
The sum of the values returned by applying the closure to each item of the collection.
Since:
1.0


sum

public static Object sum(Object[] self, Closure closure)
Sums the result of apply a closure to each item of an array. array.sum(closure) is equivalent to: array.collect(closure).sum().
Parameters:
self - An array
closure - a single parameter closure that returns a numeric value.
Returns:
The sum of the values returned by applying the closure to each item of the array.
Since:
1.7.1


sum

public static Object sum(Iterator self, Closure closure)
Sums the result of apply a closure to each item returned from an iterator. iter.sum(closure) is equivalent to: iter.collect(closure).sum(). The iterator will become exhausted of elements after determining the sum value.
Parameters:
self - An Iterator
closure - a single parameter closure that returns a numeric value.
Returns:
The sum of the values returned by applying the closure to each item from the Iterator.
Since:
1.7.1


sum

public static Object sum(Collection self, Object initialValue, Closure closure)
Sums the result of applying a closure to each item of a collection to some initial value. coll.sum(initVal, closure) is equivalent to: coll.collect(closure).sum(initVal).
assert 50+4+6+10+12 == [2,3,5,6].sum(50) { it * 2 }
Parameters:
self - a Collection
closure - a single parameter closure that returns a numeric value.
initialValue - the closure results will be summed to this initial value
Returns:
The sum of the values returned by applying the closure to each item of the collection.
Since:
1.5.0


sum

public static Object sum(Object[] self, Object initialValue, Closure closure)
Sums the result of applying a closure to each item of an array to some initial value. array.sum(initVal, closure) is equivalent to: array.collect(closure).sum(initVal).
Parameters:
self - an array
closure - a single parameter closure that returns a numeric value.
initialValue - the closure results will be summed to this initial value
Returns:
The sum of the values returned by applying the closure to each item of the array.
Since:
1.7.1


sum

public static Object sum(Iterator self, Object initialValue, Closure closure)
Sums the result of applying a closure to each item of an Iterator to some initial value. iter.sum(initVal, closure) is equivalent to: iter.collect(closure).sum(initVal). The iterator will become exhausted of elements after determining the sum value.
Parameters:
self - an Iterator
closure - a single parameter closure that returns a numeric value.
initialValue - the closure results will be summed to this initial value
Returns:
The sum of the values returned by applying the closure to each item from the Iterator.
Since:
1.7.1


tail

public static List tail(List self)
Returns the items from the List excluding the first item.
def list = [3, 4, 2]
 assert list.tail() == [4, 2]
 assert list == [3, 4, 2]
throws:
NoSuchElementException if the list is empty and you try to access the tail() item.
Parameters:
self - a List
Returns:
a list without its first element
Since:
1.5.6


tail

public static T[] tail(T[] self)
Returns the items from the Object array excluding the first item.
     String[] strings = ["a", "b", "c"]
     def result = strings.tail()
     assert strings.class.componentType == String
 
throws:
NoSuchElementException if the list is empty and you try to access the tail() item.
Parameters:
self - an Object array
Returns:
an Object array without its first element
Since:
1.7.3


times

public static void times(Number self, Closure closure)
Executes the closure this many times, starting from zero. The current index is passed to the closure each time. Example:
10.times {
   println it
 }
Prints the numbers 0 through 9.
Parameters:
self - a Number
closure - the closure to call a number of times
Since:
1.0


toArrayString

public static String toArrayString(Object[] self)
Returns the string representation of the given array. The string displays the contents of the array, similar to an array literal, i.e. {1, 2, "a"}.
Parameters:
self - an Object[]
Returns:
the string representation
Since:
1.0


toBigDecimal

public static BigDecimal toBigDecimal(String self)
Parse a String into a BigDecimal
Parameters:
self - a String
Returns:
a BigDecimal
Since:
1.0


toBigDecimal

public static BigDecimal toBigDecimal(Number self)
Transform a Number into a BigDecimal
Parameters:
self - a Number
Returns:
an BigDecimal
Since:
1.0


toBigInteger

public static BigInteger toBigInteger(String self)
Parse a String into a BigInteger
Parameters:
self - a String
Returns:
a BigInteger
Since:
1.0


toBigInteger

public static BigInteger toBigInteger(Number self)
Transform this Number into a BigInteger.
Parameters:
self - a Number
Returns:
an BigInteger
Since:
1.0


toBoolean

public static Boolean toBoolean(String self)
Converts the given string into a Boolean object. If the trimmed string is "true", "y" or "1" (ignoring case) then the result is true othewrwise it is false.
Parameters:
self - a String
Returns:
The Boolean value
Since:
1.0


toBoolean

public static Boolean toBoolean(Boolean self)
Identity conversion which returns Boolean.TRUE for a true Boolean and Boolean.FALSE for a false Boolean.
Parameters:
self - a Boolean
Returns:
the original Boolean
Since:
1.7.6


toCharacter

public static Character toCharacter(String self)
Converts the given string into a Character object using the first character in the string.
Parameters:
self - a String
Returns:
the first Character
Since:
1.0


toDouble

public static Double toDouble(String self)
Parse a String into a Double
Parameters:
self - a String
Returns:
a Double
Since:
1.0


toDouble

public static Double toDouble(Number self)
Transform a Number into a Double
Parameters:
self - a Number
Returns:
an Double
Since:
1.0


toFloat

public static Float toFloat(String self)
Parse a String into a Float
Parameters:
self - a String
Returns:
a Float
Since:
1.0


toFloat

public static Float toFloat(Number self)
Transform a Number into a Float
Parameters:
self - a Number
Returns:
an Float
Since:
1.0


toInteger

public static Integer toInteger(String self)
Parse a String into an Integer
Parameters:
self - a String
Returns:
an Integer
Since:
1.0


toInteger

public static Integer toInteger(Number self)
Transform a Number into an Integer
Parameters:
self - a Number
Returns:
an Integer
Since:
1.0


toList

public static List toList(Collection self)
Convert a Collection to a List. Always returns a new List even if the Collection is already a List.

Example usage:

def x = [1,2,3] as HashSet
 assert x.class == HashSet
 assert x.toList() instanceof List
Parameters:
self - a collection
Returns:
a List
Since:
1.0


toList

public static List toList(Iterator self)
Convert an iterator to a List. The iterator will become exhausted of elements after making this conversion.
Parameters:
self - an iterator
Returns:
a List
Since:
1.5.0


toList

public static List toList(Enumeration self)
Convert an enumeration to a List.
Parameters:
self - an enumeration
Returns:
a List
Since:
1.5.0


toList

public static List toList(T[] array)
Allows conversion of arrays into a mutable List.
Parameters:
array - an Array of Objects
Returns:
the array as a List
Since:
1.0


toList

@SuppressWarnings("unchecked")
public static List toList(byte[] array)
Converts this array to a List of the same size, with each element added to the list.
Parameters:
array - a byte array
Returns:
a list containing the contents of this array.
Since:
1.0


toList

@SuppressWarnings("unchecked")
public static List toList(boolean[] array)
Converts this array to a List of the same size, with each element added to the list.
Parameters:
array - a boolean array
Returns:
a list containing the contents of this array.
Since:
1.6.0


toList

@SuppressWarnings("unchecked")
public static List toList(char[] array)
Converts this array to a List of the same size, with each element added to the list.
Parameters:
array - a char array
Returns:
a list containing the contents of this array.
Since:
1.0


toList

@SuppressWarnings("unchecked")
public static List toList(short[] array)
Converts this array to a List of the same size, with each element added to the list.
Parameters:
array - a short array
Returns:
a list containing the contents of this array.
Since:
1.0


toList

@SuppressWarnings("unchecked")
public static List toList(int[] array)
Converts this array to a List of the same size, with each element added to the list.
Parameters:
array - an int array
Returns:
a list containing the contents of this array.
Since:
1.0


toList

@SuppressWarnings("unchecked")
public static List toList(long[] array)
Converts this array to a List of the same size, with each element added to the list.
Parameters:
array - a long array
Returns:
a list containing the contents of this array.
Since:
1.0


toList

@SuppressWarnings("unchecked")
public static List toList(float[] array)
Converts this array to a List of the same size, with each element added to the list.
Parameters:
array - a float array
Returns:
a list containing the contents of this array.
Since:
1.0


toList

@SuppressWarnings("unchecked")
public static List toList(double[] array)
Converts this array to a List of the same size, with each element added to the list.
Parameters:
array - a double array
Returns:
a list containing the contents of this array.
Since:
1.0


toList

public static List toList(String self)
Converts the given String into a List of strings of one character.
Parameters:
self - a String
Returns:
a List of characters (a 1-character String)
Since:
1.0


toListString

public static String toListString(Collection self)
Returns the string representation of the given list. The string displays the contents of the list, similar to a list literal, i.e. [1, 2, a].
Parameters:
self - a Collection
Returns:
the string representation
Since:
1.0


toListString

public static String toListString(Collection self, int maxSize)
Returns the string representation of the given list. The string displays the contents of the list, similar to a list literal, i.e. [1, 2, a].
Parameters:
self - a Collection
maxSize - stop after approximately this many characters and append '...'
Returns:
the string representation
Since:
1.7.3


toLong

public static Long toLong(String self)
Parse a String into a Long
Parameters:
self - a String
Returns:
a Long
Since:
1.0


toLong

public static Long toLong(Number self)
Transform a Number into a Long
Parameters:
self - a Number
Returns:
an Long
Since:
1.0


toLowerCase

public static char toLowerCase(Character self)
Converts the character to lowercase. Synonym for 'Character.toLowerCase(this)'.
Parameters:
self - a Character to convert
Returns:
the lowercase equivalent of the character, if any; otherwise, the character itself.
See Also:
Character.isLowerCase
String.toLowerCase
Since:
1.5.7


toMapString

public static String toMapString(Map self)
Returns the string representation of this map. The string displays the contents of the map, i.e. [one:1, two:2, three:3].
Parameters:
self - a Map
Returns:
the string representation
Since:
1.0


toMapString

public static String toMapString(Map self, int maxSize)
Returns the string representation of this map. The string displays the contents of the map, i.e. [one:1, two:2, three:3].
Parameters:
self - a Map
maxSize - stop after approximately this many characters and append '...'
Returns:
the string representation
Since:
1.0


toRowResult

@Deprecated
public static def toRowResult(def rs)
deprecated:
moved to SqlGroovyMethods.toRowResult


toShort

public static Short toShort(String self)
Parse a String into a Short
Parameters:
self - a String
Returns:
a Short
Since:
1.5.7


toSpreadMap

public static SpreadMap toSpreadMap(Map self)
Returns a new SpreadMap from this map.

For examples, if there is defined a function like as

     def fn(a, b, c, d) { return a + b + c + d }
 
, then all of the following three have the same meaning.
     println fn(a:1, [b:2, c:3].toSpreadMap(), d:4)
     println fn(a:1, *:[b:2, c:3], d:4)
     println fn(a:1, b:2, c:3, d:4)
 

Parameters:
self - a list to be converted into a spreadmap
Returns:
a newly created Spreadmap if this list is not null and its size is positive.
See Also:
SpreadMap.SpreadMap
Since:
1.0


toSpreadMap

public static SpreadMap toSpreadMap(Object[] self)
Creates a spreadable map from this array.
Parameters:
self - an object array
Returns:
a newly created Spreadmap
See Also:
SpreadMap.SpreadMap
Since:
1.0


toString

public static String toString(boolean[] self)
Returns the string representation of the given array.
Parameters:
self - an array
Returns:
the string representation
Since:
1.6.0


toString

public static String toString(byte[] self)
Returns the string representation of the given array.
Parameters:
self - an array
Returns:
the string representation
Since:
1.6.0


toString

public static String toString(char[] self)
Returns the string representation of the given array.
Parameters:
self - an array
Returns:
the string representation
Since:
1.6.0


toString

public static String toString(short[] self)
Returns the string representation of the given array.
Parameters:
self - an array
Returns:
the string representation
Since:
1.6.0


toString

public static String toString(int[] self)
Returns the string representation of the given array.
Parameters:
self - an array
Returns:
the string representation
Since:
1.6.0


toString

public static String toString(long[] self)
Returns the string representation of the given array.
Parameters:
self - an array
Returns:
the string representation
Since:
1.6.0


toString

public static String toString(float[] self)
Returns the string representation of the given array.
Parameters:
self - an array
Returns:
the string representation
Since:
1.6.0


toString

public static String toString(double[] self)
Returns the string representation of the given array.
Parameters:
self - an array
Returns:
the string representation
Since:
1.6.0


toString

public static String toString(AbstractMap self)
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


toString

public static String toString(AbstractCollection self)
Returns the string representation of the given collection. The string displays the contents of the collection, i.e. [1, 2, a].
Parameters:
self - a Collection
Returns:
the string representation
See Also:
toListString(java.util.Collection)
Since:
1.0


toString

public static String toString(Object[] self)
Returns the string representation of this array's contents.
Parameters:
self - an Object[]
Returns:
the string representation
See Also:
toArrayString(java.lang.Object[])
Since:
1.0


toString

public static String toString(Object value)
Create a String representation of this object.
Parameters:
value - an object
Returns:
a string.
Since:
1.0


toURI

public static URI toURI(String self)
Transforms a String representing a URI into a URI object.
throws:
URISyntaxException is thrown if the URI is not well formed.
Parameters:
self - the String representing a URI
Returns:
a URI
Since:
1.0


toURL

public static URL toURL(String self)
Transforms a String representing a URL into a URL object.
throws:
MalformedURLException is thrown if the URL is not well formed.
Parameters:
self - the String representing a URL
Returns:
a URL
Since:
1.0


toUpperCase

public static char toUpperCase(Character self)
Converts the character to uppercase. Synonym for 'Character.toUpperCase(this)'.
Parameters:
self - a Character to convert
Returns:
the uppercase equivalent of the character, if any; otherwise, the character itself.
See Also:
Character.isUpperCase
String.toUpperCase
Since:
1.5.7


tokenize

public static List tokenize(String self, String token)
Tokenize a String based on the given string delimiter.
Parameters:
self - a String
token - the delimiter
Returns:
a List of tokens
See Also:
StringTokenizer.StringTokenizer
Since:
1.0


tokenize

public static List tokenize(String self, Character token)
Tokenize a String based on the given character delimiter. For example:
 char pathSep = ':'
 assert "/tmp:/usr".tokenize(pathSep) == ["/tmp", "/usr"]
 
Parameters:
self - a String
token - the delimiter
Returns:
a List of tokens
See Also:
StringTokenizer.StringTokenizer
Since:
1.7.2


tokenize

public static List tokenize(String self)
Tokenize a String (with a whitespace as the delimiter).
Parameters:
self - a String
Returns:
a List of tokens
See Also:
StringTokenizer.StringTokenizer
Since:
1.0


tr

public static String tr(String self, String sourceSet, String replacementSet)
Translates a string by replacing characters from the sourceSet with characters from replacementSet. If the first character from sourceSet appears in the string, it will be replaced with the first character from replacementSet. If the second character from sourceSet appears in the string, it will be replaced with the second character from replacementSet. and so on for all provided replacement characters.

Here is an example which converts the vowels in a word from lower to uppercase:

 assert 'hello'.tr('aeiou', 'AEIOU') == 'hEllO'
 
A character range using regex-style syntax can also be used, e.g. here is an example which converts a word from lower to uppercase:
 assert 'hello'.tr('a-z', 'A-Z') == 'HELLO'
 
Hyphens at the start or end of sourceSet or replacementSet are treated as normal hyphens and are not considered to be part of a range specification. Similarly, a hyphen immediately after an earlier range is treated as a normal hyphen. So, '-x', 'x-' have no ranges while 'a-c-e' has the range 'a-c' plus the '-' character plus the 'e' character.

Unlike the unix tr command, Groovy's tr command supports reverse ranges, e.g.:

 assert 'hello'.tr('z-a', 'Z-A') == 'HELLO'
 
If replacementSet is smaller than sourceSet, then the last character from replacementSet is used as the replacement for all remaining source characters as shown here:
 assert 'Hello World!'.tr('a-z', 'A') == 'HAAAA WAAAA!'
 
If sourceSet contains repeated characters, the last specified replacement is used as shown here:
 assert 'Hello World!'.tr('lloo', '1234') == 'He224 W4r2d!'
 
The functionality provided by tr can be achieved using regular expressions but tr provides a much more compact notation and efficient implementation for certain scenarios.
Parameters:
self - the string that is to be translated
sourceSet - the set of characters to translate from
replacementSet - the set of replacement characters
Returns:
The resulting translated String
See Also:
StringUtil.tr
Since:
1.7.3


transformChar

public static void transformChar(Reader self, Writer writer, Closure closure)
Transforms each character from this reader by passing it to the given closure. The Closure should return each transformed character, which will be passed to the Writer. The reader and writer will be both be closed before this method returns.
throws:
IOException if an IOException occurs.
Parameters:
self - a Reader object
writer - a Writer to receive the transformed characters
closure - a closure that performs the required transformation
Since:
1.5.0


transformLine

public static void transformLine(Reader reader, Writer writer, Closure closure)
Transforms the lines from a reader with a Closure and write them to a writer. Both Reader and Writer are closed after the operation.
throws:
IOException if an IOException occurs.
Parameters:
reader - Lines of text to be transformed. Reader is closed afterwards.
writer - Where transformed lines are written. Writer is closed afterwards.
closure - Single parameter closure that is called to transform each line of text from the reader, before writing it to the writer.
Since:
1.0


transpose

public static List transpose(List self)
Adds GroovyCollections#transpose(List) as a method on lists.
def result = [['a', 'b'], [1, 2]].transpose()
 assert result == [['a', 1], ['b', 2]]
Parameters:
self - a List of lists
Returns:
a List of the transposed lists
See Also:
GroovyCollections.transpose
Since:
1.5.0


traverse

public static void traverse(File self, Map options, Closure closure)
Invokes closure for each descendant file in this directory tree. Sub-directories are recursively traversed as found. The traversal can be adapted by providing various options in the options Map according to the following keys:
type
A FileType enum to determine if normal files or directories or both are processed
preDir
A Closure run before each directory is processed and optionally returning a FileVisitResult value which can be used to control subsequent processing.
preRoot
A boolean indicating that the 'preDir' closure should be applied at the root level
postDir
A Closure run after each directory is processed and optionally returning a FileVisitResult value which can be used to control subsequent processing.
postRoot
A boolean indicating that the 'postDir' closure should be applied at the root level
visitRoot
A boolean indicating that the given closure should be applied for the root dir (not applicable if the 'type' is set to FileType.FILES)
maxDepth
The maximum number of directory levels when recursing (default is -1 which means infinite, set to 0 for no recursion)
filter
A filter to perform on traversed files/directories (using the isCase(java.lang.Object, java.lang.Object) method). If set, only files/dirs which match are candidates for visiting.
nameFilter
A filter to perform on the name of traversed files/directories (using the isCase(java.lang.Object, java.lang.Object) method). If set, only files/dirs which match are candidates for visiting. (Must not be set if 'filter' is set)
excludeFilter
A filter to perform on traversed files/directories (using the isCase(java.lang.Object, java.lang.Object) method). If set, any candidates which match won't be visited.
excludeNameFilter
A filter to perform on the names of traversed files/directories (using the isCase(java.lang.Object, java.lang.Object) method). If set, any candidates which match won't be visited. (Must not be set if 'excludeFilter' is set)
sort
A Closure which if set causes the files and subdirectories for each directory to be processed in sorted order. Note that even when processing only files, the order of visited subdirectories will be affected by this parameter.
This example prints out file counts and size aggregates for groovy source files within a directory tree:
 def totalSize = 0
 def count = 0
 def sortByTypeThenName = { a, b ->
     a.isFile() != b.isFile() ? a.isFile() <=> b.isFile() : a.name <=> b.name
 }
 rootDir.traverse(
         type         : FILES,
         nameFilter   : ~/.*\.groovy/,
         preDir       : { if (it.name == '.svn') return SKIP_SUBTREE },
         postDir      : { println "Found $count files in $it.name totalling $totalSize bytes"
                         totalSize = 0; count = 0 },
         postRoot     : true
         sort         : sortByTypeThenName
 ) {it -> totalSize += it.size(); count++ }
 
throws:
FileNotFoundException if the given directory does not exist
throws:
IllegalArgumentException if the provided File object does not represent a directory or illegal filter combinations are supplied
Parameters:
self - a File
options - a Map of options to alter the traversal behavior
closure - the Closure to invoke on each file/directory and optionally returning a FileVisitResult value which can be used to control subsequent processing
See Also:
sort(java.util.Collection, groovy.lang.Closure)
FileVisitResult
FileType
Since:
1.7.1


traverse

public static void traverse(File self, Closure closure)
Invokes the closure for each descendant file in this directory tree. Sub-directories are recursively traversed in a depth-first fashion. Convenience method for traverse(java.io.File, java.util.Map, groovy.lang.Closure) when no options to alter the traversal behavior are required.
throws:
FileNotFoundException if the given directory does not exist
throws:
IllegalArgumentException if the provided File object does not represent a directory
Parameters:
self - a File
closure - the Closure to invoke on each file/directory and optionally returning a FileVisitResult value which can be used to control subsequent processing
See Also:
traverse(java.io.File, java.util.Map, groovy.lang.Closure)
Since:
1.7.1


traverse

public static void traverse(File self, Map options)
Invokes the closure specified with key 'visit' in the options Map for each descendant file in this directory tree. Convenience method for traverse(java.io.File, java.util.Map, groovy.lang.Closure) allowing the 'visit' closure to be included in the options Map rather than as a parameter.
throws:
FileNotFoundException if the given directory does not exist
throws:
IllegalArgumentException if the provided File object does not represent a directory or illegal filter combinations are supplied
Parameters:
self - a File
options - a Map of options to alter the traversal behavior
See Also:
traverse(java.io.File, java.util.Map, groovy.lang.Closure)
Since:
1.7.1


trunc

public static float trunc(Float number, int precision)
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


trunc

public static float trunc(Float number)
Truncate the value
Parameters:
number - a Double
Returns:
the Double truncated to 0 decimal places (i.e. a synonym for floor)
Since:
1.6.0


trunc

public static double trunc(Double number)
Truncate the value
Parameters:
number - a Double
Returns:
the Double truncated to 0 decimal places (i.e. a synonym for floor)
Since:
1.6.4


trunc

public static double trunc(Double number, int precision)
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


unaryMinus

public static Number unaryMinus(Number left)
Negates the number. Equivalent to the '-' operator when it preceeds a single operand, i.e. -10
Parameters:
left - a Number
Returns:
the negation of the number
Since:
1.5.0


unexpand

public static String unexpand(String self)
Replaces sequences of whitespaces with tabs using tabStops of size 8.
Parameters:
self - A String to unexpand
Returns:
The unexpanded String
See Also:
unexpand(java.lang.String, int)
Since:
1.7.3


unexpand

public static String unexpand(String self, int tabStop)
Replaces sequences of whitespaces with tabs.
Parameters:
self - A String to unexpand
tabStop - The number of spaces a tab represents
Returns:
The unexpanded String
Since:
1.7.3


unexpandLine

public static String unexpandLine(String self, int tabStop)
Replaces sequences of whitespaces with tabs within a line.
Parameters:
self - A line to unexpand
tabStop - The number of spaces a tab represents
Returns:
The unexpanded String
Since:
1.7.3


unique

public static Iterator unique(Iterator self)
Returns an iterator equivalent to this iterator all duplicated items removed by using the default comparator. The original iterator will become exhausted of elements after determining the unique values. A new iterator for the unique values will be returned.
Parameters:
self - an Iterator
Returns:
the modified Iterator
Since:
1.5.5


unique

public static Collection unique(Collection self)
Modifies this collection to remove all duplicated items, using the default comparator.
assert [1,3] == [1,3,3].unique()
Parameters:
self - a collection
Returns:
the now modified collection
Since:
1.0


unique

public static Iterator unique(Iterator self, Closure closure)
Returns an iterator equivalent to this iterator but with all duplicated items removed by using a Closure to determine duplicate (equal) items. The original iterator will be fully processed after the call.

If the closure takes a single parameter, the argument passed will be each element, and the closure should return a value used for comparison (either using Comparable.compareTo or Object.equals). If the closure takes two parameters, two items from the Iterator will be passed as arguments, and the closure should return an int value (with 0 indicating the items are not unique).
Parameters:
self - an Iterator
closure - a Closure used to determine unique items
Returns:
the modified Iterator
Since:
1.5.5


unique

public static Collection unique(Collection self, Closure closure)
A convenience method for making a collection unique using a Closure to determine duplicate (equal) items.

If the closure takes a single parameter, the argument passed will be each element, and the closure should return a value used for comparison (either using Comparable.compareTo or Object.equals). If the closure takes two parameters, two items from the collection will be passed as arguments, and the closure should return an int value (with 0 indicating the items are not unique).
assert [1,4] == [1,3,4,5].unique { it % 2 }
assert [2,3,4] == [2,3,3,4].unique { a, b -> a <=> b }
Parameters:
self - a Collection
closure - a 1 or 2 arg Closure used to determine unique items
Returns:
self without any duplicates
Since:
1.0


unique

public static Iterator unique(Iterator self, Comparator comparator)
Returns an iterator equivalent to this iterator with all duplicated items removed by using the supplied comparator.
Parameters:
self - an Iterator
comparator - a Comparator
Returns:
the modified Iterator
Since:
1.5.5


unique

public static Collection unique(Collection self, Comparator comparator)
Remove all duplicates from a given Collection. Works on the receiver object and returns it. The order of members in the Collection are compared by the given Comparator. For each duplicate, the first member which is returned by the given Collection's iterator is retained, but all other ones are removed. The given Collection's original order is preserved.

     class Person {
         def fname, lname
         public String toString() {
             return fname + " " + lname
         }
     }

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

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

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

     def list = [a, b, c, d]
     List list2 = list.unique(new PersonComparator())
     assert( list2 == list && list == [a, b, c] )
 
Parameters:
self - a Collection
comparator - a Comparator
Returns:
self the now modified collection without duplicates
Since:
1.0


upto

public static void upto(Number self, Number to, Closure closure)
Iterates from this number up to the given number, inclusive, incrementing by one each time.
Parameters:
self - a Number
to - another Number to go up to
closure - the closure to call
Since:
1.0


upto

public static void upto(long self, Number to, Closure closure)
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


upto

public static void upto(Long self, Number to, Closure closure)
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


upto

public static void upto(float self, Number to, Closure closure)
Iterates from this number up to the given number, inclusive, incrementing by one each time.
Parameters:
self - a float
to - the end number
closure - the code to execute for each number
Since:
1.0


upto

public static void upto(Float self, Number to, Closure closure)
Iterates from this number up to the given number, inclusive, incrementing by one each time.
Parameters:
self - a Float
to - the end number
closure - the code to execute for each number
Since:
1.0


upto

public static void upto(double self, Number to, Closure closure)
Iterates from this number up to the given number, inclusive, incrementing by one each time.
Parameters:
self - a double
to - the end number
closure - the code to execute for each number
Since:
1.0


upto

public static void upto(Double self, Number to, Closure closure)
Iterates from this number up to the given number, inclusive, incrementing by one each time.
Parameters:
self - a Double
to - the end number
closure - the code to execute for each number
Since:
1.0


upto

public static void upto(BigInteger self, Number to, Closure closure)
Iterates from this number up to the given number, inclusive, incrementing by one each time. Example:
0.upto( 10 ) {
   println it
 }
Prints numbers 0 to 10
Parameters:
self - a BigInteger
to - the end number
closure - the code to execute for each number
Since:
1.0


upto

public static void upto(BigDecimal self, Number to, Closure closure)
Iterates from this number up to the given number, inclusive, incrementing by one each time.
0.1.upto( 10 ) {
   println it
 }
Prints numbers 0.1, 1.1, 2.1... to 9.1
Parameters:
self - a BigDecimal
to - the end number
closure - the code to execute for each number
Since:
1.0


use

public static Object use(Object self, Class categoryClass, Closure closure)
Scoped use method
Parameters:
self - any Object
categoryClass - a category class to use
closure - the closure to invoke with the category in place
Returns:
the value returned from the closure
Since:
1.0


use

public static Object use(Object self, List categoryClassList, Closure closure)
Scoped use method with list of categories.
Parameters:
self - any Object
categoryClassList - a list of category classes
closure - the closure to invoke with the categories in place
Returns:
the value returned from the closure
Since:
1.0


use

public static Object use(Object self, Object[] array)
Allows you to use a list of categories, specifying the list as varargs. use(CategoryClass1, CategoryClass2) { ... } This method saves having to wrap the the category classes in a list.
Parameters:
self - any Object
array - a list of category classes and a Closure
Returns:
the value returned from the closure
Since:
1.0


waitForOrKill

@Deprecated
public static void waitForOrKill(Process self, long numberOfMillis)
deprecated:
use ProcessGroovyMethods#waitForOrKill(Process, long)


waitForProcessOutput

@Deprecated
public static void waitForProcessOutput(Process self)
deprecated:
use ProcessGroovyMethods#waitForProcessOutput(Process)


waitForProcessOutput

@Deprecated
public static void waitForProcessOutput(Process self, StringBuffer output, StringBuffer error)
deprecated:
use #waitForProcessOutput(Process, Appendable, Appendable)


waitForProcessOutput

@Deprecated
public static void waitForProcessOutput(Process self, OutputStream output, OutputStream error)
deprecated:
use ProcessGroovyMethods#waitForProcessOutput(Process, OutputStream, OutputStream)


with

public static Object with(Object self, Closure closure)
Allows the closure to be called for the object reference self
Parameters:
self - the object to have a closure act upon
closure - the closure to call on the object
Returns:
result of calling the closure
Since:
1.5.0


withDataInputStream

public static Object withDataInputStream(File file, Closure closure)
Create a new DataInputStream for this file and passes it into the closure. This method ensures the stream is closed after the closure returns.
throws:
IOException if an IOException occurs.
Parameters:
file - a File
closure - a closure
Returns:
the value returned by the closure
See Also:
withStream(java.io.InputStream, groovy.lang.Closure)
Since:
1.5.2


withDataOutputStream

public static Object withDataOutputStream(File file, Closure closure)
Create a new DataOutputStream for this file and passes it into the closure. This method ensures the stream is closed after the closure returns.
throws:
IOException if an IOException occurs.
Parameters:
file - a File
closure - a closure
Returns:
the value returned by the closure
See Also:
withStream(java.io.OutputStream, groovy.lang.Closure)
Since:
1.5.2


withDefault

public static Map withDefault(Map self, Closure init)
Wraps a map using the delegate pattern with a wrapper that intercepts all calls to get(key). If an unknown key is found, a default value will be stored into the Map before being returned. The default value stored will be the result of calling the supplied Closure with the key as the parameter to the Closure. Example usage:
 def map = [a:1, b:2].withDefault{ k -> k.toCharacter().isLowerCase() ? 10 : -10 }
 def expected = [a:1, b:2, c:10, D:-10]
 assert expected.every{ e -> e.value == map[e.key] }

 def constMap = [:].withDefault{ 42 }
 assert constMap.foo == 42
 assert constMap.size() == 1
 
Parameters:
self - a Map
init - a Closure which is passed the unknown key
Returns:
the wrapped Map
Since:
1.7.1


withInputStream

public static Object withInputStream(File file, Closure closure)
Create a new InputStream for this file and passes it into the closure. This method ensures the stream is closed after the closure returns.
throws:
IOException if an IOException occurs.
Parameters:
file - a File
closure - a closure
Returns:
the value returned by the closure
See Also:
withStream(java.io.InputStream, groovy.lang.Closure)
Since:
1.5.2


withInputStream

public static Object withInputStream(URL url, Closure closure)
Creates a new InputStream for this URL and passes it into the closure. This method ensures the stream is closed after the closure returns.
throws:
IOException if an IOException occurs.
Parameters:
url - a URL
closure - a closure
Returns:
the value returned by the closure
See Also:
withStream(java.io.InputStream, groovy.lang.Closure)
Since:
1.5.2


withObjectInputStream

public static Object withObjectInputStream(File file, Closure closure)
Create a new ObjectInputStream for this file and pass it to the closure. This method ensures the stream is closed after the closure returns.
throws:
IOException if an IOException occurs.
Parameters:
file - a File
closure - a closure
Returns:
the value returned by the closure
See Also:
withStream(java.io.InputStream, groovy.lang.Closure)
Since:
1.5.2


withObjectInputStream

public static Object withObjectInputStream(File file, ClassLoader classLoader, Closure closure)
Create a new ObjectInputStream for this file associated with the given class loader and pass it to the closure. This method ensures the stream is closed after the closure returns.
throws:
IOException if an IOException occurs.
Parameters:
file - a File
classLoader - the class loader to use when loading the class
closure - a closure
Returns:
the value returned by the closure
See Also:
withStream(java.io.InputStream, groovy.lang.Closure)
Since:
1.5.2


withObjectInputStream

public static Object withObjectInputStream(InputStream inputStream, Closure closure)
Create a new ObjectInputStream for this file and pass it to the closure. This method ensures the stream is closed after the closure returns.
throws:
IOException if an IOException occurs.
Parameters:
inputStream - an input stream
closure - a closure
Returns:
the value returned by the closure
See Also:
withStream(java.io.InputStream, groovy.lang.Closure)
Since:
1.5.0


withObjectInputStream

public static Object withObjectInputStream(InputStream inputStream, ClassLoader classLoader, Closure closure)
Create a new ObjectInputStream for this file and pass it to the closure. This method ensures the stream is closed after the closure returns.
throws:
IOException if an IOException occurs.
Parameters:
inputStream - an input stream
classLoader - the class loader to use when loading the class
closure - a closure
Returns:
the value returned by the closure
See Also:
withStream(java.io.InputStream, groovy.lang.Closure)
Since:
1.5.0


withObjectOutputStream

public static Object withObjectOutputStream(File file, Closure closure)
Create a new ObjectOutputStream for this file and then pass it to the closure. This method ensures the stream is closed after the closure returns.
throws:
IOException if an IOException occurs.
Parameters:
file - a File
closure - a closure
Returns:
the value returned by the closure
See Also:
withStream(java.io.OutputStream, groovy.lang.Closure)
Since:
1.5.0


withObjectOutputStream

public static Object withObjectOutputStream(OutputStream outputStream, Closure closure)
Create a new ObjectOutputStream for this output stream and then pass it to the closure. This method ensures the stream is closed after the closure returns.
throws:
IOException if an IOException occurs.
Parameters:
outputStream - am output stream
closure - a closure
Returns:
the value returned by the closure
See Also:
withStream(java.io.OutputStream, groovy.lang.Closure)
Since:
1.5.0


withObjectStreams

public static Object withObjectStreams(Socket socket, Closure closure)
Creates an InputObjectStream and an OutputObjectStream from a Socket, and passes them to the closure. The streams will be closed after the closure returns, even if an exception is thrown.
throws:
IOException if an IOException occurs.
Parameters:
socket - this Socket
closure - a Closure
Returns:
the value returned by the closure
Since:
1.5.0


withOutputStream

public static Object withOutputStream(File file, Closure closure)
Creates a new OutputStream for this file and passes it into the closure. This method ensures the stream is closed after the closure returns.
throws:
IOException if an IOException occurs.
Parameters:
file - a File
closure - a closure
Returns:
the value returned by the closure
See Also:
withStream(java.io.OutputStream, groovy.lang.Closure)
Since:
1.5.2


withOutputStream

@Deprecated
public static void withOutputStream(Process self, Closure closure)
deprecated:
use ProcessGroovyMethods#withOutputStream(Process, Closure)


withPrintWriter

public static Object withPrintWriter(File file, Closure closure)
Create a new PrintWriter for this file which is then passed it into the given closure. This method ensures its the writer is closed after the closure returns.
throws:
IOException if an IOException occurs.
Parameters:
file - a File
closure - the closure to invoke with the PrintWriter
Returns:
the value returned by the closure
Since:
1.5.2


withPrintWriter

public static Object withPrintWriter(File file, String charset, Closure closure)
Create a new PrintWriter with a specified charset for this file. The writer is passed to the closure, and will be closed before this method returns.
throws:
IOException if an IOException occurs.
Parameters:
file - a File
charset - the charset
closure - the closure to invoke with the PrintWriter
Returns:
the value returned by the closure
Since:
1.5.2


withPrintWriter

public static Object withPrintWriter(Writer writer, Closure closure)
Create a new PrintWriter with a specified charset for this file. The writer is passed to the closure, and will be closed before this method returns.
throws:
IOException if an IOException occurs.
Parameters:
writer - a writer
closure - the closure to invoke with the PrintWriter
Returns:
the value returned by the closure
Since:
1.6.0


withReader

public static Object withReader(File file, Closure closure)
Create a new BufferedReader for this file and then passes it into the closure, ensuring the reader is closed after the closure returns.
throws:
IOException if an IOException occurs.
Parameters:
file - a file object
closure - a closure
Returns:
the value returned by the closure
Since:
1.5.2


withReader

public static Object withReader(File file, String charset, Closure closure)
Create a new BufferedReader for this file using the specified charset and then passes it into the closure, ensuring the reader is closed after the closure returns.
throws:
IOException if an IOException occurs.
Parameters:
file - a file object
charset - the charset for this input stream
closure - a closure
Returns:
the value returned by the closure
Since:
1.6.0


withReader

public static Object withReader(Reader reader, Closure closure)
Allows this reader to be used within the closure, ensuring that it is closed before this method returns.
throws:
IOException if an IOException occurs.
Parameters:
reader - the reader which is used and then closed
closure - the closure that the writer is passed into
Returns:
the value returned by the closure
Since:
1.5.2


withReader

public static Object withReader(URL url, Closure closure)
Helper method to create a new BufferedReader for a URL and then passes it to the closure. The reader is closed after the closure returns.
throws:
IOException if an IOException occurs.
Parameters:
url - a URL
closure - the closure to invoke with the reader
Returns:
the value returned by the closure
Since:
1.5.2


withReader

public static Object withReader(URL url, String charset, Closure closure)
Helper method to create a new Reader for a URL and then passes it to the closure. The reader is closed after the closure returns.
throws:
IOException if an IOException occurs.
Parameters:
url - a URL
charset - the charset used
closure - the closure to invoke with the reader
Returns:
the value returned by the closure
Since:
1.5.6


withReader

public static Object withReader(InputStream in, Closure closure)
Helper method to create a new Reader for a stream and then passes it into the closure. The reader (and this stream) is closed after the closure returns.
throws:
IOException if an IOException occurs.
Parameters:
in - a stream
closure - the closure to invoke with the InputStream
Returns:
the value returned by the closure
See Also:
InputStreamReader
Since:
1.5.2


withReader

public static Object withReader(InputStream in, String charset, Closure closure)
Helper method to create a new Reader for a stream and then passes it into the closure. The reader (and this stream) is closed after the closure returns.
throws:
IOException if an IOException occurs.
Parameters:
in - a stream
charset - the charset used to decode the stream
closure - the closure to invoke with the reader
Returns:
the value returned by the closure
See Also:
InputStreamReader
Since:
1.5.6


withStream

public static Object withStream(InputStream stream, Closure closure)
Allows this input stream to be used within the closure, ensuring that it is flushed and closed before this method returns.
throws:
IOException if an IOException occurs.
Parameters:
stream - the stream which is used and then closed
closure - the closure that the stream is passed into
Returns:
the value returned by the closure
Since:
1.5.2


withStream

public static Object withStream(OutputStream os, Closure closure)
Passes this OutputStream to the closure, ensuring that the stream is closed after the closure returns, regardless of errors.
throws:
IOException if an IOException occurs.
Parameters:
os - the stream which is used and then closed
closure - the closure that the stream is passed into
Returns:
the value returned by the closure
Since:
1.5.2


withStreams

public static Object withStreams(Socket socket, Closure closure)
Passes the Socket's InputStream and OutputStream to the closure. The streams will be closed after the closure returns, even if an exception is thrown.
throws:
IOException if an IOException occurs.
Parameters:
socket - a Socket
closure - a Closure
Returns:
the value returned by the closure
Since:
1.5.2


withWriter

public static Object withWriter(File file, Closure closure)
Creates a new BufferedWriter for this file, passes it to the closure, and ensures the stream is flushed and closed after the closure returns.
throws:
IOException if an IOException occurs.
Parameters:
file - a File
closure - a closure
Returns:
the value returned by the closure
Since:
1.5.2


withWriter

public static Object withWriter(File file, String charset, Closure closure)
Creates a new BufferedWriter for this file, passes it to the closure, and ensures the stream is flushed and closed after the closure returns. The writer will use the given charset encoding.
throws:
IOException if an IOException occurs.
Parameters:
file - a File
charset - the charset used
closure - a closure
Returns:
the value returned by the closure
Since:
1.5.2


withWriter

public static Object withWriter(Writer writer, Closure closure)
Allows this writer to be used within the closure, ensuring that it is flushed and closed before this method returns.
throws:
IOException if an IOException occurs.
Parameters:
writer - the writer which is used and then closed
closure - the closure that the writer is passed into
Returns:
the value returned by the closure
Since:
1.5.2


withWriter

public static Object withWriter(OutputStream stream, Closure closure)
Creates a writer from this stream, passing it to the given closure. This method ensures the stream is closed after the closure returns.
throws:
IOException if an IOException occurs.
Parameters:
stream - the stream which is used and then closed
closure - the closure that the writer is passed into
Returns:
the value returned by the closure
See Also:
withWriter(java.io.Writer, groovy.lang.Closure)
Since:
1.5.2


withWriter

public static Object withWriter(OutputStream stream, String charset, Closure closure)
Creates a writer from this stream, passing it to the given closure. This method ensures the stream is closed after the closure returns.
throws:
IOException if an IOException occurs.
Parameters:
stream - the stream which is used and then closed
charset - the charset used
closure - the closure that the writer is passed into
Returns:
the value returned by the closure
See Also:
withWriter(java.io.Writer, groovy.lang.Closure)
Since:
1.5.2


withWriter

@Deprecated
public static void withWriter(Process self, Closure closure)
deprecated:
use ProcessGroovyMethods#withWriter(Process, Closure)


withWriterAppend

public static Object withWriterAppend(File file, String charset, Closure closure)
Create a new BufferedWriter which will append to this file. The writer is passed to the closure and will be closed before this method returns.
throws:
IOException if an IOException occurs.
Parameters:
file - a File
charset - the charset used
closure - a closure
Returns:
the value returned by the closure
Since:
1.5.2


withWriterAppend

public static Object withWriterAppend(File file, Closure closure)
Create a new BufferedWriter for this file in append mode. The writer is passed to the closure and is closed after the closure returns.
throws:
IOException if an IOException occurs.
Parameters:
file - a File
closure - a closure
Returns:
the value returned by the closure
Since:
1.5.2


write

public static void write(Writer self, Writable writable)
A helper method so that dynamic dispatch of the writer.write(object) method will always use the more efficient Writable.writeTo(writer) mechanism if the object implements the Writable interface.
throws:
IOException if an I/O error occurs.
Parameters:
self - a Writer
writable - an object implementing the Writable interface
Since:
1.0


write

public static void write(File file, String text)
Write the text to the File.
throws:
IOException if an IOException occurs.
Parameters:
file - a File
text - the text to write to the File
Since:
1.0


write

public static void write(File file, String text, String charset)
Write the text to the File, using the specified encoding.
throws:
IOException if an IOException occurs.
Parameters:
file - a File
text - the text to write to the File
charset - the charset used
Since:
1.0


writeLine

public static void writeLine(BufferedWriter writer, String line)
Write the text and append a newline (using the platform's line-ending).
throws:
IOException if an IOException occurs.
Parameters:
writer - a BufferedWriter
line - the line to write
Since:
1.0


xor

public static BitSet xor(BitSet left, BitSet right)
Bitwise XOR together two BitSets. Called when the '^' operator is used between two bit sets.
Parameters:
left - a BitSet
right - another BitSet to bitwise AND
Returns:
the bitwise XOR of both BitSets
Since:
1.5.0


xor

public static Number xor(Number left, Number right)
Bitwise XOR together two Numbers. Called when the '|' operator is used.
Parameters:
left - a Number
right - another Number to bitwse XOR
Returns:
the bitwise XOR of both Numbers
Since:
1.0


xor

public static Boolean xor(Boolean left, Boolean right)
Exclusive disjunction of two boolean operators
Parameters:
left - left operator
right - right operator
Returns:
result of exclusive disjunction
Since:
1.0


 

Copyright © 2003-2010 The Codehaus. All rights reserved.