|
Groovy 1.7.9 | |||||||
FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.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.
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 |
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 |
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 |
static Process
|
execute(String self)
Executes the command specified by |
static Process
|
execute(String self, String[] envp, File dir)
Executes the command specified by |
static Process
|
execute(String self, List envp, File dir)
Executes the command specified by |
static Process
|
execute(String[] commandArray)
Executes the command specified by the given |
static Process
|
execute(String[] commandArray, String[] envp, File dir)
Executes the command specified by the |
static Process
|
execute(String[] commandArray, List envp, File dir)
Executes the command specified by the |
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 |
static Process
|
execute(List commands, List envp, File dir)
Executes the command specified by the given list,
with the environment defined by |
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
|
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 |
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
|
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 |
static String
|
join(Collection self, String separator)
Concatenates the |
static String
|
join(Object[] self, String separator)
Concatenates the |
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 |
static Map
|
plus(Map self, Collection entries)
Returns a new |
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 |
static int
|
size(String text)
Provide the standard Groovy |
static int
|
size(StringBuffer buffer)
Provide the standard Groovy |
static long
|
size(File self)
Provide the standard Groovy |
static long
|
size(Matcher self)
Provide the standard Groovy |
static int
|
size(Object[] self)
Provide the standard Groovy |
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 |
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 |
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 |
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 Object | |
---|---|
wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll |
Field Detail |
---|
public static final Class[] additionals
Method Detail |
---|
public static int abs(Number number)
number
- a Number
public static long abs(Long number)
number
- a Long
public static float abs(Float number)
number
- a Float
public static double abs(Double number)
number
- a Double
public static Socket accept(ServerSocket serverSocket, Closure closure)
serverSocket
- a ServerSocketclosure
- a Closure
public static Socket accept(ServerSocket serverSocket, boolean runInANewThread, Closure closure)
serverSocket
- a ServerSocketrunInANewThread
- This flag should be true, if the closure should be invoked in a new thread, else false.closure
- a Closure
public static boolean addAll(Collection self, T[] items)
items
- array containing elements to be added to this collection
public static boolean addAll(List self, int index, T[] items)
items
- array containing elements to be added to this collectionindex
- index at which to insert the first element from the
specified array
public static void addShutdownHook(Object self, Closure closure)
self
- the object the method is called on (ignored)closure
- the shutdown hook action
public static Number and(Number left, Number right)
left
- a Numberright
- another Number to bitwise AND
public static BitSet and(BitSet left, BitSet right)
left
- a BitSetright
- another BitSet to bitwise AND
public static Boolean and(Boolean left, Boolean right)
left
- left operatorright
- right operator
public static boolean any(Object self, Closure closure)
self
- the object over which we iterateclosure
- the closure predicate used for matching
public static boolean any(Map self, Closure closure)
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 }
self
- the map over which we iterateclosure
- the 1 or 2 arg closure predicate used for matching
public static boolean any(Object self)
self
- the object over which we iterate
public static void append(File file, Object text)
file
- a Filetext
- the text to append at the end of the File
public static void append(File file, byte[] bytes)
file
- a Filebytes
- the byte array to append to the end of the File
public static void append(File self, InputStream stream)
self
- a Filestream
- stream to read data from.
public static void append(File file, Object text, String charset)
file
- a Filetext
- the text to append at the end of the Filecharset
- the charset used
public static boolean asBoolean(Object object)
object
- the object to coerce
public static boolean asBoolean(Boolean bool)
bool
- the Boolean
public static boolean asBoolean(Matcher matcher)
matcher
- the matcher
public static boolean asBoolean(Collection collection)
assert [1,2].asBoolean() == true
assert [].asBoolean() == false
collection
- the collection
public static boolean asBoolean(Map map)
assert [:] as Boolean == false assert [a:2] as Boolean == true
map
- the map
public static boolean asBoolean(Iterator iterator)
iterator
- the iterator
public static boolean asBoolean(Enumeration enumeration)
enumeration
- the enumeration
public static boolean asBoolean(CharSequence string)
string
- the character sequence
public static boolean asBoolean(Object[] array)
array
- the array
public static boolean asBoolean(byte[] array)
array
- an array
public static boolean asBoolean(short[] array)
array
- an array
public static boolean asBoolean(int[] array)
array
- an array
public static boolean asBoolean(long[] array)
array
- an array
public static boolean asBoolean(float[] array)
array
- an array
public static boolean asBoolean(double[] array)
array
- an array
public static boolean asBoolean(boolean[] array)
array
- an array
public static boolean asBoolean(char[] array)
array
- an array
public static boolean asBoolean(Character character)
character
- the character
public static boolean asBoolean(Number number)
number
- the number
@Deprecated public static boolean asBoolean(GroovyResultSet grs)
public static Map asImmutable(Map self)
self
- a Map
public static SortedMap asImmutable(SortedMap self)
self
- a SortedMap
public static List asImmutable(List self)
self
- a List
public static Set asImmutable(Set self)
self
- a Set
public static SortedSet asImmutable(SortedSet self)
self
- a SortedSet
public static Collection asImmutable(Collection self)
def mutable = [1,2,3] def immutable = mutable.asImmutable() mutable << 4 try { immutable << 4 assert false } catch (UnsupportedOperationException) { assert true }
self
- a Collection
public static List asList(Collection self)
Example usage:
assert new HashSet().asList() instanceof List
self
- a collection to be converted into a List
public static Map asSynchronized(Map self)
self
- a Map
public static SortedMap asSynchronized(SortedMap self)
self
- a SortedMap
public static Collection asSynchronized(Collection self)
self
- a Collection
public static List asSynchronized(List self)
self
- a List
public static Set asSynchronized(Set self)
self
- a Set
public static SortedSet asSynchronized(SortedSet self)
self
- a SortedSet
public static Object asType(Collection col, Class clazz)
col
- a collectionclazz
- the desired class
public static Object asType(Object[] ary, Class clazz)
ary
- an arrayclazz
- the desired class
public static Object asType(Closure cl, Class clazz)
cl
- the implementation of the single methodclazz
- the target type
public static Object asType(Map map, Class clazz)
map
- this mapclazz
- the target type
public static Object asType(Number self, Class c)
self
- this numberc
- the desired type of the transformed result
public static Object asType(File f, Class c)
f
- a Filec
- the desired class
public static Object asType(GString self, Class c)
self
- a GStringc
- the desired class
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.
'123' as Double
By default, the following types are supported:
self
- a Stringc
- the desired class
public static Object asType(Object obj, Class type)
obj
- the object to converttype
- the goal type
public static File asWritable(File file)
file
- a File
public static File asWritable(File file, String encoding)
file
- a Fileencoding
- the encoding to be used when reading the file's contents
public static Pattern bitwiseNegate(String self)
self
- a String to convert into a regular expression
public static BitSet bitwiseNegate(BitSet self)
self
- 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)
public static String capitalize(String self)
assert 'h'.capitalize() == 'H' assert 'hello'.capitalize() == 'Hello' assert 'hello world'.capitalize() == 'Hello world' assert 'Hello World' == 'hello world'.split(' ').collect{ it.capitalize() }.join(' ')
self
- The string to capitalize
public static String center(String self, Number numberOfChars, String padding)
['A', 'BB', 'CCC', 'DDDD'].each{ println '|' + it.center(6, '+') + '|' }will produce output like:
|++A+++| |++BB++| |+CCC++| |+DDDD+|
self
- a String objectnumberOfChars
- the total minimum number of characters of the resulting stringpadding
- the charaters used for padding
public static String center(String self, Number numberOfChars)
['A', 'BB', 'CCC', 'DDDD'].each{ println '|' + it.center(6) + '|' }will produce output like:
| A | | BB | | CCC | | DDDD |
self
- a String objectnumberOfChars
- the total minimum number of characters of the resulting string
@Deprecated public static void clearTime(Date self)
@Deprecated public static void clearTime(def self)
@Deprecated public static void clearTime(Calendar self)
public static List collect(Object self, Closure closure)
def list = [1, 'a', 1.23, true ] def types = list.collect { it.class } assert types == [Integer, String, BigDecimal, Boolean]
self
- the values of the object to transformclosure
- the closure used to transform each element of the collection
public static Collection collect(Object self, Collection collection, Closure closure)
self
- the values of the object to transformcollection
- the Collection to which the transformed values are addedclosure
- the closure used to map each element of the collection
public static List collect(Collection self, Closure closure)
assert [2,4,6] == [1,2,3].collect { it * 2 }
self
- a collectionclosure
- the closure used for mapping
public static Collection collect(Collection self, Collection collection, Closure closure)
assert [1,2,3] as HashSet == [2,4,5,6].collect(new HashSet()) { (int)(it / 2) }
self
- a collectioncollection
- an initial Collection to which the transformed values are addedclosure
- the closure used to transform each element of the collection
public static Collection collect(Map self, Collection collection, Closure closure)
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
self
- a Mapcollection
- the Collection to which the mapped values are addedclosure
- the closure used for mapping, which can take one (Map.Entry) or two (key, value) parameters
public static List collect(Map self, Closure closure)
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]
self
- a Mapclosure
- the closure used to map each element of the collection
public static List collectAll(Collection self, Closure closure)
assert [2,[4,6],[8],[]] == [1,[2,3],[4],[]].collectAll { it * 2 }
self
- a collectionclosure
- the closure used to transform each element of the collection
public static Collection collectAll(Collection self, Collection collection, Closure closure)
def x = [1,[2,3],[4],[]].collectAll(new Vector()) { it * 2 } assert x == [2,[4,6],[8],[]] assert x instanceof Vector
self
- a collectioncollection
- an initial Collection to which the transformed values are addedclosure
- the closure used to transform each element of the collection
public static Map collectEntries(Map self, Map result, Closure closure)
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']
self
- a Mapresult
- the Map into which the mapped entries are putclosure
- 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
public static Map collectEntries(Map self, Closure closure)
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']
self
- a Mapclosure
- 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
public static Map collectEntries(Collection self, Map result, Closure closure)
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']
self
- a Collectionresult
- the Map into which the collected entries are putclosure
- 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
public static Map collectEntries(Object[] self, Map result, Closure closure)
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']
self
- a Collectionresult
- the Map into which the collected entries are putclosure
- 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
public static Map collectEntries(Collection self, Closure closure)
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']
self
- a Collectionclosure
- 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
public static Map collectEntries(Object[] self, Closure closure)
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']
self
- a Collectionclosure
- 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
public static List combinations(Collection self)
assert [['a', 'b'],[1, 2, 3]].combinations() == [['a', 1], ['b', 1], ['a', 2], ['b', 2], ['a', 3], ['b', 3]]
self
- a Collection of lists
public static int compareTo(Character left, Number right)
left
- a Characterright
- a Number
public static int compareTo(Number left, Character right)
left
- a Numberright
- a Character
public static int compareTo(Character left, Character right)
left
- a Characterright
- a Character
public static int compareTo(Number left, Number right)
left
- a Numberright
- another Number to compare to
@Deprecated public static Thread consumeProcessErrorStream(Process self, OutputStream err)
@Deprecated public static Thread consumeProcessErrorStream(Process self, StringBuffer error)
@Deprecated public static Thread consumeProcessErrorStream(Process self, Writer err)
@Deprecated public static void consumeProcessOutput(Process self)
@Deprecated public static void consumeProcessOutput(Process self, StringBuffer output, StringBuffer error)
@Deprecated public static void consumeProcessOutput(Process self, OutputStream output, OutputStream error)
@Deprecated public static Thread consumeProcessOutputStream(Process self, StringBuffer output)
@Deprecated public static Thread consumeProcessOutputStream(Process self, Writer output)
@Deprecated public static Thread consumeProcessOutputStream(Process self, OutputStream output)
public static boolean contains(String self, String text)
self
- a Stringtext
- a String to look for
public static boolean containsAll(Collection self, Object[] items)
items
- array to be checked for containment in this collection
public static Number count(Iterator self, Object value)
compareTo(value) == 0
or equals(value)
).
The iterator will become exhausted of elements after determining the count value.
self
- the Iterator from which we count the number of matching occurrencesvalue
- the value being searched for
public static Number count(Collection self, Object value)
compareTo(value) == 0
or equals(value)
).
assert [2,4,2,1,3,5,2,4,3].count(4) == 2
self
- the collection within which we count the number of occurrencesvalue
- the value being searched for
public static Number count(Object[] self, Object value)
compareTo(value) == 0
or equals(value)
).
self
- the array within which we count the number of occurrencesvalue
- the value being searched for
public static Number count(int[] self, Object value)
compareTo(value) == 0
or equals(value)
).
self
- the array within which we count the number of occurrencesvalue
- the value being searched for
public static Number count(long[] self, Object value)
compareTo(value) == 0
or equals(value)
).
self
- the array within which we count the number of occurrencesvalue
- the value being searched for
public static Number count(short[] self, Object value)
compareTo(value) == 0
or equals(value)
).
self
- the array within which we count the number of occurrencesvalue
- the value being searched for
public static Number count(char[] self, Object value)
compareTo(value) == 0
or equals(value)
).
self
- the array within which we count the number of occurrencesvalue
- the value being searched for
public static Number count(boolean[] self, Object value)
compareTo(value) == 0
or equals(value)
).
self
- the array within which we count the number of occurrencesvalue
- the value being searched for
public static Number count(double[] self, Object value)
compareTo(value) == 0
or equals(value)
).
self
- the array within which we count the number of occurrencesvalue
- the value being searched for
public static Number count(float[] self, Object value)
compareTo(value) == 0
or equals(value)
).
self
- the array within which we count the number of occurrencesvalue
- the value being searched for
public static Number count(byte[] self, Object value)
compareTo(value) == 0
or equals(value)
).
self
- the array within which we count the number of occurrencesvalue
- the value being searched for
public static int count(String self, String text)
self
- a Stringtext
- a substring
protected static StringBufferWriter createStringBufferWriter(StringBuffer self)
protected static StringWriter createStringWriter(String self)
@Deprecated public static byte[] decodeBase64(String value)
public static boolean deleteDir(File self)
The method returns
self
- a File
public static String denormalize(String self)
self
- a String object
public static boolean disjoint(Collection left, Collection right)
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
left
- a Collectionright
- a Collectiontrue
if the intersection of two collections
is empty, false
otherwise.
public static Number div(Character left, Number right)
left
- a Characterright
- a Number
public static Number div(Number left, Character right)
left
- a Numberright
- a Character
public static Number div(Character left, Character right)
left
- a Characterright
- another Character
public static void downto(Number self, Number to, Closure closure)
self
- a Numberto
- another Number to go down toclosure
- the closure to call
public static void downto(long self, Number to, Closure closure)
self
- a longto
- the end numberclosure
- the code to execute for each number
public static void downto(Long self, Number to, Closure closure)
self
- a Longto
- the end numberclosure
- the code to execute for each number
public static void downto(float self, Number to, Closure closure)
self
- a floatto
- the end numberclosure
- the code to execute for each number
public static void downto(Float self, Number to, Closure closure)
self
- a Floatto
- the end numberclosure
- the code to execute for each number
public static void downto(double self, Number to, Closure closure)
self
- a doubleto
- the end numberclosure
- the code to execute for each number
public static void downto(Double self, Number to, Closure closure)
self
- a Doubleto
- the end numberclosure
- the code to execute for each number
public static void downto(BigInteger self, Number to, Closure closure)
self
- a BigIntegerto
- the end numberclosure
- the code to execute for each number
public static void downto(BigDecimal self, Number to, Closure closure)
10.5.downto(0) { println it }Prints numbers 10.5, 9.5 ... to 0.5.
self
- a BigDecimalto
- the end numberclosure
- the code to execute for each number
public static String dump(Object self)
self
- an object
public static T each(T self, Closure closure)
self
- the object over which we iterateclosure
- the closure applied on each element found
public static Map each(Map self, Closure closure)
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.
self
- the map over which we iterateclosure
- the 1 or 2 arg closure applied on each entry of the map
public static void eachByte(File self, Closure closure)
self
- a Fileclosure
- a closure
public static void eachByte(File self, int bufferLen, Closure closure)
self
- a FilebufferLen
- the length of the buffer to use.closure
- a 2 parameter closure which is passed the byte[] and a number of bytes successfully read.
public static void eachByte(Byte[] self, Closure closure)
self
- a Byte arrayclosure
- a closure
public static void eachByte(byte[] self, Closure closure)
self
- a byte arrayclosure
- a closure
public static void eachByte(InputStream is, Closure closure)
is
- stream to iterate over, closed after the method callclosure
- closure to apply to each byte
public static void eachByte(InputStream is, int bufferLen, Closure closure)
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.
public static void eachByte(URL url, Closure closure)
url
- url to iterate overclosure
- closure to apply to each byte
public static void eachByte(URL url, int bufferLen, Closure closure)
url
- url to iterate overbufferLen
- the length of the buffer to use.closure
- a 2 parameter closure which is passed the byte[] and a number of bytes successfully read.
public static void eachDir(File self, Closure closure)
self
- a File (that happens to be a folder/directory)closure
- a closure (first parameter is the subdirectory file)
public static void eachDirMatch(File self, Object nameFilter, Closure closure)
self
- a filenameFilter
- 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
public static void eachDirRecurse(File self, Closure closure)
self
- a directoryclosure
- a closure
public static void eachFile(File self, FileType fileType, Closure closure)
self
- a file objectfileType
- if normal files or directories or both should be processedclosure
- the closure to invoke
public static void eachFile(File self, Closure closure)
self
- a File (that happens to be a folder/directory)closure
- a closure (first parameter is the 'child' file)
public static void eachFileMatch(File self, FileType fileType, Object nameFilter, Closure closure)
// 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()}" }
self
- a filefileType
- whether normal files or directories or both should be processednameFilter
- 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
public static void eachFileMatch(File self, Object nameFilter, Closure closure)
self
- a filenameFilter
- 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
public static void eachFileRecurse(File self, FileType fileType, Closure closure)
self
- a file objectfileType
- if normal files or directories or both should be processedclosure
- the closure to invoke on each file
public static void eachFileRecurse(File self, Closure closure)
self
- a Fileclosure
- a closure
public static Object eachLine(String self, Closure closure)
self
- a Stringclosure
- a closure
public static Object eachLine(String self, int firstLine, Closure closure)
self
- a StringfirstLine
- 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)
public static Object eachLine(File self, Closure closure)
self
- a Fileclosure
- a closure (arg 1 is line, optional arg 2 is line number starting at line 1)
public static Object eachLine(File self, String charset, Closure closure)
self
- a Filecharset
- opens the file with a specified charsetclosure
- a closure (arg 1 is line, optional arg 2 is line number starting at line 1)
public static Object eachLine(File self, int firstLine, Closure closure)
self
- a FilefirstLine
- 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)
public static Object eachLine(File self, String charset, int firstLine, Closure closure)
self
- a Filecharset
- opens the file with a specified charsetfirstLine
- 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)
public static Object eachLine(InputStream stream, String charset, Closure closure)
stream
- a streamcharset
- opens the stream with a specified charsetclosure
- a closure (arg 1 is line, optional arg 2 is line number starting at line 1)
public static Object eachLine(InputStream stream, String charset, int firstLine, Closure closure)
stream
- a streamcharset
- opens the stream with a specified charsetfirstLine
- 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)
public static Object eachLine(InputStream stream, Closure closure)
stream
- a streamclosure
- a closure (arg 1 is line, optional arg 2 is line number starting at line 1)
public static Object eachLine(InputStream stream, int firstLine, Closure closure)
stream
- a streamfirstLine
- 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)
public static Object eachLine(URL url, Closure closure)
url
- a URL to open and readclosure
- a closure to apply on each line (arg 1 is line, optional arg 2 is line number starting at line 1)
public static Object eachLine(URL url, int firstLine, Closure closure)
url
- a URL to open and readfirstLine
- 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)
public static Object eachLine(URL url, String charset, Closure closure)
url
- a URL to open and readcharset
- opens the stream with a specified charsetclosure
- a closure to apply on each line (arg 1 is line, optional arg 2 is line number starting at line 1)
public static Object eachLine(URL url, String charset, int firstLine, Closure closure)
url
- a URL to open and readcharset
- opens the stream with a specified charsetfirstLine
- 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)
public static Object eachLine(Reader self, Closure closure)
self
- a Reader, closed after the method returnsclosure
- a closure (arg 1 is line, optional arg 2 is line number starting at line 1)
public static Object eachLine(Reader self, int firstLine, Closure closure)
self
- a Reader, closed after the method returnsfirstLine
- 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)
public static String eachMatch(String self, String regex, Closure closure)
self
- the source stringregex
- a Regex stringclosure
- a closure with one parameter or as much parameters as groups
public static String eachMatch(String self, Pattern pattern, Closure closure)
self
- the source stringpattern
- a regex Patternclosure
- a closure with one parameter or as much parameters as groups
public static void eachObject(File self, Closure closure)
self
- a Fileclosure
- a closure
public static void eachObject(ObjectInputStream ois, Closure closure)
ois
- an ObjectInputStream, closed after the operationclosure
- a closure
public static Iterator eachPermutation(Collection self, Closure closure)
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]]
self
- the Collection of itemsclosure
- the closure to call for each permutation
public static Object eachWithIndex(Object self, Closure closure)
self
- an Objectclosure
- a Closure to operate on each item
public static Map eachWithIndex(Map self, Closure closure)
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)"
self
- the map over which we iterateclosure
- a 2 or 3 arg Closure to operate on each item
@Deprecated public static Writable encodeBase64(Byte[] data, boolean chunked)
@Deprecated public static Writable encodeBase64(Byte[] data)
@Deprecated public static Writable encodeBase64(byte[] data, boolean chunked)
@Deprecated public static Writable encodeBase64(byte[] data)
public static boolean equals(int[] left, int[] right)
left
- an int arrayright
- the operand array.
public static boolean equals(Object[] left, List right)
false
if either collection is null
.
left
- this arrayright
- the list being compared
public static boolean equals(List left, Object[] right)
false
if either collection is null
.
assert [1, "a"].equals( [ 1, "a" ] as Object[] )
left
- this Listright
- this Object[] being compared to
public static boolean equals(List left, List right)
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
left
- this Listright
- the List being compared to.true
if the contents of both lists are identical,
false
otherwise.
public static boolean every(Object self, Closure closure)
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 }
self
- the object over which we iterateclosure
- the closure predicate used for matching
public static boolean every(Map self, Closure closure)
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 }
self
- the map over which we iterateclosure
- the 1 or 2 arg Closure predicate used for matching
public static boolean every(Object self)
true
according to the Groovy Truth.
Equivalent to self.every({element -> element})
self
- the object over which we iterate
public static Process execute(String self)
self
as a command-line process.
For more control over Process construction you can use
java.lang.ProcessBuilder
(JDK 1.5+).
self
- a command line String
public static Process execute(String self, String[] envp, File dir)
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+).
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.
public static Process execute(String self, List envp, File dir)
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+).
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.
public static Process execute(String[] commandArray)
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+).
commandArray
- an array of String containing the command name and
parameters as separate items in the array.
public static Process execute(String[] commandArray, String[] envp, File dir)
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+).
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.
public static Process execute(String[] commandArray, List envp, File dir)
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+).
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.
public static Process execute(List commands)
For more control over Process construction you can use
java.lang.ProcessBuilder
(JDK 1.5+).
commands
- a list containing the command name and
parameters as separate items in the list.
public static Process execute(List commands, String[] envp, File dir)
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+).
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.
public static Process execute(List commands, List envp, File dir)
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+).
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.
public static String expand(String self)
self
- A String to expand
public static String expand(String self, int tabStop)
self
- A String to expandtabStop
- The number of spaces a tab represents
public static String expandLine(String self, int tabStop)
self
- A line to expandtabStop
- The number of spaces a tab represents
public static void filterLine(Reader reader, Writer writer, Closure closure)
reader
- a reader, closed after the callwriter
- a writer, closed after the callclosure
- the closure which returns booleans
public static Writable filterLine(File self, Closure closure)
self
is not readableself
- a Fileclosure
- a closure which returns a boolean indicating to filter
the line or not
public static Writable filterLine(File self, String charset, Closure closure)
self
- a Filecharset
- opens the file with a specified charsetclosure
- a closure which returns a boolean indicating to filter
the line or not
public static void filterLine(File self, Writer writer, Closure closure)
self
is not readableself
- a Filewriter
- a writer destination to write filtered lines toclosure
- a closure which takes each line as a parameter and returns
true
if the line should be written to this writer.
public static void filterLine(File self, Writer writer, String charset, Closure closure)
self
- a Filewriter
- a writer destination to write filtered lines tocharset
- opens the file with a specified charsetclosure
- a closure which takes each line as a parameter and returns
true
if the line should be written to this writer.
public static Writable filterLine(Reader reader, Closure closure)
true
if the line should be passed to the writer.
reader
- this readerclosure
- a closure used for filtering
public static Writable filterLine(InputStream self, Closure predicate)
true
if the line should be passed to the writer.
self
- an input streampredicate
- a closure which returns boolean and takes a line
public static Writable filterLine(InputStream self, String charset, Closure predicate)
true
if the line should be passed to the writer.self
- an input streamcharset
- opens the stream with a specified charsetpredicate
- a closure which returns boolean and takes a line
public static void filterLine(InputStream self, Writer writer, Closure predicate)
true
if the line should be passed to the
writer.self
- the InputStreamwriter
- a writer to write output topredicate
- a closure which returns true if a line should be accepted
public static void filterLine(InputStream self, Writer writer, String charset, Closure predicate)
true
if the line should be passed to the
writer.self
- the InputStreamwriter
- a writer to write output tocharset
- opens the stream with a specified charsetpredicate
- a closure which returns true if a line should be accepted
public static Writable filterLine(URL self, Closure predicate)
true
if the line should be passed to the writer.self
- a URLpredicate
- a closure which returns boolean and takes a line
public static Writable filterLine(URL self, String charset, Closure predicate)
true
if the line should be passed to the writer.self
- the URLcharset
- opens the URL with a specified charsetpredicate
- a closure which returns boolean and takes a line
public static void filterLine(URL self, Writer writer, Closure predicate)
true
if the line should be passed to the
writer.self
- the URLwriter
- a writer to write output topredicate
- a closure which returns true if a line should be accepted
public static void filterLine(URL self, Writer writer, String charset, Closure predicate)
true
if the line should be passed to the
writer.self
- the URLwriter
- a writer to write output tocharset
- opens the URL with a specified charsetpredicate
- a closure which returns true if a line should be accepted
public static Object find(Object self, Closure closure)
self
- an Object with an iterator returning its valuesclosure
- a closure condition
public static T find(Collection self, Closure closure)
def list = [1,2,3] assert 2 == list.find { it > 1 }
self
- a Collectionclosure
- a closure condition
public static def find(Map self, Closure closure)
assert [a:1, b:3].find { it.value == 3 }.key == "b"
self
- a Mapclosure
- a 1 or 2 arg Closure condition
public static String find(String self, String regex)
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})/)
self
- a Stringregex
- the capturing regex
public static String find(String self, Pattern pattern)
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.
self
- a Stringpattern
- the compiled regex Pattern
public static String find(String self, String regex, Closure closure)
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" }
self
- a Stringregex
- the capturing regex stringclosure
- the closure that will be passed the full match, plus each of the capturing groups
public static String find(String self, Pattern pattern, Closure closure)
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" }
self
- a Stringpattern
- the compiled regex Patternclosure
- the closure that will be passed the full match, plus each of the capturing groups
public static Collection findAll(Collection self, Closure closure)
assert [2,4] == [1,2,3,4].findAll { it % 2 == 0 }
self
- a Collectionclosure
- a closure condition
public static Collection findAll(Object self, Closure closure)
self
- an Object with an Iterator returning its valuesclosure
- a closure condition
public static Map findAll(Map self, Closure closure)
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]
self
- a Mapclosure
- a 1 or 2 arg Closure condition applying on the entries
public static List findAll(String self, String regex)
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.
self
- a Stringregex
- the capturing regex String
public static List findAll(String self, Pattern pattern)
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/)
self
- a Stringpattern
- the compiled regex Pattern
public static List findAll(String self, String regex, Closure closure)
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" }
self
- a Stringregex
- the capturing regex Stringclosure
- will be passed the full match plus each of the capturing groups
public static List findAll(String self, Pattern pattern, Closure closure)
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" }
self
- a Stringpattern
- the compiled regex Patternclosure
- will be passed the full match plus each of the capturing groups
public static int findIndexOf(Object self, Closure closure)
self
- the iteration object over which to iterateclosure
- the filter to perform a match on the collection
public static int findIndexOf(Object self, int startIndex, Closure closure)
self
- the iteration object over which to iteratestartIndex
- start matching from this indexclosure
- the filter to perform a match on the collection
public static List findIndexValues(Object self, Closure closure)
self
- the iteration object over which to iterateclosure
- the filter to perform a match on the collection
public static List findIndexValues(Object self, Number startIndex, Closure closure)
self
- the iteration object over which to iteratestartIndex
- start matching from this indexclosure
- the filter to perform a match on the collection
public static int findLastIndexOf(Object self, Closure closure)
self
- the iteration object over which to iterateclosure
- the filter to perform a match on the collection
public static int findLastIndexOf(Object self, int startIndex, Closure closure)
self
- the iteration object over which to iteratestartIndex
- start matching from this indexclosure
- the filter to perform a match on the collection
public static Object findResult(Object self, Object defaultResult, Closure closure)
self
- an Object with an iterator returning its valuesdefaultResult
- an Object that should be returned if all closure results are nullclosure
- a closure that returns a non-null value when processing should stop
public static Object findResult(Object self, Closure closure)
self
- an Object with an iterator returning its valuesclosure
- a closure that returns a non-null value when processing should stop
public static Object findResult(Collection self, Object defaultResult, Closure closure)
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 }
self
- a CollectiondefaultResult
- an Object that should be returned if all closure results are nullclosure
- a closure that returns a non-null value when processing should stop and a value should be returned
public static Object findResult(Collection self, Closure closure)
def list = [1,2,3] assert "Found 2" == list.findResult { it > 1 ? "Found $it" : null }
self
- a Collectionclosure
- a closure that returns a non-null value when processing should stop and a value should be returned
public static Object findResult(Map self, Object defaultResult, Closure closure)
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}" }
self
- a MapdefaultResult
- an Object that should be returned if all closure results are nullclosure
- a 1 or 2 arg Closure that returns a non-null value when processing should stop and a value should be returned
public static Object findResult(Map self, Closure closure)
assert "Found b:3" == [a:1, b:3].findResult { if (it.value == 3) return "Found ${it.key}:${it.value}" }
self
- a Mapclosure
- a 1 or 2 arg Closure that returns a non-null value when processing should stop and a value should be returned
public static T first(List self)
def list = [3, 4, 2] assert list.first() == 3 assert list == [3, 4, 2]
self
- a List
public static T first(T[] self)
def array = [3, 4, 2].toArray() assert array.first() == 3
self
- an Object array
public static Collection flatten(Collection self)
assert [1,2,3,4,5] == [1,[2,3],[[4]],[],5].flatten()
self
- a Collection to flatten
public static Collection flatten(Object[] self)
self
- an Array to flatten
public static Collection flatten(boolean[] self)
self
- a boolean Array to flatten
public static Collection flatten(byte[] self)
self
- a byte Array to flatten
public static Collection flatten(char[] self)
self
- a char Array to flatten
public static Collection flatten(short[] self)
self
- a short Array to flatten
public static Collection flatten(int[] self)
self
- an int Array to flatten
public static Collection flatten(long[] self)
self
- a long Array to flatten
public static Collection flatten(float[] self)
self
- a float Array to flatten
public static Collection flatten(double[] self)
self
- a double Array to flatten
public static Collection flatten(Collection self, Closure flattenUsing)
self
- a CollectionflattenUsing
- a closure to determine how to flatten non-Array, non-Collection elements
@Deprecated public static String format(Date self, String format)
@Deprecated public static String format(Calendar self, String pattern)
public static V get(Map map, K key, V defaultValue)
def map=[:] map.get("a", []) << 5 assert map == [a:[5]]
map
- a Mapkey
- the key to lookup the value ofdefaultValue
- the value to return and add to the map for this key if
there is no entry for the given key
public static Object getAt(Object self, String property)
bean[somePropertyNameExpression]
. The normal property notation
of groovy is neater and more concise but only works with compile-time known
property names.
self
- the object to act uponproperty
- the property name of interest
public static CharSequence getAt(CharSequence text, int index)
text
- a CharSequenceindex
- the index of the Character to get
public static String getAt(String text, int index)
text
- a Stringindex
- the index of the Character to get
public static CharSequence getAt(CharSequence text, Range range)
text
- a CharSequencerange
- a Range
public static CharSequence getAt(CharSequence text, IntRange range)
text
- a CharSequencerange
- an IntRange
public static CharSequence getAt(CharSequence text, EmptyRange range)
text
- a CharSequencerange
- an EmptyRange
public static String getAt(String text, IntRange range)
text
- a Stringrange
- an IntRange
public static String getAt(String text, EmptyRange range)
text
- a Stringrange
- an EmptyRange
public static String getAt(String text, Range range)
text
- a Stringrange
- a Range
public static Object getAt(Matcher matcher, int idx)
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] }
matcher
- a Matcheridx
- an index
public static List getAt(List self, Range range)
def list = [1, "a", 4.5, true] assert list[1..2] == ["a", 4.5]
self
- a Listrange
- a Range indicating the items to get
public static List getAt(List self, EmptyRange range)
def list = [true, 1, 3.4] assert list[0..<0] == []
self
- a Listrange
- a Range indicating the items to get
public static List getAt(List self, Collection indices)
def list = [true, 1, 3.4, false] assert list[1,0,2] == [1, true, 3.4]
self
- a Listindices
- a Collection of indices
public static List getAt(T[] self, Collection indices)
self
- an Array of Objectsindices
- a Collection of indices
public static CharSequence getAt(CharSequence self, Collection indices)
self
- a CharSequenceindices
- a Collection of indices
public static String getAt(String self, Collection indices)
self
- a Stringindices
- a Collection of indices
public static List getAt(Matcher self, Collection indices)
self
- a Matcherindices
- a Collection of indices
public static List getAt(T[] array, Range range)
array
- an Array of Objectsrange
- a Range
public static List getAt(T[] array, IntRange range)
array
- an Array of Objectsrange
- an IntRange
public static List getAt(T[] array, EmptyRange range)
array
- an Array of Objectsrange
- an EmptyRange
public static List getAt(T[] array, ObjectRange range)
array
- an Array of Objectsrange
- an ObjectRange
public static T getAt(List self, int idx)
def list = [2, "a", 5.3] assert list[1] == "a"
self
- a Listidx
- an index
public static T getAt(Iterator self, int idx)
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
self
- an Iteratoridx
- an index value (-self.size() <= idx < self.size())
public static V getAt(Map self, K key)
def map = [a:10] assert map["a"] == 10
self
- a Mapkey
- an Object as a key for the map
public static List getAt(Collection coll, String property)
assert [String, Long, Integer] == ["a",5L,2]["class"]
coll
- a Collectionproperty
- a String
@SuppressWarnings("unchecked") public static List getAt(byte[] array, Range range)
array
- a byte arrayrange
- a range indicating the indices for the items to retrieve
@SuppressWarnings("unchecked") public static List getAt(char[] array, Range range)
array
- a char arrayrange
- a range indicating the indices for the items to retrieve
@SuppressWarnings("unchecked") public static List getAt(short[] array, Range range)
array
- a short arrayrange
- a range indicating the indices for the items to retrieve
@SuppressWarnings("unchecked") public static List getAt(int[] array, Range range)
array
- an int arrayrange
- a range indicating the indices for the items to retrieve
@SuppressWarnings("unchecked") public static List getAt(long[] array, Range range)
array
- a long arrayrange
- a range indicating the indices for the items to retrieve
@SuppressWarnings("unchecked") public static List getAt(float[] array, Range range)
array
- a float arrayrange
- a range indicating the indices for the items to retrieve
@SuppressWarnings("unchecked") public static List getAt(double[] array, Range range)
array
- a double arrayrange
- a range indicating the indices for the items to retrieve
@SuppressWarnings("unchecked") public static List getAt(boolean[] array, Range range)
array
- a boolean arrayrange
- a range indicating the indices for the items to retrieve
@SuppressWarnings("unchecked") public static List getAt(byte[] array, IntRange range)
array
- a byte arrayrange
- an IntRange indicating the indices for the items to retrieve
@SuppressWarnings("unchecked") public static List getAt(char[] array, IntRange range)
array
- a char arrayrange
- an IntRange indicating the indices for the items to retrieve
@SuppressWarnings("unchecked") public static List getAt(short[] array, IntRange range)
array
- a short arrayrange
- an IntRange indicating the indices for the items to retrieve
@SuppressWarnings("unchecked") public static List getAt(int[] array, IntRange range)
array
- an int arrayrange
- an IntRange indicating the indices for the items to retrieve
@SuppressWarnings("unchecked") public static List getAt(long[] array, IntRange range)
array
- a long arrayrange
- an IntRange indicating the indices for the items to retrieve
@SuppressWarnings("unchecked") public static List getAt(float[] array, IntRange range)
array
- a float arrayrange
- an IntRange indicating the indices for the items to retrieve
@SuppressWarnings("unchecked") public static List getAt(double[] array, IntRange range)
array
- a double arrayrange
- an IntRange indicating the indices for the items to retrieve
@SuppressWarnings("unchecked") public static List getAt(boolean[] array, IntRange range)
array
- a boolean arrayrange
- an IntRange indicating the indices for the items to retrieve
@SuppressWarnings("unchecked") public static List getAt(byte[] array, ObjectRange range)
array
- a byte arrayrange
- an ObjectRange indicating the indices for the items to retrieve
@SuppressWarnings("unchecked") public static List getAt(char[] array, ObjectRange range)
array
- a char arrayrange
- an ObjectRange indicating the indices for the items to retrieve
@SuppressWarnings("unchecked") public static List getAt(short[] array, ObjectRange range)
array
- a short arrayrange
- an ObjectRange indicating the indices for the items to retrieve
@SuppressWarnings("unchecked") public static List getAt(int[] array, ObjectRange range)
array
- an int arrayrange
- an ObjectRange indicating the indices for the items to retrieve
@SuppressWarnings("unchecked") public static List getAt(long[] array, ObjectRange range)
array
- a long arrayrange
- an ObjectRange indicating the indices for the items to retrieve
@SuppressWarnings("unchecked") public static List getAt(float[] array, ObjectRange range)
array
- a float arrayrange
- an ObjectRange indicating the indices for the items to retrieve
@SuppressWarnings("unchecked") public static List getAt(double[] array, ObjectRange range)
array
- a double arrayrange
- an ObjectRange indicating the indices for the items to retrieve
@SuppressWarnings("unchecked") public static List getAt(boolean[] array, ObjectRange range)
array
- a byte arrayrange
- an ObjectRange indicating the indices for the items to retrieve
@SuppressWarnings("unchecked") public static List getAt(byte[] array, Collection indices)
array
- a byte arrayindices
- a collection of indices for the items to retrieve
@SuppressWarnings("unchecked") public static List getAt(char[] array, Collection indices)
array
- a char arrayindices
- a collection of indices for the items to retrieve
@SuppressWarnings("unchecked") public static List getAt(short[] array, Collection indices)
array
- a short arrayindices
- a collection of indices for the items to retrieve
@SuppressWarnings("unchecked") public static List getAt(int[] array, Collection indices)
array
- an int arrayindices
- a collection of indices for the items to retrieve
@SuppressWarnings("unchecked") public static List getAt(long[] array, Collection indices)
array
- a long arrayindices
- a collection of indices for the items to retrieve
@SuppressWarnings("unchecked") public static List getAt(float[] array, Collection indices)
array
- a float arrayindices
- a collection of indices for the items to retrieve
@SuppressWarnings("unchecked") public static List getAt(double[] array, Collection indices)
array
- a double arrayindices
- a collection of indices for the items to retrieve
@SuppressWarnings("unchecked") public static List getAt(boolean[] array, Collection indices)
array
- a boolean arrayindices
- a collection of indices for the items to retrieve
public static boolean getAt(BitSet self, int index)
self
- a BitSetindex
- index to retrieve
public static BitSet getAt(BitSet self, IntRange range)
self
- a BitSetrange
- a Range defining the desired subset
@Deprecated public static int getAt(Date self, int field)
public static byte[] getBytes(File file)
file
- the file whose content we want to read
public static byte[] getBytes(URL url)
url
- URL to read content from
public static byte[] getBytes(InputStream is)
is
- an input stream
public static char[] getChars(String self)
self
- a String
public static int getCount(Matcher matcher)
matcher
- a Matcher
@Deprecated public static String getDateString(Date self)
@Deprecated public static String getDateTimeString(Date self)
@Deprecated public static InputStream getErr(Process self)
@Deprecated public static InputStream getIn(Process self)
public static MetaClass getMetaClass(Class c)
String.metaClass.myMethod = { println "foo" }
c
- The java.lang.Class instance
public static MetaClass getMetaClass(Object obj)
obj
- The object in question
public static MetaClass getMetaClass(GroovyObject obj)
obj
- The object in question
public static List getMetaPropertyValues(Object self)
self
- the receiver object
@Deprecated public static OutputStream getOut(Process self)
public static Map getProperties(Object self)
self
- the receiver object
public static ClassLoader getRootLoader(ClassLoader self)
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.
self
- a ClassLoader
protected static List getSubList(List self, List splice)
public static String getText(File file, String charset)
file
- the file whose content we want to readcharset
- the charset used to read the content of the file
public static String getText(File file)
file
- the file whose content we want to read
public static String getText(URL url)
url
- URL to read content from
public static String getText(URL url, String charset)
url
- URL to read content fromcharset
- opens the stream with a specified charset
public static String getText(InputStream is)
is
- an input stream
public static String getText(InputStream is, String charset)
is
- an input streamcharset
- opens the stream with a specified charset
public static String getText(Reader reader)
reader
- a Reader whose content we want to read
public static String getText(BufferedReader reader)
reader
- a BufferedReader whose content we want to read
@Deprecated public static String getText(Process self)
@Deprecated public static String getTimeString(Date self)
public static Collection grep(Object self, Object filter)
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'
self
- the object over which we iteratefilter
- the filter to perform on the object (using the isCase(java.lang.Object, java.lang.Object) method)
protected static void groupAnswer(Map answer, T element, Object value)
answer
- the map containing the resultselement
- the element to be placedvalue
- the value according to which the element will be placed
public static Map groupBy(Collection self, Closure closure)
assert [0:[2,4,6], 1:[1,3,5]] == [1,2,3,4,5,6].groupBy { it % 2 }
self
- a collection to groupclosure
- a closure mapping entries on keys
public static Map groupBy(Map self, Closure closure)
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]]
self
- a map to groupclosure
- a closure mapping entries on keys
public static Map groupEntriesBy(Map self, Closure closure)
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]
self
- a map to groupclosure
- a 1 or 2 arg Closure mapping entries on keys
public static boolean hasGroup(Matcher matcher)
matcher
- a Matchertrue
if matcher contains at least one group.
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
self
- The object to inspectname
- The name of the property of interest
public static T head(List self)
def list = [3, 4, 2] assert list.head() == 3 assert list == [3, 4, 2]
self
- a List
public static T head(T[] self)
def array = [3, 4, 2].toArray() assert array.head() == 3
self
- an Object array
public static Object identity(Object self, Closure closure)
self
- the object to have a closure act uponclosure
- the closure to call on the object
public static Object inject(Collection self, Object value, Closure closure)
self
- a Collectionvalue
- a valueclosure
- a closure
public static Object inject(Iterator self, Object value, Closure closure)
self
- a Collectionvalue
- a valueclosure
- a closure
public static Object inject(Object self, Object value, Closure closure)
self
- a Collectionvalue
- a valueclosure
- a closure
public static Object inject(Object[] self, Object initialValue, Closure closure)
self
- an Object[]initialValue
- an initialValueclosure
- a closure
public static String inspect(Object self)
self
- any Object
public static Number intdiv(Character left, Number right)
left
- a Characterright
- a Number
public static Number intdiv(Number left, Character right)
left
- a Numberright
- a Character
public static Number intdiv(Character left, Character right)
left
- a Characterright
- another Character
public static Number intdiv(Number left, Number right)
left
- a Numberright
- another Number
public static Collection intersect(Collection left, Collection right)
assert [4,5] == [1,2,3,4,5].intersect([4,5,6,7,8])
left
- a Collectionright
- a Collection
public static Map intersect(Map left, Map right)
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]
left
- a mapright
- a map
public static Object invokeMethod(Object object, String method, Object arguments)
object
- any Objectmethod
- the name of the method to callarguments
- the arguments to use
public static boolean is(Object self, Object other)
def same = this.is(that)
self
- an objectother
- an object to compare identity with
public static boolean isAllWhitespace(String self)
self
- The String to check the characters in
public static boolean isBigDecimal(String self)
self
- a String
public static boolean isBigInteger(String self)
self
- a String
public static boolean isCase(Object caseValue, Object switchValue)
switch( a ) { case b: //some code }"some code" is called when
b.isCase( a )
returns
true
.
caseValue
- the case valueswitchValue
- the switch value
public static boolean isCase(String caseValue, Object switchValue)
switch( str ) { case 'one' : // etc... }Note that this returns
true
for the case where both the
'switch' and 'case' operand is null
.
caseValue
- the case valueswitchValue
- the switch value
public static boolean isCase(GString caseValue, Object switchValue)
caseValue
- the case valueswitchValue
- the switch value
public static boolean isCase(Class caseValue, Object switchValue)
switch( obj ) { case List : // obj is a list break; case Set : // etc }
caseValue
- the case valueswitchValue
- the switch value
public static boolean isCase(Collection caseValue, Object switchValue)
switch( 3 ) { case [1,3,5]: assert true break default: assert false }
caseValue
- the case valueswitchValue
- the switch value
public static boolean isCase(Map caseValue, Object switchValue)
switch( 'foo' ) { case [foo:true, bar:false]: assert true break default: assert false }
caseValue
- the case valueswitchValue
- the switch value
public static boolean isCase(Pattern caseValue, Object switchValue)
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
.
caseValue
- the case valueswitchValue
- the switch value
public static boolean isCase(Number caseValue, Number switchValue)
compareTo()
method for comparing numbers of different
types.
caseValue
- the case valueswitchValue
- the switch value
public static boolean isDigit(Character self)
self
- a Character
public static boolean isDouble(String self)
self
- a String
public static boolean isFloat(String self)
self
- a String
public static boolean isInteger(String self)
self
- a String
public static boolean isLetter(Character self)
self
- a Character
public static boolean isLetterOrDigit(Character self)
self
- a Character
public static boolean isLong(String self)
self
- a String
public static boolean isLowerCase(Character self)
self
- a Character
public static boolean isNumber(String self)
self
- a String
public static boolean isUpperCase(Character self)
self
- a Character
public static boolean isWhitespace(Character self)
self
- a Character
public static Iterator iterator(T[] a)
a
- an array
public static Iterator iterator(Object o)
o
- an object
public static Iterator iterator(Enumeration enumeration)
enumeration
- an Enumeration object
public static Iterator iterator(Matcher matcher)
matcher
- a Matcher object
public static Iterator iterator(Reader self)
self
- a Reader object
public static Iterator iterator(InputStream self)
self
- an InputStream object
public static Iterator iterator(DataInputStream self)
self
- a DataInputStream object
public static Iterator iterator(File self)
self
- a file object
public static Iterator iterator(Iterator self)
self
- an iterator object
@Deprecated public static Iterator iterator(def nodeList)
public static String join(Iterator self, String separator)
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.
self
- an Iterator of itemsseparator
- a String separator
public static String join(Collection self, String separator)
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(", ")
self
- a Collection of objectsseparator
- a String separator
public static String join(Object[] self, String separator)
toString()
representation of each
items in this array, with the given String as a separator between each
item.
self
- an array of Objectseparator
- a String separator
public static T last(List self)
def list = [3, 4, 2] assert list.last() == 2 assert list == [3, 4, 2]
self
- a List
public static T last(T[] self)
def array = [3, 4, 2].toArray() assert array.last() == 2
self
- an ObjectArray
public static Collection leftShift(Collection self, T value)
def list = [1,2] list << 3 assert list == [1,2,3]
self
- a Collectionvalue
- an Object to be added to the collection.
public static BlockingQueue leftShift(BlockingQueue self, T value)
def list = new java.util.concurrent.LinkedBlockingQueue () list << 3 << 2 << 1 assert list.iterator().collect{it} == [3,2,1]
self
- a Collectionvalue
- an Object to be added to the collection.
public static Map leftShift(Map self, def entry)
self
- a Mapentry
- a Map.Entry to be added to the Map.
public static Map leftShift(Map self, Map other)
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]
self
- a Mapother
- another Map whose entries should be added to the original Map.
public static StringBuffer leftShift(String self, Object value)
self
- a Stringvalue
- an Obect
public static StringBuffer leftShift(StringBuffer self, Object value)
self
- a StringBuffervalue
- a value to append
public static Writer leftShift(Writer self, Object value)
self
- a Writervalue
- a value to append
public static Number leftShift(Number self, Number operand)
self
- a Number objectoperand
- the shift distance by which to left shift the number
public static Writer leftShift(OutputStream self, Object value)
self
- an OutputStreamvalue
- a value to append
public static void leftShift(ObjectOutputStream self, Object value)
self
- an ObjectOutputStreamvalue
- an object to write to the stream
public static OutputStream leftShift(OutputStream self, InputStream in)
self
- stream on which to writein
- stream to read from
public static OutputStream leftShift(OutputStream self, byte[] value)
self
- an OutputStreamvalue
- a value to append
public static File leftShift(File file, Object text)
file
- a Filetext
- the text to write to the File
public static File leftShift(File file, byte[] bytes)
file
- a Filebytes
- the byte array to append to the end of the File
public static File leftShift(File file, InputStream data)
file
- a Filedata
- an InputStream of data to write to the file
public static Writer leftShift(Socket self, Object value)
self
- a Socketvalue
- a value to append
public static OutputStream leftShift(Socket self, byte[] value)
self
- a Socketvalue
- a value to append
@Deprecated public static Writer leftShift(Process self, Object value)
@Deprecated public static OutputStream leftShift(Process self, byte[] value)
public static boolean matches(String self, Pattern pattern)
self
- the string that is to be matchedpattern
- the regex Pattern to which the string of interest is to be matched
public static def max(Map self, Closure closure)
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 == 5Edge 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
self
- a Mapclosure
- a 1 or 2 arg Closure used to determine the correct ordering
public static T max(Collection self)
assert 5 == [2,3,1,5,4].max()
self
- a Collection
public static T max(Iterator self)
self
- an Iterator
public static T max(T[] self)
self
- an Object array
public static T max(Collection self, Closure closure)
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
self
- a Collectionclosure
- a 1 or 2 arg Closure used to determine the correct ordering
public static T max(Iterator self, Closure closure)
self
- an Iteratorclosure
- a Closure used to determine the correct ordering
public static T max(T[] self, Closure closure)
self
- an Object arrayclosure
- a Closure used to determine the correct ordering
public static T max(Collection self, Comparator comparator)
assert "hello" == ["hello","hi","hey"].max( { a, b -> a.length() <=> b.length() } as Comparator )
self
- a Collectioncomparator
- a Comparator
public static T max(Iterator self, Comparator comparator)
self
- an Iteratorcomparator
- a Comparator
public static T max(T[] self, Comparator comparator)
self
- an Object arraycomparator
- a Comparator
public static MetaClass metaClass(Class self, Closure closure)
self
- the class whose metaclass we wish to updateclosure
- the closure representing the new metaclass
public static MetaClass metaClass(Object self, Closure closure)
self
- the object whose metaclass we wish to updateclosure
- the closure representing the new metaclass
public static T min(Collection self)
assert 2 == [4,2,5].min()
self
- a Collection
public static T min(Iterator self)
self
- an Iterator
public static T min(T[] self)
self
- an Object array
public static T min(Collection self, Comparator comparator)
assert "hi" == ["hello","hi","hey"].min( { a, b -> a.length() <=> b.length() } as Comparator )
self
- a Collectioncomparator
- a Comparator
public static T min(Iterator self, Comparator comparator)
self
- an Iteratorcomparator
- a Comparator
public static T min(T[] self, Comparator comparator)
self
- an Object arraycomparator
- a Comparator
public static T min(Collection self, Closure closure)
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
self
- a Collectionclosure
- a 1 or 2 arg Closure used to determine the correct ordering
public static def min(Map self, Closure closure)
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 == 7Edge 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'
self
- a Mapclosure
- a 1 or 2 arg Closure used to determine the correct ordering
public static T min(Iterator self, Closure closure)
self
- an Iteratorclosure
- a Closure used to determine the correct ordering
public static T min(T[] self, Closure closure)
self
- an Object arrayclosure
- a Closure used to determine the correct ordering
public static Set minus(Set self, Collection operands)
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)
self
- this Setother
- the Set being compared to
public static Set minus(Set self, Object operand)
self
- a set objectoperand
- the operand to remove from the set
@SuppressWarnings("unchecked") public static T[] minus(T[] self, Collection removeMe)
self
- an object arrayremoveMe
- a Collection of elements to remove
@SuppressWarnings("unchecked") public static T[] minus(T[] self, T[] removeMe)
self
- an object arrayremoveMe
- an array of elements to remove
public static List minus(List self, Collection removeMe)
assert [1, "a", true, true, false, 5.3] - [true, 5.3] == [1, "a", false]
self
- a ListremoveMe
- a Collection of elements to remove
public static List minus(List self, Object operand)
assert ["a", 5, 5, true] - 5 == ["a", true]
self
- a List objectoperand
- an element to remove from the list
public static T[] minus(T[] self, Object operand)
self
- an object arrayoperand
- an element to remove from the array
public static Map minus(Map self, Map operands)
self
- a map objectoperands
- the entries to remove from the map
public static String minus(String self, Object target)
self
- a Stringtarget
- an object representing the part to remove
public static Number minus(Character left, Number right)
public static Number minus(Number left, Character right)
left
- a Numberright
- a Character
public static Number minus(Character left, Character right)
left
- a Characterright
- a Character
@Deprecated public static Date minus(Date self, int days)
@Deprecated public static def minus(def self, int days)
@Deprecated public static int minus(Calendar self, Calendar then)
@Deprecated public static int minus(Date self, Date then)
public static void mixin(MetaClass self, List categoryClasses)
self
- any ClasscategoryClasses
- a category classes to use
public static void mixin(Class self, List categoryClasses)
self
- any ClasscategoryClasses
- a category classes to use
public static void mixin(Class self, Class categoryClass)
self
- any ClasscategoryClass
- a category class to use
public static void mixin(Class self, Class[] categoryClass)
self
- any ClasscategoryClass
- a category class to use
public static void mixin(MetaClass self, Class categoryClass)
self
- any ClasscategoryClass
- a category class to use
public static void mixin(MetaClass self, Class[] categoryClass)
self
- any ClasscategoryClass
- a category class to use
public static Number mod(Number left, Number right)
left
- a Numberright
- another Number to mod
public static List multiply(Collection self, Number factor)
assert [1,2,3,1,2,3] == [1,2,3] * 2
self
- a Collectionfactor
- the number of times to append
public static String multiply(String self, Number factor)
self
- a String to be repeatedfactor
- the number of times the String should be repeated
public static Number multiply(Character left, Number right)
left
- a Characterright
- a Number
public static Number multiply(Number left, Character right)
left
- a Numberright
- a Character
public static Number multiply(Character left, Character right)
left
- a Characterright
- another Character
public static Number multiply(BigDecimal left, Double right)
left
- a BigDecimalright
- a Double
public static Number multiply(BigDecimal left, BigInteger right)
left
- a BigDecimalright
- a BigInteger
public static DataInputStream newDataInputStream(File file)
file
- a File
public static DataOutputStream newDataOutputStream(File file)
file
- a file object
public static BufferedInputStream newInputStream(File file)
file
- a File
public static BufferedInputStream newInputStream(URL url)
url
- a URL
public static T newInstance(Class c)
c
- a class
public static T newInstance(Class c, Object[] args)
newInstance(null)
or simply
newInstance()
for the default (no-arg) constructor.
c
- a classargs
- the constructor arguments
public static ObjectInputStream newObjectInputStream(File file)
file
- a file
public static ObjectInputStream newObjectInputStream(InputStream inputStream)
inputStream
- an input stream
public static ObjectInputStream newObjectInputStream(InputStream inputStream, ClassLoader classLoader)
inputStream
- an input streamclassLoader
- the class loader to use when loading the class
public static ObjectInputStream newObjectInputStream(File file, ClassLoader classLoader)
file
- a fileclassLoader
- the class loader to use when loading the class
public static ObjectOutputStream newObjectOutputStream(File file)
file
- a file
public static ObjectOutputStream newObjectOutputStream(OutputStream outputStream)
outputStream
- an output stream
public static BufferedOutputStream newOutputStream(File file)
file
- a file object
public static PrintWriter newPrintWriter(File file)
file
- a File
public static PrintWriter newPrintWriter(File file, String charset)
file
- a Filecharset
- the charset
public static PrintWriter newPrintWriter(Writer writer)
writer
- a writer
public static BufferedReader newReader(File file)
file
- a File
public static BufferedReader newReader(File file, String charset)
file
- a Filecharset
- the charset for this File
public static BufferedReader newReader(InputStream self)
self
- an input stream
public static BufferedReader newReader(InputStream self, String charset)
self
- an input streamcharset
- the charset for this input stream
public static BufferedReader newReader(URL url)
url
- a URL
public static BufferedReader newReader(URL url, String charset)
url
- a URLcharset
- opens the stream with a specified charset
public static BufferedWriter newWriter(File file)
file
- a File
public static BufferedWriter newWriter(File file, boolean append)
file
- a Fileappend
- true if data should be appended to the file
public static BufferedWriter newWriter(File file, String charset, boolean append)
file
- a Filecharset
- the name of the encoding used to write in this fileappend
- true if in append mode
public static BufferedWriter newWriter(File file, String charset)
file
- a Filecharset
- the name of the encoding used to write in this file
public static String next(String self)
self
- a String
public static Character next(Character self)
self
- a Character
public static Number next(Number self)
self
- a Number
@Deprecated public static Date next(Date self)
@Deprecated public static def next(def self)
public static String normalize(String self)
self
- a String object
public static int numberAwareCompareTo(Comparable self, Comparable other)
self
- a Comparableother
- another Comparable
public static Number or(Number left, Number right)
left
- a Numberright
- another Number to bitwise OR
public static BitSet or(BitSet left, BitSet right)
left
- a BitSetright
- another BitSet to bitwise AND
public static Boolean or(Boolean left, Boolean right)
left
- left operatorright
- right operator
@Deprecated public static Process or(Process left, Process right)
public static String padLeft(String self, Number numberOfChars, String padding)
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
self
- a String objectnumberOfChars
- the total minimum number of characters of the resulting stringpadding
- the charaters used for padding
public static String padLeft(String self, Number numberOfChars)
println 'Numbers:' [1, 10, 100, 1000].each{ println it.toString().padLeft(5) }will produce output like:
Numbers: 1 10 100 1000
self
- a String objectnumberOfChars
- the total minimum number of characters of the resulting string
public static String padRight(String self, Number numberOfChars, String padding)
['A', 'BB', 'CCC', 'DDDD'].each{ println it.padRight(5, '#') + it.size() }will produce output like:
A####1 BB###2 CCC##3 DDDD#4
self
- a String objectnumberOfChars
- the total minimum number of characters of the resulting stringpadding
- the charaters used for padding
public static String padRight(String self, Number numberOfChars)
['A', 'BB', 'CCC', 'DDDD'].each{ println it.padRight(5) + it.size() }will produce output like:
A 1 BB 2 CCC 3 DDDD 4
self
- a String objectnumberOfChars
- the total minimum number of characters of the resulting string
public static Set permutations(List self)
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
self
- the Collection of items
@Deprecated public static Process pipeTo(Process left, Process right)
public static Map plus(Map left, Map right)
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]
left
- a Mapright
- a Map
public static Map plus(Map self, Collection entries)
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.
self
- a Mapentries
- a Collection of Map.Entry items to be added to the Map.
public static Collection plus(Collection left, Collection right)
assert [1,2,3,4] == [1,2] + [3,4]
left
- the left Collectionright
- the right Collection
public static Collection plus(Collection left, T right)
assert [1,2,3] == [1,2] + 3
left
- a Collectionright
- an object to add/append
public static String plus(String left, Object value)
left
- a Stringvalue
- any Object
public static String plus(Number value, String right)
value
- a Numberright
- a String
public static String plus(StringBuffer left, String value)
left
- a StringBuffervalue
- a String
public static Number plus(Character left, Number right)
left
- a Characterright
- a Number
public static Number plus(Number left, Character right)
left
- a Numberright
- a Character
public static Number plus(Character left, Character right)
left
- a Characterright
- a Character
@Deprecated public static Date plus(Date self, int days)
@Deprecated public static def plus(def self, int days)
public static T pop(List self)
def list = ["a", false, 2] assert list.pop() == 2 assert list == ["a", false]
self
- a List
public static Number power(Number self, Number exponent)
self
- a Numberexponent
- a Number exponent
public static Number power(BigDecimal self, Integer exponent)
self
- a BigDecimalexponent
- an Integer exponent
public static Number power(BigInteger self, Integer exponent)
self
- a BigIntegerexponent
- an Integer exponent
public static Number power(Integer self, Integer exponent)
self
- an Integerexponent
- an Integer exponent
public static Number power(Long self, Integer exponent)
self
- a Longexponent
- an Integer exponent
public static String previous(String self)
self
- a String
public static Character previous(Character self)
self
- a Character
public static Number previous(Number self)
self
- a Number
@Deprecated public static Date previous(Date self)
@Deprecated public static def previous(def self)
protected static Object primitiveArrayGet(Object self, int idx)
self
- an array objectidx
- the index of interest
protected static List primitiveArrayGet(Object self, Range range)
self
- an array objectrange
- the range of indices of interest
protected static List primitiveArrayGet(Object self, Collection indices)
self
- an array objectindices
- the indices of interest
protected static Object primitiveArrayPut(Object self, int idx, Object newValue)
self
- an objectidx
- the index of interestnewValue
- the new value to be put into the index of interest
public static void print(Object self, Object value)
self
- any Objectvalue
- the value to print
public static void print(PrintWriter self, Object value)
self
- a PrintWritervalue
- the value to print
public static void print(PrintStream self, Object value)
self
- a PrintStreamvalue
- the value to print
public static void print(Closure self, Object value)
self
- a generated closurevalue
- the value to print
public static void print(Object self, PrintWriter out)
self
- any Objectout
- the PrintWriter used for printing
public static void printf(Object self, String format, Object[] values)
self
- any Objectformat
- a format stringvalues
- values referenced by the format specifiers in the format string.
public static void printf(Object self, String format, Object arg)
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[] ) }
self
- any Objectformat
- A format stringarg
- 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[].
public static void println(Object self)
self
- any Object
public static void println(Closure self)
self
- a closure
public static void println(Object self, Object value)
self
- any Objectvalue
- the value to print
public static void println(PrintWriter self, Object value)
self
- a PrintWritervalue
- the value to print
public static void println(PrintStream self, Object value)
self
- any Objectvalue
- the value to print
public static void println(Closure self, Object value)
self
- a closurevalue
- the value to print
public static void println(Object self, PrintWriter out)
self
- any Objectout
- the PrintWriter used for printing
public static boolean push(List self, T value)
def list = [3, 4, 2] list.push("x") assert list == [3, 4, 2, "x"]
self
- a Listvalue
- element to be appended to this list.
public static Map putAll(Map self, Collection entries)
self
- a Mapentries
- a Collection of Map.Entry items to be added to the Map.
public static void putAt(Object self, String property, Object newValue)
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.
self
- the object to act uponproperty
- the name of the property to setnewValue
- the value to set
public static void putAt(List self, int idx, T value)
def list = [2, 3] list[0] = 1 assert list == [1, 3]
self
- a Listidx
- an indexvalue
- the value to put at the given index
public static void putAt(StringBuffer self, IntRange range, Object value)
self
- a StringBufferrange
- a Rangevalue
- the object that's toString() will be inserted
public static void putAt(StringBuffer self, EmptyRange range, Object value)
self
- a StringBufferrange
- a Rangevalue
- the object that's toString() will be inserted
public static void putAt(List self, EmptyRange range, Object value)
def list = ["a", true] list[1..<1] = 5 assert list == ["a", 5, true]
self
- a Listrange
- the (in this case empty) subset of the list to setvalue
- the values to put at the given sublist or a Collection of values
public static void putAt(List self, EmptyRange range, Collection value)
def list = ["a", true] list[1..<1] = [4, 3, 2] assert list == ["a", 4, 3, 2, true]
self
- a Listrange
- the (in this case empty) subset of the list to setvalue
- the Collection of values
public static void putAt(List self, IntRange range, Collection col)
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.
self
- a Listrange
- the subset of the list to setcol
- the collection of values to put at the given sublist
public static void putAt(List self, IntRange range, Object value)
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.
self
- a Listrange
- the subset of the list to setvalue
- the value to put at the given sublist
public static void putAt(List self, List splice, List values)
def list = ["a", true, 42, 9.4] list[1, 4] = ["x", false] assert list == ["a", "x", 42, 9.4, false]
self
- a Listsplice
- the subset of the list to setvalues
- the value to put at the given sublist
public static void putAt(List self, List splice, Object value)
def list = ["a", true, 42, 9.4] list[1, 3] = 5 assert list == ["a", 5, 42, 5]
self
- a Listsplice
- the subset of the list to setvalue
- the value to put at the given sublist
public static V putAt(Map self, K key, V value)
self
- a Mapkey
- an Object as a key for the mapvalue
- the value to put into the map
public static void putAt(BitSet self, IntRange range, boolean value)
self
- a BitSetrange
- the range of values to setvalue
- value
public static void putAt(BitSet self, int index, boolean value)
self
- a BitSetindex
- index of the entry to setvalue
- value
public static byte[] readBytes(File file)
file
- a File
public static String readLine(Reader self)
self
- a Reader
public static List readLines(String self)
self
- a String object
public static List readLines(File file)
file
- a File
public static List readLines(File file, String charset)
file
- a Filecharset
- opens the file with a specified charset
public static List readLines(InputStream stream)
stream
- a stream
public static List readLines(InputStream stream, String charset)
stream
- a streamcharset
- opens the stream with a specified charset
public static List readLines(URL self)
self
- a URL
public static List readLines(URL self, String charset)
self
- a URLcharset
- opens the URL with a specified charset
public static List readLines(Reader reader)
reader
- a Reader
public static boolean removeAll(Collection self, T[] items)
items
- array containing elements to be removed from this collection
public static boolean removeAll(Collection self, Closure closure)
self
- a Collection to be modifiedclosure
- a closure condition
public static boolean renameTo(File self, String newPathName)
self
- a FilenewPathName
- The new pathname for the named filetrue
if and only if the renaming succeeded;
false
otherwise
public static String replaceAll(String self, Pattern pattern, String 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.
self
- the string that is to be matchedpattern
- the regex Pattern to which the string of interest is to be matchedreplacement
- the string to be substituted for the first match
public static String replaceAll(String self, String regex, Closure closure)
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.
self
- a Stringregex
- the capturing regexclosure
- the closure to apply on each captured group
public static String replaceAll(String self, Pattern pattern, Closure closure)
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.
self
- a Stringpattern
- the capturing regex Patternclosure
- the closure to apply on each captured group
public static String replaceFirst(String self, Pattern pattern, String 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.
self
- the string that is to be matchedpattern
- the regex Pattern to which the string of interest is to be matchedreplacement
- the string to be substituted for the first match
public static String replaceFirst(String self, String regex, Closure closure)
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() }
self
- a Stringregex
- the capturing regexclosure
- the closure to apply on the first captured group
public static String replaceFirst(String self, Pattern pattern, Closure closure)
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() }
self
- a Stringpattern
- the capturing regex Patternclosure
- the closure to apply on the first captured group
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
self
- The object to inspectname
- The name of the method of interestargTypes
- The argument types to match against
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
self
- The object to inspectname
- The name of the method of interest
public static boolean retainAll(Collection self, T[] items)
items
- array containing elements to be retained from this collection
public static boolean retainAll(Collection self, Closure closure)
self
- a Collection to be modifiedclosure
- a closure condition
@SuppressWarnings("unchecked") public static T[] reverse(T[] self)
self
- an Object array
public static String reverse(String self)
self
- a String
public static List reverse(List self)
def list = ["a", 4, false] assert list.reverse() == [false, 4, "a"] assert list == ["a", 4, false]
self
- a List
public static Iterator reverse(Iterator self)
self
- an Iterator
public static Map reverseEach(Map self, Closure closure)
self
- the map over which we iterateclosure
- the 1 or 2 arg closure applied on each entry of the map
public static List reverseEach(List self, Closure closure)
def result = [] [1,2,3].reverseEach { result << it } assert result == [3,2,1]
self
- a Listclosure
- a closure to which each item is passed.
public static T[] reverseEach(T[] self, Closure closure)
self
- an Object arrayclosure
- a closure to which each item is passed
public static Number rightShift(Number self, Number operand)
self
- a Number objectoperand
- the shift distance by which to right shift the number
public static Number rightShiftUnsigned(Number self, Number operand)
self
- a Number objectoperand
- the shift distance by which to right shift (unsigned) the number
public static int round(Float number)
number
- a Float
public static float round(Float number, int precision)
number
- a Floatprecision
- the number of decimal places to keep
public static long round(Double number)
number
- a Double
public static double round(Double number, int precision)
number
- a Doubleprecision
- the number of decimal places to keep
public static TimerTask runAfter(Timer timer, int delay, Closure closure)
timer
- a timer objectdelay
- the delay in milliseconds before running the closure codeclosure
- the closure to invoke
public static void setBytes(File file, byte[] bytes)
file
- the file to write tobytes
- the byte[] to write to the file
public static void setBytes(OutputStream os, byte[] bytes)
os
- an output streambytes
- the byte[] to write to the output stream
public static void setIndex(Matcher matcher, int idx)
matcher
- a Matcheridx
- the index number
public static void setMetaClass(Class self, MetaClass metaClass)
self
- the class whose metaclass we wish to setmetaClass
- the new MetaClass
public static void setMetaClass(Object self, MetaClass metaClass)
self
- the object whose metaclass we want to setmetaClass
- the new metaclass value
public static void setText(File file, String text)
file
- a Filetext
- the text to write to the File
public static void setText(File file, String text, String charset)
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'
file
- A Filecharset
- The charset used when writing to the filetext
- The text to write to the File
public static int size(Iterator self)
size()
method for Iterator
.
The iterator will become exhausted of elements after determining the size value.
self
- an Iterator
public static int size(String text)
size()
method for String
.
text
- a String
public static int size(StringBuffer buffer)
size()
method for StringBuffer
.
buffer
- a StringBuffer
public static long size(File self)
size()
method for File
.
self
- a file object
public static long size(Matcher self)
size()
method for Matcher
.
self
- a matcher object
public static int size(Object[] self)
size()
method for an array.
self
- an Array of objects
public static int size(boolean[] array)
array
- a boolean array
public static int size(byte[] array)
array
- a byte array
public static int size(char[] array)
array
- a char array
public static int size(short[] array)
array
- a short array
public static int size(int[] array)
array
- an int array
public static int size(long[] array)
array
- a long array
public static int size(float[] array)
array
- a float array
public static int size(double[] array)
array
- a double array
public static List sort(Collection self)
assert [1,2,3] == [3,1,2].sort()
self
- the collection to be sorted
public static Map sort(Map self, Closure closure)
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]
self
- the map to be sortedclosure
- a Closure used as a comparator
public static Map sort(Map self, Comparator comparator)
def map = [ba:3, cz:6, ab:5].sort({ a, b -> a[-1] <=> b[-1] } as Comparator) assert map*.value == [3, 5, 6]
self
- the map to be sortedcomparator
- a Comparator
public static Map sort(Map self)
map = [ba:3, cz:6, ab:5].sort() assert map*.value == [5, 3, 6]
self
- the map to be sorted
public static T[] sort(T[] self)
self
- the array to be sorted
public static Iterator sort(Iterator self)
self
- the Iterator to be sorted
public static Iterator sort(Iterator self, Comparator comparator)
self
- the Iterator to be sortedcomparator
- a Comparator used for comparing items
public static List sort(Collection self, Comparator comparator)
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)
self
- a collection to be sortedcomparator
- a Comparator used for the comparison
public static T[] sort(T[] self, Comparator comparator)
self
- the array to be sortedcomparator
- a Comparator used for the comparison
public static Iterator sort(Iterator self, Closure closure)
self
- the Iterator to be sortedclosure
- a Closure used to determine the correct ordering
@SuppressWarnings("unchecked") public static T[] sort(T[] self, Closure closure)
self
- the array to be sortedclosure
- a Closure used to determine the correct ordering
public static List sort(Collection self, Closure closure)
assert ["hi","hey","hello"] == ["hello","hi","hey"].sort { it.length() }
assert ["hi","hey","hello"] == ["hello","hi","hey"].sort { a, b -> a.length() <=> b.length() }
self
- a Collection to be sortedclosure
- a 1 or 2 arg Closure used to determine the correct ordering
public static SortedSet sort(SortedSet self)
self
- an identity function for an already sorted set
public static Collection split(Object self, Closure closure)
self
- an Object with an Iterator returning its valuesclosure
- a closure condition
public static Collection split(Collection self, Closure closure)
assert [[2,4],[1,3]] == [1,2,3,4].split { it % 2 == 0 }
self
- a Collection of valuesclosure
- a closure condition
public static String[] split(String self)
self
- the string to split
public static String[] split(GString self)
self
- the GString to split
public static Object splitEachLine(File self, String regex, Closure closure)
self
- a Fileregex
- the delimiting regular expressionclosure
- a closure
public static Object splitEachLine(File self, Pattern pattern, Closure closure)
self
- a Filepattern
- the regular expression Pattern for the delimiterclosure
- a closure
public static Object splitEachLine(File self, String regex, String charset, Closure closure)
self
- a Fileregex
- the delimiting regular expressioncharset
- opens the file with a specified charsetclosure
- a closure
public static Object splitEachLine(File self, Pattern pattern, String charset, Closure closure)
self
- a Filepattern
- the regular expression Pattern for the delimitercharset
- opens the file with a specified charsetclosure
- a closure
public static Object splitEachLine(URL self, String regex, Closure closure)
self
- a URL to open and readregex
- the delimiting regular expressionclosure
- a closure
public static Object splitEachLine(URL self, Pattern pattern, Closure closure)
self
- a URL to open and readpattern
- the regular expression Pattern for the delimiterclosure
- a closure
public static Object splitEachLine(URL self, String regex, String charset, Closure closure)
self
- a URL to open and readregex
- the delimiting regular expressioncharset
- opens the file with a specified charsetclosure
- a closure
public static Object splitEachLine(URL self, Pattern pattern, String charset, Closure closure)
self
- a URL to open and readpattern
- the regular expression Pattern for the delimitercharset
- opens the file with a specified charsetclosure
- a closure
public static Object splitEachLine(Reader self, String regex, Closure closure)
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|'
self
- a Reader, closed after the method returnsregex
- the delimiting regular expressionclosure
- a closure
public static Object splitEachLine(Reader self, Pattern pattern, Closure closure)
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|'
self
- a Reader, closed after the method returnspattern
- the regular expression Pattern for the delimiterclosure
- a closure
public static Object splitEachLine(InputStream stream, String regex, String charset, Closure closure)
stream
- an InputStreamregex
- the delimiting regular expressioncharset
- opens the stream with a specified charsetclosure
- a closure
public static Object splitEachLine(InputStream stream, Pattern pattern, String charset, Closure closure)
stream
- an InputStreampattern
- the regular expression Pattern for the delimitercharset
- opens the stream with a specified charsetclosure
- a closure
public static Object splitEachLine(InputStream stream, String regex, Closure closure)
stream
- an InputStreamregex
- the delimiting regular expressionclosure
- a closure
public static Object splitEachLine(InputStream stream, Pattern pattern, Closure closure)
stream
- an InputStreampattern
- the regular expression Pattern for the delimiterclosure
- a closure
public static Object splitEachLine(String self, String regex, Closure closure)
self
- a Stringregex
- the delimiting regular expressionclosure
- a closure
public static Object splitEachLine(String self, Pattern pattern, Closure closure)
self
- a Stringpattern
- the regular expression Pattern for the delimiterclosure
- a closure
public static SpreadMap spread(Map self)
self
- a map
public static String sprintf(Object self, String format, Object[] values)
self
- any Objectformat
- a format stringvalues
- values referenced by the format specifiers in the format string.
public static String sprintf(Object self, String format, Object arg)
self
- any Objectformat
- A format stringarg
- 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[].
public static void step(Number self, Number to, Number stepNumber, Closure closure)
0.step( 10, 2 ) { println it }Prints even numbers 0 through 8.
self
- a Number to start withto
- a Number to go up to, exclusivestepNumber
- a Number representing the step incrementclosure
- the closure to call
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()
self
- The String to strip the leading spaces from
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)
self
- The String to strip the characters fromnumChars
- The number of characters to strip
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()
self
- The String to strip the margin from
public static String stripMargin(String self, String marginChar)
Strip leading whitespace/control characters followed by marginChar from every line in a String.
self
- The String to strip the margin frommarginChar
- Any character that serves as margin delimiter
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('*')
self
- The String to strip the margin frommarginChar
- Any character that serves as margin delimiter
public static Map subMap(Map map, Collection keys)
assert [1:10, 2:20, 4:40].subMap( [2, 4] ) == [2:20, 4:40]
map
- a Mapkeys
- a Collection of keys
public static Set subsequences(List self)
def result = [1, 2, 3].subsequences() assert result == [[1, 2, 3], [1, 3], [2, 3], [1, 2], [1], [2], [3]] as Set
self
- the List of items
public static Object sum(Collection self)
assert 1+2+3+4 == [1,2,3,4].sum()
self
- Collection of values to add together
public static Object sum(Object[] self)
self
- The array of values to add together
public static Object sum(Iterator self)
self
- an Iterator for the values to add together
public static Object sum(Collection self, Object initialValue)
assert 5+1+2+3+4 == [1,2,3,4].sum(5)
self
- a collection of values to suminitialValue
- the items in the collection will be summed to this initial value
public static Object sum(Object[] self, Object initialValue)
self
- an array of values to suminitialValue
- the items in the array will be summed to this initial value
public static Object sum(Iterator self, Object initialValue)
self
- an Iterator for the values to add togetherinitialValue
- the items in the collection will be summed to this initial value
public static Object sum(Collection self, Closure closure)
coll.sum(closure)
is equivalent to:
coll.collect(closure).sum()
.
assert 4+6+10+12 == [2,3,5,6].sum() { it * 2 }
self
- a Collectionclosure
- a single parameter closure that returns a numeric value.
public static Object sum(Object[] self, Closure closure)
array.sum(closure)
is equivalent to:
array.collect(closure).sum()
.
self
- An arrayclosure
- a single parameter closure that returns a numeric value.
public static Object sum(Iterator self, Closure closure)
iter.sum(closure)
is equivalent to:
iter.collect(closure).sum()
. The iterator will become
exhausted of elements after determining the sum value.
self
- An Iteratorclosure
- a single parameter closure that returns a numeric value.
public static Object sum(Collection self, Object initialValue, Closure closure)
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 }
self
- a Collectionclosure
- a single parameter closure that returns a numeric value.initialValue
- the closure results will be summed to this initial value
public static Object sum(Object[] self, Object initialValue, Closure closure)
array.sum(initVal, closure)
is equivalent to:
array.collect(closure).sum(initVal)
.
self
- an arrayclosure
- a single parameter closure that returns a numeric value.initialValue
- the closure results will be summed to this initial value
public static Object sum(Iterator self, Object initialValue, Closure closure)
iter.sum(initVal, closure)
is equivalent to:
iter.collect(closure).sum(initVal)
. The iterator will become
exhausted of elements after determining the sum value.
self
- an Iteratorclosure
- a single parameter closure that returns a numeric value.initialValue
- the closure results will be summed to this initial value
public static List tail(List self)
def list = [3, 4, 2] assert list.tail() == [4, 2] assert list == [3, 4, 2]
self
- a List
public static T[] tail(T[] self)
String[] strings = ["a", "b", "c"] def result = strings.tail() assert strings.class.componentType == String
self
- an Object array
public static void times(Number self, Closure closure)
10.times { println it }Prints the numbers 0 through 9.
self
- a Numberclosure
- the closure to call a number of times
public static String toArrayString(Object[] self)
{1, 2, "a"}
.
self
- an Object[]
public static BigDecimal toBigDecimal(String self)
self
- a String
public static BigDecimal toBigDecimal(Number self)
self
- a Number
public static BigInteger toBigInteger(String self)
self
- a String
public static BigInteger toBigInteger(Number self)
self
- a Number
public static Boolean toBoolean(String self)
self
- a String
public static Boolean toBoolean(Boolean self)
self
- a Boolean
public static Character toCharacter(String self)
self
- a String
public static Double toDouble(String self)
self
- a String
public static Double toDouble(Number self)
self
- a Number
public static Float toFloat(String self)
self
- a String
public static Float toFloat(Number self)
self
- a Number
public static Integer toInteger(String self)
self
- a String
public static Integer toInteger(Number self)
self
- a Number
public static List toList(Collection self)
Example usage:
def x = [1,2,3] as HashSet assert x.class == HashSet assert x.toList() instanceof List
self
- a collection
public static List toList(Iterator self)
self
- an iterator
public static List toList(Enumeration self)
self
- an enumeration
public static List toList(T[] array)
array
- an Array of Objects
@SuppressWarnings("unchecked") public static List toList(byte[] array)
array
- a byte array
@SuppressWarnings("unchecked") public static List toList(boolean[] array)
array
- a boolean array
@SuppressWarnings("unchecked") public static List toList(char[] array)
array
- a char array
@SuppressWarnings("unchecked") public static List toList(short[] array)
array
- a short array
@SuppressWarnings("unchecked") public static List toList(int[] array)
array
- an int array
@SuppressWarnings("unchecked") public static List toList(long[] array)
array
- a long array
@SuppressWarnings("unchecked") public static List toList(float[] array)
array
- a float array
@SuppressWarnings("unchecked") public static List toList(double[] array)
array
- a double array
public static List toList(String self)
self
- a String
public static String toListString(Collection self)
[1, 2, a]
.
self
- a Collection
public static String toListString(Collection self, int maxSize)
[1, 2, a]
.
self
- a CollectionmaxSize
- stop after approximately this many characters and append '...'
public static Long toLong(String self)
self
- a String
public static Long toLong(Number self)
self
- a Number
public static char toLowerCase(Character self)
self
- a Character to convert
public static String toMapString(Map self)
[one:1, two:2, three:3]
.
self
- a Map
public static String toMapString(Map self, int maxSize)
[one:1, two:2, three:3]
.
self
- a MapmaxSize
- stop after approximately this many characters and append '...'
@Deprecated public static def toRowResult(def rs)
public static Short toShort(String self)
self
- a String
public static SpreadMap toSpreadMap(Map self)
SpreadMap
from this map.
For examples, if there is defined a function like as
, then all of the following three have the same meaning.def fn(a, b, c, d) { return a + b + c + d }
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)
self
- a list to be converted into a spreadmap
public static SpreadMap toSpreadMap(Object[] self)
self
- an object array
public static String toString(boolean[] self)
self
- an array
public static String toString(byte[] self)
self
- an array
public static String toString(char[] self)
self
- an array
public static String toString(short[] self)
self
- an array
public static String toString(int[] self)
self
- an array
public static String toString(long[] self)
self
- an array
public static String toString(float[] self)
self
- an array
public static String toString(double[] self)
self
- an array
public static String toString(AbstractMap self)
self
- a Map
public static String toString(AbstractCollection self)
[1, 2, a]
.
self
- a Collection
public static String toString(Object[] self)
self
- an Object[]
public static String toString(Object value)
value
- an object
public static URI toURI(String self)
self
- the String representing a URI
public static URL toURL(String self)
self
- the String representing a URL
public static char toUpperCase(Character self)
self
- a Character to convert
public static List tokenize(String self, String token)
self
- a Stringtoken
- the delimiter
public static List tokenize(String self, Character token)
char pathSep = ':' assert "/tmp:/usr".tokenize(pathSep) == ["/tmp", "/usr"]
self
- a Stringtoken
- the delimiter
public static List tokenize(String self)
self
- a String
public static String tr(String self, String sourceSet, String replacementSet)
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.
self
- the string that is to be translatedsourceSet
- the set of characters to translate fromreplacementSet
- the set of replacement characters
public static void transformChar(Reader self, Writer writer, Closure closure)
self
- a Reader objectwriter
- a Writer to receive the transformed charactersclosure
- a closure that performs the required transformation
public static void transformLine(Reader reader, Writer writer, Closure closure)
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.
public static List transpose(List self)
def result = [['a', 'b'], [1, 2]].transpose() assert result == [['a', 1], ['b', 2]]
self
- a List of lists
public static void traverse(File self, Map options, Closure closure)
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: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++ }
self
- a Fileoptions
- a Map of options to alter the traversal behaviorclosure
- the Closure to invoke on each file/directory and optionally returning a FileVisitResult value
which can be used to control subsequent processing
public static void traverse(File self, Closure closure)
self
- a Fileclosure
- the Closure to invoke on each file/directory and optionally returning a FileVisitResult value
which can be used to control subsequent processing
public static void traverse(File self, Map options)
self
- a Fileoptions
- a Map of options to alter the traversal behavior
public static float trunc(Float number, int precision)
number
- a Floatprecision
- the number of decimal places to keep
public static float trunc(Float number)
number
- a Double
public static double trunc(Double number)
number
- a Double
public static double trunc(Double number, int precision)
number
- a Doubleprecision
- the number of decimal places to keep
public static Number unaryMinus(Number left)
-10
left
- a Number
public static String unexpand(String self)
self
- A String to unexpand
public static String unexpand(String self, int tabStop)
self
- A String to unexpandtabStop
- The number of spaces a tab represents
public static String unexpandLine(String self, int tabStop)
self
- A line to unexpandtabStop
- The number of spaces a tab represents
public static Iterator unique(Iterator self)
self
- an Iterator
public static Collection unique(Collection self)
assert [1,3] == [1,3,3].unique()
self
- a collection
public static Iterator unique(Iterator self, Closure closure)
self
- an Iteratorclosure
- a Closure used to determine unique items
public static Collection unique(Collection self, Closure closure)
assert [1,4] == [1,3,4,5].unique { it % 2 }
assert [2,3,4] == [2,3,3,4].unique { a, b -> a <=> b }
self
- a Collectionclosure
- a 1 or 2 arg Closure used to determine unique items
public static Iterator unique(Iterator self, Comparator comparator)
self
- an Iteratorcomparator
- a Comparator
public static Collection unique(Collection self, Comparator comparator)
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] )
self
- a Collectioncomparator
- a Comparator
public static void upto(Number self, Number to, Closure closure)
self
- a Numberto
- another Number to go up toclosure
- the closure to call
public static void upto(long self, Number to, Closure closure)
self
- a longto
- the end numberclosure
- the code to execute for each number
public static void upto(Long self, Number to, Closure closure)
self
- a Longto
- the end numberclosure
- the code to execute for each number
public static void upto(float self, Number to, Closure closure)
self
- a floatto
- the end numberclosure
- the code to execute for each number
public static void upto(Float self, Number to, Closure closure)
self
- a Floatto
- the end numberclosure
- the code to execute for each number
public static void upto(double self, Number to, Closure closure)
self
- a doubleto
- the end numberclosure
- the code to execute for each number
public static void upto(Double self, Number to, Closure closure)
self
- a Doubleto
- the end numberclosure
- the code to execute for each number
public static void upto(BigInteger self, Number to, Closure closure)
0.upto( 10 ) { println it }Prints numbers 0 to 10
self
- a BigIntegerto
- the end numberclosure
- the code to execute for each number
public static void upto(BigDecimal self, Number to, Closure closure)
0.1.upto( 10 ) { println it }Prints numbers 0.1, 1.1, 2.1... to 9.1
self
- a BigDecimalto
- the end numberclosure
- the code to execute for each number
public static Object use(Object self, Class categoryClass, Closure closure)
self
- any ObjectcategoryClass
- a category class to useclosure
- the closure to invoke with the category in place
public static Object use(Object self, List categoryClassList, Closure closure)
self
- any ObjectcategoryClassList
- a list of category classesclosure
- the closure to invoke with the categories in place
public static Object use(Object self, Object[] array)
use(CategoryClass1, CategoryClass2) { ... }
This method saves having to wrap the the category
classes in a list.
self
- any Objectarray
- a list of category classes and a Closure
@Deprecated public static void waitForOrKill(Process self, long numberOfMillis)
@Deprecated public static void waitForProcessOutput(Process self)
@Deprecated public static void waitForProcessOutput(Process self, StringBuffer output, StringBuffer error)
@Deprecated public static void waitForProcessOutput(Process self, OutputStream output, OutputStream error)
public static Object with(Object self, Closure closure)
self
- the object to have a closure act uponclosure
- the closure to call on the object
public static Object withDataInputStream(File file, Closure closure)
file
- a Fileclosure
- a closure
public static Object withDataOutputStream(File file, Closure closure)
file
- a Fileclosure
- a closure
public static Map withDefault(Map self, Closure init)
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
self
- a Mapinit
- a Closure which is passed the unknown key
public static Object withInputStream(File file, Closure closure)
file
- a Fileclosure
- a closure
public static Object withInputStream(URL url, Closure closure)
url
- a URLclosure
- a closure
public static Object withObjectInputStream(File file, Closure closure)
file
- a Fileclosure
- a closure
public static Object withObjectInputStream(File file, ClassLoader classLoader, Closure closure)
file
- a FileclassLoader
- the class loader to use when loading the classclosure
- a closure
public static Object withObjectInputStream(InputStream inputStream, Closure closure)
inputStream
- an input streamclosure
- a closure
public static Object withObjectInputStream(InputStream inputStream, ClassLoader classLoader, Closure closure)
inputStream
- an input streamclassLoader
- the class loader to use when loading the classclosure
- a closure
public static Object withObjectOutputStream(File file, Closure closure)
file
- a Fileclosure
- a closure
public static Object withObjectOutputStream(OutputStream outputStream, Closure closure)
outputStream
- am output streamclosure
- a closure
public static Object withObjectStreams(Socket socket, Closure closure)
socket
- this Socketclosure
- a Closure
public static Object withOutputStream(File file, Closure closure)
file
- a Fileclosure
- a closure
@Deprecated public static void withOutputStream(Process self, Closure closure)
public static Object withPrintWriter(File file, Closure closure)
file
- a Fileclosure
- the closure to invoke with the PrintWriter
public static Object withPrintWriter(File file, String charset, Closure closure)
file
- a Filecharset
- the charsetclosure
- the closure to invoke with the PrintWriter
public static Object withPrintWriter(Writer writer, Closure closure)
writer
- a writerclosure
- the closure to invoke with the PrintWriter
public static Object withReader(File file, Closure closure)
file
- a file objectclosure
- a closure
public static Object withReader(File file, String charset, Closure closure)
file
- a file objectcharset
- the charset for this input streamclosure
- a closure
public static Object withReader(Reader reader, Closure closure)
reader
- the reader which is used and then closedclosure
- the closure that the writer is passed into
public static Object withReader(URL url, Closure closure)
url
- a URLclosure
- the closure to invoke with the reader
public static Object withReader(URL url, String charset, Closure closure)
url
- a URLcharset
- the charset usedclosure
- the closure to invoke with the reader
public static Object withReader(InputStream in, Closure closure)
in
- a streamclosure
- the closure to invoke with the InputStream
public static Object withReader(InputStream in, String charset, Closure closure)
in
- a streamcharset
- the charset used to decode the streamclosure
- the closure to invoke with the reader
public static Object withStream(InputStream stream, Closure closure)
stream
- the stream which is used and then closedclosure
- the closure that the stream is passed into
public static Object withStream(OutputStream os, Closure closure)
os
- the stream which is used and then closedclosure
- the closure that the stream is passed into
public static Object withStreams(Socket socket, Closure closure)
socket
- a Socketclosure
- a Closure
public static Object withWriter(File file, Closure closure)
file
- a Fileclosure
- a closure
public static Object withWriter(File file, String charset, Closure closure)
file
- a Filecharset
- the charset usedclosure
- a closure
public static Object withWriter(Writer writer, Closure closure)
writer
- the writer which is used and then closedclosure
- the closure that the writer is passed into
public static Object withWriter(OutputStream stream, Closure closure)
stream
- the stream which is used and then closedclosure
- the closure that the writer is passed into
public static Object withWriter(OutputStream stream, String charset, Closure closure)
stream
- the stream which is used and then closedcharset
- the charset usedclosure
- the closure that the writer is passed into
@Deprecated public static void withWriter(Process self, Closure closure)
public static Object withWriterAppend(File file, String charset, Closure closure)
file
- a Filecharset
- the charset usedclosure
- a closure
public static Object withWriterAppend(File file, Closure closure)
file
- a Fileclosure
- a closure
public static void write(Writer self, Writable writable)
self
- a Writerwritable
- an object implementing the Writable interface
public static void write(File file, String text)
file
- a Filetext
- the text to write to the File
public static void write(File file, String text, String charset)
file
- a Filetext
- the text to write to the Filecharset
- the charset used
public static void writeLine(BufferedWriter writer, String line)
writer
- a BufferedWriterline
- the line to write
public static BitSet xor(BitSet left, BitSet right)
left
- a BitSetright
- another BitSet to bitwise AND
public static Number xor(Number left, Number right)
left
- a Numberright
- another Number to bitwse XOR
public static Boolean xor(Boolean left, Boolean right)
left
- left operatorright
- right operator
Copyright © 2003-2010 The Codehaus. All rights reserved.