yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/DocumentationGroup.java

   1 /*
   2  * Copyright (c) 2015 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.model.api.stmt;
   9
  10 import javax.annotation.Nullable;
  11
  12 /**
  13  * Common interface for statements which contain either a description/reference or a description/reference/status combo.
  14  */
  15 public interface DocumentationGroup {
  16     /**
  17      * Return description statement, if available.
  18      *
  19      * @return description statement
  20      */
  21     @Nullable DescriptionStatement getDescription();
  22
  23     /**
  24      * Return description statement, if available.
  25      *
  26      * @return description statement
  27      */
  28     @Nullable ReferenceStatement getReference();
  29
  30     interface WithStatus extends DocumentationGroup {
  31
  32         @Nullable StatusStatement getStatus();
  33     }
  34 }