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