Promote BaseStatementSupport to parser.spi.meta
[yangtools.git] / yang / yang-parser-rfc7950 / src / main / java / org / opendaylight / yangtools / yang / parser / rfc7950 / stmt / must / MustStatementSupport.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.rfc7950.stmt.must;
9
10 import static java.util.Objects.requireNonNull;
11
12 import com.google.common.collect.ImmutableList;
13 import org.eclipse.jdt.annotation.NonNull;
14 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
15 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
16 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
17 import org.opendaylight.yangtools.yang.model.api.stmt.MustEffectiveStatement;
18 import org.opendaylight.yangtools.yang.model.api.stmt.MustStatement;
19 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.XPathSupport;
20 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStatementSupport;
21 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
22 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
23 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
24 import org.opendaylight.yangtools.yang.xpath.api.YangXPathExpression.QualifiedBound;
25
26 public final class MustStatementSupport
27         extends AbstractStatementSupport<QualifiedBound, MustStatement, MustEffectiveStatement> {
28     private static final SubstatementValidator SUBSTATEMENT_VALIDATOR = SubstatementValidator.builder(YangStmtMapping
29         .MUST)
30         .addOptional(YangStmtMapping.DESCRIPTION)
31         .addOptional(YangStmtMapping.ERROR_APP_TAG)
32         .addOptional(YangStmtMapping.ERROR_MESSAGE)
33         .addOptional(YangStmtMapping.REFERENCE)
34         .build();
35
36     private final @NonNull XPathSupport xpathSupport;
37
38     private MustStatementSupport(final XPathSupport xpathSupport) {
39         // Note: if we end up binding expressions, this needs to become declaredCopy()
40         super(YangStmtMapping.MUST, StatementPolicy.contextIndependent());
41         this.xpathSupport = requireNonNull(xpathSupport);
42     }
43
44     public static MustStatementSupport createInstance(final XPathSupport xpathSupport) {
45         return new MustStatementSupport(xpathSupport);
46     }
47
48     @Override
49     public QualifiedBound parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
50         return xpathSupport.parseXPath(ctx, value);
51     }
52
53     @Override
54     protected SubstatementValidator getSubstatementValidator() {
55         return SUBSTATEMENT_VALIDATOR;
56     }
57
58     @Override
59     protected MustStatement createDeclared(final StmtContext<QualifiedBound, MustStatement, ?> ctx,
60             final ImmutableList<? extends DeclaredStatement<?>> substatements) {
61         return new RegularMustStatement(ctx.getRawArgument(), ctx.getArgument(), substatements);
62     }
63
64     @Override
65     protected MustStatement createEmptyDeclared(final StmtContext<QualifiedBound, MustStatement, ?> ctx) {
66         return new EmptyMustStatement(ctx.getRawArgument(), ctx.getArgument());
67     }
68
69     @Override
70     protected MustEffectiveStatement createEffective(final Current<QualifiedBound, MustStatement> stmt,
71             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
72         return substatements.isEmpty() ? new EmptyMustEffectiveStatement(stmt.declared())
73             : new RegularMustEffectiveStatement(stmt.declared(), substatements);
74     }
75 }