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.Collection;
  11 import java.util.List;
  12 import org.eclipse.jdt.annotation.NonNull;
  13 import org.opendaylight.yangtools.yang.common.QName;
  14
  15 /**
  16  * Interface describing YANG 'list' statement.
  17  *
  18  * <p>
  19  * The 'list' statement is used to define an interior data node in the schema tree. A list entry is uniquely identified
  20  * by the values of the list's keys, if defined.
  21  */
  22 public interface ListSchemaNode extends DataNodeContainer, AugmentationTarget, DataSchemaNode,
  23         NotificationNodeContainer, ActionNodeContainer, ElementCountConstraintAware, MustConstraintAware {
  24     /**
  25      * Returns the list of leaf identifiers.
  26      *
  27      * @return List of QNames of leaf identifiers of this list, empty if the list has no keys.
  28      */
  29     @NonNull List<QName> getKeyDefinition();
  30
  31     /**
  32      * YANG 'ordered-by' statement. It defines whether the order of entries within a list are determined by the user
  33      * or the system. If not present, default is false.
  34      *
  35      * @return true if ordered-by argument is "user", false otherwise
  36      */
  37     boolean isUserOrdered();
  38
  39     /**
  40      * Returns unique constraints.
  41      *
  42      * @return Collection of unique constraints of this list schema node
  43      */
  44     @NonNull Collection<UniqueConstraint> getUniqueConstraints();
  45 }