yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/rfc6020/ChoiceStatementImpl.java

   1 /*
   2  * Copyright (c) 2015 Cisco Systems, Inc. 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.stmt.rfc6020;
   9
  10 import java.util.Collection;
  11 import java.util.Optional;
  12 import javax.annotation.Nonnull;
  13 import javax.annotation.Nullable;
  14 import org.opendaylight.yangtools.yang.common.QName;
  15 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
  16 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  17 import org.opendaylight.yangtools.yang.model.api.stmt.CaseStatement;
  18 import org.opendaylight.yangtools.yang.model.api.stmt.ChoiceStatement;
  19 import org.opendaylight.yangtools.yang.model.api.stmt.ConfigStatement;
  20 import org.opendaylight.yangtools.yang.model.api.stmt.DefaultStatement;
  21 import org.opendaylight.yangtools.yang.model.api.stmt.DescriptionStatement;
  22 import org.opendaylight.yangtools.yang.model.api.stmt.IfFeatureStatement;
  23 import org.opendaylight.yangtools.yang.model.api.stmt.MandatoryStatement;
  24 import org.opendaylight.yangtools.yang.model.api.stmt.ReferenceStatement;
  25 import org.opendaylight.yangtools.yang.model.api.stmt.StatusStatement;
  26 import org.opendaylight.yangtools.yang.model.api.stmt.WhenStatement;
  27 import org.opendaylight.yangtools.yang.parser.spi.SubstatementValidator;
  28 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractDeclaredStatement;
  29 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStatementSupport;
  30 import org.opendaylight.yangtools.yang.parser.spi.meta.StatementSupport;
  31 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  32 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
  33 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
  34 import org.opendaylight.yangtools.yang.parser.spi.source.ImplicitSubstatement;
  35 import org.opendaylight.yangtools.yang.parser.spi.source.StatementSourceReference;
  36 import org.opendaylight.yangtools.yang.parser.stmt.reactor.StatementContextBase;
  37 import org.opendaylight.yangtools.yang.parser.stmt.reactor.StatementDefinitionContext;
  38 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.ChoiceEffectiveStatementImpl;
  39
  40 public class ChoiceStatementImpl extends AbstractDeclaredStatement<QName>
  41         implements ChoiceStatement {
  42     private static final SubstatementValidator SUBSTATEMENT_VALIDATOR = SubstatementValidator.builder(YangStmtMapping
  43             .CHOICE)
  44             .addAny(YangStmtMapping.ANYXML)
  45             .addAny(YangStmtMapping.CASE)
  46             .addOptional(YangStmtMapping.CONFIG)
  47             .addAny(YangStmtMapping.CONTAINER)
  48             .addOptional(YangStmtMapping.DEFAULT)
  49             .addOptional(YangStmtMapping.DESCRIPTION)
  50             .addAny(YangStmtMapping.IF_FEATURE)
  51             .addAny(YangStmtMapping.LEAF)
  52             .addAny(YangStmtMapping.LEAF_LIST)
  53             .addAny(YangStmtMapping.LIST)
  54             .addOptional(YangStmtMapping.MANDATORY)
  55             .addOptional(YangStmtMapping.REFERENCE)
  56             .addOptional(YangStmtMapping.STATUS)
  57             .addOptional(YangStmtMapping.WHEN)
  58             .build();
  59
  60     protected ChoiceStatementImpl(final StmtContext<QName, ChoiceStatement, ?> context) {
  61         super(context);
  62     }
  63
  64     public static class Definition extends
  65             AbstractStatementSupport<QName, ChoiceStatement, EffectiveStatement<QName, ChoiceStatement>> {
  66         private static final StatementSupport<?, ?, ?> IMPLICIT_CASE = new CaseStatementImpl.Definition();
  67
  68         public Definition() {
  69             super(YangStmtMapping.CHOICE);
  70         }
  71
  72         @Override
  73         public QName parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
  74             return StmtContextUtils.qnameFromArgument(ctx, value);
  75         }
  76
  77         @Override
  78         public Optional<StatementContextBase<?, ?, ?>> beforeSubStatementCreated(
  79                 final StmtContext.Mutable<?, ?, ?> stmt, final int offset,
  80                 final StatementDefinitionContext<?, ?, ?> def, final StatementSourceReference ref, final String argument) {
  81
  82             if (YangValidationBundles.SUPPORTED_CASE_SHORTHANDS.contains(def.getPublicView())) {
  83                 return Optional.of(createImplicitCase((StatementContextBase<?, ?, ?>) stmt, offset, ref, argument));
  84             }
  85             return Optional.empty();
  86         }
  87
  88         @Override
  89         public void onStatementAdded(
  90                 final Mutable<QName, ChoiceStatement, EffectiveStatement<QName, ChoiceStatement>> stmt) {
  91             stmt.getParentContext().addToNs(ChildSchemaNodes.class, stmt.getStatementArgument(), stmt);
  92         }
  93
  94         @Override
  95         public ChoiceStatement createDeclared(final StmtContext<QName, ChoiceStatement, ?> ctx) {
  96             return new ChoiceStatementImpl(ctx);
  97         }
  98
  99         @Override
 100         public EffectiveStatement<QName, ChoiceStatement> createEffective(
 101                 final StmtContext<QName, ChoiceStatement, EffectiveStatement<QName, ChoiceStatement>> ctx) {
 102             return new ChoiceEffectiveStatementImpl(ctx);
 103         }
 104
 105         @Override
 106         protected SubstatementValidator getSubstatementValidator() {
 107             return SUBSTATEMENT_VALIDATOR;
 108         }
 109
 110         protected StatementSupport<?, ?, ?> implictCase() {
 111             return IMPLICIT_CASE;
 112         }
 113
 114         private StatementContextBase<?, ?, ?> createImplicitCase(final StmtContext.Mutable<?, ?, ?> stmt,
 115                 final int offset, final StatementSourceReference ref, final String argument) {
 116             final StatementDefinitionContext<?, ?, ?> def = new StatementDefinitionContext<>(implictCase());
 117             return ((StatementContextBase<?, ?, ?>) stmt).createSubstatement(offset, def, ImplicitSubstatement.of(ref),
 118                     argument);
 119         }
 120     }
 121
 122     @Nonnull
 123     @Override
 124     public QName getName() {
 125         return argument();
 126     }
 127
 128     @Nullable
 129     @Override
 130     public DefaultStatement getDefault() {
 131         return firstDeclared(DefaultStatement.class);
 132     }
 133
 134     @Nullable
 135     @Override
 136     public ConfigStatement getConfig() {
 137         return firstDeclared(ConfigStatement.class);
 138     }
 139
 140     @Nullable
 141     @Override
 142     public MandatoryStatement getMandatory() {
 143         return firstDeclared(MandatoryStatement.class);
 144     }
 145
 146     @Nonnull
 147     @Override
 148     public Collection<? extends CaseStatement> getCases() {
 149         return allDeclared(CaseStatement.class);
 150     }
 151
 152     @Override
 153     public WhenStatement getWhenStatement() {
 154         return firstDeclared(WhenStatement.class);
 155     }
 156
 157     @Nonnull
 158     @Override
 159     public Collection<? extends IfFeatureStatement> getIfFeatures() {
 160         return allDeclared(IfFeatureStatement.class);
 161     }
 162
 163     @Nullable
 164     @Override
 165     public StatusStatement getStatus() {
 166         return firstDeclared(StatusStatement.class);
 167     }
 168
 169     @Nullable
 170     @Override
 171     public DescriptionStatement getDescription() {
 172         return firstDeclared(DescriptionStatement.class);
 173     }
 174
 175     @Nullable
 176     @Override
 177     public ReferenceStatement getReference() {
 178         return firstDeclared(ReferenceStatement.class);
 179     }
 180 }