#9 - Add details about "index" and "element"/"component" types to MemberDetails

#21 - Work on generics / parameterized-types

Author: sebersole

README.adoc

@@ -1,16 +1,20 @@
 :fn-managed: footnote:[The application's domain and related classes]
 == Hibernate models
 
-A de-typed abstraction over "reflection" and annotations (and in the case of Hibernate ORM,
-mapping XML also).
-
 Uses a mix of https://smallrye.io/jandex/[Jandex] and Java reflection to build the de-typed abstraction model of
 classes and annotations referenced by an application's managed resources{fn-managed}.
 
 Consumers can then access details from that abstraction model in a unified way, regardless of the underlying
-source (Jandex or reflection).  For classes which we are able to access from a Jandex index, this has the benefit
-that the classes are not loaded into the ClassLoader; which is important because once a classes is loaded into
-a ClassLoader, its bytecode cannot be changed and run-time bytecode enhancement is not possible.
+source.  For classes which we are able to access from a Jandex index, this has the benefit that the classes are
+not loaded into the ClassLoader which is important because once a classes is loaded into a ClassLoader, its
+bytecode cannot be changed and run-time bytecode enhancement is not possible.
 
 This work is intended to replace the https://github.com/hibernate/hibernate-commons-annotations[`hibernate-commons-annotation`] (HCANN)
 library, which suffered from a number of shortcomings.
+
+
+=== Annotations
+
+Hibernate Models defines an actual descriptor for annotations called `AnnotationDescriptor` which provides access
+to information (whether it is repeatable, etc.) about the annotation class.  These descriptors are available from the
+`AnnotationDescriptorRegistry`.

src/main/java/org/hibernate/models/internal/AnnotationUsageHelper.java

@@ -12,8 +12,8 @@
 import java.util.List;
 import java.util.Map;
 
-import org.hibernate.models.internal.util.CollectionHelper;
 import org.hibernate.models.AnnotationAccessException;
+import org.hibernate.models.internal.util.CollectionHelper;
 import org.hibernate.models.spi.AnnotationDescriptor;
 import org.hibernate.models.spi.AnnotationUsage;
 

src/main/java/org/hibernate/models/internal/ArrayTypeDetailsImpl.java

@@ -0,0 +1,102 @@
+/*
+ * Hibernate, Relational Persistence for Idiomatic Java
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * Copyright: Red Hat Inc. and Hibernate Authors
+ */
+
+package org.hibernate.models.internal;
+
+import java.util.Objects;
+
+import org.hibernate.models.internal.util.StringHelper;
+import org.hibernate.models.spi.ArrayTypeDetails;
+import org.hibernate.models.spi.ClassDetails;
+import org.hibernate.models.spi.TypeDetails;
+
+/**
+ * @author Steve Ebersole
+ */
+public class ArrayTypeDetailsImpl implements ArrayTypeDetails {
+	private final ClassDetails arrayClassDetails;
+	private final TypeDetails constituentType;
+	private final int dimensions;
+
+	public ArrayTypeDetailsImpl(ClassDetails arrayClassDetails, TypeDetails constituentType) {
+		this.arrayClassDetails = arrayClassDetails;
+		this.constituentType = constituentType;
+		this.dimensions = StringHelper.countArrayDimensions( arrayClassDetails.getName() );
+	}
+
+	@Override
+	public ClassDetails getArrayClassDetails() {
+		return arrayClassDetails;
+	}
+
+	@Override
+	public TypeDetails getConstituentType() {
+		return constituentType;
+	}
+
+	@Override
+	public int getDimensions() {
+		return dimensions;
+	}
+
+	@Override
+	public String getName() {
+		StringBuilder builder = new StringBuilder();
+
+		TypeDetails type = this;
+		while ( type.getTypeKind() == Kind.ARRAY ) {
+			int dimensions = type.asArrayType().getDimensions();
+			while ( dimensions-- > 0 ) {
+				builder.append( '[' );
+			}
+			type = type.asArrayType().getConstituentType();
+		}
+
+		// here, `type` is an element type of the array, i.e., never array
+		if ( type.getTypeKind() == Kind.PRIMITIVE ) {
+			builder.append( type.asPrimitiveType().toCode() );
+		}
+		else {
+			// This relies on name() representing the erased type name
+			// For historical 1.x reasons, we follow the Java reflection format
+			// instead of the Java descriptor format.
+			builder.append( 'L' ).append( type.getName() ).append( ';' );
+		}
+
+		return builder.toString();
+	}
+
+	@Override
+	public boolean isImplementor(Class<?> checkType) {
+		if ( ClassDetails.OBJECT_CLASS_DETAILS.isImplementor( checkType ) ) {
+			return true;
+		}
+
+		if ( !checkType.isArray() ) {
+			return false;
+		}
+
+		return constituentType.isImplementor( checkType.getComponentType() );
+	}
+
+	@Override
+	public boolean equals(Object o) {
+		if ( this == o ) {
+			return true;
+		}
+		if ( o == null || getClass() != o.getClass() ) {
+			return false;
+		}
+		ArrayTypeDetailsImpl that = (ArrayTypeDetailsImpl) o;
+		return Objects.equals( arrayClassDetails, that.arrayClassDetails );
+	}
+
+	@Override
+	public int hashCode() {
+		return Objects.hash( arrayClassDetails );
+	}
+}

src/main/java/org/hibernate/models/internal/ClassDetailsHelper.java

@@ -12,8 +12,6 @@
 import org.hibernate.models.UnknownClassException;
 import org.hibernate.models.internal.jandex.JandexBuilders;
 import org.hibernate.models.internal.jdk.JdkBuilders;
-import org.hibernate.models.spi.ObjectClassDetails;
-import org.hibernate.models.spi.VoidClassDetails;
 import org.hibernate.models.spi.ClassDetails;
 import org.hibernate.models.spi.ClassDetailsBuilder;
 import org.hibernate.models.spi.ClassDetailsRegistry;
@@ -36,9 +34,9 @@ public ClassDetailsRegistryStandard(SourceModelBuildingContext context) {
 		this.context = context;
 		this.standardClassDetailsBuilder = new StandardClassDetailsBuilder( JdkBuilders.DEFAULT_BUILDER, context.getJandexIndex() );
 
-		classDetailsMap.put( VoidClassDetails.VOID_CLASS_DETAILS.getClassName(), VoidClassDetails.VOID_CLASS_DETAILS );
-		classDetailsMap.put( VoidClassDetails.VOID_OBJECT_CLASS_DETAILS.getClassName(), VoidClassDetails.VOID_OBJECT_CLASS_DETAILS );
-		classDetailsMap.put( ObjectClassDetails.OBJECT_CLASS_DETAILS.getClassName(), ObjectClassDetails.OBJECT_CLASS_DETAILS );
+		classDetailsMap.put( ClassDetails.VOID_CLASS_DETAILS.getClassName(), ClassDetails.VOID_CLASS_DETAILS );
+		classDetailsMap.put( ClassDetails.VOID_OBJECT_CLASS_DETAILS.getClassName(), ClassDetails.VOID_OBJECT_CLASS_DETAILS );
+		classDetailsMap.put( ClassDetails.OBJECT_CLASS_DETAILS.getClassName(), ClassDetails.OBJECT_CLASS_DETAILS );
 	}
 
 	@Override

src/main/java/org/hibernate/models/internal/ClassDetailsRegistryStandard.java

@@ -0,0 +1,64 @@
+/*
+ * Hibernate, Relational Persistence for Idiomatic Java
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * Copyright: Red Hat Inc. and Hibernate Authors
+ */
+
+package org.hibernate.models.internal;
+
+import java.util.Objects;
+
+import org.hibernate.models.spi.ClassDetails;
+import org.hibernate.models.spi.ClassTypeDetails;
+
+/**
+ * @author Steve Ebersole
+ */
+public class ClassTypeDetailsImpl implements ClassTypeDetails {
+	private final ClassDetails classDetails;
+	private final Kind kind;
+
+	public ClassTypeDetailsImpl(ClassDetails classDetails, Kind kind) {
+		assert classDetails != null;
+		assert kind == Kind.CLASS || kind == Kind.PRIMITIVE || kind == Kind.VOID;
+		this.classDetails = classDetails;
+		this.kind = kind;
+	}
+
+	public ClassDetails getClassDetails() {
+		return classDetails;
+	}
+
+	@Override
+	public String getName() {
+		return classDetails.getName();
+	}
+
+	@Override
+	public Kind getTypeKind() {
+		return kind;
+	}
+
+	@Override
+	public String toString() {
+		return "ClassTypeDetails(" + classDetails.getName() + ")";
+	}
+
+	@Override
+	public boolean equals(Object o) {
+		if ( this == o ) {
+			return true;
+		}
+		if ( o == null || getClass() != o.getClass() ) {
+			return false;
+		}
+		ClassTypeDetailsImpl that = (ClassTypeDetailsImpl) o;
+		return Objects.equals( classDetails, that.classDetails ) && kind == that.kind;
+	}
+
+	@Override
+	public int hashCode() {
+		return Objects.hash( classDetails, kind );
+	}
+}

src/main/java/org/hibernate/models/internal/ClassTypeDetailsImpl.java

@@ -11,8 +11,8 @@
 import org.hibernate.models.internal.jandex.EnumValueExtractor;
 import org.hibernate.models.internal.jandex.EnumValueWrapper;
 import org.hibernate.models.internal.jdk.PassThruExtractor;
-import org.hibernate.models.spi.ValueExtractor;
 import org.hibernate.models.spi.SourceModelBuildingContext;
+import org.hibernate.models.spi.ValueExtractor;
 import org.hibernate.models.spi.ValueWrapper;
 
 import org.jboss.jandex.AnnotationInstance;

src/main/java/org/hibernate/models/internal/EnumTypeDescriptor.java

@@ -10,6 +10,8 @@
 
 import org.hibernate.models.spi.MemberDetails;
 
+import static java.lang.reflect.Modifier.ABSTRACT;
+
 /**
  * Fills-in non-public aspects of the {@link Modifier} class
  *
@@ -75,6 +77,10 @@ public static boolean isBridge(int modifierFlags) {
 		return (modifierFlags & BRIDGE) != 0;
 	}
 
+	public static boolean isAbstract(int modifierFlags) {
+		return (modifierFlags & ABSTRACT) != 0;
+	}
+
 	/**
 	 * Determine if the modifier flags from a field indicate persist-ability.
 	 *

src/main/java/org/hibernate/models/internal/ModifierUtils.java

@@ -0,0 +1,44 @@
+/*
+ * Hibernate, Relational Persistence for Idiomatic Java
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * Copyright: Red Hat Inc. and Hibernate Authors
+ */
+
+package org.hibernate.models.internal;
+
+import java.util.List;
+
+import org.hibernate.models.spi.ClassDetails;
+import org.hibernate.models.spi.ParameterizedTypeDetails;
+import org.hibernate.models.spi.TypeDetails;
+
+/**
+ * @author Steve Ebersole
+ */
+public class ParameterizedTypeDetailsImpl implements ParameterizedTypeDetails {
+	private final ClassDetails genericClassDetails;
+	private final List<TypeDetails> arguments;
+	private final TypeDetails owner;
+
+	public ParameterizedTypeDetailsImpl(ClassDetails genericClassDetails, List<TypeDetails> arguments, TypeDetails owner) {
+		this.genericClassDetails = genericClassDetails;
+		this.arguments = arguments;
+		this.owner = owner;
+	}
+
+	@Override
+	public ClassDetails getGenericClassDetails() {
+		return genericClassDetails;
+	}
+
+	@Override
+	public List<TypeDetails> getArguments() {
+		return arguments;
+	}
+
+	@Override
+	public TypeDetails getOwner() {
+		return owner;
+	}
+}