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