Skip to content

Road grading; adds annotation-related features #36

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ljnelson merged 1 commit into from
Jan 23, 2026
Merged

Road grading; adds annotation-related features #36

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ dependency:
Always check https://search.maven.org/artifact/org.microbean/microbean-construct
for up-to-date available versions.
-->
<version>0.0.20</version>
<version>0.0.21</version>
</dependency>
```

Expand Down
108 changes: 108 additions & 0 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,114 @@
<plugin>
<artifactId>maven-checkstyle-plugin</artifactId>
<version>3.6.0</version>
<configuration>
<checkstyleRules>
<module name="Checker">
<module name="BeforeExecutionExclusionFileFilter">
<property name="fileNamePattern" value="module\-info\.java$" />
</module>
<module name="FileTabCharacter">
<property name="eachLine" value="true" />
</module>
<module name="JavadocPackage" />
<module name="LineLength">
<property name="max" value="160" />
</module>
<module name="NewlineAtEndOfFile">
<property name="lineSeparator" value="lf" />
</module>
<module name="TreeWalker">
<module name="AnnotationLocation">
<property name="allowSamelineSingleParameterlessAnnotation" value="false" />
</module>
<module name="AnnotationUseStyle" />
<module name="ArrayTypeStyle" />
<module name="AvoidNestedBlocks" />
<module name="AvoidStarImport" />
<module name="ClassMemberImpliedModifier" />
<module name="CommentsIndentation" />
<module name="DeclarationOrder" />
<module name="DefaultComesLast" />
<module name="EmptyBlock" />
<module name="EmptyCatchBlock" />
<module name="EmptyStatement" />
<module name="EqualsHashCode" />
<module name="ExplicitInitialization" />
<module name="FinalClass" />
<module name="FinalLocalVariable">
<property name="tokens" value="VARIABLE_DEF,PARAMETER_DEF" />
</module>
<module name="HideUtilityClassConstructor" />
<module name="InnerAssignment" />
<module name="InnerTypeLast" />
<module name="InterfaceIsType" />
<module name="InterfaceMemberImpliedModifier">
<property name="violateImpliedAbstractMethod" value="false" />
</module>
<module name="InvalidJavadocPosition" />
<module name="JavadocContentLocationCheck" />
<module name="JavadocMissingWhitespaceAfterAsterisk" />
<module name="JavadocParagraph" />
<module name="JavadocStyle" />
<module name="JavadocVariable">
<property name="scope" value="protected" />
</module>
<module name="LeftCurly" />
<module name="MethodTypeParameterName" />
<module name="MissingCtor" />
<module name="MissingDeprecated" />
<module name="MissingJavadocMethod" />
<module name="MissingJavadocPackage" />
<module name="MissingJavadocType">
<property name="scope" value="protected" />
</module>
<module name="MissingOverride" />
<module name="MultipleVariableDeclarations" />
<module name="ModifierOrder" />
<module name="NeedBraces" />
<module name="NoArrayTrailingComma" />
<module name="NoFinalizer" />
<module name="NonEmptyAtclauseDescription" />
<module name="OneStatementPerLine" />
<module name="OneTopLevelClass" />
<module name="OuterTypeFilename" />
<module name="OverloadMethodsDeclarationOrder" />
<module name="PackageDeclaration" />
<module name="RedundantImport" />
<module name="RegexpSinglelineJava">
<property name="format" value="\s+$" />
<property name="message" value="File contains trailing whitespace." />
</module>
<module name="RequireEmptyLineBeforeBlockTagGroup" />
<module name="RequireThis" />
<module name="RightCurly" />
<module name="SummaryJavadocCheck" />
<module name="SuppressWarningsHolder" />
<module name="UnnecessarySemicolonAfterOuterTypeDeclaration" />
<module name="UnnecessarySemicolonAfterTypeMemberDeclaration" />
<module name="UnnecessarySemicolonInEnumeration" />
<module name="UnnecessarySemicolonInTryWithResources" />
<module name="UnusedImports" />
<module name="UnusedLocalVariable" />
<module name="UpperEll" />
<module name="VariableDeclarationUsageDistance" />
</module>
<property name="charset" value="${project.build.sourceEncoding}" />
<property name="tabWidth" value="2" />
</module>
</checkstyleRules>
<propertyExpansion>
project.basedir=${project.basedir}
project.build.sourceEncoding=${project.build.sourceEncoding}
</propertyExpansion>
</configuration>
<dependencies>
<dependency>
<groupId>com.puppycrawl.tools</groupId>
<artifactId>checkstyle</artifactId>
<version>13.0.0</version>
</dependency>
</dependencies>
</plugin>
<plugin>
<artifactId>maven-clean-plugin</artifactId>
Expand Down
8 changes: 8 additions & 0 deletions src/main/java/org/microbean/construct/DefaultDomain.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,14 @@ public DefaultDomain(final ProcessingEnvironment pe, final Lock lock) {
*/


@Override // Domain
public List<? extends UniversalElement> allMembers(TypeElement e) {
e = unwrap(e);
try (var lock = lock()) {
return UniversalElement.of(this.elements().getAllMembers(e), this);
}
}

/**
* Returns a {@link UniversalType} representing an {@link javax.lang.model.type.ArrayType} whose {@linkplain
* javax.lang.model.type.ArrayType#getComponentType() component type} {@linkplain #sameType(TypeMirror, TypeMirror) is
Expand Down
132 changes: 97 additions & 35 deletions src/main/java/org/microbean/construct/Domain.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/* -*- mode: Java; c-basic-offset: 2; indent-tabs-mode: nil; coding: utf-8-unix -*-
*
* Copyright © 2024–2025 microBean™.
* Copyright © 2024–2026 microBean™.
*
* 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
Expand All @@ -23,7 +23,8 @@

import java.util.ArrayList;
import java.util.List;
import java.util.Objects;

import javax.lang.model.AnnotatedConstruct;

import javax.lang.model.element.AnnotationMirror;
import javax.lang.model.element.Element;
Expand Down Expand Up @@ -53,12 +54,15 @@
import javax.lang.model.util.Elements;
import javax.lang.model.util.Elements.Origin;

import org.microbean.construct.element.AnnotationMirrors;
import org.microbean.construct.element.UniversalElement;

import org.microbean.construct.type.UniversalType;

import static java.util.Collections.unmodifiableList;

import static java.util.Objects.requireNonNull;

import static javax.lang.model.type.TypeKind.DECLARED;

/**
Expand Down Expand Up @@ -96,44 +100,102 @@ public interface Domain extends PrimordialDomain {
* Returns an immutable, determinate, non-{@code null} {@link List} of {@link AnnotationMirror} instances representing
* all annotations <dfn>present</dfn> on an element, whether <dfn>directly present</dfn> or present via inheritance.
*
* <p>The default implementation of this method calls {@link UniversalElement#of(Element, Domain)} with the supplied
* {@code element} and {@code this} as arguments, calls the {@link
* AnnotationMirrors#allAnnotationMirrors(Element)} with the result, and returns the result.</p>
*
* @param element the {@link Element} whose present annotations should be returned; must not be {@code null}
*
* @return an immutable, determinate, non-{@code null} {@link List} of {@link AnnotationMirror} instances representing
* all annotations <dfn>present</dfn> on an element, whether <dfn>directly present</dfn> or present via inheritance
*
* @exception NullPointerException if {@code element} is {@code null}
*
* @see AnnotationMirrors#allAnnotationMirrors(Element)
*
* @see javax.lang.model.util.Elements#getAllAnnotationMirrors(Element)
*/
public default List<? extends AnnotationMirror> allAnnotationMirrors(Element element) {
element = UniversalElement.of(element, this); // handles locking, symbol completion, etc.
final List<AnnotationMirror> annotations = new ArrayList<>(8);
annotations.addAll(element.getAnnotationMirrors().reversed());
TypeMirror sc = ((TypeElement)element).getSuperclass();
if (sc.getKind() == DECLARED) {
element = ((DeclaredType)sc).asElement();
WHILE_LOOP:
while (element != null && element.getKind().isDeclaredType()) {
for (final AnnotationMirror a : element.getAnnotationMirrors().reversed()) {
// See if it's inherited
final TypeElement annotationTypeElement = (TypeElement)a.getAnnotationType().asElement();
for (final AnnotationMirror metaAnnotation : annotationTypeElement.getAnnotationMirrors()) {
if (((TypeElement)metaAnnotation.getAnnotationType().asElement()).getQualifiedName().contentEquals("java.lang.annotation.Inherited")) {
for (final AnnotationMirror existingAnnotation : annotations) {
if (existingAnnotation.getAnnotationType().asElement().equals(annotationTypeElement)) {
continue WHILE_LOOP;
}
}
annotations.add(a);
break;
}
}
}
sc = ((TypeElement)element).getSuperclass();
element = sc.getKind() == DECLARED ? ((DeclaredType)sc).asElement() : null;
}
}
return annotations.isEmpty() ? List.of() : unmodifiableList(annotations.reversed());
public default List<? extends AnnotationMirror> allAnnotationMirrors(final Element element) {
return AnnotationMirrors.allAnnotationMirrors(UniversalElement.of(element, this)); // handles locking, symbol completion
}

/**
* Returns a non-{@code null}, determinate, immutable {@link List} whose elements comprise the <dfn>members</dfn> of
* the supplied {@link TypeElement}, whether they are inherited or declared directly.
*
* <p>If the supplied {@link TypeElement} is a {@linkplain ElementKind#CLASS class}, the returned {@link List} will
* also include the class' constructors, but not any local or anonymous classes.</p>
*
* @param e a {@link TypeElement}; must not be {@code null}
*
* @return a non-{@code null}, determinate, immutable {@link List} whose elements comprise the <dfn>members</dfn> of
* the supplied {@link TypeElement}, whether they are inherited or declared directly
*
* @exception NullPointerException if {@code e} is {@code null}
*
* @see Elements#getAllMembers(TypeElement)
*/
public abstract List<? extends Element> allMembers(TypeElement e);

/**
* An <strong>experimental</strong> method that returns an {@link Element} that is {@linkplain Element#equals(Object)
* equal to} the supplied {@link Element} but {@linkplain Element#getAnnotationMirrors() with} a {@link List} of
* annotations {@linkplain List#equals(Object) equal to} the supplied {@link List} of {@link AnnotationMirror}s.
*
* <p>The supplied {@link Element} may be modified in place if the return value of its {@link
* Element#getAnnotationMirrors() getAnnotationMirrors()} method is mutable.</p>
*
* <p>No validation of any kind is performed on either argument.</p>
*
* @param annotations a {@link List} of {@link AnnotationMirror}s; must not be {@code null}
*
* @param e an {@link Element}; must not be {@code null}
*
* @return an {@link Element} that is {@linkplain Element#equals(Object) equal to} the supplied {@link Element} but
* {@linkplain Element#getAnnotationMirrors() with} a {@link List} of annotations {@linkplain List#equals(Object)
* equal to} the supplied {@link List} of {@link AnnotationMirror}s
*
* @exception NullPointerException if any argument is {@code null}
*
* @see UniversalElement#getAnnotationMirrors()
*/
public default Element annotate(final List<? extends AnnotationMirror> annotations, final Element e) {
final UniversalElement ue = UniversalElement.of(e, this);
final List<AnnotationMirror> l = ue.getAnnotationMirrors();
l.clear();
l.addAll(annotations);
return ue;
}

/**
* An <strong>experimental</strong> method that returns a {@link TypeMirror} that is {@linkplain
* TypeMirror#equals(Object) equal to} the supplied {@link TypeMirror} but {@linkplain
* TypeMirror#getAnnotationMirrors() with} a {@link List} of annotations {@linkplain List#equals(Object) equal to} the
* supplied {@link List} of {@link AnnotationMirror}s.
*
* <p>The supplied {@link TypeMirror} may be modified in place if the return value of its {@link
* TypeMirror#getAnnotationMirrors() getAnnotationMirrors()} method is mutable.</p>
*
* <p>No validation of any kind is performed on either argument.</p>
*
* @param annotations a {@link List} of {@link AnnotationMirror}s; must not be {@code null}
*
* @param t a {@link TypeMirror}; must not be {@code null}
*
* @return a {@link TypeMirror} that is {@linkplain TypeMirror#equals(Object) equal to} the supplied {@link
* TypeMirror} but {@linkplain TypeMirror#getAnnotationMirrors() with} a {@link List} of annotations {@linkplain
* List#equals(Object) equal to} the supplied {@link List} of {@link AnnotationMirror}s
*
* @exception NullPointerException if any argument is {@code null}
*
* @see UniversalType#getAnnotationMirrors()
*/
public default TypeMirror annotate(final List<? extends AnnotationMirror> annotations, final TypeMirror t) {
final UniversalType ut = UniversalType.of(t, this);
final List<AnnotationMirror> l = ut.getAnnotationMirrors();
l.clear();
l.addAll(annotations);
return ut;
}

/**
Expand Down Expand Up @@ -970,7 +1032,7 @@ public default boolean parameterized(final TypeMirror t) {
// (Convenience.)
// (Unboxing.)
public default PrimitiveType primitiveType(final CharSequence canonicalName) {
final String s = this.toString(Objects.requireNonNull(canonicalName, "canonicalName"));
final String s = this.toString(requireNonNull(canonicalName, "canonicalName"));
return switch (s) {
case "boolean", "java.lang.Boolean" -> this.primitiveType(TypeKind.BOOLEAN);
case "byte", "java.lang.Byte" -> this.primitiveType(TypeKind.BYTE);
Expand Down Expand Up @@ -1462,8 +1524,8 @@ public default TypeElement typeElement(final TypeKind primitiveTypeKind) {
*/
// (Convenience.)
public default TypeParameterElement typeParameterElement(Parameterizable p, final CharSequence name) {
Objects.requireNonNull(p, "p");
Objects.requireNonNull(name, "name");
requireNonNull(p, "p");
requireNonNull(name, "name");
while (p != null) {
switch (p) {
case UniversalElement ue:
Expand Down Expand Up @@ -1532,7 +1594,7 @@ public default TypeVariable typeVariable(Parameterizable p, final CharSequence n
*/
// (Convenience.)
public default VariableElement variableElement(final Element enclosingElement, final CharSequence simpleName) {
Objects.requireNonNull(simpleName, "simpleName");
requireNonNull(simpleName, "simpleName");
return switch (enclosingElement) {
case null -> throw new NullPointerException("enclosingElement");
case UniversalElement ue -> {
Expand Down
Loading