Javadoc, tests and cleanup

sebersole · sebersole · commit 9a79cdf07ee2 · 2024-04-23T14:44:03.000-05:00
diff --git a/src/main/java/org/hibernate/models/IllegalCastException.java b/src/main/java/org/hibernate/models/IllegalCastException.java
@@ -7,7 +7,13 @@
 
 package org.hibernate.models;
 
+import org.hibernate.models.spi.AnnotationTarget;
+
 /**
+ * Indicates an illegal cast through one of the safe cast methods
+ * such as {@linkplain AnnotationTarget#asClassDetails()},
+ * {@linkplain AnnotationTarget#asMemberDetails()}, etc.
+ *
  * @author Steve Ebersole
  */
 public class IllegalCastException extends ModelsException {
diff --git a/src/main/java/org/hibernate/models/ModelsException.java b/src/main/java/org/hibernate/models/ModelsException.java
@@ -8,7 +8,7 @@
 package org.hibernate.models;
 
 /**
- * Base exception for models building
+ * Base exception for hibernate-models
  *
  * @author Steve Ebersole
  */
diff --git a/src/main/java/org/hibernate/models/UnknownAnnotationAttributeException.java b/src/main/java/org/hibernate/models/UnknownAnnotationAttributeException.java
@@ -19,14 +19,12 @@
  */
 public class UnknownAnnotationAttributeException extends ModelsException {
 	public UnknownAnnotationAttributeException(Class<? extends Annotation> annotationType, String attributeName) {
-		this(
-				String.format(
-						Locale.ROOT,
-						"Unable to locate attribute named `%s` on annotation `%s`",
-						attributeName,
-						annotationType.getName()
-				)
-		);
+		this( String.format(
+				Locale.ROOT,
+				"Unable to locate attribute named `%s` on annotation `%s`",
+				attributeName,
+				annotationType.getName()
+		) );
 	}
 
 	public UnknownAnnotationAttributeException(String message) {
diff --git a/src/main/java/org/hibernate/models/internal/AnnotationDescriptorRegistryStandard.java b/src/main/java/org/hibernate/models/internal/AnnotationDescriptorRegistryStandard.java
@@ -8,6 +8,8 @@
 
 import java.lang.annotation.Annotation;
 import java.lang.annotation.Repeatable;
+import java.util.Collections;
+import java.util.HashMap;
 
 import org.hibernate.models.internal.jdk.AnnotationDescriptorImpl;
 import org.hibernate.models.spi.AnnotationDescriptor;
@@ -79,6 +81,9 @@ private <A extends Annotation> AnnotationDescriptor<A> buildAdHocAnnotationDescr
 
 	@Override
 	public AnnotationDescriptorRegistry makeImmutableCopy() {
-		return new AnnotationDescriptorRegistryImmutable( descriptorMap, repeatableByContainerMap );
+		return new AnnotationDescriptorRegistryImmutable(
+				java.util.Map.copyOf( descriptorMap ),
+				java.util.Map.copyOf( repeatableByContainerMap )
+		);
 	}
 }
diff --git a/src/main/java/org/hibernate/models/internal/ClassDetailsRegistryStandard.java b/src/main/java/org/hibernate/models/internal/ClassDetailsRegistryStandard.java
@@ -8,6 +8,7 @@
 
 import java.util.ArrayList;
 import java.util.List;
+import java.util.Map;
 
 import org.hibernate.models.UnknownClassException;
 import org.hibernate.models.internal.jandex.JandexBuilders;
@@ -134,6 +135,9 @@ public ClassDetails buildClassDetails(String name, SourceModelBuildingContext bu
 
 	@Override
 	public ClassDetailsRegistry makeImmutableCopy() {
-		return new ClassDetailsRegistryImmutable( classDetailsMap, subTypeClassDetailsMap );
+		return new ClassDetailsRegistryImmutable(
+				Map.copyOf( classDetailsMap ),
+				Map.copyOf( subTypeClassDetailsMap )
+		);
 	}
 }
diff --git a/src/main/java/org/hibernate/models/internal/jandex/JandexIndexerHelper.java b/src/main/java/org/hibernate/models/internal/jandex/JandexIndexerHelper.java
@@ -17,13 +17,31 @@
 import org.jboss.jandex.Indexer;
 
 /**
+ * Helper for dealing with the Jandex {@linkplain Indexer}
+ *
  * @author Steve Ebersole
  */
 public class JandexIndexerHelper {
+	/**
+	 * Apply a class to the indexer
+	 *
+	 * @param clazz The class to apply to the indexer
+	 * @param indexer The Jandex Indexer
+	 * @param classLoading Used to load the class file (bytes)
+	 *
+	 * @implNote Simply delegates to {@linkplain #apply(String, Indexer, ClassLoading)} with the class name
+	 */
 	public static void apply(Class<?> clazz, Indexer indexer, ClassLoading classLoading) {
 		apply( clazz.getName(), indexer, classLoading );
 	}
 
+	/**
+	 * Apply a class to the indexer
+	 *
+	 * @param className The class to apply to the indexer
+	 * @param indexer The Jandex Indexer
+	 * @param classLoading Used to load the class file (bytes)
+	 */
 	public static void apply(String className, Indexer indexer, ClassLoading classLoading) {
 		final String resourceName = StringHelper.classNameToResourceName( className );
 		final URL resource = classLoading.locateResource( resourceName );
diff --git a/src/main/java/org/hibernate/models/internal/jdk/JdkClassDetails.java b/src/main/java/org/hibernate/models/internal/jdk/JdkClassDetails.java
@@ -18,7 +18,6 @@
 
 import org.hibernate.models.internal.ClassDetailsSupport;
 import org.hibernate.models.internal.util.CollectionHelper;
-import org.hibernate.models.internal.util.TypeHelper;
 import org.hibernate.models.spi.ClassDetails;
 import org.hibernate.models.spi.ClassDetailsRegistry;
 import org.hibernate.models.spi.FieldDetails;
@@ -89,7 +88,7 @@ public String getClassName() {
 
 	@Override
 	public boolean isResolved() {
-		return TypeHelper.isResolved( managedClass );
+		return true;
 	}
 
 	@Override
diff --git a/src/main/java/org/hibernate/models/internal/util/TypeHelper.java b/src/main/java/org/hibernate/models/internal/util/TypeHelper.java
diff --git a/src/main/java/org/hibernate/models/spi/AnnotationDescriptorRegistry.java b/src/main/java/org/hibernate/models/spi/AnnotationDescriptorRegistry.java
@@ -34,6 +34,9 @@ public interface AnnotationDescriptorRegistry {
 	 */
 	<A extends Annotation> AnnotationDescriptor<A> getContainedRepeatableDescriptor(Class<A> javaType);
 
+	/**
+	 * Make a copy of this registry which cannot be added-to.
+	 */
 	AnnotationDescriptorRegistry makeImmutableCopy();
 
 	@FunctionalInterface
diff --git a/src/main/java/org/hibernate/models/spi/TypeDetailsHelper.java b/src/main/java/org/hibernate/models/spi/TypeDetailsHelper.java
@@ -43,9 +43,16 @@ public class TypeDetailsHelper {
 	 */
 	public static TypeDetails resolveRelativeType(TypeDetails type, TypeVariableScope container) {
 		switch ( type.getTypeKind() ) {
-			case CLASS, PRIMITIVE, VOID, ARRAY, WILDCARD_TYPE -> {
+			case CLASS, PRIMITIVE, VOID, WILDCARD_TYPE -> {
 				return type;
 			}
+			case ARRAY -> {
+				final ArrayTypeDetails arrayType = type.asArrayType();
+				return new ArrayTypeDetailsImpl(
+						arrayType.getArrayClassDetails(),
+						arrayType.getConstituentType().determineRelativeType( container )
+				);
+			}
 			case PARAMETERIZED_TYPE -> {
 				final ParameterizedTypeDetails parameterizedType = type.asParameterizedType();
 				final List<TypeDetails> resolvedArguments;
diff --git a/src/test/java/org/hibernate/models/annotations/RegistryTests.java b/src/test/java/org/hibernate/models/annotations/RegistryTests.java
@@ -0,0 +1,57 @@
+/*
+ * Hibernate, Relational Persistence for Idiomatic Java
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * Copyright: Red Hat Inc. and Hibernate Authors
+ */
+
+package org.hibernate.models.annotations;
+
+import org.hibernate.models.ModelsException;
+import org.hibernate.models.SourceModelTestHelper;
+import org.hibernate.models.internal.AnnotationDescriptorRegistryStandard;
+import org.hibernate.models.internal.SourceModelBuildingContextImpl;
+import org.hibernate.models.internal.jdk.AnnotationDescriptorImpl;
+import org.hibernate.models.spi.AnnotationDescriptorRegistry;
+
+import org.junit.jupiter.api.Test;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.junit.jupiter.api.Assertions.fail;
+
+/**
+ * @author Steve Ebersole
+ */
+public class RegistryTests {
+	@Test
+	void testImmutableRegistry() {
+		final SourceModelBuildingContextImpl buildingContext = SourceModelTestHelper.createBuildingContext();
+
+		final AnnotationDescriptorRegistryStandard base = new AnnotationDescriptorRegistryStandard( buildingContext );
+		base.register( new AnnotationDescriptorImpl<>( Annotation1.class, buildingContext ) );
+		assertThat( base.getDescriptor( Annotation1.class ) ).isNotNull();
+
+		final AnnotationDescriptorRegistry immutableCopy = base.makeImmutableCopy();
+		assertThat( immutableCopy.getDescriptor( Annotation1.class ) ).isNotNull();
+
+		// this should succeed
+		base.resolveDescriptor( Annotation2.class, annotationType -> new AnnotationDescriptorImpl<>( annotationType, buildingContext ) );
+
+		// this should fail
+		try {
+			immutableCopy.resolveDescriptor( Annotation2.class, annotationType -> new AnnotationDescriptorImpl<>( annotationType, buildingContext ) );
+			fail( "Expecting an exception" );
+		}
+		catch (ModelsException expected) {
+			assertThat( expected.getMessage() ).contains( "immutable" );
+		}
+	}
+
+	public @interface Annotation1 {
+
+	}
+
+	public @interface Annotation2 {
+
+	}
+}
diff --git a/src/test/java/org/hibernate/models/classes/GenericsTests.java b/src/test/java/org/hibernate/models/classes/GenericsTests.java
@@ -54,22 +54,32 @@ void testWrappedId(Index jandexIndex) {
 		final ClassDetailsRegistry classDetailsRegistry = buildingContext.getClassDetailsRegistry();
 
 		final ClassDetails baseClassDetails = classDetailsRegistry.getClassDetails( Base.class.getName() );
+
 		final TypeDetails idType = baseClassDetails.findFieldByName( "id" ).getType();
+		assertThat( idType.isResolved() ).isFalse();
+		assertThat( idType.determineRawClass().isResolved() ).isTrue();
 		assertThat( idType.getName() ).isEqualTo( IdWrapper.class.getName() );
+
 		final TypeDetails wrappedType = idType.asParameterizedType().getRawClassDetails().findFieldByName( "value" ).getType();
 		assertThat( wrappedType.getTypeKind() ).isEqualTo( TypeDetails.Kind.TYPE_VARIABLE );
 		assertThat( wrappedType.asTypeVariable().getIdentifier() ).isEqualTo( "T" );
 		assertThat( wrappedType.asTypeVariable().getBounds() ).hasSize( 1 );
 		assertThat( wrappedType.asTypeVariable().getBounds() ).contains( ClassBasedTypeDetails.OBJECT_TYPE_DETAILS );
+		assertThat( wrappedType.isResolved() ).isFalse();
+		assertThat( wrappedType.determineRawClass().isResolved() ).isTrue();
+
+		final ClassDetails thing1ClassDetails = classDetailsRegistry.resolveClassDetails( Thing1.class.getName() );
+		final TypeDetails thing1IdType = idType.determineRelativeType( thing1ClassDetails );
+		assertThat( thing1IdType.isResolved() ).isTrue();
+
+		final ClassDetails thing2ClassDetails = classDetailsRegistry.resolveClassDetails( Thing2.class.getName() );
+		final TypeDetails thing2IdType = idType.determineRelativeType( thing2ClassDetails );
+		assertThat( thing2IdType.isResolved() ).isTrue();
 	}
 
 	@Test
 	void testIdWithJandex() {
-		final Index index = SourceModelTestHelper.buildJandexIndex(
-				Base2.class,
-				Thing3.class,
-				Thing4.class
-		);
+		final Index index = SourceModelTestHelper.buildJandexIndex( Base2.class, Thing3.class, Thing4.class );
 		testId( index );
 	}
 
@@ -90,11 +100,59 @@ void testId(Index jandexIndex) {
 
 		final ClassDetails baseClassDetails = classDetailsRegistry.getClassDetails( Base2.class.getName() );
 		assertThat( baseClassDetails.getFields() ).hasSize( 2 );
-//		final ClassDetails idType = baseClassDetails.findFieldByName( "id" ).getType();
-//		assertThat( idType ).isSameAs( ClassDetails.OBJECT_CLASS_DETAILS );
+		final TypeDetails idType = baseClassDetails.findFieldByName( "id" ).getType();
+		assertThat( idType.isResolved() ).isFalse();
+		assertThat( idType.determineRawClass().isResolved() ).isTrue();
+
+		final ClassDetails thing3ClassDetails = classDetailsRegistry.resolveClassDetails( Thing3.class.getName() );
+		final TypeDetails thing3IdType = idType.determineRelativeType( thing3ClassDetails );
+		assertThat( thing3IdType.isResolved() ).isTrue();
+
+		final ClassDetails thing4ClassDetails = classDetailsRegistry.resolveClassDetails( Thing4.class.getName() );
+		final TypeDetails thing4IdType = idType.determineRelativeType( thing4ClassDetails );
+		assertThat( thing4IdType.isResolved() ).isTrue();
+	}
+
+	@Test
+	void testArraysWithJandex() {
+		final Index index = SourceModelTestHelper.buildJandexIndex( Base3.class, Thing5.class );
+		testArrays( index );
+	}
+
+	@Test
+	void testArraysWithoutJandex() {
+		testArrays( null );
+	}
+
+	void testArrays(Index jandexIndex) {
+		final SourceModelBuildingContextImpl buildingContext = SourceModelTestHelper.createBuildingContext(
+				jandexIndex,
+				Base3.class,
+				Thing5.class
+		);
+
+		final ClassDetailsRegistry classDetailsRegistry = buildingContext.getClassDetailsRegistry();
+		final ClassDetails baseClassDetails = classDetailsRegistry.getClassDetails( Base3.class.getName() );
+		assertThat( baseClassDetails.getFields() ).hasSize( 2 );
+
+		final TypeDetails stringArrayType = baseClassDetails.findFieldByName( "strings" ).getType();
+		assertThat( stringArrayType.isResolved() ).isTrue();
+		assertThat( stringArrayType.determineRawClass().isResolved() ).isTrue();
+
+		final TypeDetails genericArrayType = baseClassDetails.findFieldByName( "generics" ).getType();
+		assertThat( genericArrayType.isResolved() ).isFalse();
+		assertThat( genericArrayType.determineRawClass().isResolved() ).isTrue();
+
+		final ClassDetails thing5ClassDetails = classDetailsRegistry.getClassDetails( Thing5.class.getName() );
+		final TypeDetails thing5GenericArrayType = genericArrayType.determineRelativeType( thing5ClassDetails );
+		assertThat( thing5GenericArrayType.isResolved() ).isTrue();
+		assertThat( thing5GenericArrayType.determineRawClass().isResolved() ).isTrue();
+
+		assertThat( stringArrayType.determineRawClass().isResolved() ).isTrue();
+		assertThat( genericArrayType.determineRawClass().isResolved() ).isTrue();
 	}
 
-	public static class IdWrapper<T> {
+		public static class IdWrapper<T> {
 		T value;
 	}
 
@@ -125,6 +183,14 @@ public static class Thing3 extends Base2<Integer> {
 	}
 
 	@Entity
-	public static class Thing4 extends Base<String> {
+	public static class Thing4 extends Base2<String> {
+	}
+
+	public static class Base3<I> {
+		private String[] strings;
+		private I[] generics;
+	}
+
+	public static class Thing5 extends Base3<Integer> {
 	}
 }
diff --git a/src/test/java/org/hibernate/models/generics/CollectionTests.java b/src/test/java/org/hibernate/models/generics/CollectionTests.java

Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@`
`8`	`8`	`package org.hibernate.models;`
`9`	`9`
`10`	`10`	`/**`
`11`		`- * Base exception for models building`
	`11`	`+ * Base exception for hibernate-models`
`12`	`12`	`*`
`13`	`13`	`* @author Steve Ebersole`
`14`	`14`	`*/`