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