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