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 public abstract class AbstractDeclaredStatement<A> extends AbstractModelStatement<A> implements DeclaredStatement<A> {
28 protected AbstractDeclaredStatement() {
32 public StatementSource getStatementSource() {
33 return StatementSource.DECLARATION;
37 public Collection<? extends DeclaredStatement<?>> declaredSubstatements() {
38 // Default to reduce load on subclasses and keep the number of implementations down
39 return ImmutableList.of();
43 * Utility method for recovering singleton lists squashed by {@link #maskList(ImmutableList)}.
45 * @param masked list to unmask
46 * @return Unmasked list
47 * @throws NullPointerException if masked is null
48 * @throws ClassCastException if masked object does not match DeclaredStatement
50 @SuppressWarnings({ "rawtypes", "unchecked" })
51 protected static final @NonNull ImmutableList<? extends DeclaredStatement<?>> unmaskList(
52 final @NonNull Object masked) {
53 return (ImmutableList) unmaskList(masked, DeclaredStatement.class);
56 public abstract static class WithRawArgument<A> extends AbstractDeclaredStatement<A> {
57 private final String rawArgument;
59 protected WithRawArgument(final StmtContext<A, ?, ?> context) {
60 this(context.rawStatementArgument());
63 protected WithRawArgument(final String rawArgument) {
64 this.rawArgument = rawArgument;
68 public final String rawArgument() {
73 public abstract static class WithQNameArgument extends AbstractDeclaredStatement<QName> {
74 public abstract static class WithSubstatements extends WithQNameArgument {
75 private final @NonNull Object substatements;
77 protected WithSubstatements(final QName argument,
78 final ImmutableList<? extends DeclaredStatement<?>> substatements) {
80 this.substatements = maskList(substatements);
84 public final Collection<? extends DeclaredStatement<?>> declaredSubstatements() {
85 return unmaskList(substatements);
89 private final QName argument;
91 protected WithQNameArgument(final QName argument) {
92 this.argument = requireNonNull(argument);
96 public final @NonNull QName argument() {
101 public final String rawArgument() {
102 return argument.getLocalName();
106 public abstract static class WithRawStringArgument extends WithRawArgument<String> {
107 public abstract static class WithSubstatements extends WithRawStringArgument {
108 private final @NonNull Object substatements;
110 protected WithSubstatements(final StmtContext<String, ?, ?> context,
111 final ImmutableList<? extends DeclaredStatement<?>> substatements) {
113 this.substatements = maskList(substatements);
116 protected WithSubstatements(final String rawArgument,
117 final ImmutableList<? extends DeclaredStatement<?>> substatements) {
119 this.substatements = maskList(substatements);
123 public final Collection<? extends DeclaredStatement<?>> declaredSubstatements() {
124 return unmaskList(substatements);
128 protected WithRawStringArgument(final StmtContext<String, ?, ?> context) {
132 protected WithRawStringArgument(final String rawArgument) {
137 public final String argument() {
138 return rawArgument();
142 public abstract static class WithArgument<A> extends WithRawArgument<A> {
143 public abstract static class WithSubstatements<A> extends WithArgument<A> {
144 private final @NonNull Object substatements;
146 protected WithSubstatements(final StmtContext<A, ?, ?> context,
147 final ImmutableList<? extends DeclaredStatement<?>> substatements) {
149 this.substatements = maskList(substatements);
153 public final Collection<? extends DeclaredStatement<?>> declaredSubstatements() {
154 return unmaskList(substatements);
158 private final A argument;
160 protected WithArgument(final StmtContext<A, ?, ?> context) {
162 argument = context.getStatementArgument();
166 public final A argument() {
171 public abstract static class ArgumentToString<A> extends AbstractDeclaredStatement<A> {
172 public abstract static class WithSubstatements<A> extends ArgumentToString<A> {
173 private final @NonNull Object substatements;
175 protected WithSubstatements(final A argument,
176 final ImmutableList<? extends DeclaredStatement<?>> substatements) {
178 this.substatements = maskList(substatements);
182 public final Collection<? extends DeclaredStatement<?>> declaredSubstatements() {
183 return unmaskList(substatements);
187 private final @NonNull A argument;
189 protected ArgumentToString(final A argument) {
190 this.argument = requireNonNull(argument);
194 public final @NonNull A argument() {
199 public final String rawArgument() {
200 return argument.toString();