Deprecate StmtContext.getSchemaPath()
[yangtools.git] / yang / yang-parser-reactor / src / main / java / org / opendaylight / yangtools / yang / parser / stmt / reactor / SubstatementContext.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 java.util.Optional;
13 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
14 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
15 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
16 import org.opendaylight.yangtools.yang.parser.spi.meta.CopyType;
17 import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceBehaviour.NamespaceStorageNode;
18 import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceBehaviour.StorageNodeType;
19 import org.opendaylight.yangtools.yang.parser.spi.source.StatementSourceReference;
20
21 final class SubstatementContext<A, D extends DeclaredStatement<A>, E extends EffectiveStatement<A, D>> extends
22         AbstractResumedStatement<A, D, E> {
23     private final StatementContextBase<?, ?, ?> parent;
24     private final A argument;
25
26     private SubstatementContext(final SubstatementContext<A, D, E> original,
27             final StatementContextBase<?, ?, ?> parent) {
28         super(original);
29         this.parent = requireNonNull(parent, "Parent must not be null");
30         this.argument = original.argument;
31     }
32
33     SubstatementContext(final StatementContextBase<?, ?, ?> parent, final StatementDefinitionContext<A, D, E> def,
34             final StatementSourceReference ref, final String rawArgument) {
35         super(def, ref, rawArgument);
36         this.parent = requireNonNull(parent, "Parent must not be null");
37         this.argument = def.parseArgumentValue(this, rawStatementArgument());
38     }
39
40     // FIXME: YANGTOOLS-784: this constructor is only called in contexts where a different implementation
41     //                       would be more appropriate
42     SubstatementContext(final StatementContextBase<?, ?, ?> parent, final StatementDefinitionContext<A, D, E> def,
43             final StatementSourceReference ref, final String rawArgument, final A argument, final CopyType copyType) {
44         super(def, ref, rawArgument, copyType);
45         this.parent = requireNonNull(parent, "Parent must not be null");
46         this.argument = argument;
47     }
48
49     @Override
50     SubstatementContext<A, D, E> reparent(final StatementContextBase<?, ?, ?> newParent) {
51         return new SubstatementContext<>(this, newParent);
52     }
53
54     /*
55      * KEEP THINGS ORGANIZED!
56      *
57      * below methods exist in the same form in InferredStatementContext. If any adjustment is made here, make sure it is
58      * properly updated there.
59      */
60     @Override
61     @Deprecated
62     public Optional<SchemaPath> getSchemaPath() {
63         return substatementGetSchemaPath();
64     }
65
66     @Override
67     public A getStatementArgument() {
68         return argument;
69     }
70
71     @Override
72     public StatementContextBase<?, ?, ?> getParentContext() {
73         return parent;
74     }
75
76     @Override
77     public StorageNodeType getStorageNodeType() {
78         return StorageNodeType.STATEMENT_LOCAL;
79     }
80
81     @Override
82     public NamespaceStorageNode getParentNamespaceStorage() {
83         return parent;
84     }
85
86     @Override
87     public RootStatementContext<?, ?, ?> getRoot() {
88         return parent.getRoot();
89     }
90
91     @Override
92     public boolean isConfiguration() {
93         return isConfiguration(parent);
94     }
95
96     @Override
97     protected boolean isIgnoringIfFeatures() {
98         return isIgnoringIfFeatures(parent);
99     }
100
101     @Override
102     protected boolean isIgnoringConfig() {
103         return isIgnoringConfig(parent);
104     }
105
106     @Override
107     protected boolean isParentSupportedByFeatures() {
108         return parent.isSupportedByFeatures();
109     }
110 }