groovy.transform.TypeChecked Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of groovy Show documentation
Show all versions of groovy Show documentation
Groovy: A powerful, dynamic language for the JVM
/*
* Copyright 2003-2011 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
*
* 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.transform;
import java.lang.annotation.*;
import org.codehaus.groovy.transform.GroovyASTTransformationClass;
/**
* This will let the Groovy compiler use compile time checks in the style of Java.
* @author Jochen "blackdrag" Theodorou
*/
@java.lang.annotation.Documented
@Retention(RetentionPolicy.SOURCE)
@Target({ ElementType.METHOD, ElementType.TYPE,
ElementType.CONSTRUCTOR
})
@GroovyASTTransformationClass("org.codehaus.groovy.transform.StaticTypesTransformation")
public @interface TypeChecked {
TypeCheckingMode value() default TypeCheckingMode.PASS;
/**
* The list of (classpath resources) paths to type checking DSL scripts, also known
* as type checking extensions.
* @return an array of paths to groovy scripts that must be on compile classpath
*/
String[] extensions();
/**
* This annotation is added by @TypeChecked on methods which have type checking turned on.
* It is used to embed type information into binary, so that the type checker can use this information,
* if available, for precompiled classes.
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface TypeCheckingInfo {
/**
* Returns the type checker information protocol number. This is used if the format of the
* string used in {@link #inferredType()} changes.
* @return the protocol version
*/
int version() default 0;
/**
* An encoded type information.
* @return the inferred type
*/
String inferredType();
}
}