yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/builder/api/DocumentedNodeBuilder.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.model.api.Status;
  11
  12 /**
  13  * Mixin-style builder interfac for nodes, which may have documentation attached.
  14  *
  15  **/
  16 public interface DocumentedNodeBuilder {
  17
  18     /**
  19      * Returns description of resulting schema node
  20      * as was defined by description statement.
  21      *
  22      * @return description statement
  23      */
  24     String getDescription();
  25
  26     /**
  27      * Set description to this node.
  28      *
  29      * @param description description of this node
  30      */
  31     void setDescription(String description);
  32
  33     /**
  34      * Get reference of this node.
  35      *
  36      * @return reference statement
  37      */
  38     String getReference();
  39
  40     /**
  41      * Set reference to this node.
  42      *
  43      * @param reference reference to this node
  44      */
  45     void setReference(String reference);
  46
  47     /**
  48      * Get status of this node.
  49      *
  50      * @return status statement
  51      */
  52     Status getStatus();
  53
  54     /**
  55      * Set status to this node.
  56      *
  57      * @param status status of this node
  58      */
  59     void setStatus(Status status);
  60 }