Populate data/ hierarchy

[yangtools.git] / data / yang-data-api / src / main / java / org / opendaylight / yangtools / yang / data / api / schema / UserMapNode.java

diff --git a/data/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/schema/UserMapNode.java b/data/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/schema/UserMapNode.java
new file mode 100644 (file)
index 0000000..2cf620d
--- /dev/null
+++ b/data/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/schema/UserMapNode.java
@@ -0,0 +1,31 @@
+/*
+ * Copyright (c) 2014 Cisco Systems, Inc. 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.data.api.schema;
+
+import java.util.Map;
+import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
+
+/**
+ * {@link MapNode} which additionally preserves user-supplied ordering. This node represents a data instance of
+ * a {@code list} with {@code ordered-by user;} substatement and a {@code key} definition.
+ */
+public interface UserMapNode extends MapNode, OrderedNodeContainer<MapEntryNode> {
+    @Override
+    default Class<UserMapNode> contract() {
+        return UserMapNode.class;
+    }
+
+    /**
+     * {@inheritDoc}
+     *
+     * <p>
+     * The implementation is required to define a user-visible iteration order, which must match {@link #childAt(int)}.
+     */
+    @Override
+    Map<NodeIdentifierWithPredicates, MapEntryNode> asMap();
+}