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