parser/rfc7952-parser-support/src/main/java/org/opendaylight/yangtools/rfc7952/parser/AnnotationStatementSupport.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.rfc7952.parser;
   9
  10 import com.google.common.collect.ImmutableList;
  11 import org.opendaylight.yangtools.rfc7952.model.api.AnnotationEffectiveStatement;
  12 import org.opendaylight.yangtools.rfc7952.model.api.AnnotationStatement;
  13 import org.opendaylight.yangtools.rfc7952.model.api.MetadataStatements;
  14 import org.opendaylight.yangtools.yang.common.QName;
  15 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
  16 import org.opendaylight.yangtools.yang.model.api.meta.DeclarationReference;
  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.meta.StatementDefinition;
  20 import org.opendaylight.yangtools.yang.parser.api.YangParserConfiguration;
  21 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStatementSupport;
  22 import org.opendaylight.yangtools.yang.parser.spi.meta.BoundStmtCtx;
  23 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
  24 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  25 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
  26 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
  27 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
  28 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  29
  30 public final class AnnotationStatementSupport
  31          extends AbstractStatementSupport<QName, AnnotationStatement, AnnotationEffectiveStatement> {
  32     private static final SubstatementValidator VALIDATOR = SubstatementValidator.builder(MetadataStatements.ANNOTATION)
  33         .addMandatory(YangStmtMapping.TYPE)
  34         .addOptional(YangStmtMapping.DESCRIPTION)
  35         .addAny(YangStmtMapping.IF_FEATURE)
  36         .addOptional(YangStmtMapping.REFERENCE)
  37         .addOptional(YangStmtMapping.STATUS)
  38         .addOptional(YangStmtMapping.UNITS)
  39         .build();
  40
  41     public AnnotationStatementSupport(final YangParserConfiguration config) {
  42         super(MetadataStatements.ANNOTATION, StatementPolicy.reject(), config, VALIDATOR);
  43     }
  44
  45     @Override
  46     public QName parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
  47         return StmtContextUtils.parseIdentifier(ctx, value);
  48     }
  49
  50     @Override
  51     public void onStatementAdded(final Mutable<QName, AnnotationStatement, AnnotationEffectiveStatement> stmt) {
  52         final StatementDefinition parentDef = stmt.coerceParentContext().publicDefinition();
  53         SourceException.throwIf(YangStmtMapping.MODULE != parentDef && YangStmtMapping.SUBMODULE != parentDef,
  54                 stmt, "Annotations may only be defined at root of either a module or a submodule");
  55     }
  56
  57     @Override
  58     protected AnnotationStatement createDeclared(final BoundStmtCtx<QName> ctx,
  59             final ImmutableList<DeclaredStatement<?>> substatements) {
  60         return new AnnotationStatementImpl(ctx.getArgument(), substatements);
  61     }
  62
  63     @Override
  64     protected AnnotationStatement attachDeclarationReference(final AnnotationStatement stmt,
  65             final DeclarationReference reference) {
  66         return new RefAnnotationStatement(stmt, reference);
  67     }
  68
  69     @Override
  70     protected AnnotationEffectiveStatement createEffective(final Current<QName, AnnotationStatement> stmt,
  71             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
  72         return new AnnotationEffectiveStatementImpl(stmt, substatements);
  73     }
  74 }