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