parser/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/type/LeafrefSpecificationSupport.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.type;
   9
  10 import com.google.common.collect.ImmutableList;
  11 import org.opendaylight.yangtools.yang.common.QName;
  12 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
  13 import org.opendaylight.yangtools.yang.model.api.meta.DeclarationReference;
  14 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  15 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  16 import org.opendaylight.yangtools.yang.model.api.stmt.PathEffectiveStatement;
  17 import org.opendaylight.yangtools.yang.model.api.stmt.RequireInstanceEffectiveStatement;
  18 import org.opendaylight.yangtools.yang.model.api.stmt.TypeStatement.LeafrefSpecification;
  19 import org.opendaylight.yangtools.yang.model.ri.type.BaseTypes;
  20 import org.opendaylight.yangtools.yang.model.ri.type.LeafrefTypeBuilder;
  21 import org.opendaylight.yangtools.yang.parser.api.YangParserConfiguration;
  22 import org.opendaylight.yangtools.yang.parser.spi.meta.CommonStmtCtx;
  23 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
  24 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  25 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
  26 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  27
  28 final class LeafrefSpecificationSupport extends AbstractTypeSupport<LeafrefSpecification> {
  29     private static final SubstatementValidator RFC6020_VALIDATOR =
  30         SubstatementValidator.builder(YangStmtMapping.TYPE).addMandatory(YangStmtMapping.PATH).build();
  31     private static final SubstatementValidator RFC7950_VALIDATOR =
  32         SubstatementValidator.builder(YangStmtMapping.TYPE)
  33             .addMandatory(YangStmtMapping.PATH)
  34             .addOptional(YangStmtMapping.REQUIRE_INSTANCE)
  35             .build();
  36
  37     private LeafrefSpecificationSupport(final YangParserConfiguration config, final SubstatementValidator validator) {
  38         super(config, validator);
  39     }
  40
  41     static LeafrefSpecificationSupport rfc6020Instance(final YangParserConfiguration config) {
  42         return new LeafrefSpecificationSupport(config, RFC6020_VALIDATOR);
  43     }
  44
  45     static LeafrefSpecificationSupport rfc7950Instance(final YangParserConfiguration config) {
  46         return new LeafrefSpecificationSupport(config, RFC7950_VALIDATOR);
  47     }
  48
  49     @Override
  50     protected LeafrefSpecification createDeclared(final StmtContext<QName, LeafrefSpecification, ?> ctx,
  51             final ImmutableList<? extends DeclaredStatement<?>> substatements) {
  52         if (substatements.isEmpty()) {
  53             throw noPath(ctx);
  54         }
  55         return new LeafrefSpecificationImpl(ctx.getRawArgument(), ctx.getArgument(), substatements);
  56     }
  57
  58     @Override
  59     protected LeafrefSpecification attachDeclarationReference(final LeafrefSpecification stmt,
  60             final DeclarationReference reference) {
  61         return new RefLeafrefSpecification(stmt, reference);
  62     }
  63
  64     @Override
  65     protected EffectiveStatement<QName, LeafrefSpecification> createEffective(
  66             final Current<QName, LeafrefSpecification> stmt,
  67             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
  68         if (substatements.isEmpty()) {
  69             throw noPath(stmt);
  70         }
  71
  72         final LeafrefTypeBuilder builder = BaseTypes.leafrefTypeBuilder(stmt.argumentAsTypeQName());
  73
  74         for (final EffectiveStatement<?, ?> subStmt : substatements) {
  75             if (subStmt instanceof PathEffectiveStatement) {
  76                 builder.setPathStatement(((PathEffectiveStatement) subStmt).argument());
  77             } else if (subStmt instanceof RequireInstanceEffectiveStatement) {
  78                 builder.setRequireInstance(((RequireInstanceEffectiveStatement)subStmt).argument());
  79             }
  80         }
  81
  82         return new TypeEffectiveStatementImpl<>(stmt.declared(), substatements, builder);
  83     }
  84
  85     private static SourceException noPath(final CommonStmtCtx stmt) {
  86         /*
  87          *  https://tools.ietf.org/html/rfc7950#section-9.12
  88          *
  89          *     When the type is "union", the "type" statement (Section 7.4) MUST be
  90          *     present.
  91          */
  92         return new SourceException("A path statement has to be present", stmt);
  93     }
  94 }