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. Unlike what
  12  * the name would suggest, this interface corresponds more to RFC7950 {@code data definition statement} than to
  13  * {@code data node}, yet it notably does not include {@link UsesNode} and {@link AugmentationSchemaNode}, which are
  14  * resolved separately.
  15  *
  16  * <p>
  17  * Common interface is composed of {@link #isConfiguration()}, governing validity in config/operation data stores
  18  * and {@link WhenConditionAware} mixin, which governs validity based on other document data.
  19  *
  20  * @see ContainerSchemaNode
  21  * @see ListSchemaNode
  22  * @see LeafListSchemaNode
  23  * @see ChoiceSchemaNode
  24  * @see CaseSchemaNode
  25  * @see LeafSchemaNode
  26  * @see AnyxmlSchemaNode
  27  * @see AnydataSchemaNode
  28  */
  29 public interface DataSchemaNode extends SchemaNode, CopyableNode, WhenConditionAware {
  30     /**
  31      * Returns <code>true</code> if the data represents configuration data,
  32      * otherwise returns <code>false</code>.
  33      *
  34      * @return <code>true</code> if the data represents configuration data,
  35      *         otherwise returns <code>false</code>
  36      */
  37     boolean isConfiguration();
  38 }