yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/DataSchemaNode.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  * Data Schema Node represents abstract supertype from which all data tree
  12  * definitions are derived.
  13  *
  14  * <p>
  15  * Contains the method which are used for getting metadata from the schema nodes
  16  * which contains data.
  17  *
  18  * @see ContainerSchemaNode
  19  * @see ListSchemaNode
  20  * @see LeafListSchemaNode
  21  * @see ChoiceSchemaNode
  22  * @see ChoiceCaseNode
  23  * @see LeafSchemaNode
  24  * @see AnyXmlSchemaNode
  25  * @see AnyDataSchemaNode
  26  */
  27 public interface DataSchemaNode extends SchemaNode {
  28     /**
  29      * Returns <code>true</code> if the data node was added by augmentation,
  30      * otherwise returns <code>false</code>.
  31      *
  32      * @return <code>true</code> if the data node was added by augmentation,
  33      *         otherwise returns <code>false</code>
  34      */
  35     boolean isAugmenting();
  36
  37     /**
  38      * Returns <code>true</code> if the data node was added by uses statement,
  39      * otherwise returns <code>false</code>.
  40      *
  41      * @return <code>true</code> if the data node was added by uses statement,
  42      *         otherwise returns <code>false</code>
  43      */
  44     boolean isAddedByUses();
  45
  46     /**
  47      * Returns <code>true</code> if the data represents configuration data,
  48      * otherwise returns <code>false</code>.
  49      *
  50      * @return <code>true</code> if the data represents configuration data,
  51      *         otherwise returns <code>false</code>
  52      */
  53     boolean isConfiguration();
  54
  55     /**
  56      * Returns the constraints associated with Data Schema Node.
  57      *
  58      * @return the constraints associated with Data Schema Node
  59      */
  60     ConstraintDefinition getConstraints();
  61 }