YANGTOOLS-706: Split up base utility classes into rfc6020.util
[yangtools.git] / yang / yang-parser-impl / src / main / java / org / opendaylight / yangtools / yang / parser / stmt / rfc6020 / LeafStatementImpl.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 java.util.Collection;
11 import javax.annotation.Nonnull;
12 import javax.annotation.Nullable;
13 import org.opendaylight.yangtools.yang.common.QName;
14 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
15 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
16 import org.opendaylight.yangtools.yang.model.api.stmt.ConfigStatement;
17 import org.opendaylight.yangtools.yang.model.api.stmt.DefaultStatement;
18 import org.opendaylight.yangtools.yang.model.api.stmt.DescriptionStatement;
19 import org.opendaylight.yangtools.yang.model.api.stmt.IfFeatureStatement;
20 import org.opendaylight.yangtools.yang.model.api.stmt.LeafStatement;
21 import org.opendaylight.yangtools.yang.model.api.stmt.MandatoryStatement;
22 import org.opendaylight.yangtools.yang.model.api.stmt.MustStatement;
23 import org.opendaylight.yangtools.yang.model.api.stmt.ReferenceStatement;
24 import org.opendaylight.yangtools.yang.model.api.stmt.StatusStatement;
25 import org.opendaylight.yangtools.yang.model.api.stmt.TypeStatement;
26 import org.opendaylight.yangtools.yang.model.api.stmt.UnitsStatement;
27 import org.opendaylight.yangtools.yang.model.api.stmt.WhenStatement;
28 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractDeclaredStatement;
29 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractQNameStatementSupport;
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.stmt.rfc6020.effective.LeafEffectiveStatementImpl;
35
36 public class LeafStatementImpl extends AbstractDeclaredStatement<QName> implements LeafStatement {
37     private static final SubstatementValidator SUBSTATEMENT_VALIDATOR = SubstatementValidator.builder(YangStmtMapping
38             .LEAF)
39             .addOptional(YangStmtMapping.CONFIG)
40             .addOptional(YangStmtMapping.DEFAULT)
41             .addOptional(YangStmtMapping.DESCRIPTION)
42             .addAny(YangStmtMapping.IF_FEATURE)
43             .addOptional(YangStmtMapping.MANDATORY)
44             .addAny(YangStmtMapping.MUST)
45             .addOptional(YangStmtMapping.REFERENCE)
46             .addOptional(YangStmtMapping.STATUS)
47             .addMandatory(YangStmtMapping.TYPE)
48             .addOptional(YangStmtMapping.UNITS)
49             .addOptional(YangStmtMapping.WHEN)
50             .build();
51
52     protected LeafStatementImpl(final StmtContext<QName, LeafStatement, ?> context) {
53         super(context);
54     }
55
56     public static class Definition
57             extends AbstractQNameStatementSupport<LeafStatement, EffectiveStatement<QName, LeafStatement>> {
58
59         public Definition() {
60             super(YangStmtMapping.LEAF);
61         }
62
63         @Override public QName parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
64             return StmtContextUtils.qnameFromArgument(ctx,value);
65         }
66
67         @Override
68         public void onStatementAdded(final Mutable<QName, LeafStatement,
69                 EffectiveStatement<QName, LeafStatement>> stmt) {
70             stmt.getParentContext().addToNs(ChildSchemaNodes.class, stmt.getStatementArgument(), stmt);
71         }
72
73         @Override
74         public LeafStatement createDeclared(final StmtContext<QName, LeafStatement, ?> ctx) {
75             return new LeafStatementImpl(ctx);
76         }
77
78         @Override
79         public EffectiveStatement<QName, LeafStatement> createEffective(
80                 final StmtContext<QName, LeafStatement, EffectiveStatement<QName, LeafStatement>> ctx) {
81             return new LeafEffectiveStatementImpl(ctx);
82         }
83
84         @Override
85         protected SubstatementValidator getSubstatementValidator() {
86             return SUBSTATEMENT_VALIDATOR;
87         }
88
89         @Override
90         public void onFullDefinitionDeclared(
91                 final Mutable<QName, LeafStatement, EffectiveStatement<QName, LeafStatement>> ctx) {
92             super.onFullDefinitionDeclared(ctx);
93             StmtContextUtils.validateIfFeatureAndWhenOnListKeys(ctx);
94         }
95     }
96
97     @Nullable
98     @Override
99     public Collection<? extends MustStatement> getMusts() {
100         return allDeclared(MustStatement.class);
101     }
102
103     @Nullable
104     @Override
105     public DefaultStatement getDefault() {
106         return firstDeclared(DefaultStatement.class);
107     }
108
109     @Nullable
110     @Override
111     public ConfigStatement getConfig() {
112         return firstDeclared(ConfigStatement.class);
113     }
114
115     @Nullable
116     @Override
117     public MandatoryStatement getMandatory() {
118         return firstDeclared(MandatoryStatement.class);
119     }
120
121     @Nonnull
122     @Override
123     public QName getName() {
124         return argument();
125     }
126
127     @Override
128     public WhenStatement getWhenStatement() {
129         return firstDeclared(WhenStatement.class);
130     }
131
132     @Nonnull
133     @Override
134     public Collection<? extends IfFeatureStatement> getIfFeatures() {
135         return allDeclared(IfFeatureStatement.class);
136     }
137
138     @Nullable
139     @Override
140     public DescriptionStatement getDescription() {
141         return firstDeclared(DescriptionStatement.class);
142     }
143
144     @Nullable
145     @Override
146     public ReferenceStatement getReference() {
147         return firstDeclared(ReferenceStatement.class);
148     }
149
150     @Nonnull
151     @Override
152     public TypeStatement getType() {
153         return firstDeclared(TypeStatement.class);
154     }
155
156     @Nullable
157     @Override
158     public UnitsStatement getUnits() {
159         return firstDeclared(UnitsStatement.class);
160     }
161
162     @Nullable
163     @Override
164     public StatusStatement getStatus() {
165         return firstDeclared(StatusStatement.class);
166     }
167 }