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.parser.spi.IdentityNamespace;
  21 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStatementSupport;
  22 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
  23 import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
  24 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder;
  25 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceAction;
  26 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceContext;
  27 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.Prerequisite;
  28 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase;
  29 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  30 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
  31 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
  32 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
  33
  34 abstract class AbstractIdentityAwareStatementSupport<D extends DeclaredStatement<QName>,
  35         E extends EffectiveStatement<QName, D>> extends AbstractStatementSupport<QName, D, E> {
  36     private final SubstatementValidator validator;
  37
  38     AbstractIdentityAwareStatementSupport(final StatementDefinition publicDefinition) {
  39         super(publicDefinition, StatementPolicy.exactReplica());
  40         validator = SubstatementValidator.builder(publicDefinition).build();
  41     }
  42
  43     @Override
  44     public final QName parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
  45         return StmtContextUtils.parseNodeIdentifier(ctx, value);
  46     }
  47
  48     @Override
  49     public void onStatementDefinitionDeclared(final Mutable<QName, D, E> stmt) {
  50         final ModelActionBuilder action = stmt.newInferenceAction(ModelProcessingPhase.EFFECTIVE_MODEL);
  51         action.requiresCtx(stmt, IdentityNamespace.class, stmt.getArgument(), ModelProcessingPhase.EFFECTIVE_MODEL);
  52
  53         action.apply(new InferenceAction() {
  54             @Override
  55             public void apply(final InferenceContext ctx) {
  56                 // No-op, we just want to ensure the statement is specified
  57             }
  58
  59             @Override
  60             public void prerequisiteFailed(final Collection<? extends Prerequisite<?>> failed) {
  61                 throw new InferenceException(stmt, "Unable to resolve identity %s", stmt.argument());
  62             }
  63         });
  64     }
  65
  66     @Override
  67     protected final SubstatementValidator getSubstatementValidator() {
  68         return validator;
  69     }
  70
  71     @Override
  72     protected final E createEffective(final Current<QName, D> stmt,
  73             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
  74         final QName qname = stmt.getArgument();
  75         final StmtContext<?, ?, IdentityEffectiveStatement> identityCtx =
  76             verifyNotNull(stmt.getFromNamespace(IdentityNamespace.class, qname), "Failed to find identity %s", qname);
  77         return createEffective(stmt.declared(), identityCtx.buildEffective(), substatements);
  78     }
  79
  80     abstract @NonNull E createEffective(@NonNull D declared, @NonNull IdentityEffectiveStatement identity,
  81         ImmutableList<? extends EffectiveStatement<?, ?>> substatements);
  82 }