yang/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/AbstractEffectiveDocumentedNode.java

   1 /*
   2  * Copyright (c) 2019 PANTHEON.tech, 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.parser.rfc7950.stmt;
   9
  10 import com.google.common.annotations.Beta;
  11 import java.util.Optional;
  12 import org.eclipse.jdt.annotation.Nullable;
  13 import org.opendaylight.yangtools.yang.model.api.DocumentedNode;
  14 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  15 import org.opendaylight.yangtools.yang.model.api.stmt.DescriptionEffectiveStatement;
  16 import org.opendaylight.yangtools.yang.model.api.stmt.ReferenceEffectiveStatement;
  17 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  18
  19 @Beta
  20 @Deprecated(forRemoval = true)
  21 // FIXME: 6.0.0: fold this into AbstractEffectiveDocumentedNodeWithStatus
  22 public abstract class AbstractEffectiveDocumentedNode<A, D extends DeclaredStatement<A>>
  23         extends DeclaredEffectiveStatementBase<A, D> implements DocumentedNode {
  24     private final @Nullable String description;
  25     private final @Nullable String reference;
  26
  27     protected AbstractEffectiveDocumentedNode(final StmtContext<A, D, ?> ctx) {
  28         super(ctx);
  29         description = findFirstEffectiveSubstatementArgument(DescriptionEffectiveStatement.class).orElse(null);
  30         reference = findFirstEffectiveSubstatementArgument(ReferenceEffectiveStatement.class).orElse(null);
  31     }
  32
  33     @Override
  34     public final Optional<String> getDescription() {
  35         return Optional.ofNullable(description);
  36     }
  37
  38     @Override
  39     public final Optional<String> getReference() {
  40         return Optional.ofNullable(reference);
  41     }
  42
  43     protected final @Nullable String nullableDescription() {
  44         return description;
  45     }
  46
  47     protected final @Nullable String nullableReference() {
  48         return reference;
  49     }
  50 }