yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/builder/api/UnknownSchemaNodeBuilder.java

   1 /*
   2  * Copyright (c) 2014 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.common.QName;
  11 import org.opendaylight.yangtools.yang.model.api.ExtensionDefinition;
  12 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  13 import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;
  14
  15 public interface UnknownSchemaNodeBuilder extends SchemaNodeBuilder, DocumentedNodeBuilder {
  16
  17     @Override
  18     SchemaPath getPath();
  19
  20     /**
  21      * Returns true if node was added via uses statement
  22      *
  23      * @return true if node was added via uses statement
  24      */
  25     boolean isAddedByUses();
  26
  27     /**
  28      * Sets flag if node was introduced by uses statement
  29      *
  30      * @param addedByUses true if node was introduced by uses, false otherwise
  31      */
  32     void setAddedByUses(boolean addedByUses);
  33
  34     /**
  35      *
  36      * Returns QName associated with this unknown node.
  37      *
  38      * @return QName associated with this unknown node.
  39      */
  40     QName getNodeType();
  41
  42     /**
  43      * Returns string representation of argument associated with this unknown node.
  44      *
  45      * @return string representation of argument associated with this unknown node.
  46      */
  47     String getNodeParameter();
  48
  49     /**
  50      * Sets string representation of argument associated with this unknown node.
  51      * @param nodeParameter string representation of argument associated with this unknown node.
  52      */
  53     void setNodeParameter(String nodeParameter);
  54
  55     /**
  56      * Returns extension definition, which declares this unknown node
  57      * @return extension definition, which declares this unknown node
  58      */
  59     ExtensionDefinition getExtensionDefinition();
  60
  61     /**
  62      * Sets extension definition, which declares this unknown node
  63      * @param extensionDefinition extension definition, which declares this unknown node
  64      */
  65     void setExtensionDefinition(ExtensionDefinition extensionDefinition);
  66
  67     /**
  68      * Returns builder for extension, which declares this unknown node.
  69      *
  70      * @return builder for extension, which declares this unknown node.
  71      */
  72     ExtensionBuilder getExtensionBuilder();
  73
  74     /**
  75      * Sets extension builder, which declares this unknown node
  76      *
  77      * @param extension
  78      *            extension builder, which declares this unknown node
  79      */
  80     void setExtensionBuilder(ExtensionBuilder extension);
  81
  82     @Override
  83     UnknownSchemaNode build();
  84
  85     /**
  86      * Sets node type associated with this unknown schema node
  87      *
  88      * @param qName node type associated with this unknown schema node
  89      */
  90     void setNodeType(QName qName);
  91
  92 }