yang/rfc8040-parser-support/src/main/java/org/opendaylight/yangtools/rfc8040/parser/YangDataStatementSupport.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.rfc8040.parser;
   9
  10 import static com.google.common.base.Verify.verifyNotNull;
  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.rfc8040.model.api.YangDataEffectiveStatement;
  16 import org.opendaylight.yangtools.rfc8040.model.api.YangDataStatement;
  17 import org.opendaylight.yangtools.rfc8040.model.api.YangDataStatements;
  18 import org.opendaylight.yangtools.yang.common.Empty;
  19 import org.opendaylight.yangtools.yang.common.QName;
  20 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
  21 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  22 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  23 import org.opendaylight.yangtools.yang.model.api.stmt.DataTreeEffectiveStatement;
  24 import org.opendaylight.yangtools.yang.model.spi.meta.AbstractDeclaredStatement.WithRawStringArgument.WithSubstatements;
  25 import org.opendaylight.yangtools.yang.parser.api.YangParserConfiguration;
  26 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStringStatementSupport;
  27 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
  28 import org.opendaylight.yangtools.yang.parser.spi.meta.InvalidSubstatementException;
  29 import org.opendaylight.yangtools.yang.parser.spi.meta.MissingSubstatementException;
  30 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  31 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
  32 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
  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 YangDataStatementSupport
  38         extends AbstractStringStatementSupport<YangDataStatement, YangDataEffectiveStatement> {
  39     /**
  40      * Declared statement representation of 'yang-data' extension defined in
  41      * <a href="https://tools.ietf.org/html/rfc8040#section-8">RFC 8040</a>.
  42      */
  43     private static final class Declared extends WithSubstatements implements YangDataStatement {
  44         Declared(final String rawArgument, final ImmutableList<? extends DeclaredStatement<?>> substatements) {
  45             super(rawArgument, substatements);
  46         }
  47     }
  48
  49     private final SubstatementValidator declaredValidator;
  50
  51     public YangDataStatementSupport(final YangParserConfiguration config) {
  52         super(YangDataStatements.YANG_DATA, StatementPolicy.reject(), config);
  53         declaredValidator = SubstatementValidator.builder(YangDataStatements.YANG_DATA)
  54                 .addMandatory(YangStmtMapping.CONTAINER)
  55                 .addOptional(YangStmtMapping.USES)
  56                 .build();
  57     }
  58
  59     @Override
  60     public void onStatementAdded(final Mutable<String, YangDataStatement, YangDataEffectiveStatement> ctx) {
  61         // as per https://tools.ietf.org/html/rfc8040#section-8,
  62         // yang-data is ignored unless it appears as a top-level statement
  63         if (ctx.coerceParentContext().getParentContext() != null) {
  64             ctx.setIsSupportedToBuildEffective(false);
  65         }
  66     }
  67
  68     @Override
  69     public void onFullDefinitionDeclared(final Mutable<String, YangDataStatement, YangDataEffectiveStatement> ctx) {
  70         // Parse and populate our argument to be picked up when we build the effecitve statement
  71         final String argument = SourceException.throwIfNull(ctx.argument(), ctx, "yang-data requires an argument");
  72         final QName qname = StmtContextUtils.parseIdentifier(ctx, argument);
  73         ctx.addToNs(YangDataArgumentNamespace.class, Empty.getInstance(), qname);
  74     }
  75
  76     @Override
  77     public boolean isIgnoringIfFeatures() {
  78         return true;
  79     }
  80
  81     @Override
  82     public boolean isIgnoringConfig() {
  83         return true;
  84     }
  85
  86     @Override
  87     protected SubstatementValidator getSubstatementValidator() {
  88         return declaredValidator;
  89     }
  90
  91     @Override
  92     protected YangDataStatement createDeclared(@NonNull final StmtContext<String, YangDataStatement, ?> ctx,
  93             final ImmutableList<? extends DeclaredStatement<?>> substatements) {
  94         return new Declared(ctx.getRawArgument(), substatements);
  95     }
  96
  97     @Override
  98     protected YangDataEffectiveStatement createEffective(final Current<String, YangDataStatement> stmt,
  99             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 100         // So now we need to deal with effective validation. The requirement is that:
 101         //        It MUST contain data definition statements
 102         //        that result in exactly one container data node definition.
 103         final long dataDefs = substatements.stream().filter(DataTreeEffectiveStatement.class::isInstance).count();
 104         if (dataDefs == 0) {
 105             throw new MissingSubstatementException("yang-data requires exactly one container", stmt.sourceReference());
 106         }
 107         if (dataDefs > 1) {
 108             throw new InvalidSubstatementException(stmt,
 109                 "yang-data requires exactly one data definition node, found %s", dataDefs);
 110         }
 111
 112         return new YangDataEffectiveStatementImpl(stmt, substatements,
 113             verifyNotNull(stmt.namespaceItem(YangDataArgumentNamespace.class, Empty.getInstance())));
 114     }
 115 }