Document Key(Effective)Statement's argument

Iteration order of the returned set has additional requirements, make
sure we document them.

Change-Id: I72ed3c8e45e7149187a4c295ab3e3d6526fbb368
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>

diff --git a/model/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/KeyEffectiveStatement.java b/model/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/KeyEffectiveStatement.java
index 054f0fb3ebe47c2edd54a00454595e160ac8ae98..b39c878deca403fa8998ac0f40b67256a869c79a 100644 (file)
--- a/model/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/KeyEffectiveStatement.java
+++ b/model/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/KeyEffectiveStatement.java
@@ -20,4 +20,13 @@ public interface KeyEffectiveStatement extends EffectiveStatement<Set<QName>, Ke
     default  StatementDefinition statementDefinition() {
         return YangStmtMapping.KEY;
     }
+
+    /**
+     * {@inheritDoc}
+     *
+     * <p>
+     * Iteration order of the returned set is required to match the order in which key components were declared.
+     */
+    @Override
+    Set<QName> argument();
 }

diff --git a/model/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/KeyStatement.java b/model/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/KeyStatement.java
index ff82ba55bf188bbffca7c6d39e4ac37c1fa03585..62670e1390b664ebb03d5680bfa219d93786b07e 100644 (file)
--- a/model/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/KeyStatement.java
+++ b/model/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/KeyStatement.java
@@ -13,9 +13,21 @@ import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
 import org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition;
 
+/**
+ * Declared representation of a {@code key} statement.
+ */
 public interface KeyStatement extends DeclaredStatement<Set<QName>> {
     @Override
     default StatementDefinition statementDefinition() {
         return YangStmtMapping.KEY;
     }
+
+    /**
+     * {@inheritDoc}
+     *
+     * <p>
+     * Iteration order of the returned set is required to match the order in which key components were declared.
+     */
+    @Override
+    Set<QName> argument();
 }