检查注释处理器中是否缺少超类

时间:2011-10-12 09:48:33

标签: java inheritance mirror annotation-processing

在注释处理器中获取TypeElement时,您可以使用方法TypeMirror来请求其超类(或更具体地,getSuperClass()According to the JavaDoc,一种不明确扩展的类型(换句话说,Object是超类)或者接口将返回NoType NONE作为超类TypeKind

无视整个模型/镜像API的事情似乎在某种程度上让您迷失方向,我将如何可靠地检查这一点?这是一些代码提取:

//Cast is safe since TypeKind is checked before this
final TypeElement el = (TypeElement)annotatedElement;
...
final TypeMirror parent = el.getSuperclass();
//Checking whether "nothing" is extended
if(parent.getKind().equals(TypeKind.NONE) && parent instanceof NoType) {
    ...         
}

这是正确的方式吗?看起来相当笨重。由于equals method of TypeMirror不应该用于语义相等性检查,我想知道将它用于TypeKind是否安全。我的直觉是肯定的,因为它是一个枚举,但后来我怀疑instanceof

有更好的方法吗?整个javax.lang.model包及其子代在整个商店都有交叉引用,我从来都不清楚什么是最好的方法。对于某些东西,有一些有用的实用方法,然后看似简单的任务需要像上面那样可疑的杂技。

1 个答案:

答案 0 :(得分:8)

我刚做了一个测试并意识到我误解了文档。它为java.lang.Object和接口返回类型为NONE的NoType,而不是隐式扩展Object的内容。傻我。我不需要检查,因为较早的检查是否注释元素是严格意义上的类(不是枚举或接口),如果是,则返回。换句话说,检查规范名称是java.lang.Object还是使用Types.isSameType应该可以解决问题。

对不起伙计们。我决定不删除,因为其他人可能会带着相同的问题到达。如果您认为合适,请随意投票删除。

编辑:这是我最终选择的......

boolean superTypeValid = true;
final TypeMirror parent = el.getSuperClass();
if(!parent.getKind().equals(TypeKind.DECLARED)) {
    messager.printMessage(Kind.ERROR, "May only inherit from a class; not enums, annotations or other declared kinds.", annotatedElement, mirror);
    superTypeValid = false;
} else {
    final DeclaredType parentType = (DeclaredType)parent;
    final Element parentEl = parentType.asElement();
    if(!parentEl.getKind().equals(ElementKind.CLASS)) {
        messager.printMessage(Kind.ERROR, "May only inherit from a class; not enums, annotations or other declared kinds.", annotatedElement, mirror);
        superTypeValid = false;
    }
}
...
if(superTypeValid) {
    if(typeUtils.isSameType(parent, elUtils.getTypeElement("java.lang.Object").asType())) {
        messager.printMessage(Kind.ERROR, "Inherit must not be set to true if the class doesn't extend.", annotatedElement, mirror);
        valid = false;
    } else {
        ...
    }
}

如果其中一些错误消息看起来很奇怪,那是因为我留下了一些项目特定的东西。