Package: groovy.lang

## [Java] Class Closure<V>

- groovy.lang.Closure

- All Implemented Interfaces and Traits:
    Cloneable, GroovyCallable, Runnable, Serializable

      public abstract class Closure
      extends GroovyObjectSupport

  Represents any closure object in Groovy.

  Groovy allows instances of Closures to be called in a short form. For example:

       def a = 1
       def c = { a }
       assert c() == 1

  To be able to use a Closure in this way with your own subclass, you need to provide a doCall method with any signature you want to. This ensures that getMaximumNumberOfParameters() and getParameterTypes() will work too without any additional code. If no doCall method is provided a closure must be used in its long form like

       def a = 1
       def c = {a}
       assert c.call() == 1

- - ### Field Summary

    Fields
    Modifiers | Name | Description
    --- | --- | ---
    `static int` | `DELEGATE_FIRST` | With this resolveStrategy set the closure will attempt to resolve property references and methods to the delegate first then the owner.
    `static int` | `DELEGATE_ONLY` | With this resolveStrategy set the closure will resolve property references and methods to the delegate only and entirely bypass the owner.
    `static int` | `DONE` |
    `static Closure` | `IDENTITY` |
    `static int` | `OWNER_FIRST` | With this resolveStrategy set the closure will attempt to resolve property references and methods to the owner first, then the delegate (this is the default strategy).
    `static int` | `OWNER_ONLY` | With this resolveStrategy set the closure will resolve property references and methods to the owner only and not call the delegate at all.
    `static int` | `SKIP` |
    `static int` | `TO_SELF` | With this resolveStrategy set the closure will resolve property references to itself and go through the usual MetaClass look-up process.
    `protected int` | `maximumNumberOfParameters` |
    `protected Class[]` | `parameterTypes` |

  - ### Properties Summary

    Properties
    Type | Name and description
    --- | ---
    `Object` | `delegate`
    `int` | `directive`
    `Object` | `property`
    `int` | `resolveStrategy`

  - ### Constructor Summary

    Constructors
    Constructor and description
    `Closure (Object owner, Object thisObject)`
    `Closure (Object owner)` Constructor used when the "this" object for the Closure is null.

  - ### Methods Summary

    Methods
    Type Params | Return Type | Name and description
    --- | --- | ---
    `` | `Closure` | `asWritable()` Returns: a version of this closure which implements Writable.
    `` | `V` | `call()` Invokes the closure without any parameters, returning any value if applicable.
    `` | `V` | `call(Object... args)`
    `` | `V` | `call(Object arguments)` Invokes the closure, returning any value if applicable.
    `` | `Object` | `clone()`
    `` | `Closure<V>` | `curry(Object... arguments)` Support for Closure currying.
    `` | `Closure<V>` | `curry(Object argument)` Support for Closure currying.
    `` | `Closure<V>` | `dehydrate()` Returns a copy of this closure where the "owner", "delegate" and "thisObject" fields are null, allowing proper serialization when one of them is not serializable.
    `` | `Object` | `getDelegate()` @return the delegate Object to which method calls will go which is typically the outer class when the closure is constructed
    `` | `int` | `getDirective()` @return Returns the directive.
    `` | `int` | `getMaximumNumberOfParameters()` @return the maximum number of parameters a doCall method of this closure can take
    `` | `Object` | `getOwner()` @return the owner Object to which method calls will go which is typically the outer class when the closure is constructed
    `` | `Class[]` | `getParameterTypes()` @return the parameter types of the longest doCall method of this closure
    `` | `Object` | `getProperty(String property)`
    `` | `int` | `getResolveStrategy()` Gets the strategy which the closure uses to resolve methods and properties
    `` | `Object` | `getThisObject()`
    `` | `boolean` | `isCase(Object candidate)`
    `` | `Closure<V>` | `leftShift(Closure other)` Support for Closure reverse composition.
    `` | `V` | `leftShift(Object arg)`
    `` | `Closure<V>` | `memoize()` Creates a caching variant of the closure.
    `` | `Closure<V>` | `memoizeAtLeast(int protectedCacheSize)` Creates a caching variant of the closure with automatic cache size adjustment and lower limit on the cache size.
    `` | `Closure<V>` | `memoizeAtMost(int maxCacheSize)` Creates a caching variant of the closure with upper limit on the cache size.
    `` | `Closure<V>` | `memoizeBetween(int protectedCacheSize, int maxCacheSize)` Creates a caching variant of the closure with automatic cache size adjustment and lower and upper limits on the cache size.
    `` | `Closure<V>` | `ncurry(int n, Object... arguments)` Support for Closure currying at a given index.
    `` | `Closure<V>` | `ncurry(int n, Object argument)` Support for Closure currying at a given index.
    `` | `Closure<V>` | `rcurry(Object... arguments)` Support for Closure "right" currying.
    `` | `Closure<V>` | `rcurry(Object argument)` Support for Closure "right" currying.
    `` | `Closure<V>` | `rehydrate(Object delegate, Object owner, Object thisObject)` Returns a copy of this closure for which the delegate, owner and thisObject are replaced with the supplied parameters.
    `<W>` | `Closure<W>` | `rightShift(Closure<W> other)` Support for Closure forward composition.
    `` | `void` | `run()`
    `` | `void` | `setDelegate(Object delegate)` Allows the delegate to be changed such as when performing markup building
    `` | `void` | `setDirective(int directive)` @param directive The directive to set.
    `` | `void` | `setProperty(String property, Object newValue)`
    `` | `void` | `setResolveStrategy(int resolveStrategy)` Sets the strategy which the closure uses to resolve property references and methods.
    `` | `protected static Object` | `throwRuntimeException(Throwable throwable)`
    `` | `Closure<V>` | `trampoline(Object... args)` Builds a trampolined variant of the current closure.
    `` | `Closure<V>` | `trampoline()` Builds a trampolined variant of the current closure.

  - ### Inherited Methods Summary

    Inherited Methods
    Methods inherited from class | Name
    --- | ---
    `class GroovyObjectSupport` | `getMetaClass, getProperty, invokeMethod, setMetaClass, setProperty`
    `class Object` | `wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll`

- - ### Field Detail

    - #### public static final int DELEGATE_FIRST

      With this resolveStrategy set the closure will attempt to resolve property references and methods to the delegate first then the owner. For example the following code:

           class Test {
               def x = 30
               def y = 40

               def run() {
                   def data = [ x: 10, y: 20 ]
                   def cl = { y = x + y }
                   cl.delegate = data
                   cl.resolveStrategy = Closure.DELEGATE_FIRST
                   cl()
                   assert x == 30
                   assert y == 40
                   assert data == [x:10, y:30]
               }
           }

           new Test().run()

      This will succeed, because the x and y variables declared in the delegate shadow the fields in the owner class.

      Note that local variables are always looked up first, independently of the resolution strategy.

    - #### public static final int DELEGATE_ONLY

      With this resolveStrategy set the closure will resolve property references and methods to the delegate only and entirely bypass the owner. For example the following code :

           class Test {
               def x = 30
               def y = 40
               def z = 50

               def run() {
                   def data = [ x: 10, y: 20 ]
                   def cl = { y = x + y + z }
                   cl.delegate = data
                   cl.resolveStrategy = Closure.DELEGATE_ONLY
                   cl()
                   println x
                   println y
                   println data
               }
           }

           new Test().run()

      will throw an error because even if the owner declares a "z" field, the resolution strategy will bypass lookup in the owner.

      Note that local variables are always looked up first, independently of the resolution strategy.

    - #### public static final int DONE

    - #### public static final Closure IDENTITY

    - #### public static final int OWNER_FIRST

      With this resolveStrategy set the closure will attempt to resolve property references and methods to the owner first, then the delegate (this is the default strategy). For example the following code:

           class Test {
               def x = 30
               def y = 40

               def run() {
                   def data = [ x: 10, y: 20 ]
                   def cl = { y = x + y }
                   cl.delegate = data
                   cl()
                   assert x == 30
                   assert y == 70
                   assert data == [x:10, y:20]
               }
           }

           new Test().run()

      Will succeed, because the x and y fields declared in the Test class shadow the variables in the delegate.

      Note that local variables are always looked up first, independently of the resolution strategy.

    - #### public static final int OWNER_ONLY

      With this resolveStrategy set the closure will resolve property references and methods to the owner only and not call the delegate at all. For example the following code :

           class Test {
               def x = 30
               def y = 40

               def run() {
                   def data = [ x: 10, y: 20, z: 30 ]
                   def cl = { y = x + y + z }
                   cl.delegate = data
                   cl.resolveStrategy = Closure.OWNER_ONLY
                   cl()
                   println x
                   println y
                   println data
               }
           }

           new Test().run()

      will throw "No such property: z" error because even if the z variable is declared in the delegate, no lookup is made.

      Note that local variables are always looked up first, independently of the resolution strategy.

    - #### public static final int SKIP

    - #### public static final int TO_SELF

      With this resolveStrategy set the closure will resolve property references to itself and go through the usual MetaClass look-up process. This means that properties and methods are neither resolved from the owner nor the delegate, but only on the closure object itself. This allows the developer to override getProperty using ExpandoMetaClass of the closure itself.

      Note that local variables are always looked up first, independently of the resolution strategy.

    - #### protected int maximumNumberOfParameters

    - #### protected Class[] parameterTypes

  - ### Property Detail

    - #### Object delegate

    - #### int directive

    - #### Object property

    - #### int resolveStrategy

  - ### Constructor Detail

    - #### public Closure(Object owner, Object thisObject)

    - #### public Closure(Object owner)

      Constructor used when the "this" object for the Closure is null. This is rarely the case in normal Groovy usage.

      Parameters:
        `owner` - the Closure owner

  - ### Method Detail

    - #### public Closure asWritable()

      Returns:
        a version of this closure which implements Writable. Note that the returned Writable also overrides toString() in order to allow rendering the result directly to a String.

    - #### public V call()

      Invokes the closure without any parameters, returning any value if applicable.

      Returns:
        the value if applicable or null if there is no return statement in the closure

    - #### @SuppressWarnings("unchecked") public V call(Object... args)

    - #### public V call(Object arguments)

      Invokes the closure, returning any value if applicable.

      Parameters:
        `arguments` - could be a single value or a List of values
      Returns:
        the value if applicable or null if there is no return statement in the closure

    - #### public Object clone()

    - #### public Closure<V> curry(Object... arguments)

      Support for Closure currying.

      Typical usage:

           def multiply = { a, b -> a * b }
           def doubler = multiply.curry(2)
           assert doubler(4) == 8

      Note: special treatment is given to Closure vararg-style capability. If you curry a vararg parameter, you don't consume the entire vararg array but instead the first parameter of the vararg array as the following example shows:

           def a = { one, two, Object[] others -> one + two + others.sum() }
           assert a.parameterTypes.name == ['java.lang.Object', 'java.lang.Object', '[Ljava.lang.Object;']
           assert a(1,2,3,4) == 10
           def b = a.curry(1)
           assert b.parameterTypes.name == ['java.lang.Object', '[Ljava.lang.Object;']
           assert b(2,3,4) == 10
           def c = b.curry(2)
           assert c.parameterTypes.name == ['[Ljava.lang.Object;']
           assert c(3,4) == 10
           def d = c.curry(3)
           assert d.parameterTypes.name == ['[Ljava.lang.Object;']
           assert d(4) == 10
           def e = d.curry(4)
           assert e.parameterTypes.name == ['[Ljava.lang.Object;']
           assert e() == 10
           assert e(5) == 15

      Parameters:
        `arguments` - the arguments to bind
      Returns:
        the new closure with its arguments bound

    - #### public Closure<V> curry(Object argument)

      Support for Closure currying.

      Parameters:
        `argument` - the argument to bind
      Returns:
        the new closure with the argument bound
      See Also:
        curry(Object...)

    - #### @SuppressWarnings("unchecked") public Closure<V> dehydrate()

      Returns a copy of this closure where the "owner", "delegate" and "thisObject" fields are null, allowing proper serialization when one of them is not serializable.

      Returns:
        a serializable closure.
      Since:
        1.8.5

    - #### public Object getDelegate()

      Returns:
        the delegate Object to which method calls will go which is typically the outer class when the closure is constructed

    - #### public int getDirective()

      Returns:
        Returns the directive.

    - #### public int getMaximumNumberOfParameters()

      Returns:
        the maximum number of parameters a doCall method of this closure can take

    - #### public Object getOwner()

      Returns:
        the owner Object to which method calls will go which is typically the outer class when the closure is constructed

    - #### public Class[] getParameterTypes()

      Returns:
        the parameter types of the longest doCall method of this closure

    - #### public Object getProperty(String property)

    - #### public int getResolveStrategy()

      Gets the strategy which the closure uses to resolve methods and properties

      Returns:
        The resolve strategy
      See Also:
        Closure.DELEGATE_FIRST
        Closure.DELEGATE_ONLY
        Closure.OWNER_FIRST
        Closure.OWNER_ONLY
        Closure.TO_SELF

    - #### public Object getThisObject()

    - #### public boolean isCase(Object candidate)

    - #### public Closure<V> leftShift(Closure other)

      Support for Closure reverse composition.

      Typical usage:

           def times2 = { a -> a * 2 }
           def add3 = { a -> a + 3 }
           def addThenTimes = times2 << add3
           // equivalent: addThenTimes = { a -> times2(add3(a)) }
           assert addThenTimes(3) == 12

      Parameters:
        `other` - the Closure to compose with the current Closure
      Returns:
        the new composed Closure

    - #### public V leftShift(Object arg)

    - #### public Closure<V> memoize()

      Creates a caching variant of the closure. Whenever the closure is called, the mapping between the parameters and the return value is preserved in cache making subsequent calls with the same arguments fast. This variant will keep all cached values forever, i.e. till the closure gets garbage-collected. The returned function can be safely used concurrently from multiple threads, however, the implementation values high average-scenario performance and so concurrent calls on the memoized function with identical argument values may not necessarily be able to benefit from each other's cached return value. With this having been mentioned, the performance trade-off still makes concurrent use of memoized functions safe and highly recommended. The cache gets garbage-collected together with the memoized closure.

      Returns:
        A new closure forwarding to the original one while caching the results

    - #### public Closure<V> memoizeAtLeast(int protectedCacheSize)

      Creates a caching variant of the closure with automatic cache size adjustment and lower limit on the cache size. Whenever the closure is called, the mapping between the parameters and the return value is preserved in cache making subsequent calls with the same arguments fast. This variant allows the garbage collector to release entries from the cache and at the same time allows the user to specify how many entries should be protected from the eventual gc-initiated eviction. Cached entries exceeding the specified preservation threshold are made available for eviction based on the LRU (Last Recently Used) strategy. Given the non-deterministic nature of garbage collector, the actual cache size may grow well beyond the limits set by the user if memory is plentiful. The returned function can be safely used concurrently from multiple threads, however, the implementation values high average-scenario performance and so concurrent calls on the memoized function with identical argument values may not necessarily be able to benefit from each other's cached return value. Also the protectedCacheSize parameter might not be respected accurately in such scenarios for some periods of time. With this having been mentioned, the performance trade-off still makes concurrent use of memoized functions safe and highly recommended. The cache gets garbage-collected together with the memoized closure.

      Parameters:
        `protectedCacheSize` - Number of cached return values to protect from garbage collection
      Returns:
        A new function forwarding to the original one while caching the results

    - #### public Closure<V> memoizeAtMost(int maxCacheSize)

      Creates a caching variant of the closure with upper limit on the cache size. Whenever the closure is called, the mapping between the parameters and the return value is preserved in cache making subsequent calls with the same arguments fast. This variant will keep all values until the upper size limit is reached. Then the values in the cache start rotating using the LRU (Last Recently Used) strategy. The returned function can be safely used concurrently from multiple threads, however, the implementation values high average-scenario performance and so concurrent calls on the memoized function with identical argument values may not necessarily be able to benefit from each other's cached return value. With this having been mentioned, the performance trade-off still makes concurrent use of memoized functions safe and highly recommended. The cache gets garbage-collected together with the memoized closure.

      Parameters:
        `maxCacheSize` - The maximum size the cache can grow to
      Returns:
        A new function forwarding to the original one while caching the results

    - #### public Closure<V> memoizeBetween(int protectedCacheSize, int maxCacheSize)

      Creates a caching variant of the closure with automatic cache size adjustment and lower and upper limits on the cache size. Whenever the closure is called, the mapping between the parameters and the return value is preserved in cache making subsequent calls with the same arguments fast. This variant allows the garbage collector to release entries from the cache and at the same time allows the user to specify how many entries should be protected from the eventual gc-initiated eviction. Cached entries exceeding the specified preservation threshold are made available for eviction based on the LRU (Last Recently Used) strategy. Given the non-deterministic nature of garbage collector, the actual cache size may grow well beyond the protected size limits set by the user, if memory is plentiful. Also, this variant will never exceed in size the upper size limit. Once the upper size limit has been reached, the values in the cache start rotating using the LRU (Last Recently Used) strategy. The returned function can be safely used concurrently from multiple threads, however, the implementation values high average-scenario performance and so concurrent calls on the memoized function with identical argument values may not necessarily be able to benefit from each other's cached return value. Also the protectedCacheSize parameter might not be respected accurately in such scenarios for some periods of time. With this having been mentioned, the performance trade-off still makes concurrent use of memoized functions safe and highly recommended. The cache gets garbage-collected together with the memoized closure.

      Parameters:
        `protectedCacheSize` - Number of cached return values to protect from garbage collection
        `maxCacheSize` - The maximum size the cache can grow to
      Returns:
        A new function forwarding to the original one while caching the results

    - #### public Closure<V> ncurry(int n, Object... arguments)

      Support for Closure currying at a given index. Parameters are supplied from index position "n". Typical usage:

           def caseInsensitive = { a, b -> a.toLowerCase() <=> b.toLowerCase() } as Comparator
           def caseSensitive = { a, b -> a <=> b } as Comparator
           def animals1 = ['ant', 'dog', 'BEE']
           def animals2 = animals1 + ['Cat']
           // curry middle param of this utility method:
           // Collections#binarySearch(List list, Object key, Comparator c)
           def catSearcher = Collections.&binarySearch.ncurry(1, "cat")
           [[animals1, animals2], [caseInsensitive, caseSensitive]].combinations().each{ a, c ->
             def idx = catSearcher(a.sort(c), c)
             print a.sort(c).toString().padRight(22)
             if (idx < 0) println "Not found but would belong in position ${-idx - 1}"
             else println "Found at index $idx"
           }
           // =>
           // [ant, BEE, dog]       Not found but would belong in position 2
           // [ant, BEE, Cat, dog]  Found at index 2
           // [BEE, ant, dog]       Not found but would belong in position 2
           // [BEE, Cat, ant, dog]  Not found but would belong in position 3

      The position of the curried parameters will be calculated eagerly and implies all arguments prior to the specified n index are supplied. Default parameter values prior to the n index will not be available.
      Parameters:
        `n` - the index from which to bind parameters (may be -ve in which case it will be normalized)
        `arguments` - the arguments to bind
      Returns:
        the new closure with its arguments bound
      See Also:
        curry(Object...)

    - #### public Closure<V> ncurry(int n, Object argument)

      Support for Closure currying at a given index.

      Parameters:
        `argument` - the argument to bind
      Returns:
        the new closure with the argument bound
      See Also:
        ncurry(int, Object...)

    - #### public Closure<V> rcurry(Object... arguments)

      Support for Closure "right" currying. Parameters are supplied on the right rather than left as per the normal curry() method. Typical usage:

           def divide = { a, b -> a / b }
           def halver = divide.rcurry(2)
           assert halver(8) == 4

      The position of the curried parameters will be calculated lazily, for example, if two overloaded doCall methods are available, the supplied arguments plus the curried arguments will be concatenated and the result used for method selection.
      Parameters:
        `arguments` - the arguments to bind
      Returns:
        the new closure with its arguments bound
      See Also:
        curry(Object...)

    - #### public Closure<V> rcurry(Object argument)

      Support for Closure "right" currying.

      Parameters:
        `argument` - the argument to bind
      Returns:
        the new closure with the argument bound
      See Also:
        rcurry(Object...)

    - #### @SuppressWarnings("unchecked") public Closure<V> rehydrate(Object delegate, Object owner, Object thisObject)

      Returns a copy of this closure for which the delegate, owner and thisObject are replaced with the supplied parameters. Use this when you want to rehydrate a closure which has been made serializable thanks to the dehydrate() method.

      Parameters:
        `delegate` - the closure delegate
        `owner` - the closure owner
        `thisObject` - the closure "this" object
      Returns:
        a copy of this closure where owner, delegate and thisObject are replaced
      Since:
        1.8.5

    - #### <W> public Closure<W> rightShift(Closure<W> other)

      Support for Closure forward composition.

      Typical usage:

           def times2 = { a -> a * 2 }
           def add3 = { a -> a + 3 }
           def timesThenAdd = times2 >> add3
           // equivalent: timesThenAdd = { a -> add3(times2(a)) }
           assert timesThenAdd(3) == 9

      Parameters:
        `other` - the Closure to compose with the current Closure
      Returns:
        the new composed Closure

    - #### public void run()

    - #### public void setDelegate(Object delegate)

      Allows the delegate to be changed such as when performing markup building

      Parameters:
        `delegate` - the new delegate

    - #### public void setDirective(int directive)

      Parameters:
        `directive` - The directive to set.

    - #### public void setProperty(String property, Object newValue)

    - #### public void setResolveStrategy(int resolveStrategy)

      Sets the strategy which the closure uses to resolve property references and methods. The default is Closure.OWNER_FIRST

      Parameters:
        `resolveStrategy` - The resolve strategy to set
      See Also:
        Closure.DELEGATE_FIRST
        Closure.DELEGATE_ONLY
        Closure.OWNER_FIRST
        Closure.OWNER_ONLY
        Closure.TO_SELF

    - #### protected static Object throwRuntimeException(Throwable throwable)

    - #### public Closure<V> trampoline(Object... args)

      Builds a trampolined variant of the current closure. To prevent stack overflow due to deep recursion, functions can instead leverage the trampoline mechanism and avoid recursive calls altogether. Under trampoline, the function is supposed to perform one step of the calculation and, instead of a recursive call to itself or another function, it return back a new closure, which will be executed by the trampoline as the next step. Once a non-closure value is returned, the trampoline stops and returns the value as the final result. Here is an example:

           def fact
           fact = { n, total ->
               n == 0 ? total : fact.trampoline(n - 1, n * total)
           }.trampoline()
           def factorial = { n -> fact(n, 1G)}
           println factorial(20) // => 2432902008176640000

      Parameters:
        `args` - Parameters to the closure, so as the trampoline mechanism can call it
      Returns:
        A closure, which will execute the original closure on a trampoline.

    - #### public Closure<V> trampoline()

      Builds a trampolined variant of the current closure. To prevent stack overflow due to deep recursion, functions can instead leverage the trampoline mechanism and avoid recursive calls altogether. Under trampoline, the function is supposed to perform one step of the calculation and, instead of a recursive call to itself or another function, it return back a new closure, which will be executed by the trampoline as the next step. Once a non-closure value is returned, the trampoline stops and returns the value as the final result.

      Returns:
        A closure, which will execute the original closure on a trampoline.
      See Also:
        trampoline(Object...)