[GROOVY-7632] Groovy named parameters static check

• Type: Improvement
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 3.0.0-alpha-4, 2.5.5
• Component/s: groovy-jdk, Static Type Checker
• Assignee: Paul King
• Reporter: Daniil Ovchinnikov
• Created: 15/Oct/15 17:31
• Updated: 16/Jan/19 12:07
• Resolved: 16/Nov/18 01:21

Description

It would be really nice if groovy will include some annotation for type checking named params.
For example we do not know what map is expected until we go into source.

Annotation

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.PARAMETER})
public @interface NamedParams {

    NamedParam[] value();
    boolean unknowns() default false;

    @interface NamedParam {
        String value();
        Class type() default Object.class;
        int genericTypeIndex() default -1;
        String target() default "";
        boolean required() default false;
    }
}

Example Usage

def foo(@NamedParams([
        @NamedParam("bar"),
        @NamedParam(value = "baz", type = String)]) Map map) {
    println map.bar
    println map.baz
}

foo(bar: [], baz: "")

In @CompileStatic case it could be used to fail the compilation if user tries to get some unknown value from map, and also fail if user does not pass some required argument.

Also it could be used to annotate map-constructors in compile-time.

And the last one: it will be VERY useful for IDEs.

Issue Links

• is duplicated by: GROOVY-7662 @BindsTo annotation for checking map parameters
• relates to: GROOVY-7662 @BindsTo annotation for checking map parameters
• links to: GitHub Pull Request #822