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 com.google.common.annotations.Beta;
  11 import com.google.common.collect.ImmutableList;
  12 import org.eclipse.jdt.annotation.NonNull;
  13 import org.opendaylight.yangtools.rfc8040.model.api.YangDataEffectiveStatement;
  14 import org.opendaylight.yangtools.rfc8040.model.api.YangDataStatement;
  15 import org.opendaylight.yangtools.rfc8040.model.api.YangDataStatements;
  16 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
  17 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  18 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  19 import org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition;
  20 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.AbstractDeclaredStatement.WithRawStringArgument.WithSubstatements;
  21 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.BaseStringStatementSupport;
  22 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
  23 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  24 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
  25 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
  26
  27 @Beta
  28 public final class YangDataStatementSupport
  29         extends BaseStringStatementSupport<YangDataStatement, YangDataEffectiveStatement> {
  30     /**
  31      * Declared statement representation of 'yang-data' extension defined in
  32      * <a href="https://tools.ietf.org/html/rfc8040#section-8">RFC 8040</a>.
  33      */
  34     private static final class Declared extends WithSubstatements implements YangDataStatement {
  35         Declared(final String rawArgument, final ImmutableList<? extends DeclaredStatement<?>> substatements) {
  36             super(rawArgument, substatements);
  37         }
  38     }
  39
  40     private static final YangDataStatementSupport INSTANCE = new YangDataStatementSupport(YangDataStatements.YANG_DATA);
  41
  42     private final SubstatementValidator validator;
  43
  44     private YangDataStatementSupport(final StatementDefinition definition) {
  45         super(definition);
  46         validator = SubstatementValidator.builder(definition)
  47                 .addMandatory(YangStmtMapping.CONTAINER)
  48                 .addOptional(YangStmtMapping.USES)
  49                 .build();
  50     }
  51
  52     public static YangDataStatementSupport getInstance() {
  53         return INSTANCE;
  54     }
  55
  56     @Override
  57     public void onFullDefinitionDeclared(final Mutable<String, YangDataStatement, YangDataEffectiveStatement> ctx) {
  58         // as per https://tools.ietf.org/html/rfc8040#section-8,
  59         // yang-data is ignored unless it appears as a top-level statement
  60         if (ctx.coerceParentContext().getParentContext() != null) {
  61             ctx.setIsSupportedToBuildEffective(false);
  62         }
  63     }
  64
  65     @Override
  66     public boolean isIgnoringIfFeatures() {
  67         return true;
  68     }
  69
  70     @Override
  71     public boolean isIgnoringConfig() {
  72         return true;
  73     }
  74
  75     @Override
  76     protected SubstatementValidator getSubstatementValidator() {
  77         return validator;
  78     }
  79
  80     @Override
  81     protected YangDataStatement createDeclared(@NonNull final StmtContext<String, YangDataStatement, ?> ctx,
  82             final ImmutableList<? extends DeclaredStatement<?>> substatements) {
  83         return new Declared(ctx.coerceRawStatementArgument(), substatements);
  84     }
  85
  86     @Override
  87     protected YangDataStatement createEmptyDeclared(final StmtContext<String, YangDataStatement, ?> ctx) {
  88         return createDeclared(ctx, ImmutableList.of());
  89     }
  90
  91     @Override
  92     protected YangDataEffectiveStatement createEffective(final Current<String, YangDataStatement> stmt,
  93             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
  94         // in case of yang-data node we need to perform substatement validation at the point when we have
  95         // effective substatement contexts already available - if the node has only a uses statement declared in it,
  96         // one top-level container node may very well be added to the yang-data as an effective statement
  97         validator.validate(stmt.caerbannog());
  98         return new YangDataEffectiveStatementImpl(stmt, substatements);
  99     }
 100 }