yang/odlext-parser-support/src/main/java/org/opendaylight/yangtools/odlext/parser/AbstractIdentityAwareStatementSupport.java

   1 /*
   2  * Copyright (c) 2021 PANTHEON.tech, 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.odlext.parser;
   9
  10 import static com.google.common.base.Verify.verifyNotNull;
  11
  12 import com.google.common.collect.ImmutableList;
  13 import java.util.Collection;
  14 import org.eclipse.jdt.annotation.NonNull;
  15 import org.opendaylight.yangtools.yang.common.QName;
  16 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  17 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  18 import org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition;
  19 import org.opendaylight.yangtools.yang.model.api.stmt.IdentityEffectiveStatement;
  20 import org.opendaylight.yangtools.yang.model.parser.api.YangParserConfiguration;
  21 import org.opendaylight.yangtools.yang.parser.spi.IdentityNamespace;
  22 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStatementSupport;
  23 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
  24 import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
  25 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder;
  26 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceAction;
  27 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceContext;
  28 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.Prerequisite;
  29 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase;
  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
  35 abstract class AbstractIdentityAwareStatementSupport<D extends DeclaredStatement<QName>,
  36         E extends EffectiveStatement<QName, D>> extends AbstractStatementSupport<QName, D, E> {
  37     private final SubstatementValidator validator;
  38
  39     AbstractIdentityAwareStatementSupport(final StatementDefinition publicDefinition,
  40             final YangParserConfiguration config) {
  41         super(publicDefinition, StatementPolicy.exactReplica(), config);
  42         validator = SubstatementValidator.builder(publicDefinition).build();
  43     }
  44
  45     @Override
  46     public final QName parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
  47         return StmtContextUtils.parseNodeIdentifier(ctx, value);
  48     }
  49
  50     @Override
  51     public void onStatementDefinitionDeclared(final Mutable<QName, D, E> stmt) {
  52         final ModelActionBuilder action = stmt.newInferenceAction(ModelProcessingPhase.EFFECTIVE_MODEL);
  53         action.requiresCtx(stmt, IdentityNamespace.class, stmt.getArgument(), ModelProcessingPhase.EFFECTIVE_MODEL);
  54
  55         action.apply(new InferenceAction() {
  56             @Override
  57             public void apply(final InferenceContext ctx) {
  58                 // No-op, we just want to ensure the statement is specified
  59             }
  60
  61             @Override
  62             public void prerequisiteFailed(final Collection<? extends Prerequisite<?>> failed) {
  63                 throw new InferenceException(stmt, "Unable to resolve identity %s", stmt.argument());
  64             }
  65         });
  66     }
  67
  68     @Override
  69     protected final SubstatementValidator getSubstatementValidator() {
  70         return validator;
  71     }
  72
  73     @Override
  74     protected final E createEffective(final Current<QName, D> stmt,
  75             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
  76         final QName qname = stmt.getArgument();
  77         final StmtContext<?, ?, IdentityEffectiveStatement> identityCtx =
  78             verifyNotNull(stmt.getFromNamespace(IdentityNamespace.class, qname), "Failed to find identity %s", qname);
  79         return createEffective(stmt.declared(), identityCtx.buildEffective(), substatements);
  80     }
  81
  82     abstract @NonNull E createEffective(@NonNull D declared, @NonNull IdentityEffectiveStatement identity,
  83         ImmutableList<? extends EffectiveStatement<?, ?>> substatements);
  84 }