Object

Methods Summary

Methods
Return type	Name and parameters
`void`	`addShutdownHook(Closure closure)` Allows the usage of addShutdownHook without getting the runtime first.
`boolean`	`any()` Iterates over the elements of a collection, and checks whether at least one element is true according to the Groovy Truth.
`boolean`	`any(Closure predicate)` Iterates over the contents of an object or collection, and checks whether a predicate is valid for at least one element.
`boolean`	`asBoolean()` Coerce an object instance to a boolean value.
`Object`	`asType(Class clazz)` Converts the given array to either a List, Set, or SortedSet.
`Object`	`average()` Averages the items in an array.
`Collection`	`collect()` Iterates through this aggregate Object transforming each item into a new value using Closure.IDENTITY as a transformer, basically returning a list of items copied from the original object.
`List`	`collect(Closure transform)` Iterates through this aggregate Object transforming each item into a new value using the `transform` closure, returning a list of transformed values.
`Collection`	`collect(Collection collector, Closure transform)` Iterates through this aggregate Object transforming each item into a new value using the `transform` closure and adding it to the supplied `collector`.
`boolean`	`contains(Object value)` Checks whether the array contains the given value.
`Number`	`count(Object value)` Counts the number of occurrences of the given value inside this array.
`String`	`dump()` Generates a detailed dump string of an object showing its class, hashCode and fields.
`Object`	`each(Closure closure)` Iterates through an aggregate type or data structure, passing each item to the given closure.
`Object`	`eachWithIndex(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.
`boolean`	`equals(List right)` Determines if the contents of this array are equal to the contents of the given list, in the same order.
`boolean`	`every()` Iterates over every element of a collection, and checks whether all elements are `true` according to the Groovy Truth.
`boolean`	`every(Closure predicate)` Used to determine if the given predicate closure is valid (i.e. returns `true` for all items in this data structure).
`Object`	`find()` Finds the first item matching the IDENTITY Closure (i.e. matching Groovy truth).
`Object`	`find(Closure closure)` Finds the first value matching the closure condition.
`Collection`	`findAll()` Finds all items matching the IDENTITY Closure (i.e. matching Groovy truth).
`Collection`	`findAll(Closure closure)` Finds all items matching the closure condition.
`int`	`findIndexOf(Closure condition)` Iterates over the elements of an aggregate of items and returns the index of the first item that matches the condition specified in the closure.
`int`	`findIndexOf(int startIndex, Closure condition)` Iterates over the elements of an aggregate of items, starting from a specified startIndex, and returns the index of the first item that matches the condition specified in the closure.
`List`	`findIndexValues(Closure condition)` Iterates over the elements of an aggregate of items and returns the index values of the items that match the condition specified in the closure.
`List`	`findIndexValues(Number startIndex, Closure condition)` Iterates over the elements of an aggregate of items, starting from a specified startIndex, and returns the index values of the items that match the condition specified in the closure.
`int`	`findLastIndexOf(Closure condition)` Iterates over the elements of an aggregate of items and returns the index of the last item that matches the condition specified in the closure.
`int`	`findLastIndexOf(int startIndex, Closure condition)` Iterates over the elements of an aggregate of items, starting from a specified startIndex, and returns the index of the last item that matches the condition specified in the closure.
`Object`	`findResult(Closure condition)` Treats the object as iterable, iterating through the values it represents and returns the first non-null result obtained from calling the closure, otherwise returns null.
`Object`	`findResult(Object defaultResult, Closure condition)` Treats the object as iterable, iterating through the values it represents and returns the first non-null result obtained from calling the closure, otherwise returns the defaultResult.
`Collection`	`flatten()` Flatten an array.
`Object`	`getAt(String property)` Allows the subscript operator to be used to lookup dynamic property values.
`MetaClass`	`getMetaClass()` Obtains a MetaClass for an object either from the registry or in the case of a GroovyObject from the object itself.
`List`	`getMetaPropertyValues()` 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'.
`Map`	`getProperties()` Convenience method that calls Object#getMetaPropertyValues()(self) and provides the data in form of simple key/value pairs, i.e. without type() information.
`Collection`	`grep()` Iterates over the collection of items which this Object represents and returns each item that matches using the IDENTITY Closure as a filter - effectively returning all elements which satisfy Groovy truth.
`Collection`	`grep(Object filter)` Iterates over the collection of items which this Object represents and returns each item that matches the given filter - calling the `Object#isCase(java.lang.Object)` method used by switch statements.
`Map`	`groupBy(Object closures)` Sorts all array members into (sub)groups determined by the supplied mapping closures as per the Iterable variant of this method.
`Map`	`groupBy(List closures)` Sorts all array members into (sub)groups determined by the supplied mapping closures as per the list variant of this method.
`MetaProperty`	`hasProperty(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
`Object`	`identity(Closure closure)` Allows the closure to be called for the object reference self.
`Object`	`inject(Closure closure)` Iterates through the given Object, passing in the first value to the closure along with the first item.
`Object`	`inject(Object initialValue, Closure closure)` Iterates through the given Object, passing in the initial value to the closure along with the first item.
`String`	`inspect()` Inspects returns the String that matches what would be typed into a terminal to create this object.
`Object`	`invokeMethod(String method, Object arguments)` Provide a dynamic method invocation method which can be overloaded in classes to implement dynamic proxies easily.
`boolean`	`is(Object other)` Identity check.
`boolean`	`isCase(Object switchValue)` Method for overloading the behavior of the 'case' method in switch statements.
`Iterator`	`iterator()` Attempts to create an Iterator for the given object by first converting it to a Collection.
`String`	`join(String separator)` Concatenates the `toString()` representation of each items in this array, with the given String as a separator between each item.
`MetaClass`	`metaClass(Closure closure)` Sets/updates the metaclass for a given object to a closure.
`void`	`print(PrintWriter out)` Print to a console in interactive format.
`void`	`print(Object value)` Print a value formatted Groovy style to self if it is a Writer, otherwise to the standard output stream.
`void`	`printf(String format, Object arg)` Prints a formatted string using the specified format string and arguments.
`void`	`printf(String format, Object[] values)` Printf to the standard output stream.
`void`	`println()` Print a linebreak to the standard output stream.
`void`	`println(PrintWriter out)` Print to a console in interactive format.
`void`	`println(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.
`void`	`putAt(String property, Object newValue)` Allows the subscript operator to be used to set dynamically named property values.
`List`	`respondsTo(String name)` Returns an object satisfying Groovy truth if the implementing MetaClass responds to a method with the given name regardless of the arguments.
`List`	`respondsTo(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.
`void`	`setMetaClass(MetaClass metaClass)` Set the metaclass for an object.
`int`	`size()` Provide the standard Groovy `size()` method for an array.
`static void`	`sleep(long milliseconds)` Sleep for so many milliseconds, even if interrupted.
`static void`	`sleep(long milliseconds, Closure onInterrupt)` Sleep for so many milliseconds, using a given closure for interrupt processing.
`Collection`	`split(Closure closure)` Splits all items into two lists based on the closure condition.
`String`	`sprintf(String format, Object arg)` Returns a formatted string using the specified format string and arguments.
`String`	`sprintf(String format, Object[] values)` Sprintf to a string.
`Stream`	`stream()` Returns a sequential Stream containing a single element.
`Object`	`sum()` Sums the items in an array.
`Object`	`sum(Object initialValue)` Sums the items in an array, adding the result to some initial value.
`Object`	`tap(Closure closure)` Allows the closure to be called for the object reference self (similar to `with` and always returns self.
`String`	`toArrayString()` Returns the string representation of the given array.
`SpreadMap`	`toSpreadMap()` Creates a spreadable map from this array.
`String`	`toString()` Returns the string representation of this array's contents.
`Object`	`use(Class categoryClass, Closure closure)` Scoped use method
`Object`	`use(Object[] array)` Allows you to use a list of categories, specifying the list as varargs.
`Object`	`use(List categoryClassList, Closure closure)` Scoped use method with list of categories.
`Object`	`with(boolean returning, Closure closure)` Allows the closure to be called for the object reference self.
`Object`	`with(Closure closure)` Allows the closure to be called for the object reference self.
`Object`	`withTraits(Class traits)` Dynamically wraps an instance into something which implements the supplied trait classes.

- Methods Detail
  - public void addShutdownHook(Closure closure)
    
    Allows the usage of addShutdownHook without getting the runtime first.
    
    Parameters:
    
    closure - the shutdown hook action
    
    Since:
    
    1.5.0
  - public boolean any()
    
    Iterates over the elements of a collection, and checks whether at least one element is true according to the Groovy Truth. Equivalent to self.any({element -> element})
```
assert [false, true].any()
assert [0, 1].any()
assert ![0, 0].any()
```
    Returns:
    
    true if any item in the collection matches the closure predicate
    
    Since:
    
    1.5.0
  - public boolean any(Closure predicate)
    
    Iterates over the contents of an object or collection, and checks whether a predicate is valid for at least one element.
```
assert [1, 2, 3].any { it == 2 }
assert ![1, 2, 3].any { it > 3 }
```
    Parameters:
    
    predicate - the closure predicate used for matching
    
    Returns:
    
    true if any iteration for the object matches the closure predicate
    
    Since:
    
    1.0
  - public boolean asBoolean()
    
    Coerce an object instance to a boolean value. An object is coerced to true if it's not null, to false if it is null.
    
    Returns:
    
    the boolean value
    
    Since:
    
    1.7.0
  - public Object asType(Class clazz)
    
    Converts the given array to either a List, Set, or SortedSet. If the given class is something else, the call is deferred to Object#asType(Class).
    
    Parameters:
    
    clazz - the desired class
    
    Returns:
    
    the object resulting from this type conversion
    
    Since:
    
    1.5.1
    
    See Also:
    
    Object#asType(java.lang.Class)
  - public Object average()
    
    Averages the items in an array. This is equivalent to invoking the "plus" method on all items in the array and then dividing by the total count using the "div" method for the resulting sum.
```
assert 3 == ([1, 2, 6] as Integer[]).average()
```
    Returns:
    
    The average of all of the items
    
    Since:
    
    3.0.0
    
    See Also:
    
    Object[]#sum()
  - public Collection collect()
    
    Iterates through this aggregate Object transforming each item into a new value using Closure.IDENTITY as a transformer, basically returning a list of items copied from the original object.
```
assert [1,2,3] == [1,2,3].iterator().collect()
```
    Returns:
    
    a Collection of the transformed values
    
    Since:
    
    1.8.5
    
    See Also:
    
    Closure#IDENTITY
  - public List collect(Closure transform)
    
    Iterates through this aggregate Object transforming each item into a new value using the transform closure, returning a list of transformed values. Example:
```
def list = [1, 'a', 1.23, true ]
def types = list.collect { it.class }
assert types == [Integer, String, BigDecimal, Boolean]
```
    Parameters:
    
    transform - the closure used to transform each item of the aggregate object
    
    Returns:
    
    a List of the transformed values
    
    Since:
    
    1.0
  - public Collection collect(Collection collector, Closure transform)
    
    Iterates through this aggregate Object transforming each item into a new value using the transform closure and adding it to the supplied collector.
    
    Parameters:
    
    collector - the Collection to which the transformed values are added
    
    transform - the closure used to transform each item of the aggregate object
    
    Returns:
    
    the collector with all transformed values added to it
    
    Since:
    
    1.0
  - public boolean contains(Object value)
    
    Checks whether the array contains the given value.
    
    Parameters:
    
    value - the value being searched for
    
    Returns:
    
    true if the array contains the value
    
    Since:
    
    1.8.6
  - public Number count(Object value)
    
    Counts the number of occurrences of the given value inside this array. Comparison is done using Groovy's == operator (using compareTo(value) == 0 or equals(value) ).
    
    Parameters:
    
    value - the value being searched for
    
    Returns:
    
    the number of occurrences
    
    Since:
    
    1.6.4
  - public String dump()
    
    Generates a detailed dump string of an object showing its class, hashCode and fields.
    
    Returns:
    
    the dump representation
    
    Since:
    
    1.0
  - public Object each(Closure closure)
    
    Iterates through an aggregate type or data structure, passing each item to the given closure. Custom types may utilize this method by simply providing an "iterator()" method. The items returned from the resulting iterator will be passed to the closure.
```
String result = ''
['a', 'b', 'c'].each{ result += it }
assert result == 'abc'
```
    Parameters:
    
    closure - the closure applied on each element found
    
    Returns:
    
    the self Object
    
    Since:
    
    1.0
  - public Object eachWithIndex(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.
```
String result = ''
['a', 'b', 'c'].eachWithIndex{ letter, index -> result += "$index:$letter" }
assert result == '0:a1:b2:c'
```
    Parameters:
    
    closure - a Closure to operate on each item
    
    Returns:
    
    the self Object
    
    Since:
    
    1.0
  - public boolean equals(List right)
    
    Determines if the contents of this array are equal to the contents of the given list, in the same order. This returns false if either collection is null.
    
    Parameters:
    
    right - the List being compared
    
    Returns:
    
    true if the contents of both collections are equal
    
    Since:
    
    1.5.0
  - public boolean every()
    
    Iterates over every element of a collection, and checks whether all elements are true according to the Groovy Truth. Equivalent to self.every({element -> element})
```
assert [true, true].every()
assert [1, 1].every()
assert ![1, 0].every()
```
    Returns:
    
    true if every item in the collection matches satisfies Groovy truth
    
    Since:
    
    1.5.0
  - public boolean every(Closure predicate)
    
    Used to determine if the given predicate closure is valid (i.e. returns true for all items in this data structure). A simple example for a list:
```
def list = [3,4,5]
def greaterThanTwo = list.every { it > 2 }
```
    Parameters:
    
    predicate - the closure predicate used for matching
    
    Returns:
    
    true if every iteration of the object matches the closure predicate
    
    Since:
    
    1.0
  - public Object find()
    
    Finds the first item matching the IDENTITY Closure (i.e. matching Groovy truth).
    Example:
```
def items = [null, 0, 0.0, false, '', [], 42, 43]
assert items.find() == 42
```
    Returns:
    
    the first Object found or null if none was found
    
    Since:
    
    1.8.1
    
    See Also:
    
    Closure#IDENTITY
  - public Object find(Closure closure)
    
    Finds the first value matching the closure condition.
```
def numbers = [1, 2, 3]
def result = numbers.find { it > 1}
assert result == 2
```
    Parameters:
    
    closure - a closure condition
    
    Returns:
    
    the first Object found or null if none was found
    
    Since:
    
    1.0
  - public Collection findAll()
    
    Finds all items matching the IDENTITY Closure (i.e. matching Groovy truth).
    Example:
```
def items = [1, 2, 0, false, true, '', 'foo', [], [4, 5], null]
assert items.findAll() == [1, 2, true, 'foo', [4, 5]]
```
    Returns:
    
    a List of the values found
    
    Since:
    
    1.8.1
    
    See Also:
    
    Closure#IDENTITY
  - public Collection findAll(Closure closure)
    
    Finds all items matching the closure condition.
    
    Parameters:
    
    closure - a closure condition
    
    Returns:
    
    a List of the values found
    
    Since:
    
    1.6.0
  - public int findIndexOf(Closure condition)
    
    Iterates over the elements of an aggregate of items and returns the index of the first item that matches the condition specified in the closure.
    
    Parameters:
    
    condition - the matching condition
    
    Returns:
    
    an integer that is the index of the first matched object or -1 if no match was found
    
    Since:
    
    1.0
  - public int findIndexOf(int startIndex, Closure condition)
    
    Iterates over the elements of an aggregate of items, starting from a specified startIndex, and returns the index of the first item that matches the condition specified in the closure. Example (aggregate is ChronoUnit enum values):
```
import java.time.temporal.ChronoUnit
def nameStartsWithM = { it.name().startsWith('M') }
def first  = ChronoUnit.findIndexOf(nameStartsWithM)
def second = ChronoUnit.findIndexOf(first + 1, nameStartsWithM)
def third  = ChronoUnit.findIndexOf(second + 1, nameStartsWithM)
Set units  = [first, second, third]
assert !units.contains(-1) // should have found 3 of MICROS, MILLIS, MINUTES, MONTHS, ...
assert units.size() == 3 // just check size so as not to rely on order
```
    Parameters:
    
    startIndex - start matching from this index
    
    condition - the matching condition
    
    Returns:
    
    an integer that is the index of the first matched object or -1 if no match was found
    
    Since:
    
    1.5.0
  - public List findIndexValues(Closure condition)
    
    Iterates over the elements of an aggregate of items and returns the index values of the items that match the condition specified in the closure.
    
    Parameters:
    
    condition - the matching condition
    
    Returns:
    
    a list of numbers corresponding to the index values of all matched objects
    
    Since:
    
    1.5.2
  - public List findIndexValues(Number startIndex, Closure condition)
    
    Iterates over the elements of an aggregate of items, starting from a specified startIndex, and returns the index values of the items that match the condition specified in the closure.
    
    Parameters:
    
    startIndex - start matching from this index
    
    condition - the matching condition
    
    Returns:
    
    a list of numbers corresponding to the index values of all matched objects
    
    Since:
    
    1.5.2
  - public int findLastIndexOf(Closure condition)
    
    Iterates over the elements of an aggregate of items and returns the index of the last item that matches the condition specified in the closure. Example (aggregate is ChronoUnit enum values):
```
import java.time.temporal.ChronoUnit
def nameStartsWithM = { it.name().startsWith('M') }
def first = ChronoUnit.findIndexOf(nameStartsWithM)
def last  = ChronoUnit.findLastIndexOf(nameStartsWithM)
// should have found 2 unique index values for MICROS, MILLIS, MINUTES, MONTHS, ...
assert first != -1 && last != -1 && first != last
```
    Parameters:
    
    condition - the matching condition
    
    Returns:
    
    an integer that is the index of the last matched object or -1 if no match was found
    
    Since:
    
    1.5.2
  - public int findLastIndexOf(int startIndex, Closure condition)
    
    Iterates over the elements of an aggregate of items, starting from a specified startIndex, and returns the index of the last item that matches the condition specified in the closure.
    
    Parameters:
    
    startIndex - start matching from this index
    
    condition - the matching condition
    
    Returns:
    
    an integer that is the index of the last matched object or -1 if no match was found
    
    Since:
    
    1.5.2
  - public Object findResult(Closure condition)
    
    Treats the object as iterable, iterating through the values it represents and returns the first non-null result obtained from calling the closure, otherwise returns null.
```
int[] numbers = [1, 2, 3]
assert numbers.findResult { if(it > 1) return it } == 2
assert numbers.findResult { if(it > 4) return it } == null
```
    Parameters:
    
    condition - a closure that returns a non-null value to indicate that processing should stop and the value should be returned
    
    Returns:
    
    the first non-null result of the closure
    
    Since:
    
    1.7.5
  - public Object findResult(Object defaultResult, Closure condition)
    
    Treats the object as iterable, iterating through the values it represents and returns the first non-null result obtained from calling the closure, otherwise returns the defaultResult.
```
int[] numbers = [1, 2, 3]
assert numbers.findResult(5) { if(it > 1) return it } == 2
assert numbers.findResult(5) { if(it > 4) return it } == 5
```
    Parameters:
    
    defaultResult - an Object that should be returned if all closure results are null
    
    condition - a closure that returns a non-null value to indicate that processing should stop and the value should be returned
    
    Returns:
    
    the first non-null result of the closure, otherwise the default value
    
    Since:
    
    1.7.5
  - public Collection flatten()
    
    Flatten an array. This array and any nested arrays or collections have their contents (recursively) added to the new collection.
    
    Returns:
    
    a flattened Collection
    
    Since:
    
    1.6.0
  - public Object getAt(String property)
    
    Allows the subscript operator to be used to lookup dynamic property values. bean[somePropertyNameExpression]. The normal property notation of groovy is neater and more concise but only works with compile-time known property names.
    
    Parameters:
    
    property - the property name of interest
    
    Returns:
    
    the property value
    
    Since:
    
    1.0
  - public MetaClass getMetaClass()
    
    Obtains a MetaClass for an object either from the registry or in the case of a GroovyObject from the object itself.
    
    Returns:
    
    The MetaClass
    
    Since:
    
    1.5.0
  - public List getMetaPropertyValues()
    
    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'.
    
    Returns:
    
    list of PropertyValue objects
    
    Since:
    
    1.0
    
    See Also:
    
    Expando#getMetaPropertyValues()
  - public Map getProperties()
    
    Convenience method that calls Object#getMetaPropertyValues()(self) and provides the data in form of simple key/value pairs, i.e. without type() information.
    
    Returns:
    
    meta properties as Map of key/value pairs
    
    Since:
    
    1.0
  - public Collection grep()
    
    Iterates over the collection of items which this Object represents and returns each item that matches using the IDENTITY Closure as a filter - effectively returning all elements which satisfy Groovy truth.
    Example:
```
def items = [1, 2, 0, false, true, '', 'foo', [], [4, 5], null]
assert items.grep() == [1, 2, true, 'foo', [4, 5]]
```
    Returns:
    
    a collection of objects which match the filter
    
    Since:
    
    1.8.1
    
    See Also:
    
    Closure#IDENTITY
  - public Collection grep(Object filter)
    
    Iterates over the collection of items which this Object represents and returns each item that matches the given filter - calling the Object#isCase(java.lang.Object) method used by switch statements. This method can be used with different kinds of filters like regular expressions, classes, ranges etc. Example:
```
def list = ['a', 'b', 'aa', 'bc', 3, 4.5]
assert list.grep( ~/a+/ )  == ['a', 'aa']
assert list.grep( ~/../ )  == ['aa', 'bc']
assert list.grep( Number ) == [ 3, 4.5 ]
assert list.grep{ it.toString().size() == 1 } == [ 'a', 'b', 3 ]
```
    Parameters:
    
    filter - the filter to perform on the object (using the Object#isCase(java.lang.Object) method)
    
    Returns:
    
    a collection of objects which match the filter
    
    Since:
    
    1.5.6
  - public Map groupBy(Object closures)
    
    Sorts all array members into (sub)groups determined by the supplied mapping closures as per the Iterable variant of this method.
    
    Parameters:
    
    closures - an array of closures, each mapping entries on keys
    
    Returns:
    
    a new Map grouped by keys on each criterion
    
    Since:
    
    2.2.0
    
    See Also:
    
    Iterable#groupBy(Object...)
    
    Closure#IDENTITY
  - public Map groupBy(List closures)
    
    Sorts all array members into (sub)groups determined by the supplied mapping closures as per the list variant of this method.
    
    Parameters:
    
    closures - a list of closures, each mapping entries on keys
    
    Returns:
    
    a new Map grouped by keys on each criterion
    
    Since:
    
    2.2.0
    
    See Also:
    
    Closure#IDENTITY
    
    Iterable#groupBy(List)
  - public MetaProperty hasProperty(String name)
    
    Returns true of the implementing MetaClass has a property of the given name
    Note that this method will only return true for realised properties and does not take into account implementation of getProperty or propertyMissing
    
    Parameters:
    
    name - The name of the property of interest
    
    Returns:
    
    The found MetaProperty or null if it doesn't exist
    
    Since:
    
    1.6.1
    
    See Also:
    
    MetaObjectProtocol#hasProperty(java.lang.Object, java.lang.String)
  - public Object identity(Closure closure)
    
    Allows the closure to be called for the object reference self. Synonym for 'with()'.
    
    Parameters:
    
    closure - the closure to call on the object
    
    Returns:
    
    result of calling the closure
    
    Since:
    
    1.0
    
    See Also:
    
    Object#with(Closure)
  - public Object inject(Closure closure)
    
    Iterates through the given Object, passing in the first value to the closure along with the first item. The result is passed back (injected) into the closure along with the second item. The new result is injected back into the closure along with the third item and so on until further iteration of the object is not possible. Also known as foldLeft in functional parlance.
    
    Parameters:
    
    closure - a closure
    
    Returns:
    
    the result of the last closure call
    
    Since:
    
    1.8.7
    
    See Also:
    
    Collection#inject(Object, Closure)
  - public Object inject(Object initialValue, Closure closure)
    
    Iterates through the given Object, passing in the initial value to the closure along with the first item. The result is passed back (injected) into the closure along with the second item. The new result is injected back into the closure along with the third item and so on until further iteration of the object is not possible. Also known as foldLeft in functional parlance.
    
    Parameters:
    
    initialValue - some initial value
    
    closure - a closure
    
    Returns:
    
    the result of the last closure call
    
    Since:
    
    1.5.0
    
    See Also:
    
    Collection#inject(Object, Closure)
  - public String inspect()
    
    Inspects returns the String that matches what would be typed into a terminal to create this object.
    
    Returns:
    
    a String that matches what would be typed into a terminal to create this object. e.g. [1, 'hello'].inspect() -> [1, "hello"]
    
    Since:
    
    1.0
  - public Object invokeMethod(String method, Object arguments)
    
    Provide a dynamic method invocation method which can be overloaded in classes to implement dynamic proxies easily.
    
    Parameters:
    
    method - the name of the method to call
    
    arguments - the arguments to use
    
    Returns:
    
    the result of the method call
    
    Since:
    
    1.0
  - public boolean is(Object other)
    
    Identity check. Since == is overridden in Groovy with the meaning of equality we need some fallback to check for object identity. Invoke using the 'is' method, like so: def same = this.is(that)
    
    Parameters:
    
    other - an object to compare identity with
    
    Returns:
    
    true if self and other are both references to the same instance, false otherwise
    
    Since:
    
    1.0
  - public boolean isCase(Object switchValue)
    
    Method for overloading the behavior of the 'case' method in switch statements. The default implementation handles arrays types but otherwise simply delegates to Object#equals, but this may be overridden for other types. In this example:
```
 switch( a ) {
  case b: //some code
}
```
    "some code" is called when b.isCase( a ) returns true.
    
    Parameters:
    
    switchValue - the switch value
    
    Returns:
    
    true if the switchValue is deemed to be equal to the caseValue
    
    Since:
    
    1.0
  - public Iterator iterator()
    
    Attempts to create an Iterator for the given object by first converting it to a Collection.
    
    Returns:
    
    an Iterator for the given Object.
    
    Since:
    
    1.0
    
    See Also:
    
    DefaultTypeTransformation#asCollection(java.lang.Object)
  - public String join(String separator)
    
    Concatenates the toString() representation of each items in this array, with the given String as a separator between each item.
    
    Parameters:
    
    separator - a String separator
    
    Returns:
    
    the joined String
    
    Since:
    
    1.0
  - public MetaClass metaClass(Closure closure)
    
    Sets/updates the metaclass for a given object to a closure.
    
    Parameters:
    
    closure - the closure representing the new metaclass
    
    Returns:
    
    the new metaclass value
    
    Since:
    
    1.6.0
  - public void print(PrintWriter out)
    
    Print to a console in interactive format.
    
    Parameters:
    
    out - the PrintWriter used for printing
    
    Since:
    
    1.0
  - public void print(Object value)
    
    Print a value formatted Groovy style to self if it is a Writer, otherwise to the standard output stream.
    
    Parameters:
    
    value - the value to print
    
    Since:
    
    1.0
  - public void printf(String format, Object arg)
    
    Prints a formatted string using the specified format string and arguments.
    Examples:
```
    printf ( "Hello, %s!\n" , [ "world" ] as String[] )
    printf ( "Hello, %s!\n" , [ "Groovy" ])
    printf ( "%d + %d = %d\n" , [ 1 , 2 , 1+2 ] as Integer[] )
    printf ( "%d + %d = %d\n" , [ 3 , 3 , 3+3 ])

    ( 1..5 ).each { printf ( "-- %d\n" , [ it ] as Integer[] ) }
    ( 1..5 ).each { printf ( "-- %d\n" , [ it ] as int[] ) }
    ( 0x41..0x45 ).each { printf ( "-- %c\n" , [ it ] as char[] ) }
    ( 07..011 ).each { printf ( "-- %d\n" , [ it ] as byte[] ) }
    ( 7..11 ).each { printf ( "-- %d\n" , [ it ] as short[] ) }
    ( 7..11 ).each { printf ( "-- %d\n" , [ it ] as long[] ) }
    ( 7..11 ).each { printf ( "-- %5.2f\n" , [ it ] as float[] ) }
    ( 7..11 ).each { printf ( "-- %5.2g\n" , [ it ] as double[] ) }
```
    Parameters:
    
    format - A format string
    
    arg - Argument which is referenced by the format specifiers in the format string. The type of arg should be one of Object[], List, int[], short[], byte[], char[], boolean[], long[], float[], or double[].
    
    Since:
    
    1.0
  - public void printf(String format, Object[] values)
    
    Printf to the standard output stream.
    
    Parameters:
    
    format - a format string
    
    values - values referenced by the format specifiers in the format string
    
    Since:
    
    1.0
  - public void println()
    
    Print a linebreak to the standard output stream.
    
    Since:
    
    1.0
  - public void println(PrintWriter out)
    
    Print to a console in interactive format.
    
    Parameters:
    
    out - the PrintWriter used for printing
    
    Since:
    
    1.0
  - public void println(Object value)
    
    Print a value formatted Groovy style (followed by a newline) to self if it is a Writer, otherwise to the standard output stream.
    
    Parameters:
    
    value - the value to print
    
    Since:
    
    1.0
  - public void putAt(String property, Object newValue)
    
    Allows the subscript operator to be used to set dynamically named property values. bean[somePropertyNameExpression] = foo. The normal property notation of groovy is neater and more concise but only works with property names which are known at compile time.
    
    Parameters:
    
    property - the name of the property to set
    
    newValue - the value to set
    
    Since:
    
    1.0
  - public List respondsTo(String name)
    
    Returns an object satisfying Groovy truth if the implementing MetaClass responds to a method with the given name regardless of the arguments.
    Note that this method's return value is based on realised methods and does not take into account objects or classes that implement invokeMethod or methodMissing
    This method is "safe" in that it will always return a value and never throw an exception
    
    Parameters:
    
    name - The name of the method of interest
    
    Returns:
    
    A List of MetaMethods matching the given name or an empty list if no matching methods exist
    
    Since:
    
    1.6.1
    
    See Also:
    
    MetaObjectProtocol#respondsTo(java.lang.Object, java.lang.String)
  - public List respondsTo(String name, Object[] argTypes)
    
    Returns an object satisfying Groovy truth if the implementing MetaClass responds to a method with the given name and arguments types.
    Note that this method's return value is based on realised methods and does not take into account objects or classes that implement invokeMethod or methodMissing
    This method is "safe" in that it will always return a value and never throw an exception
    
    Parameters:
    
    name - The name of the method of interest
    
    argTypes - The argument types to match against
    
    Returns:
    
    A List of MetaMethods matching the argument types which will be empty if no matching methods exist
    
    Since:
    
    1.6.0
    
    See Also:
    
    MetaObjectProtocol#respondsTo(java.lang.Object, java.lang.String, java.lang.Object[])
  - public void setMetaClass(MetaClass metaClass)
    
    Set the metaclass for an object.
    
    Parameters:
    
    metaClass - the new metaclass value
    
    Since:
    
    1.6.0
  - public int size()
    
    Provide the standard Groovy size() method for an array.
    
    Returns:
    
    the size (length) of the Array
    
    Since:
    
    1.0
  - public static void sleep(long milliseconds)
    
    Sleep for so many milliseconds, even if interrupted.
    
    Parameters:
    
    milliseconds - the number of milliseconds to sleep
    
    Since:
    
    1.0
  - public static void sleep(long milliseconds, Closure onInterrupt)
    
    Sleep for so many milliseconds, using a given closure for interrupt processing.
    
    Parameters:
    
    milliseconds - the number of milliseconds to sleep
    
    onInterrupt - interrupt handler, InterruptedException is passed to the Closure as long as it returns false, the sleep continues
    
    Since:
    
    1.0
  - public Collection split(Closure closure)
    
    Splits all items into two lists based on the closure condition. The first list contains all items matching the closure expression. The second list all those that don't.
    
    Parameters:
    
    closure - a closure condition
    
    Returns:
    
    a List whose first item is the accepted values and whose second item is the rejected values
    
    Since:
    
    1.6.0
  - public String sprintf(String format, Object arg)
    
    Returns a formatted string using the specified format string and arguments.
    
    Parameters:
    
    format - A format string
    
    arg - Argument which is referenced by the format specifiers in the format string. The type of arg should be one of Object[], List, int[], short[], byte[], char[], boolean[], long[], float[], or double[].
    
    Returns:
    
    the resulting printf'd string
    
    Since:
    
    1.5.0
  - public String sprintf(String format, Object[] values)
    
    Sprintf to a string.
    
    Parameters:
    
    format - a format string
    
    values - values referenced by the format specifiers in the format string
    
    Returns:
    
    the resulting formatted string
    
    Since:
    
    1.5.0
  - public Stream stream()
    
    Returns a sequential Stream containing a single element.
```
def item = 'string'
assert item.stream().toList() == ['string']
assert item.stream().findFirst().isPresent()
```
    Since:
    
    3.0.0
  - public Object sum()
    
    Sums the items in an array. This is equivalent to invoking the "plus" method on all items in the array.
    
    Returns:
    
    The sum of all of the items
    
    Since:
    
    1.7.1
    
    See Also:
    
    Iterator#sum()
  - public Object sum(Object initialValue)
    
    Sums the items in an array, adding the result to some initial value.
    
    Parameters:
    
    initialValue - the items in the array will be summed to this initial value
    
    Returns:
    
    The sum of all of the items.
    
    Since:
    
    1.7.1
  - public Object tap(Closure closure)
    
    Allows the closure to be called for the object reference self (similar to with and always returns self.
    Any method invoked inside the closure will first be invoked on the self reference. For instance, the following method calls to the append() method are invoked on the StringBuilder instance:
```
def b = new StringBuilder().tap {
  append('foo')
  append('bar')
}
assert b.toString() == 'foobar'
```
    This is commonly used to simplify object creation, such as this example:
```
def p = new Person().tap {
  firstName = 'John'
  lastName = 'Doe'
}
```
    Parameters:
    
    closure - the closure to call on the object
    
    Returns:
    
    self
    
    Since:
    
    2.5.0
    
    See Also:
    
    Object#with(boolean, Closure)
    
    Object#with(Closure)
  - public String toArrayString()
    
    Returns the string representation of the given array. The string displays the contents of the array, similar to an array literal, i.e. {1, 2, "a"}.
    
    Returns:
    
    the string representation
    
    Since:
    
    1.0
  - public SpreadMap toSpreadMap()
    
    Creates a spreadable map from this array.
    
    Returns:
    
    a newly created SpreadMap
    
    Since:
    
    1.0
    
    See Also:
    
    SpreadMap#SpreadMap(java.lang.Object[])
    
    Map#toSpreadMap()
  - public String toString()
    
    Returns the string representation of this array's contents.
    
    Returns:
    
    the string representation
    
    Since:
    
    1.0
    
    See Also:
    
    Object[]#toArrayString()
  - public Object use(Class categoryClass, Closure closure)
    
    Scoped use method
    
    Parameters:
    
    categoryClass - a category class to use
    
    closure - the closure to invoke with the category in place
    
    Returns:
    
    the value returned from the closure
    
    Since:
    
    1.0
  - public Object use(Object[] array)
    
    Allows you to use a list of categories, specifying the list as varargs. use(CategoryClass1, CategoryClass2) { ... } This method saves having to wrap the category classes in a list.
    
    Parameters:
    
    array - a list of category classes and a Closure
    
    Returns:
    
    the value returned from the closure
    
    Since:
    
    1.0
  - public Object use(List categoryClassList, Closure closure)
    
    Scoped use method with list of categories.
    
    Parameters:
    
    categoryClassList - a list of category classes
    
    closure - the closure to invoke with the categories in place
    
    Returns:
    
    the value returned from the closure
    
    Since:
    
    1.0
  - public Object with(boolean returning, Closure closure)
    
    Allows the closure to be called for the object reference self.
    Any method invoked inside the closure will first be invoked on the self reference. For example, the following method calls to the append() method are invoked on the StringBuilder instance and then, because 'returning' is true, the self instance is returned:
```
def b = new StringBuilder().with(true) {
  append('foo')
  append('bar')
}
assert b.toString() == 'foobar'
```
    The returning parameter is commonly set to true when using with to simplify object creation, such as this example:
```
def p = new Person().with(true) {
  firstName = 'John'
  lastName = 'Doe'
}
```
    Alternatively, 'tap' is an alias for 'with(true)', so that method can be used instead. The other main use case for with is when returning a value calculated using self as shown here:
```
def fullName = person.with(false){ "$firstName $lastName" }
```
    Alternatively, 'with' is an alias for 'with(false)', so the boolean parameter can be omitted instead.
    
    Parameters:
    
    returning - if true, return the self object; otherwise, the result of calling the closure
    
    closure - the closure to call on the object
    
    Returns:
    
    the self object or the result of calling the closure depending on 'returning'
    
    Since:
    
    2.5.0
    
    See Also:
    
    Object#with(Closure)
    
    Object#tap(Closure)
  - public Object with(Closure closure)
    
    Allows the closure to be called for the object reference self.
    Any method invoked inside the closure will first be invoked on the self reference. For instance, the following method calls to the append() method are invoked on the StringBuilder instance:
```
def b = new StringBuilder().with {
  append('foo')
  append('bar')
  return it
}
assert b.toString() == 'foobar'
```
    This is commonly used to simplify object creation, such as this example:
```
def p = new Person().with {
  firstName = 'John'
  lastName = 'Doe'
  return it
}
```
    The other typical usage, uses the self object while creating some value:
```
def fullName = person.with{ "$firstName $lastName" }
```
    Parameters:
    
    closure - the closure to call on the object
    
    Returns:
    
    result of calling the closure
    
    Since:
    
    1.5.0
    
    See Also:
    
    Object#with(boolean, Closure)
    
    Object#tap(Closure)
  - public Object withTraits(Class traits)
    
    Dynamically wraps an instance into something which implements the supplied trait classes. It is guaranteed that the returned object will implement the trait interfaces, but the original type of the object is lost (replaced with a proxy).
    
    Parameters:
    
    traits - a list of trait classes
    
    Returns:
    
    a proxy implementing the trait interfaces

Class Object

Methods Summary

Methods Detail

public void addShutdownHook(Closure closure)

public boolean any()

public boolean any(Closure predicate)

public boolean asBoolean()

public Object asType(Class clazz)

public Object average()

public Collection collect()

public List collect(Closure transform)

public Collection collect(Collection collector, Closure transform)

public boolean contains(Object value)

public Number count(Object value)

public String dump()

public Object each(Closure closure)

public Object eachWithIndex(Closure closure)

public boolean equals(List right)

public boolean every()

public boolean every(Closure predicate)

public Object find()

public Object find(Closure closure)

public Collection findAll()

public Collection findAll(Closure closure)

public int findIndexOf(Closure condition)

public int findIndexOf(int startIndex, Closure condition)

public List findIndexValues(Closure condition)

public List findIndexValues(Number startIndex, Closure condition)

public int findLastIndexOf(Closure condition)

public int findLastIndexOf(int startIndex, Closure condition)

public Object findResult(Closure condition)

public Object findResult(Object defaultResult, Closure condition)

public Collection flatten()

public Object getAt(String property)

public MetaClass getMetaClass()

public List getMetaPropertyValues()

public Map getProperties()

public Collection grep()

public Collection grep(Object filter)

public Map groupBy(Object closures)

public Map groupBy(List closures)

public MetaProperty hasProperty(String name)

public Object identity(Closure closure)

public Object inject(Closure closure)

public Object inject(Object initialValue, Closure closure)

public String inspect()

public Object invokeMethod(String method, Object arguments)

public boolean is(Object other)

public boolean isCase(Object switchValue)

public Iterator iterator()

public String join(String separator)

public MetaClass metaClass(Closure closure)

public void print(PrintWriter out)

public void print(Object value)

public void printf(String format, Object arg)

public void printf(String format, Object[] values)

public void println()

public void println(PrintWriter out)

public void println(Object value)

public void putAt(String property, Object newValue)

public List respondsTo(String name)

public List respondsTo(String name, Object[] argTypes)

public void setMetaClass(MetaClass metaClass)

public int size()

public static void sleep(long milliseconds)

public static void sleep(long milliseconds, Closure onInterrupt)

public Collection split(Closure closure)

public String sprintf(String format, Object arg)

public String sprintf(String format, Object[] values)

public Stream stream()

public Object sum()

public Object sum(Object initialValue)

public Object tap(Closure closure)

public String toArrayString()

public SpreadMap toSpreadMap()

public String toString()

public Object use(Class categoryClass, Closure closure)

public Object use(Object[] array)

public Object use(List categoryClassList, Closure closure)

public Object with(boolean returning, Closure closure)