注释处理器,生成编译器错误

时间:2013-07-31 00:33:56

标签: java annotations javac

我正在尝试创建自定义注释,例如,确保字段或方法同时为publicfinal,并且如果字段或方法是,则会生成编译时错误不同于publicfinal,如下例所示:

// Compiles
@PublicFinal
public final int var = 2;

// Compiles
@PublicFinal
public final void myMethod {}

// Compile time error
@PublicFinal
private final int fail = 2;

到目前为止,我已经制作了两个自定义注释界面:

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

@Documented
@Retention(RetentionPolicy.SOURCE)
@Target({ElementType.METHOD, ElementType.FIELD})
public @interface PublicFinal { }

Processor

import javax.annotation.processing.AbstractProcessor;
import javax.annotation.processing.RoundEnvironment;
import javax.annotation.processing.SupportedAnnotationTypes;
import javax.lang.model.element.Modifier;
import javax.lang.model.element.TypeElement;
import java.util.Set;

@SupportedAnnotationTypes("PublicFinal")
public class PubicFinalProcessor extends AbstractProcessor
{
    @Override
    public boolean process(
            Set<? extends TypeElement> annotations,
            RoundEnvironment roundEnv)
    {
        for (TypeElement typeElement : annotations)
        {
            Set<Modifier> modifiers = typeElement.getModifiers();

            if (!modifiers.contains(Modifier.FINAL)
                    || !modifiers.contains(Modifier.PUBLIC))
            {
                // Compile time error.
                // TODO How do I raise an error?
            }
        }

        // All PublicFinal annotations are handled by this Processor.
        return true;
    }
}

正如TODO暗示的那样,我不知道如何生成编译时错误。处理器的documentation表明我不应该抛出异常,

  

如果处理器抛出未捕获的异常,该工具可能会停止其他活动的注释处理器。

继续描述引发错误情况时会发生什么,但现在如何引发错误情况。

问题:如何引发错误条件,以便生成编译时错误?

1 个答案:

答案 0 :(得分:18)

您可能想要processingEnv.getMessager().printMessage(Kind.ERROR, "method wasn't public and final", element)

Messager:“打印带有错误类型的邮件会引发错误。”