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.Collection;
15 import java.util.Optional;
16 import org.eclipse.jdt.annotation.NonNull;
17 import org.opendaylight.yangtools.yang.common.QName;
18 import org.opendaylight.yangtools.yang.model.api.CaseSchemaNode;
19 import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
20 import org.opendaylight.yangtools.yang.model.api.Status;
21 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
22 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
23 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
24 import org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition;
25 import org.opendaylight.yangtools.yang.model.api.stmt.ChoiceEffectiveStatement;
26 import org.opendaylight.yangtools.yang.model.api.stmt.ChoiceStatement;
27 import org.opendaylight.yangtools.yang.model.api.stmt.DefaultEffectiveStatement;
28 import org.opendaylight.yangtools.yang.model.api.stmt.MandatoryEffectiveStatement;
29 import org.opendaylight.yangtools.yang.model.api.stmt.StatusEffectiveStatement;
30 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatements;
31 import org.opendaylight.yangtools.yang.model.spi.meta.SubstatementIndexingException;
32 import org.opendaylight.yangtools.yang.parser.rfc7950.reactor.YangValidationBundles;
33 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.EffectiveStatementMixins.EffectiveStatementWithFlags.FlagsBuilder;
34 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.case_.CaseStatementSupport;
35 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractSchemaTreeStatementSupport;
36 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
37 import org.opendaylight.yangtools.yang.parser.spi.meta.ImplicitParentAwareStatementSupport;
38 import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
39 import org.opendaylight.yangtools.yang.parser.spi.meta.StatementSupport;
40 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
41 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
42 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
45 public final class ChoiceStatementSupport
46 extends AbstractSchemaTreeStatementSupport<ChoiceStatement, ChoiceEffectiveStatement>
47 implements ImplicitParentAwareStatementSupport {
48 private static final @NonNull ChoiceStatementSupport RFC6020_INSTANCE = new ChoiceStatementSupport(
49 SubstatementValidator.builder(YangStmtMapping.CHOICE)
50 .addAny(YangStmtMapping.ANYXML)
51 .addAny(YangStmtMapping.CASE)
52 .addOptional(YangStmtMapping.CONFIG)
53 .addAny(YangStmtMapping.CONTAINER)
54 .addOptional(YangStmtMapping.DEFAULT)
55 .addOptional(YangStmtMapping.DESCRIPTION)
56 .addAny(YangStmtMapping.IF_FEATURE)
57 .addAny(YangStmtMapping.LEAF)
58 .addAny(YangStmtMapping.LEAF_LIST)
59 .addAny(YangStmtMapping.LIST)
60 .addOptional(YangStmtMapping.MANDATORY)
61 .addOptional(YangStmtMapping.REFERENCE)
62 .addOptional(YangStmtMapping.STATUS)
63 .addOptional(YangStmtMapping.WHEN)
65 CaseStatementSupport.rfc6020Instance());
67 private static final @NonNull ChoiceStatementSupport RFC7950_INSTANCE = new ChoiceStatementSupport(
68 SubstatementValidator.builder(YangStmtMapping.CHOICE)
69 .addAny(YangStmtMapping.ANYDATA)
70 .addAny(YangStmtMapping.ANYXML)
71 .addAny(YangStmtMapping.CASE)
72 .addOptional(YangStmtMapping.CONFIG)
73 .addAny(YangStmtMapping.CONTAINER)
74 .addOptional(YangStmtMapping.DEFAULT)
75 .addOptional(YangStmtMapping.DESCRIPTION)
76 .addAny(YangStmtMapping.IF_FEATURE)
77 .addAny(YangStmtMapping.LEAF)
78 .addAny(YangStmtMapping.LEAF_LIST)
79 .addAny(YangStmtMapping.LIST)
80 .addOptional(YangStmtMapping.MANDATORY)
81 .addOptional(YangStmtMapping.REFERENCE)
82 .addOptional(YangStmtMapping.STATUS)
83 .addOptional(YangStmtMapping.WHEN)
85 CaseStatementSupport.rfc7950Instance());
87 private final SubstatementValidator validator;
88 private final CaseStatementSupport implicitCase;
90 private ChoiceStatementSupport(final SubstatementValidator validator, final CaseStatementSupport implicitCase) {
91 super(YangStmtMapping.CHOICE, instantiatedPolicy());
92 this.validator = requireNonNull(validator);
93 this.implicitCase = requireNonNull(implicitCase);
96 public static @NonNull ChoiceStatementSupport rfc6020Instance() {
97 return RFC6020_INSTANCE;
100 public static @NonNull ChoiceStatementSupport rfc7950Instance() {
101 return RFC7950_INSTANCE;
105 public Optional<StatementSupport<?, ?, ?>> getImplicitParentFor(final StatementDefinition stmtDef) {
106 return YangValidationBundles.SUPPORTED_CASE_SHORTHANDS.contains(stmtDef) ? Optional.of(implicitCase)
111 protected SubstatementValidator getSubstatementValidator() {
116 protected ChoiceStatement createDeclared(@NonNull final StmtContext<QName, ChoiceStatement, ?> ctx,
117 final ImmutableList<? extends DeclaredStatement<?>> substatements) {
118 return DeclaredStatements.createChoice(ctx.getArgument(), substatements);
122 protected ChoiceStatement createEmptyDeclared(@NonNull final StmtContext<QName, ChoiceStatement, ?> ctx) {
123 return DeclaredStatements.createChoice(ctx.getArgument());
127 public ChoiceEffectiveStatement copyEffective(final Current<QName, ChoiceStatement> stmt,
128 final ChoiceEffectiveStatement original) {
129 return new ChoiceEffectiveStatementImpl((ChoiceEffectiveStatementImpl) original,
130 computeFlags(stmt, original.effectiveSubstatements()), stmt.effectivePath(),
131 (ChoiceSchemaNode) stmt.original());
135 protected ChoiceEffectiveStatement createEffective(final Current<QName, ChoiceStatement> stmt,
136 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
137 final String defaultArg = findFirstArgument(substatements, DefaultEffectiveStatement.class, null);
138 final CaseSchemaNode defaultCase;
139 if (defaultArg != null) {
142 qname = QName.create(stmt.getArgument(), defaultArg);
143 } catch (IllegalArgumentException e) {
144 throw new SourceException(stmt, e, "Default statement has invalid name '%s'", defaultArg);
147 // FIXME: this does not work with submodules, as they are
148 defaultCase = InferenceException.throwIfNull(findCase(qname, substatements), stmt,
149 "Default statement refers to missing case %s", qname);
155 return new ChoiceEffectiveStatementImpl(stmt.declared(), substatements, computeFlags(stmt, substatements),
156 stmt.effectivePath(), defaultCase, (ChoiceSchemaNode) stmt.original());
157 } catch (SubstatementIndexingException e) {
158 throw new SourceException(e.getMessage(), stmt, e);
162 private static int computeFlags(final Current<?, ?> stmt,
163 final Collection<? extends EffectiveStatement<?, ?>> substatements) {
164 return new FlagsBuilder()
165 .setHistory(stmt.history())
166 .setStatus(findFirstArgument(substatements, StatusEffectiveStatement.class, Status.CURRENT))
167 .setConfiguration(stmt.effectiveConfig().asNullable())
168 .setMandatory(findFirstArgument(substatements, MandatoryEffectiveStatement.class, Boolean.FALSE))
172 private static CaseSchemaNode findCase(final QName qname,
173 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
174 for (final EffectiveStatement<?, ?> effectiveStatement : substatements) {
175 if (effectiveStatement instanceof CaseSchemaNode) {
176 final CaseSchemaNode choiceCaseNode = (CaseSchemaNode) effectiveStatement;
177 if (qname.equals(choiceCaseNode.getQName())) {
178 return choiceCaseNode;