model/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 import java.util.Collection;
  11 import org.eclipse.jdt.annotation.NonNull;
  12 import org.opendaylight.yangtools.yang.model.api.stmt.LeafListEffectiveStatement;
  13
  14 /**
  15  * Interface describing YANG 'leaf-list' statement.
  16  */
  17 public interface LeafListSchemaNode extends TypedDataSchemaNode, MustConstraintAware, ElementCountConstraintAware,
  18         DerivableSchemaNode<LeafListSchemaNode>, EffectiveStatementEquivalent<LeafListEffectiveStatement> {
  19     /**
  20      * YANG 'ordered-by' statement. It defines whether the order of entries
  21      * within this leaf-list are determined by the user or the system. If not
  22      * present, default is false.
  23      *
  24      * @return true if ordered-by argument is "user", false otherwise
  25      */
  26     boolean isUserOrdered();
  27
  28     /**
  29      * Return the default value of this leaf-list, as per the rules outlined in
  30      * <a href="https://tools.ietf.org/html/rfc7950#section-7.7.4">Section 7.4.4 of RFC7950</a>. RFC6020 does not
  31      * allow for default value of leaf-list, hence the returned list will be empty.
  32      *
  33      * @return Ordered list of Strings which specify the default values of this leaf-list
  34      */
  35     @NonNull Collection<? extends @NonNull Object> getDefaults();
  36 }