2 * Copyright (c) 2017 Pantheon Technologies, s.r.o. and others. All rights reserved.
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
8 package org.opendaylight.yangtools.rfc7952.parser;
10 import com.google.common.collect.ImmutableList;
11 import org.eclipse.jdt.annotation.NonNull;
12 import org.opendaylight.yangtools.rfc7952.model.api.AnnotationEffectiveStatement;
13 import org.opendaylight.yangtools.rfc7952.model.api.AnnotationSchemaNode;
14 import org.opendaylight.yangtools.rfc7952.model.api.AnnotationStatement;
15 import org.opendaylight.yangtools.rfc7952.model.api.MetadataStatements;
16 import org.opendaylight.yangtools.yang.common.QName;
17 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
18 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
19 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
20 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
21 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
22 import org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition;
23 import org.opendaylight.yangtools.yang.model.api.stmt.TypeEffectiveStatement;
24 import org.opendaylight.yangtools.yang.model.api.stmt.UnitsStatement;
25 import org.opendaylight.yangtools.yang.model.util.type.ConcreteTypeBuilder;
26 import org.opendaylight.yangtools.yang.model.util.type.ConcreteTypes;
27 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.AbstractDeclaredStatement.WithQNameArgument.WithSubstatements;
28 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.BaseStatementSupport;
29 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.UnknownEffectiveStatementBase;
30 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
31 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
32 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
33 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
34 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
36 public final class AnnotationStatementSupport
37 extends BaseStatementSupport<QName, AnnotationStatement, AnnotationEffectiveStatement> {
39 private static final class Declared extends WithSubstatements implements AnnotationStatement {
40 Declared(final QName argument, final ImmutableList<? extends DeclaredStatement<?>> substatements) {
41 super(argument, substatements);
45 private static final class Effective extends UnknownEffectiveStatementBase<QName, AnnotationStatement>
46 implements AnnotationEffectiveStatement, AnnotationSchemaNode {
48 private final @NonNull TypeDefinition<?> type;
49 private final @NonNull SchemaPath path;
51 Effective(final StmtContext<QName, AnnotationStatement, ?> ctx,
52 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
53 super(ctx, substatements);
54 path = ctx.coerceParentContext().getSchemaPath().get().createChild(argument());
56 final TypeEffectiveStatement<?> typeStmt = SourceException.throwIfNull(
57 firstSubstatementOfType(TypeEffectiveStatement.class), ctx.getStatementSourceReference(),
58 "AnnotationStatementSupport %s is missing a 'type' statement", argument());
60 final ConcreteTypeBuilder<?> builder = ConcreteTypes.concreteTypeBuilder(typeStmt.getTypeDefinition(),
62 final StmtContext<String, ?, ?> unitsStmt = StmtContextUtils.findFirstEffectiveSubstatement(ctx,
63 UnitsStatement.class);
64 if (unitsStmt != null) {
65 builder.setUnits(unitsStmt.getStatementArgument());
67 type = builder.build();
71 public QName getQName() {
72 return path.getLastComponent();
77 public SchemaPath getPath() {
82 public TypeDefinition<?> getType() {
87 public TypeDefinition<?> getTypeDefinition() {
92 public AnnotationEffectiveStatement asEffectiveStatement() {
97 private static final AnnotationStatementSupport INSTANCE = new AnnotationStatementSupport(
98 MetadataStatements.ANNOTATION);
100 private final SubstatementValidator validator;
102 AnnotationStatementSupport(final StatementDefinition definition) {
104 this.validator = SubstatementValidator.builder(definition)
105 .addMandatory(YangStmtMapping.TYPE)
106 .addOptional(YangStmtMapping.DESCRIPTION)
107 .addAny(YangStmtMapping.IF_FEATURE)
108 .addOptional(YangStmtMapping.REFERENCE)
109 .addOptional(YangStmtMapping.STATUS)
110 .addOptional(YangStmtMapping.UNITS)
114 public static AnnotationStatementSupport getInstance() {
119 public QName parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
120 return StmtContextUtils.parseIdentifier(ctx, value);
124 public void onStatementAdded(final Mutable<QName, AnnotationStatement, AnnotationEffectiveStatement> stmt) {
125 final StatementDefinition parentDef = stmt.coerceParentContext().getPublicDefinition();
126 SourceException.throwIf(YangStmtMapping.MODULE != parentDef && YangStmtMapping.SUBMODULE != parentDef,
127 stmt.getStatementSourceReference(),
128 "Annotations may only be defined at root of either a module or a submodule");
132 protected SubstatementValidator getSubstatementValidator() {
137 protected AnnotationStatement createDeclared(final StmtContext<QName, AnnotationStatement, ?> ctx,
138 final ImmutableList<? extends DeclaredStatement<?>> substatements) {
139 return new Declared(ctx.coerceStatementArgument(), substatements);
143 protected AnnotationStatement createEmptyDeclared(final StmtContext<QName, AnnotationStatement, ?> ctx) {
144 return createDeclared(ctx, ImmutableList.of());
148 protected AnnotationEffectiveStatement createEffective(
149 final StmtContext<QName, AnnotationStatement, AnnotationEffectiveStatement> ctx,
150 final AnnotationStatement declared,
151 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
152 return new Effective(ctx, substatements);
156 protected AnnotationEffectiveStatement createEmptyEffective(
157 final StmtContext<QName, AnnotationStatement, AnnotationEffectiveStatement> ctx,
158 final AnnotationStatement declared) {
159 return new Effective(ctx, ImmutableList.of());