yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/builder/api/Builder.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 java.util.List;
  11 import org.opendaylight.yangtools.concepts.Mutable;
  12
  13 /**
  14  * Parent interface for all builder interfaces.
  15  */
  16 public interface Builder extends Mutable {
  17
  18     /**
  19      * Returns name of module in which node created by this builder
  20      * was declared.
  21      *
  22      * @return module name
  23      */
  24     String getModuleName();
  25
  26     /**
  27      * Get current line in yang file, on which statement
  28      * associated with this builder was declared.
  29      *
  30      * @return current line in yang file
  31      */
  32     int getLine();
  33
  34     /**
  35      * Returns parent node builder of this node.
  36      *
  37      * @return parent node builder or null if this is top level node
  38      */
  39     Builder getParent();
  40
  41     /**
  42      * Set parent of this node.
  43      *
  44      * @param parent
  45      *            parent node builder
  46      */
  47     void setParent(Builder parent);
  48
  49     /**
  50      * Adds an unknown node builder to this builder.
  51      *
  52      * When product (child) is builded by the {@link #build()}
  53      * method, this builder is also built and unknown node is added
  54      * as child to the product of this builder.
  55      *
  56      * @param unknownNode an unknown node builder
  57      */
  58     void addUnknownNodeBuilder(UnknownSchemaNodeBuilder unknownNode);
  59
  60     /**
  61      * Get builders of unknown nodes defined in this node.
  62      *
  63      * @return collection of UnknownSchemaNodeBuilder objects
  64      */
  65     List<UnknownSchemaNodeBuilder> getUnknownNodes();
  66
  67     /**
  68      * Build YANG data model node.
  69      *
  70      * This method should create an instance of YANG data model node. After
  71      * creating an instance, this instance should be returned for each call
  72      * without repeating build process.
  73      *
  74      * @return YANG data model node
  75      */
  76     Object build();
  77
  78 }