#67 - Remove target arg from AnnotationDescriptor#ceateUsage forms

Author: sebersole

src/main/java/org/hibernate/models/RepeatableAnnotationException.java

@@ -0,0 +1,35 @@
+/*
+ * Hibernate, Relational Persistence for Idiomatic Java
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * Copyright: Red Hat Inc. and Hibernate Authors
+ */
+
+package org.hibernate.models;
+
+import java.lang.annotation.Annotation;
+import java.util.Locale;
+
+import org.hibernate.models.spi.AnnotationDescriptor;
+import org.hibernate.models.spi.AnnotationTarget;
+
+/**
+ * Indicates an attempt to {@linkplain org.hibernate.models.spi.MutableAnnotationTarget#addAnnotationUsage add}
+ * a {@linkplain AnnotationDescriptor#isRepeatable() repeatable} annotation to a target.  The repeatable
+ * {@linkplain AnnotationDescriptor#getRepeatableContainer() container} should always be used instead.
+ *
+ * @author Steve Ebersole
+ */
+public class RepeatableAnnotationException extends ModelsException {
+	public RepeatableAnnotationException(AnnotationDescriptor<? extends Annotation> repeatableDescriptor, AnnotationTarget target) {
+		super(
+				String.format(
+						Locale.ROOT,
+						"A repeatable annotation (%s) was added to a target (%s); use the container annotation (%s) instead",
+						repeatableDescriptor.getAnnotationType().getName(),
+						target.getName(),
+						repeatableDescriptor.getRepeatableContainer().getAnnotationType().getName()
+				)
+		);
+	}
+}

src/main/java/org/hibernate/models/internal/dynamic/AbstractAnnotationTarget.java

@@ -10,10 +10,13 @@
 import java.util.HashMap;
 import java.util.Map;
 
+import org.hibernate.models.RepeatableAnnotationException;
 import org.hibernate.models.internal.AnnotationTargetSupport;
 import org.hibernate.models.spi.AnnotationUsage;
 import org.hibernate.models.spi.SourceModelBuildingContext;
 
+import static org.hibernate.models.internal.ModelsLogging.MODELS_LOGGER;
+
 /**
  * @author Steve Ebersole
  */
@@ -40,17 +43,20 @@ public void clearAnnotationUsages() {
 		usageMap.clear();
 	}
 
-	/**
-	 * Applies the given {@code annotationUsage} to this target.
-	 *
-	 * @todo It is undefined currently what happens if the annotation type is already applied on this target.
-	 */
+	@Override
 	public <X extends Annotation> void addAnnotationUsage(AnnotationUsage<X> annotationUsage) {
 		assert annotationUsage.getAnnotationDescriptor().getAllowableTargets().contains( getKind() );
-		final AnnotationUsage<?> previous = usageMap.put( annotationUsage.getAnnotationType(), annotationUsage );
 
-		if ( previous != null ) {
-			// todo : ignore?  log?  exception?
+		if ( annotationUsage.getAnnotationDescriptor().isRepeatable() ) {
+			throw new RepeatableAnnotationException( annotationUsage.getAnnotationDescriptor(), this );
+		}
+
+		final AnnotationUsage<? extends Annotation> previous = getUsageMap().put(
+				annotationUsage.getAnnotationType(),
+				annotationUsage
+		);
+		if ( previous != null && MODELS_LOGGER.isDebugEnabled() ) {
+			MODELS_LOGGER.debugf( "AnnotationUsage (%s) was replaced (%s)", annotationUsage, previous );
 		}
 	}
 

src/main/java/org/hibernate/models/internal/jandex/AbstractAnnotationTarget.java

@@ -9,10 +9,13 @@
 import java.lang.annotation.Annotation;
 import java.util.Map;
 
+import org.hibernate.models.RepeatableAnnotationException;
 import org.hibernate.models.internal.AnnotationTargetSupport;
 import org.hibernate.models.spi.AnnotationUsage;
 import org.hibernate.models.spi.SourceModelBuildingContext;
 
+import static org.hibernate.models.internal.ModelsLogging.MODELS_LOGGER;
+
 /**
  * @author Steve Ebersole
  */
@@ -47,7 +50,18 @@ public void clearAnnotationUsages() {
 	@Override
 	public <X extends Annotation> void addAnnotationUsage(AnnotationUsage<X> annotationUsage) {
 		assert annotationUsage.getAnnotationDescriptor().getAllowableTargets().contains( getKind() );
-		getUsageMap().put( annotationUsage.getAnnotationType(), annotationUsage );
+
+		if ( annotationUsage.getAnnotationDescriptor().isRepeatable() ) {
+			throw new RepeatableAnnotationException( annotationUsage.getAnnotationDescriptor(), this );
+		}
+
+		final AnnotationUsage<? extends Annotation> previous = getUsageMap().put(
+				annotationUsage.getAnnotationType(),
+				annotationUsage
+		);
+		if ( previous != null && MODELS_LOGGER.isDebugEnabled() ) {
+			MODELS_LOGGER.debugf( "AnnotationUsage (%s) was replaced (%s)", annotationUsage, previous );
+		}
 	}
 
 	@Override

src/main/java/org/hibernate/models/internal/jdk/AbstractAnnotationTarget.java

@@ -11,10 +11,13 @@
 import java.util.Map;
 import java.util.function.Supplier;
 
+import org.hibernate.models.RepeatableAnnotationException;
 import org.hibernate.models.internal.AnnotationTargetSupport;
 import org.hibernate.models.spi.AnnotationUsage;
 import org.hibernate.models.spi.SourceModelBuildingContext;
 
+import static org.hibernate.models.internal.ModelsLogging.MODELS_LOGGER;
+
 /**
  * AnnotationTarget where we know the annotations up front, but
  * want to delay processing them until (unless!) they are needed
@@ -65,6 +68,16 @@ public void clearAnnotationUsages() {
 	@Override
 	public <X extends Annotation> void addAnnotationUsage(AnnotationUsage<X> annotationUsage) {
 		assert annotationUsage.getAnnotationDescriptor().getAllowableTargets().contains( getKind() );
-		getUsageMap().put( annotationUsage.getAnnotationType(), annotationUsage );
+		if ( annotationUsage.getAnnotationDescriptor().isRepeatable() ) {
+			throw new RepeatableAnnotationException( annotationUsage.getAnnotationDescriptor(), this );
+		}
+
+		final AnnotationUsage<? extends Annotation> previous = getUsageMap().put(
+				annotationUsage.getAnnotationType(),
+				annotationUsage
+		);
+		if ( previous != null && MODELS_LOGGER.isDebugEnabled() ) {
+			MODELS_LOGGER.debugf( "AnnotationUsage (%s) was replaced (%s)", annotationUsage, previous );
+		}
 	}
 }

src/main/java/org/hibernate/models/spi/MutableAnnotationTarget.java

@@ -8,6 +8,8 @@
 
 import java.lang.annotation.Annotation;
 
+import org.hibernate.models.RepeatableAnnotationException;
+
 /**
  * Extension of AnnotationTarget which allows manipulation of the annotations
  *
@@ -22,22 +24,38 @@ public interface MutableAnnotationTarget extends AnnotationTarget {
 
 	/**
 	 * Add an annotation usage to this target
+	 *
+	 * @apiNote Expects the {@linkplain AnnotationDescriptor#getRepeatableContainer() container} form instead of
+	 * {@linkplain AnnotationDescriptor#isRepeatable() repeatable} annotations.
+	 *
+	 * @throws RepeatableAnnotationException Indicates a {@linkplain AnnotationDescriptor#isRepeatable() repeatable}
+	 * annotation was passed.
 	 */
 	<X extends Annotation> void addAnnotationUsage(AnnotationUsage<X> annotationUsage);
 
 	/**
 	 * Applies a usage of the given {@code annotationType} to this target.  Will return
 	 * an existing usage, if one, or create a new usage.
+	 *
+	 * @apiNote Expects the {@linkplain AnnotationDescriptor#getRepeatableContainer() container} form instead of
+	 * {@linkplain AnnotationDescriptor#isRepeatable() repeatable} annotations.
+	 *
+	 * @throws RepeatableAnnotationException Indicates a {@linkplain AnnotationDescriptor#isRepeatable() repeatable}
+	 * annotation was passed.
 	 */
 	default <A extends Annotation> MutableAnnotationUsage<A> applyAnnotationUsage(
-			AnnotationDescriptor<A> annotationType,
+			AnnotationDescriptor<A> annotationDescriptor,
 			SourceModelBuildingContext buildingContext) {
-		final MutableAnnotationUsage<A> existing = (MutableAnnotationUsage<A>) getAnnotationUsage( annotationType );
+		if ( annotationDescriptor.isRepeatable() ) {
+			throw new RepeatableAnnotationException( annotationDescriptor, this );
+		}
+
+		final MutableAnnotationUsage<A> existing = (MutableAnnotationUsage<A>) getAnnotationUsage( annotationDescriptor );
 		if ( existing != null ) {
 			return existing;
 		}
 
-		final MutableAnnotationUsage<A> usage = annotationType.createUsage( buildingContext );
+		final MutableAnnotationUsage<A> usage = annotationDescriptor.createUsage( buildingContext );
 		addAnnotationUsage( usage );
 		return usage;
 	}