yang/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 org.opendaylight.yangtools.rfc7952.model.api.AnnotationEffectiveStatement;
  11 import org.opendaylight.yangtools.rfc7952.model.api.AnnotationStatement;
  12 import org.opendaylight.yangtools.rfc7952.model.api.MetadataStatements;
  13 import org.opendaylight.yangtools.yang.common.QName;
  14 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  15 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
  16 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
  17 import org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition;
  18 import org.opendaylight.yangtools.yang.model.api.stmt.TypeEffectiveStatement;
  19 import org.opendaylight.yangtools.yang.model.api.stmt.UnitsStatement;
  20 import org.opendaylight.yangtools.yang.model.util.type.ConcreteTypeBuilder;
  21 import org.opendaylight.yangtools.yang.model.util.type.ConcreteTypes;
  22 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.UnknownEffectiveStatementBase;
  23 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractDeclaredStatement;
  24 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStatementSupport;
  25 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  26 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
  27 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
  28 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
  29 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  30
  31 public final class AnnotationStatementSupport
  32         extends AbstractStatementSupport<QName, AnnotationStatement, AnnotationEffectiveStatement> {
  33
  34     private static final class Declared extends AbstractDeclaredStatement<QName> implements AnnotationStatement {
  35         Declared(final StmtContext<QName, ?, ?> context) {
  36             super(context);
  37         }
  38
  39         @Override
  40         public QName getArgument() {
  41             return argument();
  42         }
  43     }
  44
  45     private static final class Effective extends UnknownEffectiveStatementBase<QName, AnnotationStatement>
  46             implements AnnotationEffectiveStatement {
  47
  48         private final TypeDefinition<?> type;
  49         private final SchemaPath path;
  50
  51         Effective(final StmtContext<QName, AnnotationStatement, ?> ctx) {
  52             super(ctx);
  53             path = ctx.coerceParentContext().getSchemaPath().get().createChild(argument());
  54
  55             final TypeEffectiveStatement<?> typeStmt = SourceException.throwIfNull(
  56                 firstSubstatementOfType(TypeEffectiveStatement.class), ctx.getStatementSourceReference(),
  57                 "AnnotationStatementSupport %s is missing a 'type' statement", argument());
  58
  59             final ConcreteTypeBuilder<?> builder = ConcreteTypes.concreteTypeBuilder(typeStmt.getTypeDefinition(),
  60                 path);
  61             final StmtContext<String, ?, ?> unitsStmt = StmtContextUtils.findFirstEffectiveSubstatement(ctx,
  62                 UnitsStatement.class);
  63             if (unitsStmt != null) {
  64                 builder.setUnits(unitsStmt.getStatementArgument());
  65             }
  66             type = builder.build();
  67         }
  68
  69         @Override
  70         public QName getQName() {
  71             return path.getLastComponent();
  72         }
  73
  74         @Override
  75         public SchemaPath getPath() {
  76             return path;
  77         }
  78
  79         @Override
  80         public TypeDefinition<?> getType() {
  81             return type;
  82         }
  83     }
  84
  85     private static final AnnotationStatementSupport INSTANCE = new AnnotationStatementSupport(
  86         MetadataStatements.ANNOTATION);
  87
  88     private final SubstatementValidator validator;
  89
  90     AnnotationStatementSupport(final StatementDefinition definition) {
  91         super(definition);
  92         this.validator = SubstatementValidator.builder(definition)
  93                 .addMandatory(YangStmtMapping.TYPE)
  94                 .addOptional(YangStmtMapping.DESCRIPTION)
  95                 .addAny(YangStmtMapping.IF_FEATURE)
  96                 .addOptional(YangStmtMapping.REFERENCE)
  97                 .addOptional(YangStmtMapping.STATUS)
  98                 .addOptional(YangStmtMapping.UNITS)
  99                 .build();
 100     }
 101
 102     public static AnnotationStatementSupport getInstance() {
 103         return INSTANCE;
 104     }
 105
 106     @Override
 107     public AnnotationStatement createDeclared(final StmtContext<QName, AnnotationStatement, ?> ctx) {
 108         return new Declared(ctx);
 109     }
 110
 111     @Override
 112     public AnnotationEffectiveStatement createEffective(
 113             final StmtContext<QName, AnnotationStatement, AnnotationEffectiveStatement> ctx) {
 114         return new Effective(ctx);
 115     }
 116
 117     @Override
 118     public QName parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
 119         return StmtContextUtils.parseIdentifier(ctx, value);
 120     }
 121
 122     @Override
 123     public void onStatementAdded(final Mutable<QName, AnnotationStatement, AnnotationEffectiveStatement> stmt) {
 124         final StatementDefinition parentDef = stmt.coerceParentContext().getPublicDefinition();
 125         SourceException.throwIf(YangStmtMapping.MODULE != parentDef && YangStmtMapping.SUBMODULE != parentDef,
 126                 stmt.getStatementSourceReference(),
 127                 "Annotations may only be defined at root of either a module or a submodule");
 128     }
 129
 130     @Override
 131     protected SubstatementValidator getSubstatementValidator() {
 132         return validator;
 133     }
 134 }