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 / RefineStatementImpl.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
9 package org.opendaylight.yangtools.yang.parser.stmt.rfc6020;
10
11 import java.util.Collection;
12 import javax.annotation.Nonnull;
13 import javax.annotation.Nullable;
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.MandatoryStatement;
21 import org.opendaylight.yangtools.yang.model.api.stmt.MaxElementsStatement;
22 import org.opendaylight.yangtools.yang.model.api.stmt.MinElementsStatement;
23 import org.opendaylight.yangtools.yang.model.api.stmt.MustStatement;
24 import org.opendaylight.yangtools.yang.model.api.stmt.PresenceStatement;
25 import org.opendaylight.yangtools.yang.model.api.stmt.ReferenceStatement;
26 import org.opendaylight.yangtools.yang.model.api.stmt.RefineStatement;
27 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier;
28 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractDeclaredStatement;
29 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStatementSupport;
30 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
31 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
32 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.RefineEffectiveStatementImpl;
33
34 public class RefineStatementImpl extends AbstractDeclaredStatement<SchemaNodeIdentifier> implements RefineStatement {
35     private static final SubstatementValidator SUBSTATEMENT_VALIDATOR = SubstatementValidator.builder(YangStmtMapping
36             .REFINE)
37             .addOptional(YangStmtMapping.DEFAULT)
38             .addOptional(YangStmtMapping.DESCRIPTION)
39             .addOptional(YangStmtMapping.REFERENCE)
40             .addOptional(YangStmtMapping.CONFIG)
41             .addOptional(YangStmtMapping.MANDATORY)
42             .addOptional(YangStmtMapping.PRESENCE)
43             .addAny(YangStmtMapping.MUST)
44             .addOptional(YangStmtMapping.MIN_ELEMENTS)
45             .addOptional(YangStmtMapping.MAX_ELEMENTS)
46             .build();
47
48     protected RefineStatementImpl(final StmtContext<SchemaNodeIdentifier, RefineStatement, ?> context) {
49         super(context);
50     }
51
52     public static class Definition extends AbstractStatementSupport<SchemaNodeIdentifier, RefineStatement,
53             EffectiveStatement<SchemaNodeIdentifier, RefineStatement>> {
54
55         public Definition() {
56             super(YangStmtMapping.REFINE);
57         }
58
59         @Override
60         public SchemaNodeIdentifier parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
61             return Utils.nodeIdentifierFromPath(ctx, value);
62         }
63
64         @Override
65         public RefineStatement createDeclared(final StmtContext<SchemaNodeIdentifier, RefineStatement, ?> ctx) {
66             return new RefineStatementImpl(ctx);
67         }
68
69         @Override
70         public EffectiveStatement<SchemaNodeIdentifier, RefineStatement> createEffective(
71                 final StmtContext<SchemaNodeIdentifier, RefineStatement,
72                 EffectiveStatement<SchemaNodeIdentifier, RefineStatement>> ctx) {
73             return new RefineEffectiveStatementImpl(ctx);
74         }
75
76         @Override
77         protected SubstatementValidator getSubstatementValidator() {
78             return SUBSTATEMENT_VALIDATOR;
79         }
80     }
81
82     @Override
83     public String getTargetNode() {
84         return rawArgument();
85     }
86
87     @Nullable
88     @Override
89     public DescriptionStatement getDescription() {
90         return firstDeclared(DescriptionStatement.class);
91     }
92
93     @Nonnull
94     @Override
95     public Collection<? extends IfFeatureStatement> getIfFeatures() {
96         return allDeclared(IfFeatureStatement.class);
97     }
98
99     @Nullable
100     @Override
101     public ReferenceStatement getReference() {
102         return firstDeclared(ReferenceStatement.class);
103     }
104
105     @Nonnull
106     @Override
107     public Collection<? extends MustStatement> getMusts() {
108         return allDeclared(MustStatement.class);
109     }
110
111     @Nonnull
112     @Override
113     public Collection<? extends DefaultStatement> getDefaults() {
114         return allDeclared(DefaultStatement.class);
115     }
116
117     @Nullable
118     @Override
119     public ConfigStatement getConfig() {
120         return firstDeclared(ConfigStatement.class);
121     }
122
123     @Nullable
124     @Override
125     public PresenceStatement getPresence() {
126         return firstDeclared(PresenceStatement.class);
127     }
128
129     @Nullable
130     @Override
131     public MandatoryStatement getMandatory() {
132         return firstDeclared(MandatoryStatement.class);
133     }
134
135     @Nullable
136     @Override
137     public MinElementsStatement getMinElements() {
138         return firstDeclared(MinElementsStatement.class);
139     }
140
141     @Nullable
142     @Override
143     public MaxElementsStatement getMaxElements() {
144         return firstDeclared(MaxElementsStatement.class);
145     }
146 }