HV-2128 Add HV-specific Path and expose the leaf node through it

Signed-off-by: marko-bekhta <[email protected]>

Author: marko-bekhta

documentation/src/test/java/org/hibernate/validator/referenceguide/chapter12/propertypath/PropertyPathTest.java

@@ -19,6 +19,7 @@
 import org.hibernate.validator.HibernateValidator;
 import org.hibernate.validator.path.PropertyNode;
 
+import org.junit.Assert;
 import org.junit.Test;
 
 /**
@@ -60,6 +61,13 @@ public void testPropertyNodeGetValueForSet() {
 		assertEquals( node.getName(), "name" );
 		assertEquals( node.as( PropertyNode.class ).getValue(), "Bob" );
 		//end::include[]
+		if ( path instanceof org.hibernate.validator.path.Path hvPath ) {
+			assertEquals( hvPath.getLeafNode().getName(), "name" );
+			assertEquals( hvPath.getLeafNode().as( PropertyNode.class ).getValue(), "Bob" );
+		}
+		else {
+			Assert.fail( "Unexpected path node type: " + path.getClass().getName() );
+		}
 
 		assertFalse( nodeIterator.hasNext() );
 	}

engine/src/main/java/org/hibernate/validator/internal/engine/path/MaterializedPath.java

@@ -8,7 +8,8 @@
 import java.io.Serializable;
 import java.util.Iterator;
 
-import jakarta.validation.Path;
+import org.hibernate.validator.path.Path;
+
 
 final class MaterializedPath implements Path, Serializable {
 
@@ -71,4 +72,9 @@ static String asString(MaterializedNode currentLeafNode) {
 		}
 		return builder.toString();
 	}
+
+	@Override
+	public Node getLeafNode() {
+		return leafNode;
+	}
 }

engine/src/main/java/org/hibernate/validator/internal/engine/path/MutablePath.java

@@ -15,12 +15,12 @@
 import java.util.regex.Pattern;
 
 import jakarta.validation.ElementKind;
-import jakarta.validation.Path;
 
 import org.hibernate.validator.internal.metadata.aggregated.ExecutableMetaData;
 import org.hibernate.validator.internal.util.Contracts;
 import org.hibernate.validator.internal.util.logging.Log;
 import org.hibernate.validator.internal.util.logging.LoggerFactory;
+import org.hibernate.validator.path.Path;
 
 /**
  * Internal, mutable implementation of {@code jakarta.validation.Path}.
@@ -182,6 +182,7 @@ public void removeLeafNode() {
 		}
 	}
 
+	@Override
 	public MutableNode getLeafNode() {
 		return currentLeafNode;
 	}

engine/src/main/java/org/hibernate/validator/path/Path.java

@@ -0,0 +1,27 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ * Copyright Red Hat Inc. and Hibernate Authors
+ */
+package org.hibernate.validator.path;
+
+import org.hibernate.validator.Incubating;
+
+/**
+ * An extended representation of the validation path, provides Hibernate Validator specific functionality.
+ */
+@Incubating
+public interface Path extends jakarta.validation.Path {
+
+	/**
+	 * @return The leaf node of the current path.
+	 * This is a shortcut method to iterating over the path till the last node.
+	 */
+	default jakarta.validation.Path.Node getLeafNode() {
+		Path.Node leafNode = null;
+		for ( Node node : this ) {
+			leafNode = node;
+		}
+		return leafNode;
+	}
+
+}