Add DataObjectReference.{find,get}FirstKey()

Previous installation failed to provide the usual methods for user, this
patch fixes that up.

JIRA: YANGTOOLS-1660
Change-Id: Ic700e573342d64dda69115da81d92a3a84ed8fae
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>

diff --git a/binding/binding-spec/src/main/java/org/opendaylight/yangtools/binding/DataObjectReference.java b/binding/binding-spec/src/main/java/org/opendaylight/yangtools/binding/DataObjectReference.java
index f7ff8dd7df939ee171ec7e24bdb7ac7c0af088a3..5fbe3dff6f1bc59f77babea6f22d2e72097d289e 100644 (file)
--- a/binding/binding-spec/src/main/java/org/opendaylight/yangtools/binding/DataObjectReference.java
+++ b/binding/binding-spec/src/main/java/org/opendaylight/yangtools/binding/DataObjectReference.java
@@ -12,6 +12,8 @@ import static java.util.Objects.requireNonNull;
 import com.google.common.collect.ImmutableList;
 import java.io.Serializable;
 import java.util.List;
+import java.util.NoSuchElementException;
+import java.util.Optional;
 import org.eclipse.jdt.annotation.NonNull;
 import org.eclipse.jdt.annotation.Nullable;
 import org.opendaylight.yangtools.binding.impl.AbstractDataObjectReference;
@@ -356,4 +358,38 @@ public sealed interface DataObjectReference<T extends DataObject> extends Immuta
      * @throws NullPointerException if {@code listItem} is {@code null}
      */
     <E extends EntryObject<E, K>, K extends Key<E>> @Nullable K firstKeyOf(Class<@NonNull E> listItem);
+
+    /**
+     * Returns an {@link Optional} containing the {@link Key} associated with the first component of specified type in
+     * this reference.
+     *
+     * @param <E> entry type
+     * @param <K> key type
+     * @param listItem entry type class
+     * @return an optional {@link Key}
+     * @throws NullPointerException if {@code listItem} is {@code null}
+     */
+    default <E extends EntryObject<E, K>, K extends Key<E>> Optional<K> findFirstKeyOf(
+            final Class<@NonNull E> listItem) {
+        return Optional.ofNullable(firstKeyOf(listItem));
+    }
+
+    /**
+     * Returns the {@link Key} associated with the first component of specified type in this reference, throwing
+     * {@link NoSuchElementException} if no match is found.
+     *
+     * @param <E> entry type
+     * @param <K> key type
+     * @param listItem entry type class
+     * @return the {@link Key} associated with the component
+     * @throws NullPointerException if {@code listItem} is {@code null}
+     * @throws NoSuchElementException if the component type is not present
+     */
+    default <E extends EntryObject<E, K>, K extends Key<E>> @NonNull K getFirstKeyOf(final Class<@NonNull E> listItem) {
+        final var key = firstKeyOf(listItem);
+        if (key != null) {
+            return key;
+        }
+        throw new NoSuchElementException("No step matching " + listItem + " found in " + this);
+    }
 }

diff --git a/binding/binding-spec/src/test/java/org/opendaylight/yangtools/yang/binding/YT1660Test.java b/binding/binding-spec/src/test/java/org/opendaylight/yangtools/yang/binding/YT1660Test.java
new file mode 100644 (file)
index 0000000..bea2e50
--- /dev/null
+++ b/binding/binding-spec/src/test/java/org/opendaylight/yangtools/yang/binding/YT1660Test.java
@@ -0,0 +1,59 @@
+/*
+ * Copyright (c) 2025 PANTHEON.tech, s.r.o. and others.  All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
+package org.opendaylight.yangtools.yang.binding;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertThrows;
+
+import java.util.NoSuchElementException;
+import java.util.Optional;
+import org.junit.jupiter.api.Test;
+import org.opendaylight.yangtools.binding.DataObjectIdentifier;
+import org.opendaylight.yangtools.binding.DataObjectReference;
+import org.opendaylight.yangtools.binding.DataObjectReference.WithKey;
+import org.opendaylight.yangtools.binding.test.mock.Node;
+import org.opendaylight.yangtools.binding.test.mock.NodeChild;
+import org.opendaylight.yangtools.binding.test.mock.NodeChildKey;
+import org.opendaylight.yangtools.binding.test.mock.NodeKey;
+import org.opendaylight.yangtools.binding.test.mock.Nodes;
+
+class YT1660Test {
+    private final WithKey<NodeChild, NodeChildKey> id = DataObjectIdentifier.builder(Nodes.class)
+        .child(Node.class, new NodeKey(3))
+        .child(NodeChild.class, new NodeChildKey(5))
+        .build();
+    private final WithKey<NodeChild, NodeChildKey> ref = DataObjectReference.builder(Nodes.class)
+        .child(Node.class)
+        .child(NodeChild.class, new NodeChildKey(4))
+        .build();
+
+    @Test
+    void testFindFirstKey() {
+        assertEquals(Optional.of(new NodeKey(3)), id.findFirstKeyOf(Node.class));
+        assertEquals(Optional.of(id.key()), id.findFirstKeyOf(NodeChild.class));
+
+        assertEquals(Optional.of(ref.key()), ref.findFirstKeyOf(NodeChild.class));
+        assertEquals(Optional.empty(), ref.findFirstKeyOf(Node.class));
+    }
+
+    @Test
+    void testGetFirstKey() {
+        assertEquals(new NodeKey(3), id.getFirstKeyOf(Node.class));
+        assertEquals(id.key(), id.getFirstKeyOf(NodeChild.class));
+
+        assertEquals(ref.key(), ref.getFirstKeyOf(NodeChild.class));
+        final var ex = assertThrows(NoSuchElementException.class, () -> ref.getFirstKeyOf(Node.class));
+        assertEquals("""
+            No step matching interface org.opendaylight.yangtools.binding.test.mock.Node found in DataObjectReference[
+              org.opendaylight.yangtools.binding.test.mock.Nodes
+              org.opendaylight.yangtools.binding.test.mock.Node(any)
+              org.opendaylight.yangtools.binding.test.mock.NodeChild[org.opendaylight.yangtools.binding.test.mock\
+            .NodeChildKey@4]
+            ]""", ex.getMessage());
+    }
+}