yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/ListSchemaNode.java

   1 /*
   2  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.yangtools.yang.model.api;
   9
  10 import java.util.List;
  11
  12 import org.opendaylight.yangtools.yang.common.QName;
  13
  14 /**
  15  * Interface describing YANG 'list' statement.
  16  * <p>
  17  * The 'list' statement is used to define an interior data node in the schema
  18  * tree. A list entry is uniquely identified by the values of the list's keys,
  19  * if defined.
  20  * </p>
  21  */
  22 public interface ListSchemaNode extends DataNodeContainer, AugmentationTarget, DataSchemaNode {
  23
  24     /**
  25      * @return List of QNames of leaf identifiers of this list
  26      */
  27     List<QName> getKeyDefinition();
  28
  29     /**
  30      * YANG 'ordered-by' statement. It defines whether the order of entries
  31      * within a list are determined by the user or the system. If not present,
  32      * default is false.
  33      *
  34      * @return true if ordered-by argument is "user", false otherwise
  35      */
  36     boolean isUserOrdered();
  37
  38 }