Populate xpath/ hierarchy
[yangtools.git] / yang / yang-parser-rfc7950 / src / main / java / org / opendaylight / yangtools / yang / parser / rfc7950 / stmt / meta / AbstractImplicitStatementSupport.java
1 /*
2  * Copyright (c) 2020 PANTHEON.tech, s.r.o. 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.rfc7950.stmt.meta;
9
10 import static java.util.Objects.requireNonNull;
11
12 import com.google.common.collect.ImmutableList;
13 import org.eclipse.jdt.annotation.NonNull;
14 import org.opendaylight.yangtools.yang.common.QName;
15 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
16 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
17 import org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition;
18 import org.opendaylight.yangtools.yang.model.api.meta.StatementOrigin;
19 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaTreeEffectiveStatement;
20 import org.opendaylight.yangtools.yang.parser.api.YangParserConfiguration;
21 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractSchemaTreeStatementSupport;
22 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
23 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
24
25 /**
26  * A massively-misnamed superclass for statements which are both schema tree participants and can be created as implicit
27  * nodes. This covers {@code case}, {@code input} and {@code output} statements.
28  *
29  * @param <D> Declared Statement representation
30  * @param <E> Effective Statement representation
31  */
32 abstract class AbstractImplicitStatementSupport<D extends DeclaredStatement<QName>,
33         E extends SchemaTreeEffectiveStatement<D>> extends AbstractSchemaTreeStatementSupport<D, E> {
34     AbstractImplicitStatementSupport(final StatementDefinition publicDefinition, final StatementPolicy<QName, D> policy,
35             final YangParserConfiguration config, final SubstatementValidator validator) {
36         super(publicDefinition, policy, config, requireNonNull(validator));
37     }
38
39     @Override
40     public final E copyEffective(final Current<QName, D> stmt, final E original) {
41         final StatementOrigin source = stmt.origin();
42         switch (source) {
43             case CONTEXT:
44                 return copyUndeclaredEffective(stmt, original);
45             case DECLARATION:
46                 return copyDeclaredEffective(stmt, original);
47             default:
48                 throw new IllegalStateException("Unhandled statement source " + source);
49         }
50     }
51
52     @Override
53     protected E createEffective(final Current<QName, D> stmt,
54             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
55         final StatementOrigin origin = stmt.origin();
56         switch (origin) {
57             case CONTEXT:
58                 return createUndeclaredEffective(stmt, substatements);
59             case DECLARATION:
60                 return createDeclaredEffective(stmt, substatements);
61             default:
62                 throw new IllegalStateException("Unhandled statement origin " + origin);
63         }
64     }
65
66     abstract @NonNull E copyDeclaredEffective(@NonNull Current<QName, D> stmt, @NonNull E original);
67
68     abstract @NonNull E copyUndeclaredEffective(@NonNull Current<QName, D> stmt, @NonNull E original);
69
70     abstract @NonNull E createDeclaredEffective(@NonNull Current<QName, D> stmt,
71             @NonNull ImmutableList<? extends EffectiveStatement<?, ?>> substatements);
72
73     abstract @NonNull E createUndeclaredEffective(@NonNull Current<QName, D> stmt,
74             @NonNull ImmutableList<? extends EffectiveStatement<?, ?>> substatements);
75 }