Graphpocalypse: actually let's just deprecate the makeXxxxSubGraph() operations...

... and delete the new ones I added.

The reasoning here is that they just aren't properly typesafe,
as you can see by the hoops I had to go through to actually
implement them. And since the whole package is marked
@Incubating, we're not committed to them.

Author: gavinking

hibernate-core/src/main/java/org/hibernate/graph/AttributeNode.java

@@ -6,8 +6,6 @@
 
 
 import jakarta.persistence.Subgraph;
-import jakarta.persistence.metamodel.ManagedType;
-import org.hibernate.Incubating;
 import org.hibernate.metamodel.model.domain.PersistentAttribute;
 
 import java.util.Map;
@@ -99,23 +97,27 @@ public interface AttributeNode<J> extends GraphNode<J>, jakarta.persistence.Attr
 	/**
 	 * Create and return a new value {@link SubGraph} rooted at this node,
 	 * or return an existing such {@link SubGraph} if there is one.
-	 * <p>
+	 *
+	 * @deprecated This operation is not properly type safe.
 	 * Note that {@code graph.addAttributeNode(att).makeSubGraph()} is a
 	 * synonym for {@code graph.addSubgraph(att)}.
 	 *
 	 * @see Graph#addSubgraph(jakarta.persistence.metamodel.Attribute)
 	 */
+	@Deprecated(since = "7.0")
 	SubGraph<?> makeSubGraph();
 
 	/**
 	 * Create and return a new key {@link SubGraph} rooted at this node,
 	 * or return an existing such {@link SubGraph} if there is one.
-	 * <p>
+	 *
+	 * @deprecated This operation is not properly type safe.
 	 * Note that {@code graph.addAttributeNode(att).makeKeySubGraph()} is a
 	 * synonym for {@code graph.addMapKeySubgraph(att)}.
 	 *
 	 * @see Graph#addMapKeySubgraph(jakarta.persistence.metamodel.MapAttribute)
 	 */
+	@Deprecated(since = "7.0")
 	SubGraph<?> makeKeySubGraph();
 
 	/**
@@ -125,14 +127,16 @@ public interface AttributeNode<J> extends GraphNode<J>, jakarta.persistence.Attr
 	 * <p>
 	 * If the given type is a proper subtype of the value type, the result
 	 * is a treated subgraph.
-	 * <p>
+	 *
+	 * @deprecated This operation is not properly type safe.
 	 * Note that {@code graph.addAttributeNode(att).makeSubGraph(cl)}
 	 * is a synonym for {@code graph.addTreatedSubgraph(att,cl)}.
 	 *
 	 * @param subtype The type or treated type of the value type
 	 *
 	 * @see Graph#addTreatedSubgraph(jakarta.persistence.metamodel.Attribute, Class)
 	 */
+	@Deprecated(since = "7.0")
 	<S> SubGraph<S> makeSubGraph(Class<S> subtype);
 
 	/**
@@ -142,43 +146,15 @@ public interface AttributeNode<J> extends GraphNode<J>, jakarta.persistence.Attr
 	 * <p>
 	 * If the given type is a proper subtype of the key type, the result
 	 * is a treated subgraph.
-	 * <p>
+	 *
+	 * @deprecated This operation is not properly type safe.
 	 * Note that {@code graph.addAttributeNode(att).makeKeySubGraph(cl)}
 	 * is a synonym for {@code graph.addTreatedMapKeySubgraph(att,cl)}.
 	 *
 	 * @param subtype The type or treated type of the key type
 	 *
 	 * @see Graph#addTreatedMapKeySubgraph(jakarta.persistence.metamodel.MapAttribute,Class)
 	 */
+	@Deprecated(since = "7.0")
 	<S> SubGraph<S> makeKeySubGraph(Class<S> subtype);
-
-	/**
-	 * Create and return a new value {@link SubGraph} rooted at this node,
-	 * with the given type, which may be a subtype of the value type,
-	 * or return an existing such {@link SubGraph} if there is one.
-	 * <p>
-	 * If the given type is a proper subtype of the value type, the result
-	 * is a treated subgraph.
-	 *
-	 * @param subtype The type or treated type of the value type
-	 *
-	 * @since 7.0
-	 */
-	@Incubating
-	<S> SubGraph<S> makeSubGraph(ManagedType<S> subtype);
-
-	/**
-	 * Create and return a new value {@link SubGraph} rooted at this node,
-	 * with the given type, which may be a subtype of the key type,
-	 * or return an existing such {@link SubGraph} if there is one.
-	 * <p>
-	 * If the given type is a proper subtype of the key type, the result
-	 * is a treated subgraph.
-	 *
-	 * @param subtype The type or treated type of the key type
-	 *
-	 * @since 7.0
-	 */
-	@Incubating
-	<S> SubGraph<S> makeKeySubGraph(ManagedType<S> subtype);
 }

hibernate-core/src/main/java/org/hibernate/graph/internal/AttributeNodeImpl.java

@@ -77,7 +77,7 @@ public SubGraphImplementor<K> getKeySubGraph() {
 		return keySubgraph;
 	}
 
-	@Override
+	@Override @Deprecated
 	public SubGraphImplementor<V> makeSubGraph() {
 		verifyMutability();
 		if ( valueSubgraph == null ) {
@@ -86,7 +86,7 @@ public SubGraphImplementor<V> makeSubGraph() {
 		return valueSubgraph;
 	}
 
-	@Override
+	@Override @Deprecated
 	public <S> SubGraphImplementor<S> makeSubGraph(Class<S> subtype) {
 		final ManagedDomainType<V> managedType = asManagedType( valueGraphType );
 		if ( !managedType.getBindableJavaType().isAssignableFrom( subtype ) ) {
@@ -99,21 +99,7 @@ public <S> SubGraphImplementor<S> makeSubGraph(Class<S> subtype) {
 		return (SubGraphImplementor<S>) result;
 	}
 
-	@Override
-	public <S> SubGraphImplementor<S> makeSubGraph(ManagedType<S> subtype) {
-		final ManagedDomainType<V> managedType = asManagedType( valueGraphType );
-		final Class<S> javaType = subtype.getJavaType();
-		if ( !managedType.getBindableJavaType().isAssignableFrom( javaType ) ) {
-			throw new IllegalArgumentException( "Not a subtype: " + javaType.getName() );
-		}
-		@SuppressWarnings("unchecked")
-		final ManagedDomainType<? extends V> castType = (ManagedDomainType<? extends V>) subtype;
-		final SubGraphImplementor<? extends V> result = makeSubGraph().addTreatedSubgraph( castType );
-		//noinspection unchecked
-		return (SubGraphImplementor<S>) result;
-	}
-
-	@Override
+	@Override @Deprecated
 	public SubGraphImplementor<K> makeKeySubGraph() {
 		verifyMutability();
 		checkMap();
@@ -123,7 +109,7 @@ public SubGraphImplementor<K> makeKeySubGraph() {
 		return keySubgraph;
 	}
 
-	@Override
+	@Override @Deprecated
 	public <S> SubGraphImplementor<S> makeKeySubGraph(Class<S> subtype) {
 		checkMap();
 		final ManagedDomainType<K> type = asManagedType( keyGraphType );
@@ -137,21 +123,6 @@ public <S> SubGraphImplementor<S> makeKeySubGraph(Class<S> subtype) {
 		return (SubGraphImplementor<S>) result;
 	}
 
-	@Override
-	public <S> SubGraphImplementor<S> makeKeySubGraph(ManagedType<S> subtype) {
-		checkMap();
-		final ManagedDomainType<K> type = asManagedType( keyGraphType );
-		final Class<S> javaType = subtype.getJavaType();
-		if ( !type.getBindableJavaType().isAssignableFrom( javaType ) ) {
-			throw new IllegalArgumentException( "Not a key subtype: " + javaType.getName() );
-		}
-		@SuppressWarnings("unchecked")
-		final ManagedDomainType<? extends K> castType = (ManagedDomainType<? extends K>) subtype;
-		final SubGraphImplementor<? extends K> result = makeKeySubGraph().addTreatedSubgraph( castType );
-		//noinspection unchecked
-		return (SubGraphImplementor<S>) result;
-	}
-
 	private void checkMap() {
 		if ( keyGraphType == null ) {
 			throw new CannotContainSubGraphException( "Attribute '" + description() + "' is not a Map" );

hibernate-core/src/main/java/org/hibernate/graph/spi/AttributeNodeImplementor.java

@@ -21,24 +21,18 @@ public interface AttributeNodeImplementor<J> extends AttributeNode<J>, GraphNode
 	@Override
 	AttributeNodeImplementor<J> makeCopy(boolean mutable);
 
-	@Override
+	@Override @Deprecated
 	SubGraphImplementor<?> makeSubGraph();
 
-	@Override
+	@Override @Deprecated
 	SubGraphImplementor<?> makeKeySubGraph();
 
-	@Override
+	@Override @Deprecated
 	<S> SubGraphImplementor<S> makeSubGraph(Class<S> subtype);
 
-	@Override
+	@Override @Deprecated
 	<S> SubGraphImplementor<S> makeKeySubGraph(Class<S> subtype);
 
-	@Override
-	<S> SubGraphImplementor<S> makeSubGraph(ManagedType<S> subtype);
-
-	@Override
-	<S> SubGraphImplementor<S> makeKeySubGraph(ManagedType<S> subtype);
-
 	void merge(AttributeNodeImplementor<J> other);
 
 	SubGraphImplementor<?> getSubGraph();