opendaylight/sal/yang-prototype/yang/yang-model-parser-impl/src/main/java/org/opendaylight/controller/yang/parser/builder/api/SchemaNodeBuilder.java

   1 /*\r
   2  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.\r
   3  *\r
   4  * This program and the accompanying materials are made available under the\r
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,\r
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html\r
   7  */\r
   8 package org.opendaylight.controller.yang.parser.builder.api;\r
   9 \r
  10 import org.opendaylight.controller.yang.common.QName;\r
  11 import org.opendaylight.controller.yang.model.api.SchemaNode;\r
  12 import org.opendaylight.controller.yang.model.api.SchemaPath;\r
  13 import org.opendaylight.controller.yang.model.api.Status;\r
  14 \r
  15 /**\r
  16  * Interface for all builders of SchemaNode nodes.\r
  17  */\r
  18 public interface SchemaNodeBuilder extends Builder {\r
  19 \r
  20     /**\r
  21      * Get qname of this node.\r
  22      *\r
  23      * @return QName of this node\r
  24      */\r
  25     QName getQName();\r
  26 \r
  27     /**\r
  28      * Get schema path of this node.\r
  29      *\r
  30      * @return SchemaPath of this node\r
  31      */\r
  32     SchemaPath getPath();\r
  33 \r
  34     /**\r
  35      * Set schema path to this node.\r
  36      *\r
  37      * @param schemaPath\r
  38      */\r
  39     void setPath(SchemaPath schemaPath);\r
  40 \r
  41     /**\r
  42      * Get description of this node.\r
  43      *\r
  44      * @return description statement\r
  45      */\r
  46     String getDescription();\r
  47 \r
  48     /**\r
  49      * Set description to this node.\r
  50      *\r
  51      * @param description\r
  52      */\r
  53     void setDescription(String description);\r
  54 \r
  55     /**\r
  56      * Get reference of this node.\r
  57      *\r
  58      * @return reference statement\r
  59      */\r
  60     String getReference();\r
  61 \r
  62     /**\r
  63      * Set reference to this node.\r
  64      *\r
  65      * @param reference\r
  66      */\r
  67     void setReference(String reference);\r
  68 \r
  69     /**\r
  70      * Get status of this node.\r
  71      *\r
  72      * @return status statement\r
  73      */\r
  74     Status getStatus();\r
  75 \r
  76     /**\r
  77      * Set status to this node.\r
  78      *\r
  79      * @param status\r
  80      */\r
  81     void setStatus(Status status);\r
  82 \r
  83     /**\r
  84      * Build SchemaNode object from this builder.\r
  85      */\r
  86     SchemaNode build();\r
  87 \r
  88 }\r