jakarta.enterprise.lang.model.declarations.DeclarationInfo Maven / Gradle / Ivy

Go to download
package jakarta.enterprise.lang.model.declarations;

import jakarta.enterprise.lang.model.AnnotationTarget;
import jakarta.enterprise.lang.model.types.Type;

/**
 * Declarations are:
 *
 * 
 * a package, as declared in {@code package-info.java}
 * a class, including interfaces, enums, and annotations
 * a field
 * a method, including constructors
 * a method parameter
 * 
 */
public interface DeclarationInfo extends AnnotationTarget {
    // TODO reevaluate the is*/as*/kind() approach (everywhere!); maybe type checks and casts are better, maybe
    //  something completely different is even better

    @Override
    default boolean isDeclaration() {
        return true;
    }

    @Override
    default boolean isType() {
        return false;
    }

    @Override
    default DeclarationInfo asDeclaration() {
        return this;
    }

    @Override
    default Type asType() {
        throw new IllegalStateException("Not a type");
    }

    enum Kind {
        /** Packages can be annotated in {@code package-info.java}. */
        PACKAGE,
        CLASS,
        METHOD,
        PARAMETER,
        FIELD,
    }

    Kind kind();

    default boolean isPackage() {
        return kind() == Kind.PACKAGE;
    }

    default boolean isClass() {
        return kind() == Kind.CLASS;
    }

    default boolean isMethod() {
        return kind() == Kind.METHOD;
    }

    default boolean isParameter() {
        return kind() == Kind.PARAMETER;
    }

    default boolean isField() {
        return kind() == Kind.FIELD;
    }

    default PackageInfo asPackage() {
        throw new IllegalStateException("Not a package");
    }

    default ClassInfo asClass() {
        throw new IllegalStateException("Not a class");
    }

    default MethodInfo asMethod() {
        throw new IllegalStateException("Not a method");
    }

    default ParameterInfo asParameter() {
        throw new IllegalStateException("Not a parameter");
    }

    default FieldInfo asField() {
        throw new IllegalStateException("Not a field");
    }
}