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

   1 /*
   2  * Copyright (c) 2018 Pantheon Technoglogies, s.r.o. 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 com.google.common.annotations.Beta;
  11 import java.util.Optional;
  12 import org.eclipse.jdt.annotation.NonNull;
  13 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  14
  15 /**
  16  * Common interface for statements which contain either a description/reference or a description/reference/status combo.
  17  */
  18 @Beta
  19 public interface DocumentedDeclaredStatement<T> extends DeclaredStatement<T> {
  20     /**
  21      * Return description statement, if available.
  22      *
  23      * @return description statement
  24      */
  25     default @NonNull Optional<DescriptionStatement> getDescription() {
  26         return findFirstDeclaredSubstatement(DescriptionStatement.class);
  27     }
  28
  29     /**
  30      * Return description statement, if available.
  31      *
  32      * @return description statement
  33      */
  34     default @NonNull Optional<ReferenceStatement> getReference() {
  35         return findFirstDeclaredSubstatement(ReferenceStatement.class);
  36     }
  37
  38     interface WithStatus<T> extends DocumentedDeclaredStatement<T> {
  39         default @NonNull Optional<StatusStatement> getStatus() {
  40             return findFirstDeclaredSubstatement(StatusStatement.class);
  41         }
  42     }
  43 }