aff545e7f771f373fe1678e122284176d28e2f1e
[yangtools.git] / yang / yang-parser-impl / src / main / java / org / opendaylight / yangtools / yang / parser / stmt / rfc8040 / YangDataStatementSupport.java
1 /*
2  * Copyright (c) 2017 Pantheon Technologies, s.r.o. 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.rfc8040;
9
10 import com.google.common.annotations.Beta;
11 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
12 import org.opendaylight.yangtools.yang.model.api.stmt.UnknownStatement;
13 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStatementSupport;
14 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
15 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
16 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
17 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.SupportedExtensionsMapping;
18
19 @Beta
20 public final class YangDataStatementSupport extends AbstractStatementSupport<String, UnknownStatement<String>,
21         EffectiveStatement<String, UnknownStatement<String>>> {
22     private static final YangDataStatementSupport INSTANCE = new YangDataStatementSupport();
23
24     private YangDataStatementSupport() {
25         super(SupportedExtensionsMapping.YANG_DATA);
26     }
27
28     public static YangDataStatementSupport getInstance() {
29         return INSTANCE;
30     }
31
32     @Override
33     protected SubstatementValidator getSubstatementValidator() {
34         return YangDataStatement.SUBSTATEMENT_VALIDATOR;
35     }
36
37     @Override
38     public String parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
39         return value;
40     }
41
42     @Override
43     public UnknownStatement<String> createDeclared(final StmtContext<String, UnknownStatement<String>, ?> ctx) {
44         return new YangDataStatement(ctx);
45     }
46
47     @Override
48     public EffectiveStatement<String, UnknownStatement<String>> createEffective(final StmtContext<String,
49             UnknownStatement<String>, EffectiveStatement<String, UnknownStatement<String>>> ctx) {
50         // in case of yang-data node we need to perform substatement validation at the point when we have
51         // effective substatement contexts already available - if the node has only a uses statement declared in it,
52         // one top-level container node may very well be added to the yang-data as an effective statement
53         YangDataStatement.SUBSTATEMENT_VALIDATOR.validate(ctx);
54         return new YangDataEffectiveStatement(ctx);
55     }
56
57     @Override
58     public void onFullDefinitionDeclared(final Mutable<String, UnknownStatement<String>,
59             EffectiveStatement<String, UnknownStatement<String>>> ctx) {
60         // as per https://tools.ietf.org/html/rfc8040#section-8,
61         // yang-data is ignored unless it appears as a top-level statement
62         if (ctx.getParentContext().getParentContext() != null) {
63             ctx.setIsSupportedToBuildEffective(false);
64         }
65     }
66
67     @Override
68     public boolean isIgnoringIfFeatures() {
69         return true;
70     }
71
72     @Override
73     public boolean isIgnoringConfig() {
74         return true;
75     }
76 }