Teach YANG parser to retain DeclarationReference
[yangtools.git] / yang / yang-parser-rfc7950 / src / main / java / org / opendaylight / yangtools / yang / parser / rfc7950 / stmt / type / UnionSpecificationSupport.java
1 /*
2  * Copyright (c) 2017 Pantheon Technologies, 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.type;
9
10 import com.google.common.collect.ImmutableList;
11 import org.eclipse.jdt.annotation.NonNull;
12 import org.opendaylight.yangtools.yang.common.QName;
13 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
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.stmt.TypeEffectiveStatement;
17 import org.opendaylight.yangtools.yang.model.api.stmt.TypeStatement.UnionSpecification;
18 import org.opendaylight.yangtools.yang.model.parser.api.YangParserConfiguration;
19 import org.opendaylight.yangtools.yang.model.ri.type.BaseTypes;
20 import org.opendaylight.yangtools.yang.model.ri.type.UnionTypeBuilder;
21 import org.opendaylight.yangtools.yang.parser.spi.meta.CommonStmtCtx;
22 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
23 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
24 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
25 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
26
27 final class UnionSpecificationSupport extends AbstractTypeSupport<UnionSpecification> {
28     private static final SubstatementValidator SUBSTATEMENT_VALIDATOR =
29         SubstatementValidator.builder(YangStmtMapping.TYPE).addMultiple(YangStmtMapping.TYPE).build();
30
31     UnionSpecificationSupport(final YangParserConfiguration config) {
32         super(config);
33     }
34
35     @Override
36     protected SubstatementValidator getSubstatementValidator() {
37         return SUBSTATEMENT_VALIDATOR;
38     }
39
40     @Override
41     protected UnionSpecification createDeclared(final StmtContext<QName, UnionSpecification, ?> ctx,
42             final ImmutableList<? extends DeclaredStatement<?>> substatements) {
43         if (substatements.isEmpty()) {
44             throw noType(ctx);
45         }
46         return new UnionSpecificationImpl(ctx.getRawArgument(), ctx.getArgument(), substatements);
47     }
48
49     @Override
50     protected EffectiveStatement<QName, UnionSpecification> createEffective(
51             final Current<QName, UnionSpecification> stmt,
52             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
53         if (substatements.isEmpty()) {
54             throw noType(stmt);
55         }
56
57         final UnionTypeBuilder builder = BaseTypes.unionTypeBuilder(stmt.argumentAsTypeQName());
58
59         for (final EffectiveStatement<?, ?> subStmt : substatements) {
60             if (subStmt instanceof TypeEffectiveStatement) {
61                 builder.addType(((TypeEffectiveStatement<?>)subStmt).getTypeDefinition());
62             }
63         }
64
65         return new TypeEffectiveStatementImpl<>(stmt.declared(), substatements, builder);
66     }
67
68     private static SourceException noType(final @NonNull CommonStmtCtx stmt) {
69         /*
70          *  https://tools.ietf.org/html/rfc7950#section-9.12
71          *
72          *     When the type is "union", the "type" statement (Section 7.4) MUST be
73          *     present.
74          */
75         return new SourceException("At least one type statement has to be present", stmt);
76     }
77 }