YANGTOOLS-706: Split up base utility classes into rfc6020.util
[yangtools.git] / yang / yang-parser-impl / src / main / java / org / opendaylight / yangtools / yang / parser / rfc6020 / util / AbstractEffectiveDocumentedNode.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.parser.rfc6020.util;
9
10 import java.util.Optional;
11 import javax.annotation.Nonnull;
12 import org.opendaylight.yangtools.yang.model.api.DocumentedNode;
13 import org.opendaylight.yangtools.yang.model.api.Status;
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.model.api.stmt.StatusEffectiveStatement;
18 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
19
20 public abstract class AbstractEffectiveDocumentedNode<A, D extends DeclaredStatement<A>>
21         extends DeclaredEffectiveStatementBase<A, D> implements DocumentedNode.WithStatus {
22
23     private final String description;
24     private final String reference;
25     private final Status status;
26
27     /**
28      * Constructor.
29      *
30      * @param ctx
31      *            context of statement.
32      */
33     protected AbstractEffectiveDocumentedNode(final StmtContext<A, D, ?> ctx) {
34         super(ctx);
35
36         final DescriptionEffectiveStatement descStmt = firstEffective(DescriptionEffectiveStatement.class);
37         if (descStmt != null) {
38             description = descStmt.argument();
39         } else {
40             description = null;
41         }
42
43         final ReferenceEffectiveStatement refStmt = firstEffective(ReferenceEffectiveStatement.class);
44         if (refStmt != null) {
45             reference = refStmt.argument();
46         } else {
47             reference = null;
48         }
49
50         final StatusEffectiveStatement statusStmt = firstEffective(StatusEffectiveStatement.class);
51         if (statusStmt != null) {
52             status = statusStmt.argument();
53         } else {
54             status = Status.CURRENT;
55         }
56     }
57
58     @Override
59     public final Optional<String> getDescription() {
60         return Optional.ofNullable(description);
61     }
62
63     @Override
64     public final Optional<String> getReference() {
65         return Optional.ofNullable(reference);
66     }
67
68     @Nonnull
69     @Override
70     public final Status getStatus() {
71         return status;
72     }
73 }