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 definitions are derived.
  12  *
  13  * <p>
  14  * Common interface is composed of {@link #isConfiguration()}, governing validity in config/operation data stores
  15  * and {@link WhenConditionAware} mixin, which governs validity based on other document data.
  16  *
  17  * @see ContainerSchemaNode
  18  * @see ListSchemaNode
  19  * @see LeafListSchemaNode
  20  * @see ChoiceSchemaNode
  21  * @see ChoiceCaseNode
  22  * @see LeafSchemaNode
  23  * @see AnyXmlSchemaNode
  24  * @see AnyDataSchemaNode
  25  */
  26 public interface DataSchemaNode extends SchemaNode, CopyableNode, WhenConditionAware {
  27     /**
  28      * Returns <code>true</code> if the data represents configuration data,
  29      * otherwise returns <code>false</code>.
  30      *
  31      * @return <code>true</code> if the data represents configuration data,
  32      *         otherwise returns <code>false</code>
  33      */
  34     boolean isConfiguration();
  35
  36     /**
  37      * Returns the constraints associated with Data Schema Node.
  38      *
  39      * @return the constraints associated with Data Schema Node
  40      */
  41     ConstraintDefinition getConstraints();
  42 }