yang/rfc7952-parser-support/src/main/java/org/opendaylight/yangtools/rfc7952/parser/Annotation.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 final class Annotation extends AbstractStatementSupport<String, AnnotationStatement, AnnotationEffectiveStatement> {
  32
  33     private static final class Declared extends AbstractDeclaredStatement<String> implements AnnotationStatement {
  34         Declared(final StmtContext<String, ?, ?> context) {
  35             super(context);
  36         }
  37
  38         @Override
  39         public String getArgument() {
  40             return argument();
  41         }
  42     }
  43
  44     private static final class Effective extends UnknownEffectiveStatementBase<String, AnnotationStatement>
  45             implements AnnotationEffectiveStatement {
  46
  47         private final TypeDefinition<?> type;
  48         private final SchemaPath path;
  49
  50         Effective(final StmtContext<String, AnnotationStatement, ?> ctx) {
  51             super(ctx);
  52             path = ctx.getParentContext().getSchemaPath().get().createChild(
  53                 StmtContextUtils.qnameFromArgument(ctx, argument()));
  54
  55             final TypeEffectiveStatement<?> typeStmt = SourceException.throwIfNull(
  56                 firstSubstatementOfType(TypeEffectiveStatement.class), ctx.getStatementSourceReference(),
  57                 "Annotation %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 Annotation INSTANCE = new Annotation(MetadataStatements.ANNOTATION);
  86
  87     private final SubstatementValidator validator;
  88
  89     Annotation(final StatementDefinition definition) {
  90         super(definition);
  91         this.validator = SubstatementValidator.builder(definition)
  92                 .addMandatory(YangStmtMapping.TYPE)
  93                 .addOptional(YangStmtMapping.DESCRIPTION)
  94                 .addAny(YangStmtMapping.IF_FEATURE)
  95                 .addOptional(YangStmtMapping.REFERENCE)
  96                 .addOptional(YangStmtMapping.STATUS)
  97                 .addOptional(YangStmtMapping.UNITS)
  98                 .build();
  99     }
 100
 101     static Annotation getInstance() {
 102         return INSTANCE;
 103     }
 104
 105     @Override
 106     public AnnotationStatement createDeclared(final StmtContext<String, AnnotationStatement, ?> ctx) {
 107         return new Declared(ctx);
 108     }
 109
 110     @Override
 111     public AnnotationEffectiveStatement createEffective(
 112             final StmtContext<String, AnnotationStatement, AnnotationEffectiveStatement> ctx) {
 113         return new Effective(ctx);
 114     }
 115
 116     @Override
 117     public String parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
 118         // FIXME: validate this is in fact an identifier as per RFC7950 Section 6.2
 119         return value;
 120     }
 121
 122     @Override
 123     public void onStatementAdded(final Mutable<String, AnnotationStatement, AnnotationEffectiveStatement> stmt) {
 124         final StatementDefinition parentDef = stmt.getParentContext().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 }