groovy.lang.DelegatesTo Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of groovy Show documentation
Groovy: A powerful multi-faceted language for the JVM
There is a newer version: 5.0.0-alpha-11
/*
 *  Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you under the Apache License, Version 2.0 (the
 *  "License"); you may not use this file except in compliance
 *  with the License.  You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing,
 *  software distributed under the License is distributed on an
 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *  KIND, either express or implied.  See the License for the
 *  specific language governing permissions and limitations
 *  under the License.
 */
package groovy.lang;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;

/**
 * This annotation can be used by API or DSL writers to specify what the delegate
 * type of a closure will be. This is important for IDE support.
 * 
 * This annotation can also be used to help the type checker ({@link groovy.transform.TypeChecked})
 * which would not report errors then if the delegate is of the documented type. Of course, it is
 * also compatible with {@link groovy.transform.CompileStatic}.
 * 

 * Example:
 * 
 * // Declare that the delegate of the closure will be an ExecSpec
 * ExecResult exec(@DelegatesTo(ExecSpec) Closure closure) { ... }
 * 
 *
 * @since 2.1.0
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@java.lang.annotation.Target(ElementType.PARAMETER)
public @interface DelegatesTo {

    /**
     * The closure's delegate type, if not using {@code DelegatesTo.Target} or {@link #type()}.
     */
    Class value() default DelegatesTo.Target.class;

    /**
     * The closure's resolve strategy.
     *
     * @see Closure#DELEGATE_FIRST
     * @see Closure#DELEGATE_ONLY
     * @see Closure#OWNER_FIRST
     * @see Closure#OWNER_ONLY
     * @see Closure#TO_SELF
     */
    int strategy() default Closure.OWNER_FIRST;

    /**
     * The index of the generic type that will be the type of the closure's delegate.
     * The generic types are considered with respect to the {@code @DelegatesTo.Target} annotated
     * parameter for this usage, with the index starting at 0.
     */
    int genericTypeIndex() default -1;

    /**
     * In cases when there are multiple {@code @DelegatesTo.Target} annotated parameters, this
     * member should be set to the {@link DelegatesTo.Target#value()} of the correct target.
     */
    String target() default "";

    /**
     * The type member should be used when the type of the delegate cannot be
     * represented by {@link #value()} or {@link #target()}. In this case, it
     * is possible to use a string to represent the type, at the cost of more
     * compile time and potential uncaught load errors if the type is invalid.
     *
     * @since 2.4.0
     */
    String type() default "";

    /**
     * Specifies the delegate for a {@code @DelegatesTo} annotated parameter of the same method.
     * 
     * Example:
     * 
     * // Declare that the delegate of the closure will be the "spec" argument
     * ExecResult exec(@DelegatesTo.Target ExecSpec spec, @DelegatesTo Closure closure) { ... }
     * 
     */
    @Documented
    @Retention(RetentionPolicy.RUNTIME)
    @java.lang.annotation.Target(ElementType.PARAMETER)
    @interface Target {

        /**
         * An identifier used to disambiguate targets when there are multiple
         * {@code @DelegatesTo.Target} annotated parameters.
         */
        String value() default "";
    }
}