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

2022-09-01 19:14:33

我正在尝试创建一个自定义注释,例如,确保字段或方法既是 and 又是 和,并且如果字段或方法不是两者都是 and,则会生成编译时错误,如以下示例所示:publicfinalpublicfinal

// 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

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

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

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


答案 1

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

消息者:“打印错误类型的消息将引发错误。


答案 2

推荐