2 * Copyright (c) 2020 PANTHEON.tech, s.r.o. and others. All rights reserved.
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
8 package org.opendaylight.yangtools.yang.parser.rfc7950.stmt;
10 import static java.util.Objects.requireNonNull;
12 import com.google.common.annotations.Beta;
13 import com.google.common.collect.ImmutableList;
14 import java.util.Collection;
15 import org.eclipse.jdt.annotation.NonNull;
16 import org.opendaylight.yangtools.yang.common.QName;
17 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
18 import org.opendaylight.yangtools.yang.model.api.meta.StatementSource;
19 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
22 * An abstract base class for {@link DeclaredStatement} implementations. This is a direct competition to
23 * {@link org.opendaylight.yangtools.yang.parser.spi.meta.AbstractDeclaredStatement}, providing lower-footprint
27 // FIXME: 7.0.0: we should be able to promote this to model.spi.meta package.
28 public abstract class AbstractDeclaredStatement<A> extends AbstractModelStatement<A> implements DeclaredStatement<A> {
29 protected AbstractDeclaredStatement() {
33 public StatementSource getStatementSource() {
34 return StatementSource.DECLARATION;
38 public Collection<? extends DeclaredStatement<?>> declaredSubstatements() {
39 // Default to reduce load on subclasses and keep the number of implementations down
40 return ImmutableList.of();
44 * Utility method for recovering singleton lists squashed by {@link #maskList(ImmutableList)}.
46 * @param masked list to unmask
47 * @return Unmasked list
48 * @throws NullPointerException if masked is null
49 * @throws ClassCastException if masked object does not match DeclaredStatement
51 @SuppressWarnings({ "rawtypes", "unchecked" })
52 protected static final @NonNull ImmutableList<? extends DeclaredStatement<?>> unmaskList(
53 final @NonNull Object masked) {
54 return (ImmutableList) unmaskList(masked, DeclaredStatement.class);
57 public abstract static class WithRawArgument<A> extends AbstractDeclaredStatement<A> {
58 private final String rawArgument;
61 protected WithRawArgument(final StmtContext<A, ?, ?> context) {
62 this(context.rawStatementArgument());
65 protected WithRawArgument(final String rawArgument) {
66 this.rawArgument = rawArgument;
70 public final String rawArgument() {
75 public abstract static class WithQNameArgument extends AbstractDeclaredStatement<QName> {
76 public abstract static class WithSubstatements extends WithQNameArgument {
77 private final @NonNull Object substatements;
79 protected WithSubstatements(final QName argument,
80 final ImmutableList<? extends DeclaredStatement<?>> substatements) {
82 this.substatements = maskList(substatements);
86 public final Collection<? extends DeclaredStatement<?>> declaredSubstatements() {
87 return unmaskList(substatements);
91 private final @NonNull QName argument;
93 protected WithQNameArgument(final QName argument) {
94 this.argument = requireNonNull(argument);
98 public final @NonNull QName argument() {
103 public final String rawArgument() {
104 return argument.getLocalName();
108 public abstract static class WithRawStringArgument extends WithRawArgument<String> {
109 public abstract static class WithSubstatements extends WithRawStringArgument {
110 private final @NonNull Object substatements;
113 protected WithSubstatements(final StmtContext<String, ?, ?> context,
114 final ImmutableList<? extends DeclaredStatement<?>> substatements) {
116 this.substatements = maskList(substatements);
119 protected WithSubstatements(final String rawArgument,
120 final ImmutableList<? extends DeclaredStatement<?>> substatements) {
122 this.substatements = maskList(substatements);
126 public final Collection<? extends DeclaredStatement<?>> declaredSubstatements() {
127 return unmaskList(substatements);
132 protected WithRawStringArgument(final StmtContext<String, ?, ?> context) {
136 protected WithRawStringArgument(final String rawArgument) {
141 public final String argument() {
142 return rawArgument();
146 public abstract static class WithArgument<A> extends WithRawArgument<A> {
147 public abstract static class WithSubstatements<A> extends WithArgument<A> {
148 private final @NonNull Object substatements;
151 protected WithSubstatements(final StmtContext<A, ?, ?> context,
152 final ImmutableList<? extends DeclaredStatement<?>> substatements) {
154 this.substatements = maskList(substatements);
157 protected WithSubstatements(final String rawArgument, final A argument,
158 final ImmutableList<? extends DeclaredStatement<?>> substatements) {
159 super(rawArgument, argument);
160 this.substatements = maskList(substatements);
164 public final Collection<? extends DeclaredStatement<?>> declaredSubstatements() {
165 return unmaskList(substatements);
169 private final A argument;
172 protected WithArgument(final StmtContext<A, ?, ?> context) {
174 argument = context.getStatementArgument();
177 protected WithArgument(final String rawArgument, A argument) {
179 this.argument = argument;
183 public final A argument() {
188 public abstract static class ArgumentToString<A> extends AbstractDeclaredStatement<A> {
189 public abstract static class WithSubstatements<A> extends ArgumentToString<A> {
190 private final @NonNull Object substatements;
192 protected WithSubstatements(final A argument,
193 final ImmutableList<? extends DeclaredStatement<?>> substatements) {
195 this.substatements = maskList(substatements);
199 public final Collection<? extends DeclaredStatement<?>> declaredSubstatements() {
200 return unmaskList(substatements);
204 private final @NonNull A argument;
206 protected ArgumentToString(final A argument) {
207 this.argument = requireNonNull(argument);
211 public final @NonNull A argument() {
216 public final String rawArgument() {
217 return argument.toString();
221 public abstract static class WithoutArgument extends AbstractDeclaredStatement<Void> {
222 public abstract static class WithSubstatements extends WithoutArgument {
223 private final @NonNull Object substatements;
225 protected WithSubstatements(final ImmutableList<? extends DeclaredStatement<?>> substatements) {
226 this.substatements = maskList(substatements);
230 public final Collection<? extends DeclaredStatement<?>> declaredSubstatements() {
231 return unmaskList(substatements);
236 public final Void argument() {
241 public final String rawArgument() {