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  *
  12  * Data Schema Node represents abstract supertype from which all data tree
  13  * definitions are derived.
  14  *
  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  *
  26  *
  27  */
  28 public interface DataSchemaNode extends SchemaNode {
  29
  30     /**
  31      * Returns <code>true</code> if the data node was added by augmentation,
  32      * otherwise returns <code>false</code>
  33      *
  34      * @return <code>true</code> if the data node was added by augmentation,
  35      *         otherwise returns <code>false</code>
  36      */
  37     boolean isAugmenting();
  38
  39     /**
  40      * Returns <code>true</code> if the data node was added by uses statement,
  41      * otherwise returns <code>false</code>
  42      *
  43      * @return <code>true</code> if the data node was added by uses statement,
  44      *         otherwise returns <code>false</code>
  45      */
  46     boolean isAddedByUses();
  47
  48     /**
  49      * Returns <code>true</code> if the data represents configuration data,
  50      * otherwise returns <code>false</code>
  51      *
  52      * @return <code>true</code> if the data represents configuration data,
  53      *         otherwise returns <code>false</code>
  54      */
  55     boolean isConfiguration();
  56
  57     /**
  58      * Returns the constraints associated with Data Schema Node
  59      *
  60      * @return the constraints associated with Data Schema Node
  61      */
  62     ConstraintDefinition getConstraints();
  63 }