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