Migrate DocumentedNode/Status to JDT annotations
[yangtools.git] / yang / yang-parser-rfc7950 / src / main / java / org / opendaylight / yangtools / yang / parser / rfc7950 / stmt / UnknownEffectiveStatementBase.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
9 package org.opendaylight.yangtools.yang.parser.rfc7950.stmt;
10
11 import com.google.common.base.Preconditions;
12 import com.google.common.collect.ImmutableList;
13 import com.google.common.collect.ImmutableList.Builder;
14 import java.util.List;
15 import javax.annotation.Nonnull;
16 import org.eclipse.jdt.annotation.NonNull;
17 import org.opendaylight.yangtools.yang.common.QName;
18 import org.opendaylight.yangtools.yang.model.api.ExtensionDefinition;
19 import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;
20 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
21 import org.opendaylight.yangtools.yang.model.api.stmt.ExtensionStatement;
22 import org.opendaylight.yangtools.yang.model.api.stmt.UnknownStatement;
23 import org.opendaylight.yangtools.yang.parser.spi.ExtensionNamespace;
24 import org.opendaylight.yangtools.yang.parser.spi.meta.CopyHistory;
25 import org.opendaylight.yangtools.yang.parser.spi.meta.CopyType;
26 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
27
28 public abstract class UnknownEffectiveStatementBase<A, D extends UnknownStatement<A>>
29         extends AbstractSchemaEffectiveDocumentedNode<A, D> implements UnknownSchemaNode {
30
31     private final boolean addedByUses;
32     private final boolean addedByAugmentation;
33
34     private final ExtensionDefinition extension;
35     private final @NonNull List<UnknownSchemaNode> unknownNodes;
36     private final QName nodeType;
37     private final String nodeParameter;
38
39     protected UnknownEffectiveStatementBase(final StmtContext<A, D, ?> ctx) {
40         super(ctx);
41
42         final StmtContext<?, ExtensionStatement, EffectiveStatement<QName, ExtensionStatement>> extensionInit =
43                 ctx.getFromNamespace(ExtensionNamespace.class, ctx.getPublicDefinition().getStatementName());
44
45         if (extensionInit == null) {
46             extension = null;
47             nodeType = ctx.getPublicDefinition().getStatementName();
48         } else {
49             final EffectiveStatement<QName, ExtensionStatement> effective = extensionInit.buildEffective();
50             Preconditions.checkState(effective instanceof ExtensionDefinition,
51                 "Statement %s is not an ExtensionDefinition", effective);
52             extension = (ExtensionDefinition) extensionInit.buildEffective();
53             nodeType = null;
54         }
55
56         // initCopyType
57         final CopyHistory copyTypesFromOriginal = ctx.getCopyHistory();
58         if (copyTypesFromOriginal.contains(CopyType.ADDED_BY_USES_AUGMENTATION)) {
59             this.addedByAugmentation = true;
60             this.addedByUses = true;
61         } else {
62             this.addedByAugmentation = copyTypesFromOriginal.contains(CopyType.ADDED_BY_AUGMENTATION);
63             this.addedByUses = copyTypesFromOriginal.contains(CopyType.ADDED_BY_USES);
64         }
65
66         nodeParameter = ctx.rawStatementArgument() == null ? "" : ctx.rawStatementArgument();
67
68         // TODO init other fields (see Bug1412Test)
69         final Builder<UnknownSchemaNode> builder = ImmutableList.builder();
70         for (final EffectiveStatement<?, ?> effectiveStatement : effectiveSubstatements()) {
71             if (effectiveStatement instanceof UnknownSchemaNode) {
72                 builder.add((UnknownSchemaNode) effectiveStatement);
73             }
74         }
75         unknownNodes = builder.build();
76     }
77
78     @Deprecated
79     @Override
80     public boolean isAddedByAugmentation() {
81         return addedByAugmentation;
82     }
83
84     @Override
85     public QName getNodeType() {
86         return extension == null ? nodeType : extension.getQName();
87     }
88
89     @Override
90     public String getNodeParameter() {
91         return nodeParameter;
92     }
93
94     @Deprecated
95     @Override
96     public boolean isAddedByUses() {
97         return addedByUses;
98     }
99
100     @Override
101     public ExtensionDefinition getExtensionDefinition() {
102         return extension;
103     }
104
105     @Nonnull
106     @Override
107     public List<UnknownSchemaNode> getUnknownSchemaNodes() {
108         return unknownNodes;
109     }
110
111     @Override
112     public String toString() {
113         final QName type = getNodeType();
114         return String.valueOf(type.getNamespace()) + ":" + type.getLocalName() + " " + nodeParameter;
115     }
116 }