Cleanup StmtContext nullness annotations
[yangtools.git] / yang / yang-parser-reactor / src / main / java / org / opendaylight / yangtools / yang / parser / stmt / reactor / StatementDefinitionContext.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.stmt.reactor;
9
10 import static java.util.Objects.requireNonNull;
11
12 import com.google.common.base.MoreObjects;
13 import com.google.common.base.MoreObjects.ToStringHelper;
14 import java.util.HashMap;
15 import java.util.Map;
16 import java.util.Optional;
17 import org.eclipse.jdt.annotation.NonNull;
18 import org.opendaylight.yangtools.yang.common.QName;
19 import org.opendaylight.yangtools.yang.common.QNameModule;
20 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
21 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
22 import org.opendaylight.yangtools.yang.model.api.meta.IdentifierNamespace;
23 import org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition;
24 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase;
25 import org.opendaylight.yangtools.yang.parser.spi.meta.StatementFactory;
26 import org.opendaylight.yangtools.yang.parser.spi.meta.StatementSupport;
27 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
28 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
29
30 public class StatementDefinitionContext<A, D extends DeclaredStatement<A>, E extends EffectiveStatement<A, D>> {
31     private final @NonNull StatementSupport<A, D, E> support;
32     private final Map<String, StatementDefinitionContext<?, ?, ?>> argumentSpecificSubDefinitions;
33     private Map<StatementDefinitionContext<?, ?, ?>, StatementDefinitionContext<?,?,?>> unknownStmtDefsOfYangStmts;
34
35     public StatementDefinitionContext(final StatementSupport<A, D, E> support) {
36         this.support = requireNonNull(support);
37         this.argumentSpecificSubDefinitions = support.hasArgumentSpecificSupports() ? new HashMap<>() : null;
38     }
39
40     public @NonNull StatementFactory<A, D, E> getFactory() {
41         return support;
42     }
43
44     public A parseArgumentValue(final StmtContext<A, D, E> context, final String value) {
45         return support.parseArgumentValue(context, value);
46     }
47
48     public A adaptArgumentValue(final StmtContext<A, D, E> context, final QNameModule targetModule) {
49         return support.adaptArgumentValue(context, targetModule);
50     }
51
52     public void checkNamespaceAllowed(final Class<? extends IdentifierNamespace<?,?>> namespace) {
53         // Noop
54     }
55
56     public @NonNull StatementDefinition getPublicView() {
57         return support.getPublicView();
58     }
59
60     public Optional<StatementSupport<?, ?, ?>> getImplicitParentFor(final StatementDefinition stmtDef) {
61         return support.getImplicitParentFor(stmtDef);
62     }
63
64     public boolean onStatementAdded(final Mutable<A, D, E> stmt) {
65         support.onStatementAdded(stmt);
66         return false;
67     }
68
69     public void onDeclarationFinished(final Mutable<A, D, E> statement, final ModelProcessingPhase phase) {
70         switch (phase) {
71             case SOURCE_PRE_LINKAGE:
72                 support.onPreLinkageDeclared(statement);
73                 break;
74             case SOURCE_LINKAGE:
75                 support.onLinkageDeclared(statement);
76                 break;
77             case STATEMENT_DEFINITION:
78                 support.onStatementDefinitionDeclared(statement);
79                 break;
80             case FULL_DECLARATION:
81                 support.onFullDefinitionDeclared(statement);
82                 break;
83             default:
84                 break;
85         }
86     }
87
88     public @NonNull Class<?> getRepresentingClass() {
89         return support.getDeclaredRepresentationClass();
90     }
91
92     public boolean hasArgument() {
93         return support.getArgumentName() != null;
94     }
95
96     public boolean isArgumentYinElement() {
97         return support.isArgumentYinElement();
98     }
99
100     public @NonNull QName getStatementName() {
101         return support.getStatementName();
102     }
103
104     public QName getArgumentName() {
105         return support.getArgumentName();
106     }
107
108     @Override
109     public final String toString() {
110         return addToStringAttributes(MoreObjects.toStringHelper(this).omitNullValues()).toString();
111     }
112
113     protected ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
114         return toStringHelper.add("statement", getStatementName());
115     }
116
117     @NonNull StatementDefinitionContext<?, ?, ?> getSubDefinitionSpecificForArgument(final String argument) {
118         if (!hasArgumentSpecificSubDefinitions()) {
119             return this;
120         }
121
122         StatementDefinitionContext<?, ?, ?> potential = argumentSpecificSubDefinitions.get(argument);
123         if (potential == null) {
124             final StatementSupport<?, ?, ?> argumentSpecificSupport = support.getSupportSpecificForArgument(argument);
125             potential = argumentSpecificSupport != null ? new StatementDefinitionContext<>(argumentSpecificSupport)
126                     : this;
127             argumentSpecificSubDefinitions.put(argument, potential);
128         }
129
130         return potential;
131     }
132
133     boolean hasArgumentSpecificSubDefinitions() {
134         return support.hasArgumentSpecificSupports();
135     }
136
137     String internArgument(final String rawArgument) {
138         return support.internArgument(rawArgument);
139     }
140
141     StatementDefinitionContext<?, ?, ?> getAsUnknownStatementDefinition(
142             final StatementDefinitionContext<?, ?, ?> yangStmtDef) {
143         if (unknownStmtDefsOfYangStmts != null) {
144             final StatementDefinitionContext<?, ?, ?> existing = unknownStmtDefsOfYangStmts.get(yangStmtDef);
145             if (existing != null) {
146                 return existing;
147             }
148         } else {
149             unknownStmtDefsOfYangStmts = new HashMap<>();
150         }
151
152         @SuppressWarnings("unchecked")
153         final StatementDefinitionContext<?, ?, ?> ret = support.getUnknownStatementDefinitionOf(
154             yangStmtDef.getPublicView()).map(StatementDefinitionContext::new).orElse(null);
155         if (ret != null) {
156             unknownStmtDefsOfYangStmts.put(yangStmtDef, ret);
157         }
158         return ret;
159     }
160
161     boolean isIgnoringIfFeatures() {
162         return support.isIgnoringIfFeatures();
163     }
164
165     boolean isIgnoringConfig() {
166         return support.isIgnoringConfig();
167     }
168 }