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