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 static com.google.common.base.Verify.verifyNotNull;
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.spi.type.ConcreteTypeBuilder;
30 import org.opendaylight.yangtools.yang.model.spi.type.ConcreteTypes;
31 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.AbstractDeclaredStatement.WithQNameArgument.WithSubstatements;
32 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.UnknownEffectiveStatementBase;
33 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStatementSupport;
34 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
35 import org.opendaylight.yangtools.yang.parser.spi.meta.SchemaPathSupport;
36 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
37 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
38 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
39 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
40 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
42 public final class AnnotationStatementSupport
43 extends AbstractStatementSupport<QName, AnnotationStatement, AnnotationEffectiveStatement> {
45 private static final class Declared extends WithSubstatements implements AnnotationStatement {
46 Declared(final QName argument, final ImmutableList<? extends DeclaredStatement<?>> substatements) {
47 super(argument, substatements);
51 private static final class Effective extends UnknownEffectiveStatementBase<QName, AnnotationStatement>
52 implements AnnotationEffectiveStatement, AnnotationSchemaNode {
54 private final @NonNull TypeDefinition<?> type;
55 private final @Nullable SchemaPath path;
57 Effective(final Current<QName, AnnotationStatement> stmt,
58 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
59 super(stmt, substatements);
60 final QName qname = stmt.getArgument();
62 // FIXME: move this into onFullDefinitionDeclared()
63 final TypeEffectiveStatement<?> typeStmt = SourceException.throwIfNull(
64 firstSubstatementOfType(TypeEffectiveStatement.class), stmt,
65 "AnnotationStatementSupport %s is missing a 'type' statement", qname);
67 final ConcreteTypeBuilder<?> builder = ConcreteTypes.concreteTypeBuilder(typeStmt.getTypeDefinition(),
69 final UnitsEffectiveStatement unitsStmt = firstSubstatementOfType(UnitsEffectiveStatement.class);
70 if (unitsStmt != null) {
71 builder.setUnits(unitsStmt.argument());
73 type = builder.build();
75 path = SchemaPathSupport.toOptionalPath(stmt.getEffectiveParent().getSchemaPath().createChild(qname));
79 public QName getQName() {
80 return verifyNotNull(argument());
85 public SchemaPath getPath() {
86 return SchemaNodeDefaults.throwUnsupportedIfNull(this, path);
90 public TypeDefinition<?> getType() {
95 public TypeDefinition<?> getTypeDefinition() {
100 public AnnotationEffectiveStatement asEffectiveStatement() {
105 private static final AnnotationStatementSupport INSTANCE = new AnnotationStatementSupport(
106 MetadataStatements.ANNOTATION);
108 private final SubstatementValidator validator;
110 AnnotationStatementSupport(final StatementDefinition definition) {
111 super(definition, StatementPolicy.reject());
112 this.validator = SubstatementValidator.builder(definition)
113 .addMandatory(YangStmtMapping.TYPE)
114 .addOptional(YangStmtMapping.DESCRIPTION)
115 .addAny(YangStmtMapping.IF_FEATURE)
116 .addOptional(YangStmtMapping.REFERENCE)
117 .addOptional(YangStmtMapping.STATUS)
118 .addOptional(YangStmtMapping.UNITS)
122 public static AnnotationStatementSupport getInstance() {
127 public QName parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
128 return StmtContextUtils.parseIdentifier(ctx, value);
132 public void onStatementAdded(final Mutable<QName, AnnotationStatement, AnnotationEffectiveStatement> stmt) {
133 final StatementDefinition parentDef = stmt.coerceParentContext().publicDefinition();
134 SourceException.throwIf(YangStmtMapping.MODULE != parentDef && YangStmtMapping.SUBMODULE != parentDef,
135 stmt, "Annotations may only be defined at root of either a module or a submodule");
139 protected SubstatementValidator getSubstatementValidator() {
144 protected AnnotationStatement createDeclared(final StmtContext<QName, AnnotationStatement, ?> ctx,
145 final ImmutableList<? extends DeclaredStatement<?>> substatements) {
146 return new Declared(ctx.getArgument(), substatements);
150 protected AnnotationStatement createEmptyDeclared(final StmtContext<QName, AnnotationStatement, ?> ctx) {
151 return createDeclared(ctx, ImmutableList.of());
155 protected AnnotationEffectiveStatement createEffective(final Current<QName, AnnotationStatement> stmt,
156 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
157 return new Effective(stmt, substatements);