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 public interface DataSchemaNodeBuilder extends SchemaNodeBuilder, GroupingMember {
  17
  18
  19
  20     /**
  21      *
  22      * Returns true if product of this builder is added by augmentation.
  23      *
  24      * @return true, if this node is added by augmentation, false otherwise
  25      */
  26     boolean isAugmenting();
  27
  28     /**
  29      * Set if the product of the builder node is introduced by augmentation.
  30      *
  31      * @param augmenting
  32      */
  33     void setAugmenting(boolean augmenting);
  34
  35     /**
  36      * Get value of config statement.
  37      *
  38      * @return value of config statement
  39      */
  40     boolean isConfiguration();
  41
  42     /**
  43      * Set config statement to the product.
  44      *
  45      *
  46      * @param config true if config true was set, false if config false was set.
  47      */
  48     void setConfiguration(boolean config);
  49
  50     /**
  51      * Get constraints of this builder.
  52      *
  53      * @return constraints of this builder
  54      */
  55     ConstraintsBuilder getConstraints();
  56
  57     /**
  58      * Build DataSchemaNode object from this builder.
  59      *
  60      * @return instance of {@link DataSchemaNode} based on the state present in this builder.
  61      */
  62     @Override
  63     DataSchemaNode build();
  64
  65 }