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.EffectiveStmtCtx.Current;
31 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
32 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
33 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
34 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
35 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
37 public final class AnnotationStatementSupport
38 extends BaseStatementSupport<QName, AnnotationStatement, AnnotationEffectiveStatement> {
40 private static final class Declared extends WithSubstatements implements AnnotationStatement {
41 Declared(final QName argument, final ImmutableList<? extends DeclaredStatement<?>> substatements) {
42 super(argument, substatements);
46 private static final class Effective extends UnknownEffectiveStatementBase<QName, AnnotationStatement>
47 implements AnnotationEffectiveStatement, AnnotationSchemaNode {
49 private final @NonNull TypeDefinition<?> type;
50 private final @NonNull SchemaPath path;
52 Effective(final Current<QName, AnnotationStatement> stmt,
53 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
54 super(stmt, substatements);
55 path = stmt.getParent().getSchemaPath().createChild(argument());
57 final TypeEffectiveStatement<?> typeStmt = SourceException.throwIfNull(
58 firstSubstatementOfType(TypeEffectiveStatement.class), stmt.sourceReference(),
59 "AnnotationStatementSupport %s is missing a 'type' statement", argument());
61 final ConcreteTypeBuilder<?> builder = ConcreteTypes.concreteTypeBuilder(typeStmt.getTypeDefinition(),
63 final StmtContext<String, ?, ?> unitsStmt = StmtContextUtils.findFirstEffectiveSubstatement(
64 stmt.caerbannog(), UnitsStatement.class);
65 if (unitsStmt != null) {
66 builder.setUnits(unitsStmt.getStatementArgument());
68 type = builder.build();
72 public QName getQName() {
73 return path.getLastComponent();
78 public SchemaPath getPath() {
83 public TypeDefinition<?> getType() {
88 public TypeDefinition<?> getTypeDefinition() {
93 public AnnotationEffectiveStatement asEffectiveStatement() {
98 private static final AnnotationStatementSupport INSTANCE = new AnnotationStatementSupport(
99 MetadataStatements.ANNOTATION);
101 private final SubstatementValidator validator;
103 AnnotationStatementSupport(final StatementDefinition definition) {
105 this.validator = SubstatementValidator.builder(definition)
106 .addMandatory(YangStmtMapping.TYPE)
107 .addOptional(YangStmtMapping.DESCRIPTION)
108 .addAny(YangStmtMapping.IF_FEATURE)
109 .addOptional(YangStmtMapping.REFERENCE)
110 .addOptional(YangStmtMapping.STATUS)
111 .addOptional(YangStmtMapping.UNITS)
115 public static AnnotationStatementSupport getInstance() {
120 public QName parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
121 return StmtContextUtils.parseIdentifier(ctx, value);
125 public void onStatementAdded(final Mutable<QName, 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");
133 protected SubstatementValidator getSubstatementValidator() {
138 protected AnnotationStatement createDeclared(final StmtContext<QName, AnnotationStatement, ?> ctx,
139 final ImmutableList<? extends DeclaredStatement<?>> substatements) {
140 return new Declared(ctx.coerceStatementArgument(), substatements);
144 protected AnnotationStatement createEmptyDeclared(final StmtContext<QName, AnnotationStatement, ?> ctx) {
145 return createDeclared(ctx, ImmutableList.of());
149 protected AnnotationEffectiveStatement createEffective(final Current<QName, AnnotationStatement> stmt,
150 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
151 return new Effective(stmt, substatements);