yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/rfc6020/RpcStatementImpl.java

   1 /*
   2  * Copyright (c) 2015 Cisco Systems, Inc. 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.stmt.rfc6020;
   9
  10 import java.util.Collection;
  11 import javax.annotation.Nonnull;
  12 import javax.annotation.Nullable;
  13 import org.opendaylight.yangtools.yang.common.QName;
  14 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
  15 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  16 import org.opendaylight.yangtools.yang.model.api.stmt.DescriptionStatement;
  17 import org.opendaylight.yangtools.yang.model.api.stmt.GroupingStatement;
  18 import org.opendaylight.yangtools.yang.model.api.stmt.IfFeatureStatement;
  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.ReferenceStatement;
  22 import org.opendaylight.yangtools.yang.model.api.stmt.RpcStatement;
  23 import org.opendaylight.yangtools.yang.model.api.stmt.StatusStatement;
  24 import org.opendaylight.yangtools.yang.model.api.stmt.TypedefStatement;
  25 import org.opendaylight.yangtools.yang.parser.spi.SubstatementValidator;
  26 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractDeclaredStatement;
  27 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStatementSupport;
  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.source.ImplicitSubstatement;
  33 import org.opendaylight.yangtools.yang.parser.stmt.reactor.StatementContextBase;
  34 import org.opendaylight.yangtools.yang.parser.stmt.reactor.StatementDefinitionContext;
  35 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.RpcEffectiveStatementImpl;
  36
  37 public class RpcStatementImpl extends AbstractDeclaredStatement<QName>
  38         implements RpcStatement {
  39     private static final SubstatementValidator SUBSTATEMENT_VALIDATOR = SubstatementValidator.builder(YangStmtMapping
  40             .RPC)
  41             .addOptional(YangStmtMapping.DESCRIPTION)
  42             .addAny(YangStmtMapping.GROUPING)
  43             .addAny(YangStmtMapping.IF_FEATURE)
  44             .addOptional(YangStmtMapping.INPUT)
  45             .addOptional(YangStmtMapping.OUTPUT)
  46             .addOptional(YangStmtMapping.REFERENCE)
  47             .addOptional(YangStmtMapping.STATUS)
  48             .addAny(YangStmtMapping.TYPEDEF)
  49             .build();
  50
  51     protected RpcStatementImpl(final StmtContext<QName, RpcStatement, ?> context) {
  52         super(context);
  53     }
  54
  55     public static class Definition
  56             extends AbstractStatementSupport<QName, RpcStatement, EffectiveStatement<QName, RpcStatement>> {
  57         // TODO: share instances
  58         private static final StatementSupport<?, ?, ?> IMPLICIT_INPUT = new InputStatementImpl.Definition();
  59         private static final StatementSupport<?, ?, ?> IMPLICIT_OUTPUT = new OutputStatementImpl.Definition();
  60
  61         public Definition() {
  62             super(YangStmtMapping.RPC);
  63         }
  64
  65         @Override
  66         public QName parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
  67             return StmtContextUtils.qnameFromArgument(ctx, value);
  68         }
  69
  70         @Override
  71         public void onStatementAdded(final Mutable<QName, RpcStatement, EffectiveStatement<QName, RpcStatement>> stmt) {
  72             stmt.getParentContext().addToNs(ChildSchemaNodes.class, stmt.getStatementArgument(), stmt);
  73         }
  74
  75         @Override
  76         public RpcStatement createDeclared(
  77                 final StmtContext<QName, RpcStatement, ?> ctx) {
  78             return new RpcStatementImpl(ctx);
  79         }
  80
  81         @Override
  82         public EffectiveStatement<QName, RpcStatement> createEffective(
  83                 final StmtContext<QName, RpcStatement, EffectiveStatement<QName, RpcStatement>> ctx) {
  84             return new RpcEffectiveStatementImpl(ctx);
  85         }
  86
  87         @Override
  88         public void onFullDefinitionDeclared(final Mutable<QName, RpcStatement, EffectiveStatement<QName, RpcStatement>> stmt) {
  89             super.onFullDefinitionDeclared(stmt);
  90
  91             if (StmtContextUtils.findFirstDeclaredSubstatement(stmt, InputStatement.class) == null) {
  92                 addImplicitStatement((StatementContextBase<?, ?, ?>) stmt, implictInput());
  93             }
  94
  95             if (StmtContextUtils.findFirstDeclaredSubstatement(stmt, OutputStatement.class) == null) {
  96                 addImplicitStatement((StatementContextBase<?, ?, ?>) stmt, implictOutput());
  97             }
  98         }
  99
 100         @Override
 101         protected SubstatementValidator getSubstatementValidator() {
 102             return SUBSTATEMENT_VALIDATOR;
 103         }
 104
 105         protected StatementSupport<?, ?, ?> implictInput() {
 106             return IMPLICIT_INPUT;
 107         }
 108
 109         protected StatementSupport<?, ?, ?> implictOutput() {
 110             return IMPLICIT_OUTPUT;
 111         }
 112
 113         private static void addImplicitStatement(final StatementContextBase<?, ?, ?> parent,
 114                 final StatementSupport<?, ?, ?> statementToAdd) {
 115             final StatementDefinitionContext<?, ?, ?> stmtDefCtx = new StatementDefinitionContext<>(statementToAdd);
 116
 117             parent.createSubstatement(parent.declaredSubstatements().size(), stmtDefCtx,
 118                 ImplicitSubstatement.of(parent.getStatementSourceReference()), null);
 119         }
 120     }
 121
 122     @Override
 123     public QName getName() {
 124         return argument();
 125     }
 126
 127     @Nonnull
 128     @Override
 129     public Collection<? extends TypedefStatement> getTypedefs() {
 130         return allDeclared(TypedefStatement.class);
 131     }
 132
 133     @Nonnull
 134     @Override
 135     public Collection<? extends GroupingStatement> getGroupings() {
 136         return allDeclared(GroupingStatement.class);
 137     }
 138
 139     @Nullable
 140     @Override
 141     public StatusStatement getStatus() {
 142         return firstDeclared(StatusStatement.class);
 143     }
 144
 145     @Nullable
 146     @Override
 147     public DescriptionStatement getDescription() {
 148         return firstDeclared(DescriptionStatement.class);
 149     }
 150
 151     @Nullable
 152     @Override
 153     public ReferenceStatement getReference() {
 154         return firstDeclared(ReferenceStatement.class);
 155     }
 156
 157     @Override
 158     public InputStatement getInput() {
 159         return firstDeclared(InputStatement.class);
 160     }
 161
 162     @Override
 163     public OutputStatement getOutput() {
 164         return firstDeclared(OutputStatement.class);
 165     }
 166
 167     @Nonnull
 168     @Override
 169     public Collection<? extends IfFeatureStatement> getIfFeatures() {
 170         return allDeclared(IfFeatureStatement.class);
 171     }
 172 }