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  * @deprecated Pre-Beryllium implementation, scheduled for removal.
  16  */
  17 @Deprecated
  18 public interface DocumentedNodeBuilder {
  19
  20     /**
  21      * Returns description of resulting schema node
  22      * as was defined by description statement.
  23      *
  24      * @return description statement
  25      */
  26     String getDescription();
  27
  28     /**
  29      * Set description to this node.
  30      *
  31      * @param description description of this node
  32      */
  33     void setDescription(String description);
  34
  35     /**
  36      * Get reference of this node.
  37      *
  38      * @return reference statement
  39      */
  40     String getReference();
  41
  42     /**
  43      * Set reference to this node.
  44      *
  45      * @param reference reference to this node
  46      */
  47     void setReference(String reference);
  48
  49     /**
  50      * Get status of this node.
  51      *
  52      * @return status statement
  53      */
  54     Status getStatus();
  55
  56     /**
  57      * Set status to this node.
  58      *
  59      * @param status status of this node
  60      */
  61     void setStatus(Status status);
  62 }