X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=yang%2Fyang-model-api%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fyangtools%2Fyang%2Fmodel%2Fapi%2FListSchemaNode.java;fp=yang%2Fyang-model-api%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fyangtools%2Fyang%2Fmodel%2Fapi%2FListSchemaNode.java;h=c36528adbbce85dca399a258d3cac92d566ad45a;hb=5c1f875f69e35248aa4115c429bd962160beeef4;hp=0000000000000000000000000000000000000000;hpb=80562b826a79ad9a832be902427e54359df7725b;p=yangtools.git

diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/ListSchemaNode.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/ListSchemaNode.java
new file mode 100644
index 0000000000..c36528adbb
--- /dev/null
+++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/ListSchemaNode.java
@@ -0,0 +1,39 @@
+/*
+ * Copyright (c) 2013 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.model.api;
+
+import java.util.List;
+
+import org.opendaylight.yangtools.yang.common.QName;
+
+/**
+ * Interface describing YANG 'list' statement.
+ * <p>
+ * The 'list' statement is used to define an interior data node in the schema
+ * tree. A list entry is uniquely identified by the values of the list's keys,
+ * if defined.
+ * </p>
+ */
+public interface ListSchemaNode extends DataNodeContainer, AugmentationTarget,
+        DataSchemaNode {
+
+    /**
+     * @return List of QNames of leaf identifiers of this list
+     */
+    public List<QName> getKeyDefinition();
+
+    /**
+     * YANG 'ordered-by' statement. It defines whether the order of entries
+     * within a list are determined by the user or the system. If not present,
+     * default is false.
+     *
+     * @return true if ordered-by argument is "user", false otherwise
+     */
+    boolean isUserOrdered();
+
+}