yang/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/refine/RefineStatementSupport.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.refine;
   9
  10 import static com.google.common.base.Verify.verifyNotNull;
  11 import static java.util.Objects.requireNonNull;
  12
  13 import com.google.common.annotations.Beta;
  14 import com.google.common.collect.ImmutableList;
  15 import org.eclipse.jdt.annotation.NonNull;
  16 import org.opendaylight.yangtools.yang.common.Empty;
  17 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
  18 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
  19 import org.opendaylight.yangtools.yang.model.api.meta.DeclarationReference;
  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.RefineEffectiveStatement;
  23 import org.opendaylight.yangtools.yang.model.api.stmt.RefineStatement;
  24 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Descendant;
  25 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatementDecorators;
  26 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatements;
  27 import org.opendaylight.yangtools.yang.parser.api.YangParserConfiguration;
  28 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.ArgumentUtils;
  29 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStatementSupport;
  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
  34 @Beta
  35 public final class RefineStatementSupport
  36         extends AbstractStatementSupport<Descendant, RefineStatement, RefineEffectiveStatement> {
  37     private static final SubstatementValidator RFC6020_VALIDATOR = SubstatementValidator.builder(YangStmtMapping.REFINE)
  38         .addOptional(YangStmtMapping.DEFAULT)
  39         .addOptional(YangStmtMapping.DESCRIPTION)
  40         .addOptional(YangStmtMapping.REFERENCE)
  41         .addOptional(YangStmtMapping.CONFIG)
  42         .addOptional(YangStmtMapping.MANDATORY)
  43         .addOptional(YangStmtMapping.PRESENCE)
  44         .addAny(YangStmtMapping.MUST)
  45         .addOptional(YangStmtMapping.MIN_ELEMENTS)
  46         .addOptional(YangStmtMapping.MAX_ELEMENTS)
  47         .build();
  48     private static final SubstatementValidator RFC7950_VALIDATOR = SubstatementValidator.builder(YangStmtMapping.REFINE)
  49         .addOptional(YangStmtMapping.DEFAULT)
  50         .addOptional(YangStmtMapping.DESCRIPTION)
  51         .addOptional(YangStmtMapping.REFERENCE)
  52         .addOptional(YangStmtMapping.CONFIG)
  53         .addAny(YangStmtMapping.IF_FEATURE)
  54         .addOptional(YangStmtMapping.MANDATORY)
  55         .addOptional(YangStmtMapping.PRESENCE)
  56         .addAny(YangStmtMapping.MUST)
  57         .addOptional(YangStmtMapping.MIN_ELEMENTS)
  58         .addOptional(YangStmtMapping.MAX_ELEMENTS)
  59         .build();
  60
  61     private final SubstatementValidator validator;
  62
  63     private RefineStatementSupport(final YangParserConfiguration config, final SubstatementValidator validator) {
  64         super(YangStmtMapping.REFINE, StatementPolicy.reject(), config);
  65         this.validator = requireNonNull(validator);
  66     }
  67
  68     public static @NonNull RefineStatementSupport rfc6020Instance(final YangParserConfiguration config) {
  69         return new RefineStatementSupport(config, RFC6020_VALIDATOR);
  70     }
  71
  72     public static @NonNull RefineStatementSupport rfc7950Instance(final YangParserConfiguration config) {
  73         return new RefineStatementSupport(config, RFC7950_VALIDATOR);
  74     }
  75
  76     @Override
  77     public Descendant parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
  78         return ArgumentUtils.parseDescendantSchemaNodeIdentifier(ctx, value);
  79     }
  80
  81     @Override
  82     protected SubstatementValidator getSubstatementValidator() {
  83         return validator;
  84     }
  85
  86     @Override
  87     protected RefineStatement createDeclared(final StmtContext<Descendant, RefineStatement, ?> ctx,
  88             final ImmutableList<? extends DeclaredStatement<?>> substatements) {
  89         return DeclaredStatements.createRefine(ctx.getRawArgument(), ctx.getArgument(), substatements);
  90     }
  91
  92     @Override
  93     protected RefineStatement attachDeclarationReference(final RefineStatement stmt,
  94             final DeclarationReference reference) {
  95         return DeclaredStatementDecorators.decorateRefine(stmt, reference);
  96     }
  97
  98     @Override
  99     protected RefineEffectiveStatement createEffective(final Current<Descendant, RefineStatement> stmt,
 100             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 101         // Empty refine is exceedingly unlikely: let's be lazy and reuse the implementation
 102         return new RefineEffectiveStatementImpl(stmt.declared(), substatements,
 103             (SchemaNode) verifyNotNull(stmt.namespaceItem(RefineTargetNamespace.class, Empty.getInstance()))
 104                 .buildEffective());
 105     }
 106 }