yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/builder/api/DataSchemaNodeBuilder.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.parser.builder.api;
   9
  10 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  11
  12 /**
  13  * Interface for all yang data-schema nodes [anyxml, case, container, grouping,
  14  * list, module, notification].
  15  *
  16  * @deprecated Pre-Beryllium implementation, scheduled for removal.
  17  */
  18 @Deprecated
  19 public interface DataSchemaNodeBuilder extends SchemaNodeBuilder, GroupingMember {
  20
  21     /**
  22      * Get original builder definition from grouping, where it is defined.
  23      *
  24      * @return original builder definition from grouping if this node is added
  25      *         by uses, null otherwise
  26      */
  27     SchemaNodeBuilder getOriginal();
  28
  29     /**
  30      * Set original builder definition from grouping
  31      *
  32      * @param original
  33      *            original builder definition from grouping
  34      */
  35     void setOriginal(SchemaNodeBuilder original);
  36
  37     /**
  38      *
  39      * Returns true if product of this builder is added by augmentation.
  40      *
  41      * @return true, if this node is added by augmentation, false otherwise
  42      */
  43     boolean isAugmenting();
  44
  45     /**
  46      * Set if the product of the builder node is introduced by augmentation.
  47      *
  48      * @param augmenting information about augmentation
  49      */
  50     void setAugmenting(boolean augmenting);
  51
  52     /**
  53      * Get value of config statement.
  54      *
  55      * @return value of config statement
  56      */
  57     boolean isConfiguration();
  58
  59     /**
  60      * Set config statement to the product.
  61      *
  62      *
  63      * @param config true if config true was set, false if config false was set.
  64      */
  65     void setConfiguration(boolean config);
  66
  67     /**
  68      * Get constraints of this builder.
  69      *
  70      * @return constraints of this builder
  71      */
  72     ConstraintsBuilder getConstraints();
  73
  74     /**
  75      * Build DataSchemaNode object from this builder.
  76      *
  77      * @return instance of {@link DataSchemaNode} based on the state present in this builder.
  78      */
  79     @Override
  80     DataSchemaNode build();
  81
  82 }