yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/LeafListSchemaNode.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 /**
  11  * Interface describing YANG 'leaf-list' statement.
  12  */
  13 public interface LeafListSchemaNode extends DataSchemaNode {
  14
  15     /**
  16      * Returns type of the instance which implements <code>DataSchemaNode</code>
  17      * .
  18      *
  19      * @return type definition of leaf-list schema node which represents the
  20      *         value of the argument of the YANG <code>type</code> substatement
  21      *         of the <code>leaf-list</code> statement
  22      */
  23     TypeDefinition<? extends TypeDefinition<?>> getType();
  24
  25     /**
  26      * YANG 'ordered-by' statement. It defines whether the order of entries
  27      * within this leaf-list are determined by the user or the system. If not
  28      * present, default is false.
  29      *
  30      * @return true if ordered-by argument is "user", false otherwise
  31      */
  32     boolean isUserOrdered();
  33
  34 }