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