yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/rfc6020/YangDataStatementImpl.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
   9 package org.opendaylight.yangtools.yang.parser.stmt.rfc6020;
  10
  11 import com.google.common.annotations.Beta;
  12 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
  13 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  14 import org.opendaylight.yangtools.yang.model.api.stmt.UnknownStatement;
  15 import org.opendaylight.yangtools.yang.parser.spi.SubstatementValidator;
  16 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractDeclaredStatement;
  17 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStatementSupport;
  18 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  19 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
  20 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.YangDataEffectiveStatementImpl;
  21
  22 /**
  23  * Declared statement representation of 'yang-data' extension defined in https://tools.ietf.org/html/rfc8040#section-8
  24  */
  25 @Beta
  26 public class YangDataStatementImpl extends AbstractDeclaredStatement<String> implements UnknownStatement<String> {
  27     private static final SubstatementValidator SUBSTATEMENT_VALIDATOR = SubstatementValidator.builder(
  28             SupportedExtensionsMapping.YANG_DATA)
  29             .addMandatory(YangStmtMapping.CONTAINER)
  30             .addOptional(YangStmtMapping.USES)
  31             .build();
  32
  33     YangDataStatementImpl(final StmtContext<String, UnknownStatement<String>, ?> ctx) {
  34         super(ctx);
  35     }
  36
  37     public static class YangDataSupport extends AbstractStatementSupport<String, UnknownStatement<String>,
  38             EffectiveStatement<String, UnknownStatement<String>>> {
  39
  40         public YangDataSupport() {
  41             super(SupportedExtensionsMapping.YANG_DATA);
  42         }
  43
  44         @Override
  45         protected SubstatementValidator getSubstatementValidator() {
  46             return SUBSTATEMENT_VALIDATOR;
  47         }
  48
  49         @Override
  50         public String parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
  51             return value;
  52         }
  53
  54         @Override
  55         public UnknownStatement<String> createDeclared(final StmtContext<String, UnknownStatement<String>, ?> ctx) {
  56             return new YangDataStatementImpl(ctx);
  57         }
  58
  59         @Override
  60         public EffectiveStatement<String, UnknownStatement<String>> createEffective(final StmtContext<String,
  61                 UnknownStatement<String>, EffectiveStatement<String, UnknownStatement<String>>> ctx) {
  62             // in case of yang-data node we need to perform substatement validation at the point when we have
  63             // effective substatement contexts already available - if the node has only a uses statement declared in it,
  64             // one top-level container node may very well be added to the yang-data as an effective statement
  65             SUBSTATEMENT_VALIDATOR.validate(ctx);
  66             return new YangDataEffectiveStatementImpl(ctx);
  67         }
  68
  69         @Override
  70         public void onFullDefinitionDeclared(final Mutable<String, UnknownStatement<String>,
  71                 EffectiveStatement<String, UnknownStatement<String>>> ctx) {
  72             // as per https://tools.ietf.org/html/rfc8040#section-8,
  73             // yang-data is ignored unless it appears as a top-level statement
  74             if (ctx.getParentContext().getParentContext() != null) {
  75                 ctx.setIsSupportedToBuildEffective(false);
  76             }
  77         }
  78     }
  79
  80     @Override
  81     public String getArgument() {
  82         return argument();
  83     }
  84 }