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.eclipse.jdt.annotation.Nullable;
13 import org.opendaylight.yangtools.rfc7952.model.api.AnnotationEffectiveStatement;
14 import org.opendaylight.yangtools.rfc7952.model.api.AnnotationSchemaNode;
15 import org.opendaylight.yangtools.rfc7952.model.api.AnnotationStatement;
16 import org.opendaylight.yangtools.rfc7952.model.api.MetadataStatements;
17 import org.opendaylight.yangtools.yang.common.QName;
18 import org.opendaylight.yangtools.yang.model.api.SchemaNodeDefaults;
19 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
20 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
21 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
22 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
23 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
24 import org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition;
25 import org.opendaylight.yangtools.yang.model.api.stmt.TypeEffectiveStatement;
26 import org.opendaylight.yangtools.yang.model.api.stmt.UnitsEffectiveStatement;
27 import org.opendaylight.yangtools.yang.model.util.type.ConcreteTypeBuilder;
28 import org.opendaylight.yangtools.yang.model.util.type.ConcreteTypes;
29 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.AbstractDeclaredStatement.WithQNameArgument.WithSubstatements;
30 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.UnknownEffectiveStatementBase;
31 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStatementSupport;
32 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
33 import org.opendaylight.yangtools.yang.parser.spi.meta.SchemaPathSupport;
34 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
35 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
36 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
37 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
38 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
40 public final class AnnotationStatementSupport
41 extends AbstractStatementSupport<QName, AnnotationStatement, AnnotationEffectiveStatement> {
43 private static final class Declared extends WithSubstatements implements AnnotationStatement {
44 Declared(final QName argument, final ImmutableList<? extends DeclaredStatement<?>> substatements) {
45 super(argument, substatements);
49 private static final class Effective extends UnknownEffectiveStatementBase<QName, AnnotationStatement>
50 implements AnnotationEffectiveStatement, AnnotationSchemaNode {
52 private final @NonNull TypeDefinition<?> type;
53 private final @Nullable SchemaPath path;
55 Effective(final Current<QName, AnnotationStatement> stmt,
56 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
57 super(stmt, substatements);
58 path = SchemaPathSupport.wrap(stmt.getEffectiveParent().getSchemaPath().createChild(argument()));
60 final TypeEffectiveStatement<?> typeStmt = SourceException.throwIfNull(
61 firstSubstatementOfType(TypeEffectiveStatement.class), stmt,
62 "AnnotationStatementSupport %s is missing a 'type' statement", argument());
64 final ConcreteTypeBuilder<?> builder = ConcreteTypes.concreteTypeBuilder(typeStmt.getTypeDefinition(),
66 final UnitsEffectiveStatement unitsStmt = firstSubstatementOfType(UnitsEffectiveStatement.class);
67 if (unitsStmt != null) {
68 builder.setUnits(unitsStmt.argument());
70 type = builder.build();
74 public QName getQName() {
75 return path.getLastComponent();
80 public SchemaPath getPath() {
81 return SchemaNodeDefaults.throwUnsupportedIfNull(this, path);
85 public TypeDefinition<?> getType() {
90 public TypeDefinition<?> getTypeDefinition() {
95 public AnnotationEffectiveStatement asEffectiveStatement() {
100 private static final AnnotationStatementSupport INSTANCE = new AnnotationStatementSupport(
101 MetadataStatements.ANNOTATION);
103 private final SubstatementValidator validator;
105 AnnotationStatementSupport(final StatementDefinition definition) {
106 super(definition, CopyPolicy.REJECT);
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)
117 public static AnnotationStatementSupport getInstance() {
122 public QName parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
123 return StmtContextUtils.parseIdentifier(ctx, value);
127 public void onStatementAdded(final Mutable<QName, AnnotationStatement, AnnotationEffectiveStatement> stmt) {
128 final StatementDefinition parentDef = stmt.coerceParentContext().publicDefinition();
129 SourceException.throwIf(YangStmtMapping.MODULE != parentDef && YangStmtMapping.SUBMODULE != parentDef,
130 stmt, "Annotations may only be defined at root of either a module or a submodule");
134 protected SubstatementValidator getSubstatementValidator() {
139 protected AnnotationStatement createDeclared(final StmtContext<QName, AnnotationStatement, ?> ctx,
140 final ImmutableList<? extends DeclaredStatement<?>> substatements) {
141 return new Declared(ctx.getArgument(), substatements);
145 protected AnnotationStatement createEmptyDeclared(final StmtContext<QName, AnnotationStatement, ?> ctx) {
146 return createDeclared(ctx, ImmutableList.of());
150 protected AnnotationEffectiveStatement createEffective(final Current<QName, AnnotationStatement> stmt,
151 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
152 return new Effective(stmt, substatements);