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