grails.artefact.ApiDelegate Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2011-2022 the original author or authors.
 *
 * Licensed 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
 *
 *      https://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 grails.artefact;

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

import org.codehaus.groovy.transform.GroovyASTTransformationClass;

/**
 * Similar to Groovy's @Delegate AST transform but instead assumes the first
 * argument to every method is 'this'.
 *
 * @author Graeme Rocher
 * @since 2.0
 */
@java.lang.annotation.Documented
@Retention(RetentionPolicy.SOURCE)
@Target({ ElementType.FIELD })
@GroovyASTTransformationClass("org.grails.compiler.injection.ApiDelegateTransformation")
public @interface ApiDelegate {

    /**
     * @return The super class to check for in the first argument of api methods
     */
    Class value();

}