Apache Groovy 3.0.20 · groovy.transform.stc.SingleSignatureClosureHint

Access	Constructor and Description
public	SingleSignatureClosureHint()

Method Summary

Modifier and Type Method and Description

Modifier and Type	Method and Description
public List<ClassNode[]>	getClosureSignatures(final MethodNode the method node for which a `groovy.lang.Closure` parameter was annotated with `ClosureParams` node, final SourceUnit the source unit of the file being compiled sourceUnit, final CompilationUnit the compilation unit of the file being compiled compilationUnit, final String[] the options, corresponding to the `ClosureParams#options()` found on the annotation @return a non-null list of signature, where a signature corresponds to an array of class nodes, each of them matching a parameter. options, final ASTNode the AST node, in the compiled file, which triggered a call to this method. Normally only used for logging/error handling usage) Implements abstract groovy.transform.stc.ClosureSignatureHint.getClosureSignatures. Subclasses should implement this method, which returns the list of accepted closure signatures.
public abstract ClassNode[]	getParameterTypes(MethodNode node, String[] options, SourceUnit sourceUnit, CompilationUnit unit, ASTNode usage)

public List<ClassNode[]>

getClosureSignatures(final MethodNode

the method node for which a groovy.lang.Closure parameter was annotated with ClosureParams

node, final SourceUnit

the source unit of the file being compiled

sourceUnit, final CompilationUnit

the compilation unit of the file being compiled

compilationUnit, final String[]

the options, corresponding to the ClosureParams#options() found on the annotation @return a non-null list of signature, where a signature corresponds to an array of class nodes, each of them matching a parameter.

options, final ASTNode

the AST node, in the compiled file, which triggered a call to this method. Normally only used for logging/error handling

usage)

Implements abstract groovy.transform.stc.ClosureSignatureHint.getClosureSignatures.

Subclasses should implement this method, which returns the list of accepted closure signatures.

public abstract ClassNode[]

getParameterTypes(MethodNode node, String[] options, SourceUnit sourceUnit, CompilationUnit unit, ASTNode usage)

Inherited from groovy.transform.stc.ClosureSignatureHint:: findClassNode pickGenericType pickGenericType

SingleSignatureClosureHint	back to summary
public SingleSignatureClosureHint()

Method Detail

getClosureSignatures back to summary

getClosureSignatures	back to summary
public List<ClassNode[]> getClosureSignatures(final MethodNode node, final SourceUnit sourceUnit, final CompilationUnit compilationUnit, final String[] options, final ASTNode usage) Implements abstract groovy.transform.stc.ClosureSignatureHint.getClosureSignatures. Doc from groovy.transform.stc.ClosureSignatureHint.getClosureSignatures. Subclasses should implement this method, which returns the list of accepted closure signatures. The compiler will call this method each time, in a source file, a method call using a closure literal is encountered and that the target method has the corresponding `groovy.lang.Closure` parameter annotated with `groovy.transform.stc.ClosureParams`. So imagine the following code needs to be compiled: `@groovy.transform.TypeChecked void doSomething() { println ['a','b'].collect { it.toUpperCase() } }` The collect method accepts a closure, but normally, the type checker doesn't have enough type information in the sole `org.codehaus.groovy.runtime.DefaultGroovyMethods#collect(java.lang.Iterable, groovy.lang.Closure)` method signature to infer the type of it. With the annotation, it will now try to find an annotation on the closure parameter. If it finds it, then an instance of the hint class is created and the type checker calls it with the following arguments: the method node corresponding to the target method (here, the `org.codehaus.groovy.runtime.DefaultGroovyMethods#collect(java.lang.Iterable, groovy.lang.Closure)` method the (optional) list of options found in the annotation Now, the hint instance can return the list of expected parameters. Here, it would have to say that the collect method accepts a closure for which the only argument is of the type of the first generic type of the first argument. With that type information, the type checker can now infer that the type of it is String, because the first argument (here the receiver of the collect method) is a List<String> Subclasses are therefore expected to return the signatures according to the available context, which is only the target method and the potential options. Parameters node:MethodNode the method node for which a `groovy.lang.Closure` parameter was annotated with `ClosureParams` sourceUnit:SourceUnit the source unit of the file being compiled compilationUnit:CompilationUnit the compilation unit of the file being compiled options:String[] the options, corresponding to the `ClosureParams#options()` found on the annotation @return a non-null list of signature, where a signature corresponds to an array of class nodes, each of them matching a parameter. usage:ASTNode the AST node, in the compiled file, which triggered a call to this method. Normally only used for logging/error handling

public List<ClassNode[]> getClosureSignatures(final MethodNode node, final SourceUnit sourceUnit, final CompilationUnit compilationUnit, final String[] options, final ASTNode usage)

Implements abstract groovy.transform.stc.ClosureSignatureHint.getClosureSignatures.

Doc from groovy.transform.stc.ClosureSignatureHint.getClosureSignatures.

Subclasses should implement this method, which returns the list of accepted closure signatures.

The compiler will call this method each time, in a source file, a method call using a closure literal is encountered and that the target method has the corresponding groovy.lang.Closure parameter annotated with groovy.transform.stc.ClosureParams. So imagine the following code needs to be compiled:

@groovy.transform.TypeChecked
void doSomething() {
    println ['a','b'].collect { it.toUpperCase() }
}

The collect method accepts a closure, but normally, the type checker doesn't have enough type information in the sole org.codehaus.groovy.runtime.DefaultGroovyMethods#collect(java.lang.Iterable, groovy.lang.Closure) method signature to infer the type of it. With the annotation, it will now try to find an annotation on the closure parameter. If it finds it, then an instance of the hint class is created and the type checker calls it with the following arguments:

the method node corresponding to the target method (here, the org.codehaus.groovy.runtime.DefaultGroovyMethods#collect(java.lang.Iterable, groovy.lang.Closure) method
the (optional) list of options found in the annotation

Now, the hint instance can return the list of expected parameters. Here, it would have to say that the collect method accepts a closure for which the only argument is of the type of the first generic type of the first argument.

With that type information, the type checker can now infer that the type of it is String, because the first argument (here the receiver of the collect method) is a List<String>

Subclasses are therefore expected to return the signatures according to the available context, which is only the target method and the potential options.

Parameters

node:MethodNode: the method node for which a groovy.lang.Closure parameter was annotated with ClosureParams
sourceUnit:SourceUnit: the source unit of the file being compiled
compilationUnit:CompilationUnit: the compilation unit of the file being compiled
options:String[]: the options, corresponding to the ClosureParams#options() found on the annotation @return a non-null list of signature, where a signature corresponds to an array of class nodes, each of them matching a parameter.
usage:ASTNode: the AST node, in the compiled file, which triggered a call to this method. Normally only used for logging/error handling

getParameterTypes	back to summary
public abstract ClassNode[] getParameterTypes(MethodNode node, String[] options, SourceUnit sourceUnit, CompilationUnit unit, ASTNode usage)

public abstract Class SingleSignatureClosureHint

Constructor Summary

Method Summary

Constructor Detail

Method Detail