parser/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/meta/ContainerStatementSupport.java

   1 /*
   2  * Copyright (c) 2017 Pantheon Technologies, s.r.o. 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.rfc7950.stmt.meta;
   9
  10 import com.google.common.annotations.Beta;
  11 import com.google.common.collect.ImmutableList;
  12 import java.util.Collection;
  13 import org.eclipse.jdt.annotation.NonNull;
  14 import org.opendaylight.yangtools.yang.common.QName;
  15 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
  16 import org.opendaylight.yangtools.yang.model.api.Status;
  17 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
  18 import org.opendaylight.yangtools.yang.model.api.meta.DeclarationReference;
  19 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  20 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  21 import org.opendaylight.yangtools.yang.model.api.stmt.ContainerEffectiveStatement;
  22 import org.opendaylight.yangtools.yang.model.api.stmt.ContainerStatement;
  23 import org.opendaylight.yangtools.yang.model.api.stmt.PresenceEffectiveStatement;
  24 import org.opendaylight.yangtools.yang.model.api.stmt.StatusEffectiveStatement;
  25 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatementDecorators;
  26 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatements;
  27 import org.opendaylight.yangtools.yang.model.ri.stmt.EffectiveStatements;
  28 import org.opendaylight.yangtools.yang.model.spi.meta.EffectiveStatementMixins.EffectiveStatementWithFlags.FlagsBuilder;
  29 import org.opendaylight.yangtools.yang.model.spi.meta.SubstatementIndexingException;
  30 import org.opendaylight.yangtools.yang.parser.api.YangParserConfiguration;
  31 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.EffectiveStmtUtils;
  32 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractSchemaTreeStatementSupport;
  33 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
  34 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  35 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
  36 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  37
  38 @Beta
  39 public final class ContainerStatementSupport
  40         extends AbstractSchemaTreeStatementSupport<ContainerStatement, ContainerEffectiveStatement> {
  41     private static final SubstatementValidator RFC6020_VALIDATOR =
  42         SubstatementValidator.builder(YangStmtMapping.CONTAINER)
  43             .addAny(YangStmtMapping.ANYXML)
  44             .addAny(YangStmtMapping.CHOICE)
  45             .addOptional(YangStmtMapping.CONFIG)
  46             .addAny(YangStmtMapping.CONTAINER)
  47             .addOptional(YangStmtMapping.DESCRIPTION)
  48             .addAny(YangStmtMapping.GROUPING)
  49             .addAny(YangStmtMapping.IF_FEATURE)
  50             .addAny(YangStmtMapping.LEAF)
  51             .addAny(YangStmtMapping.LEAF_LIST)
  52             .addAny(YangStmtMapping.LIST)
  53             .addAny(YangStmtMapping.MUST)
  54             .addOptional(YangStmtMapping.PRESENCE)
  55             .addOptional(YangStmtMapping.REFERENCE)
  56             .addOptional(YangStmtMapping.STATUS)
  57             .addAny(YangStmtMapping.TYPEDEF)
  58             .addAny(YangStmtMapping.USES)
  59             .addOptional(YangStmtMapping.WHEN)
  60             .build();
  61
  62     private static final SubstatementValidator RFC7950_VALIDATOR =
  63         SubstatementValidator.builder(YangStmtMapping.CONTAINER)
  64             .addAny(YangStmtMapping.ACTION)
  65             .addAny(YangStmtMapping.ANYDATA)
  66             .addAny(YangStmtMapping.ANYXML)
  67             .addAny(YangStmtMapping.CHOICE)
  68             .addOptional(YangStmtMapping.CONFIG)
  69             .addAny(YangStmtMapping.CONTAINER)
  70             .addOptional(YangStmtMapping.DESCRIPTION)
  71             .addAny(YangStmtMapping.GROUPING)
  72             .addAny(YangStmtMapping.IF_FEATURE)
  73             .addAny(YangStmtMapping.LEAF)
  74             .addAny(YangStmtMapping.LEAF_LIST)
  75             .addAny(YangStmtMapping.LIST)
  76             .addAny(YangStmtMapping.MUST)
  77             .addAny(YangStmtMapping.NOTIFICATION)
  78             .addOptional(YangStmtMapping.PRESENCE)
  79             .addOptional(YangStmtMapping.REFERENCE)
  80             .addOptional(YangStmtMapping.STATUS)
  81             .addAny(YangStmtMapping.TYPEDEF)
  82             .addAny(YangStmtMapping.USES)
  83             .addOptional(YangStmtMapping.WHEN)
  84             .build();
  85
  86     private ContainerStatementSupport(final YangParserConfiguration config, final SubstatementValidator validator) {
  87         super(YangStmtMapping.CONTAINER, instantiatedPolicy(), config, validator);
  88     }
  89
  90     public static @NonNull ContainerStatementSupport rfc6020Instance(final YangParserConfiguration config) {
  91         return new ContainerStatementSupport(config, RFC6020_VALIDATOR);
  92     }
  93
  94     public static @NonNull ContainerStatementSupport rfc7950Instance(final YangParserConfiguration config) {
  95         return new ContainerStatementSupport(config, RFC7950_VALIDATOR);
  96     }
  97
  98     @Override
  99     protected ContainerStatement createDeclared(final StmtContext<QName, ContainerStatement, ?> ctx,
 100             final ImmutableList<? extends DeclaredStatement<?>> substatements) {
 101         return DeclaredStatements.createContainer(ctx.getArgument(), substatements);
 102     }
 103
 104     @Override
 105     protected ContainerStatement attachDeclarationReference(final ContainerStatement stmt,
 106             final DeclarationReference reference) {
 107         return DeclaredStatementDecorators.decorateContainer(stmt, reference);
 108     }
 109
 110     @Override
 111     protected ContainerEffectiveStatement createEffective(final Current<QName, ContainerStatement> stmt,
 112             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 113         EffectiveStmtUtils.checkUniqueGroupings(stmt, substatements);
 114         EffectiveStmtUtils.checkUniqueTypedefs(stmt, substatements);
 115         EffectiveStmtUtils.checkUniqueUses(stmt, substatements);
 116
 117         try {
 118             return EffectiveStatements.createContainer(stmt.declared(), stmt.effectivePath(),
 119                 createFlags(stmt, substatements), substatements, stmt.original(ContainerSchemaNode.class));
 120         } catch (SubstatementIndexingException e) {
 121             throw new SourceException(e.getMessage(), stmt, e);
 122         }
 123     }
 124
 125     @Override
 126     public ContainerEffectiveStatement copyEffective(final Current<QName, ContainerStatement> stmt,
 127             final ContainerEffectiveStatement original) {
 128         return EffectiveStatements.copyContainer(original, stmt.effectivePath(),
 129             createFlags(stmt, original.effectiveSubstatements()), stmt.original(ContainerSchemaNode.class));
 130     }
 131
 132     private static int createFlags(final Current<?, ?> stmt,
 133             final Collection<? extends EffectiveStatement<?, ?>> substatements) {
 134         return new FlagsBuilder()
 135             .setHistory(stmt.history())
 136             .setStatus(findFirstArgument(substatements, StatusEffectiveStatement.class, Status.CURRENT))
 137             .setConfiguration(stmt.effectiveConfig().asNullable())
 138             .setPresence(findFirstStatement(substatements, PresenceEffectiveStatement.class) != null)
 139             .toFlags();
 140     }
 141 }
 142