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