2 * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.yangtools.yang.parser.builder.api;
10 import java.util.List;
11 import org.opendaylight.yangtools.concepts.Mutable;
14 * Parent interface for all builder interfaces.
16 public interface Builder extends Mutable {
19 * Returns name of module in which node created by this builder
24 String getModuleName();
27 * Set name of module in which this node is declared.
30 * @deprecated Module name should be set during creation of builder.
33 void setModuleName(String moduleName);
36 * Get current line in yang file, on which statement
37 * associated with this builder was declared.
39 * @return current line in yang file
44 * Returns parent node builder of this node.
46 * @return parent node builder or null if this is top level node
51 * Set parent of this node.
56 void setParent(Builder parent);
59 * Adds an unknown node builder to this builder.
61 * When product (child) is builded by the {@link #build()}
62 * method, this builder is also built and unknown node is added
63 * as child to the product of this builder.
67 void addUnknownNodeBuilder(UnknownSchemaNodeBuilder unknownNode);
70 * Get builders of unknown nodes defined in this node.
72 * @return collection of UnknownSchemaNodeBuilder objects
74 List<UnknownSchemaNodeBuilder> getUnknownNodes();
77 * Build YANG data model node.
79 * This method should create an instance of YANG data model node. After
80 * creating an instance, this instance should be returned for each call
81 * without repeating build process.
83 * @return YANG data model node