Bug 2444 - add missing API of some declared statements
[yangtools.git] / yang / yang-parser-impl / src / main / java / org / opendaylight / yangtools / yang / parser / stmt / rfc6020 / TypedefStatementImpl.java
1 /*
2  * Copyright (c) 2015 Cisco Systems, Inc. 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.yang.parser.stmt.rfc6020;
9
10 import javax.annotation.Nonnull;
11 import javax.annotation.Nullable;
12 import org.opendaylight.yangtools.yang.common.QName;
13 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
14 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
15 import org.opendaylight.yangtools.yang.model.api.stmt.DefaultStatement;
16 import org.opendaylight.yangtools.yang.model.api.stmt.DescriptionStatement;
17 import org.opendaylight.yangtools.yang.model.api.stmt.ReferenceStatement;
18 import org.opendaylight.yangtools.yang.model.api.stmt.StatusStatement;
19 import org.opendaylight.yangtools.yang.model.api.stmt.TypeStatement;
20 import org.opendaylight.yangtools.yang.model.api.stmt.TypedefEffectiveStatement;
21 import org.opendaylight.yangtools.yang.model.api.stmt.TypedefStatement;
22 import org.opendaylight.yangtools.yang.model.api.stmt.UnitsStatement;
23 import org.opendaylight.yangtools.yang.parser.spi.TypeNamespace;
24 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractDeclaredStatement;
25 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractQNameStatementSupport;
26 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
27 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
28 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
29 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
30 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.TypeDefEffectiveStatementImpl;
31
32 public class TypedefStatementImpl extends AbstractDeclaredStatement<QName> implements TypedefStatement {
33     private static final SubstatementValidator SUBSTATEMENT_VALIDATOR = SubstatementValidator.builder(YangStmtMapping
34             .TYPEDEF)
35             .addOptional(YangStmtMapping.DEFAULT)
36             .addOptional(YangStmtMapping.DESCRIPTION)
37             .addOptional(YangStmtMapping.REFERENCE)
38             .addOptional(YangStmtMapping.STATUS)
39             .addMandatory(YangStmtMapping.TYPE)
40             .addOptional(YangStmtMapping.UNITS)
41             .build();
42
43     protected TypedefStatementImpl(final StmtContext<QName, TypedefStatement, ?> context) {
44         super(context);
45     }
46
47     public static class Definition extends
48             AbstractQNameStatementSupport<TypedefStatement, EffectiveStatement<QName, TypedefStatement>> {
49
50         public Definition() {
51             super(YangStmtMapping.TYPEDEF);
52         }
53
54         @Override
55         public QName parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
56             return StmtContextUtils.qnameFromArgument(ctx, value);
57         }
58
59         @Override
60         public TypedefStatement createDeclared(final StmtContext<QName, TypedefStatement, ?> ctx) {
61             return new TypedefStatementImpl(ctx);
62         }
63
64         @Override
65         public EffectiveStatement<QName, TypedefStatement> createEffective(
66                 final StmtContext<QName, TypedefStatement, EffectiveStatement<QName, TypedefStatement>> ctx) {
67             return new TypeDefEffectiveStatementImpl(ctx);
68         }
69
70         @Override
71         public void onFullDefinitionDeclared(final StmtContext.Mutable<QName, TypedefStatement,
72                 EffectiveStatement<QName, TypedefStatement>> stmt) {
73             super.onFullDefinitionDeclared(stmt);
74
75             if (stmt != null && stmt.getParentContext() != null) {
76                 final StmtContext<?, TypedefStatement, TypedefEffectiveStatement> existing = stmt.getParentContext()
77                         .getFromNamespace(TypeNamespace.class, stmt.getStatementArgument());
78                 SourceException.throwIf(existing != null, stmt.getStatementSourceReference(),
79                         "Duplicate name for typedef %s", stmt.getStatementArgument());
80
81                 stmt.getParentContext().addContext(TypeNamespace.class, stmt.getStatementArgument(), stmt);
82             }
83         }
84
85         @Override
86         protected SubstatementValidator getSubstatementValidator() {
87             return SUBSTATEMENT_VALIDATOR;
88         }
89     }
90
91     @Nullable
92     @Override
93     public StatusStatement getStatus() {
94         return firstDeclared(StatusStatement.class);
95     }
96
97     @Nullable
98     @Override
99     public DescriptionStatement getDescription() {
100         return firstDeclared(DescriptionStatement.class);
101     }
102
103     @Nullable
104     @Override
105     public ReferenceStatement getReference() {
106         return firstDeclared(ReferenceStatement.class);
107     }
108
109     @Nonnull
110     @Override
111     public TypeStatement getType() {
112         return firstDeclared(TypeStatement.class);
113     }
114
115     @Override
116     public UnitsStatement getUnits() {
117         return firstDeclared(UnitsStatement.class);
118     }
119
120     @Nonnull
121     @Override
122     public QName getName() {
123         return argument();
124     }
125
126     @Nullable
127     @Override
128     public DefaultStatement getDefault() {
129         return firstDeclared(DefaultStatement.class);
130     }
131 }