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.ConstraintDefinition;
  15 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  16 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
  17 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
  18 import org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition;
  19 import org.opendaylight.yangtools.yang.model.api.stmt.TypeEffectiveStatement;
  20 import org.opendaylight.yangtools.yang.model.api.stmt.UnitsStatement;
  21 import org.opendaylight.yangtools.yang.model.util.type.ConcreteTypeBuilder;
  22 import org.opendaylight.yangtools.yang.model.util.type.ConcreteTypes;
  23 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.UnknownEffectiveStatementBase;
  24 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractDeclaredStatement;
  25 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStatementSupport;
  26 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  27 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
  28 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
  29 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
  30 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  31
  32 final class Annotation 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.getParentContext().getSchemaPath().get().createChild(
  54                 StmtContextUtils.qnameFromArgument(ctx, argument()));
  55
  56             final TypeEffectiveStatement<?> typeStmt = SourceException.throwIfNull(
  57                 firstSubstatementOfType(TypeEffectiveStatement.class), ctx.getStatementSourceReference(),
  58                 "Annotation %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         @Override
  86         public boolean isConfiguration() {
  87             return false;
  88         }
  89
  90         @Override
  91         public ConstraintDefinition getConstraints() {
  92             return null;
  93         }
  94
  95         @Override
  96         public boolean isAugmenting() {
  97             return false;
  98         }
  99     }
 100
 101     private static final Annotation INSTANCE = new Annotation(MetadataStatements.ANNOTATION);
 102
 103     private final SubstatementValidator validator;
 104
 105     Annotation(final StatementDefinition definition) {
 106         super(definition);
 107         this.validator = SubstatementValidator.builder(definition)
 108                 .addMandatory(YangStmtMapping.TYPE)
 109                 .addOptional(YangStmtMapping.DESCRIPTION)
 110                 .addAny(YangStmtMapping.IF_FEATURE)
 111                 .addOptional(YangStmtMapping.REFERENCE)
 112                 .addOptional(YangStmtMapping.STATUS)
 113                 .addOptional(YangStmtMapping.UNITS)
 114                 .build();
 115     }
 116
 117     static Annotation getInstance() {
 118         return INSTANCE;
 119     }
 120
 121     @Override
 122     public AnnotationStatement createDeclared(final StmtContext<String, AnnotationStatement, ?> ctx) {
 123         return new Declared(ctx);
 124     }
 125
 126     @Override
 127     public AnnotationEffectiveStatement createEffective(
 128             final StmtContext<String, AnnotationStatement, AnnotationEffectiveStatement> ctx) {
 129         return new Effective(ctx);
 130     }
 131
 132     @Override
 133     public String parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
 134         // FIXME: validate this is in fact an identifier as per RFC7950 Section 6.2
 135         return value;
 136     }
 137
 138     @Override
 139     public void onStatementAdded(final Mutable<String, AnnotationStatement, AnnotationEffectiveStatement> stmt) {
 140         final StatementDefinition parentDef = stmt.getParentContext().getPublicDefinition();
 141         SourceException.throwIf(YangStmtMapping.MODULE != parentDef && YangStmtMapping.SUBMODULE != parentDef,
 142                 stmt.getStatementSourceReference(),
 143                 "Annotations may only be defined at root of either a module or a submodule");
 144     }
 145
 146     @Override
 147     protected SubstatementValidator getSubstatementValidator() {
 148         return validator;
 149     }
 150 }