yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/builder/api/SchemaNodeBuilder.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.common.QName;
  11 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
  12 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  13 import org.opendaylight.yangtools.yang.model.api.Status;
  14
  15 /**
  16  * Interface for all builders of SchemaNode nodes.
  17  */
  18 public interface SchemaNodeBuilder extends Builder {
  19
  20     /**
  21      * Get qname of this node.
  22      *
  23      * @return QName of this node
  24      */
  25     QName getQName();
  26
  27     /**
  28      * Get schema path of this node.
  29      *
  30      * @return SchemaPath of this node
  31      */
  32     SchemaPath getPath();
  33
  34     /**
  35      * Get description of this node.
  36      *
  37      * @return description statement
  38      */
  39     String getDescription();
  40
  41     /**
  42      * Set description to this node.
  43      *
  44      * @param description
  45      */
  46     void setDescription(String description);
  47
  48     /**
  49      * Get reference of this node.
  50      *
  51      * @return reference statement
  52      */
  53     String getReference();
  54
  55     /**
  56      * Set reference to this node.
  57      *
  58      * @param reference
  59      */
  60     void setReference(String reference);
  61
  62     /**
  63      * Get status of this node.
  64      *
  65      * @return status statement
  66      */
  67     Status getStatus();
  68
  69     /**
  70      * Set status to this node.
  71      *
  72      * @param status
  73      */
  74     void setStatus(Status status);
  75
  76     /**
  77      * Build SchemaNode object from this builder.
  78      */
  79     SchemaNode build();
  80
  81 }