2 * Copyright (c) 2017 Pantheon Technologies, s.r.o. and others. All rights reserved.
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
8 package org.opendaylight.yangtools.yang.parser.rfc7950.stmt.choice;
10 import static java.util.Objects.requireNonNull;
12 import com.google.common.annotations.Beta;
13 import com.google.common.collect.ImmutableList;
14 import java.util.Optional;
15 import org.eclipse.jdt.annotation.NonNull;
16 import org.opendaylight.yangtools.yang.common.QName;
17 import org.opendaylight.yangtools.yang.model.api.CaseSchemaNode;
18 import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
19 import org.opendaylight.yangtools.yang.model.api.Status;
20 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
21 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
22 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
23 import org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition;
24 import org.opendaylight.yangtools.yang.model.api.stmt.ChoiceEffectiveStatement;
25 import org.opendaylight.yangtools.yang.model.api.stmt.ChoiceStatement;
26 import org.opendaylight.yangtools.yang.model.api.stmt.DefaultEffectiveStatement;
27 import org.opendaylight.yangtools.yang.model.api.stmt.MandatoryEffectiveStatement;
28 import org.opendaylight.yangtools.yang.model.api.stmt.StatusEffectiveStatement;
29 import org.opendaylight.yangtools.yang.parser.rfc7950.reactor.YangValidationBundles;
30 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.BaseSchemaTreeStatementSupport;
31 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.EffectiveStatementMixins.EffectiveStatementWithFlags.FlagsBuilder;
32 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.SubstatementIndexingException;
33 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.case_.CaseStatementSupport;
34 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
35 import org.opendaylight.yangtools.yang.parser.spi.meta.ImplicitParentAwareStatementSupport;
36 import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
37 import org.opendaylight.yangtools.yang.parser.spi.meta.StatementSupport;
38 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
39 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
40 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
43 public final class ChoiceStatementSupport
44 extends BaseSchemaTreeStatementSupport<ChoiceStatement, ChoiceEffectiveStatement>
45 implements ImplicitParentAwareStatementSupport {
46 private static final @NonNull ChoiceStatementSupport RFC6020_INSTANCE = new ChoiceStatementSupport(
47 SubstatementValidator.builder(YangStmtMapping.CHOICE)
48 .addAny(YangStmtMapping.ANYXML)
49 .addAny(YangStmtMapping.CASE)
50 .addOptional(YangStmtMapping.CONFIG)
51 .addAny(YangStmtMapping.CONTAINER)
52 .addOptional(YangStmtMapping.DEFAULT)
53 .addOptional(YangStmtMapping.DESCRIPTION)
54 .addAny(YangStmtMapping.IF_FEATURE)
55 .addAny(YangStmtMapping.LEAF)
56 .addAny(YangStmtMapping.LEAF_LIST)
57 .addAny(YangStmtMapping.LIST)
58 .addOptional(YangStmtMapping.MANDATORY)
59 .addOptional(YangStmtMapping.REFERENCE)
60 .addOptional(YangStmtMapping.STATUS)
61 .addOptional(YangStmtMapping.WHEN)
63 CaseStatementSupport.rfc6020Instance());
65 private static final @NonNull ChoiceStatementSupport RFC7950_INSTANCE = new ChoiceStatementSupport(
66 SubstatementValidator.builder(YangStmtMapping.CHOICE)
67 .addAny(YangStmtMapping.ANYDATA)
68 .addAny(YangStmtMapping.ANYXML)
69 .addAny(YangStmtMapping.CASE)
70 .addOptional(YangStmtMapping.CONFIG)
71 .addAny(YangStmtMapping.CONTAINER)
72 .addOptional(YangStmtMapping.DEFAULT)
73 .addOptional(YangStmtMapping.DESCRIPTION)
74 .addAny(YangStmtMapping.IF_FEATURE)
75 .addAny(YangStmtMapping.LEAF)
76 .addAny(YangStmtMapping.LEAF_LIST)
77 .addAny(YangStmtMapping.LIST)
78 .addOptional(YangStmtMapping.MANDATORY)
79 .addOptional(YangStmtMapping.REFERENCE)
80 .addOptional(YangStmtMapping.STATUS)
81 .addOptional(YangStmtMapping.WHEN)
83 CaseStatementSupport.rfc7950Instance());
85 private final SubstatementValidator validator;
86 private final CaseStatementSupport implicitCase;
88 private ChoiceStatementSupport(final SubstatementValidator validator, final CaseStatementSupport implicitCase) {
89 super(YangStmtMapping.CHOICE, StatementPolicy.legacyDeclaredCopy());
90 this.validator = requireNonNull(validator);
91 this.implicitCase = requireNonNull(implicitCase);
94 public static @NonNull ChoiceStatementSupport rfc6020Instance() {
95 return RFC6020_INSTANCE;
98 public static @NonNull ChoiceStatementSupport rfc7950Instance() {
99 return RFC7950_INSTANCE;
103 public Optional<StatementSupport<?, ?, ?>> getImplicitParentFor(final StatementDefinition stmtDef) {
104 return YangValidationBundles.SUPPORTED_CASE_SHORTHANDS.contains(stmtDef) ? Optional.of(implicitCase)
109 protected SubstatementValidator getSubstatementValidator() {
114 protected ChoiceStatement createDeclared(@NonNull final StmtContext<QName, ChoiceStatement, ?> ctx,
115 final ImmutableList<? extends DeclaredStatement<?>> substatements) {
116 return new RegularChoiceStatement(ctx.getArgument(), substatements);
120 protected ChoiceStatement createEmptyDeclared(@NonNull final StmtContext<QName, ChoiceStatement, ?> ctx) {
121 return new EmptyChoiceStatement(ctx.getArgument());
125 protected ChoiceEffectiveStatement createEffective(final Current<QName, ChoiceStatement> stmt,
126 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
127 final String defaultArg = findFirstArgument(substatements, DefaultEffectiveStatement.class, null);
128 final CaseSchemaNode defaultCase;
129 if (defaultArg != null) {
132 qname = QName.create(stmt.getArgument(), defaultArg);
133 } catch (IllegalArgumentException e) {
134 throw new SourceException(stmt, e, "Default statement has invalid name '%s'", defaultArg);
137 // FIXME: this does not work with submodules, as they are
138 defaultCase = InferenceException.throwIfNull(findCase(qname, substatements), stmt,
139 "Default statement refers to missing case %s", qname);
144 final int flags = new FlagsBuilder()
145 .setHistory(stmt.history())
146 .setStatus(findFirstArgument(substatements, StatusEffectiveStatement.class, Status.CURRENT))
147 .setConfiguration(stmt.effectiveConfig().asNullable())
148 .setMandatory(findFirstArgument(substatements, MandatoryEffectiveStatement.class, Boolean.FALSE))
151 return new ChoiceEffectiveStatementImpl(stmt.declared(), substatements, flags, stmt.wrapSchemaPath(),
152 defaultCase, (ChoiceSchemaNode) stmt.original());
153 } catch (SubstatementIndexingException e) {
154 throw new SourceException(e.getMessage(), stmt, e);
158 private static CaseSchemaNode findCase(final QName qname,
159 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
160 for (final EffectiveStatement<?, ?> effectiveStatement : substatements) {
161 if (effectiveStatement instanceof CaseSchemaNode) {
162 final CaseSchemaNode choiceCaseNode = (CaseSchemaNode) effectiveStatement;
163 if (qname.equals(choiceCaseNode.getQName())) {
164 return choiceCaseNode;