yang/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/rpc/AbstractRpcStatementSupport.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.rpc;
   9
  10 import static com.google.common.base.Preconditions.checkState;
  11 import static com.google.common.base.Verify.verify;
  12
  13 import com.google.common.collect.ImmutableList;
  14 import org.opendaylight.yangtools.yang.common.QName;
  15 import org.opendaylight.yangtools.yang.model.api.Status;
  16 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
  17 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  18 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  19 import org.opendaylight.yangtools.yang.model.api.stmt.InputStatement;
  20 import org.opendaylight.yangtools.yang.model.api.stmt.OutputStatement;
  21 import org.opendaylight.yangtools.yang.model.api.stmt.RpcEffectiveStatement;
  22 import org.opendaylight.yangtools.yang.model.api.stmt.RpcStatement;
  23 import org.opendaylight.yangtools.yang.model.api.stmt.StatusEffectiveStatement;
  24 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.BaseSchemaTreeStatementSupport;
  25 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.EffectiveStatementMixins.EffectiveStatementWithFlags.FlagsBuilder;
  26 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.SubstatementIndexingException;
  27 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
  28 import org.opendaylight.yangtools.yang.parser.spi.meta.StatementSupport;
  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 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  34 import org.opendaylight.yangtools.yang.parser.stmt.reactor.StatementContextBase;
  35
  36 abstract class AbstractRpcStatementSupport extends BaseSchemaTreeStatementSupport<RpcStatement, RpcEffectiveStatement> {
  37     private static final SubstatementValidator SUBSTATEMENT_VALIDATOR = SubstatementValidator.builder(
  38         YangStmtMapping.RPC)
  39         .addOptional(YangStmtMapping.DESCRIPTION)
  40         .addAny(YangStmtMapping.GROUPING)
  41         .addAny(YangStmtMapping.IF_FEATURE)
  42         .addOptional(YangStmtMapping.INPUT)
  43         .addOptional(YangStmtMapping.OUTPUT)
  44         .addOptional(YangStmtMapping.REFERENCE)
  45         .addOptional(YangStmtMapping.STATUS)
  46         .addAny(YangStmtMapping.TYPEDEF)
  47         .build();
  48
  49     AbstractRpcStatementSupport() {
  50         super(YangStmtMapping.RPC);
  51     }
  52
  53     @Override
  54     public final void onFullDefinitionDeclared(final Mutable<QName, RpcStatement, RpcEffectiveStatement> stmt) {
  55         super.onFullDefinitionDeclared(stmt);
  56
  57         verify(stmt instanceof StatementContextBase);
  58         if (StmtContextUtils.findFirstDeclaredSubstatement(stmt, InputStatement.class) == null) {
  59             ((StatementContextBase<?, ?, ?>) stmt).appendImplicitSubstatement(implictInput(), null);
  60         }
  61         if (StmtContextUtils.findFirstDeclaredSubstatement(stmt, OutputStatement.class) == null) {
  62             ((StatementContextBase<?, ?, ?>) stmt).appendImplicitSubstatement(implictOutput(), null);
  63         }
  64     }
  65
  66     @Override
  67     protected final SubstatementValidator getSubstatementValidator() {
  68         return SUBSTATEMENT_VALIDATOR;
  69     }
  70
  71     @Override
  72     protected final RpcStatement createDeclared(final StmtContext<QName, RpcStatement, ?> ctx,
  73             final ImmutableList<? extends DeclaredStatement<?>> substatements) {
  74         return new RegularRpcStatement(ctx.getArgument(), substatements);
  75     }
  76
  77     @Override
  78     protected final RpcStatement createEmptyDeclared(final StmtContext<QName, RpcStatement, ?> ctx) {
  79         return new EmptyRpcStatement(ctx.getArgument());
  80     }
  81
  82     @Override
  83     protected RpcEffectiveStatement createEffective(final Current<QName, RpcStatement> stmt,
  84             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
  85         checkState(!substatements.isEmpty(), "Missing implicit input/output statements at %s", stmt.sourceReference());
  86
  87         try {
  88             return new RpcEffectiveStatementImpl(stmt.declared(), substatements, computeFlags(substatements),
  89                 stmt.wrapSchemaPath());
  90         } catch (SubstatementIndexingException e) {
  91             throw new SourceException(e.getMessage(), stmt.sourceReference(), e);
  92         }
  93     }
  94
  95     abstract StatementSupport<?, ?, ?> implictInput();
  96
  97     abstract StatementSupport<?, ?, ?> implictOutput();
  98
  99     private static int computeFlags(final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 100         return new FlagsBuilder()
 101                 .setStatus(findFirstArgument(substatements, StatusEffectiveStatement.class, Status.CURRENT))
 102                 .toFlags();
 103     }
 104 }