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  * Contains the method which are used for getting metadata from the schema nodes
  13  * which contains data.
  14  *
  15  */
  16 public interface DataSchemaNode extends SchemaNode {
  17
  18     /**
  19      * Returns <code>true</code> if the data node was added by augmentation,
  20      * otherwise returns <code>false</code>
  21      *
  22      * @return <code>true</code> if the data node was added by augmentation,
  23      *         otherwise returns <code>false</code>
  24      */
  25     boolean isAugmenting();
  26
  27     /**
  28      * Returns <code>true</code> if the data node was added by uses statement,
  29      * otherwise returns <code>false</code>
  30      *
  31      * @return <code>true</code> if the data node was added by uses statement,
  32      *         otherwise returns <code>false</code>
  33      */
  34     boolean isAddedByUses();
  35
  36     /**
  37      * Returns <code>true</code> if the data represents configuration data,
  38      * otherwise returns <code>false</code>
  39      *
  40      * @return <code>true</code> if the data represents configuration data,
  41      *         otherwise returns <code>false</code>
  42      */
  43     boolean isConfiguration();
  44
  45     /**
  46      * Returns the constraints associated with Data Schema Node
  47      *
  48      * @return the constraints associated with Data Schema Node
  49      */
  50     ConstraintDefinition getConstraints();
  51 }