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.model.spi.meta;
10 import com.google.common.annotations.Beta;
11 import com.google.common.base.MoreObjects;
12 import com.google.common.base.Strings;
13 import com.google.common.collect.Collections2;
14 import com.google.common.collect.ImmutableSet;
15 import java.util.Collection;
16 import java.util.Optional;
17 import org.eclipse.jdt.annotation.NonNull;
18 import org.eclipse.jdt.annotation.NonNullByDefault;
19 import org.eclipse.jdt.annotation.Nullable;
20 import org.opendaylight.yangtools.concepts.Immutable;
21 import org.opendaylight.yangtools.concepts.Mutable;
22 import org.opendaylight.yangtools.yang.common.QName;
23 import org.opendaylight.yangtools.yang.model.api.ActionDefinition;
24 import org.opendaylight.yangtools.yang.model.api.ActionNodeContainer;
25 import org.opendaylight.yangtools.yang.model.api.AddedByUsesAware;
26 import org.opendaylight.yangtools.yang.model.api.AugmentationSchemaNode;
27 import org.opendaylight.yangtools.yang.model.api.AugmentationTarget;
28 import org.opendaylight.yangtools.yang.model.api.ConstraintMetaDefinition;
29 import org.opendaylight.yangtools.yang.model.api.ContainerLike;
30 import org.opendaylight.yangtools.yang.model.api.CopyableNode;
31 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
32 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
33 import org.opendaylight.yangtools.yang.model.api.DerivableSchemaNode;
34 import org.opendaylight.yangtools.yang.model.api.DocumentedNode;
35 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
36 import org.opendaylight.yangtools.yang.model.api.InputSchemaNode;
37 import org.opendaylight.yangtools.yang.model.api.MandatoryAware;
38 import org.opendaylight.yangtools.yang.model.api.MustConstraintAware;
39 import org.opendaylight.yangtools.yang.model.api.MustDefinition;
40 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
41 import org.opendaylight.yangtools.yang.model.api.NotificationNodeContainer;
42 import org.opendaylight.yangtools.yang.model.api.OperationDefinition;
43 import org.opendaylight.yangtools.yang.model.api.OutputSchemaNode;
44 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
45 import org.opendaylight.yangtools.yang.model.api.SchemaNodeDefaults;
46 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
47 import org.opendaylight.yangtools.yang.model.api.Status;
48 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
49 import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;
50 import org.opendaylight.yangtools.yang.model.api.UsesNode;
51 import org.opendaylight.yangtools.yang.model.api.WhenConditionAware;
52 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
53 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
54 import org.opendaylight.yangtools.yang.model.api.stmt.DescriptionEffectiveStatement;
55 import org.opendaylight.yangtools.yang.model.api.stmt.ErrorAppTagEffectiveStatement;
56 import org.opendaylight.yangtools.yang.model.api.stmt.ErrorMessageEffectiveStatement;
57 import org.opendaylight.yangtools.yang.model.api.stmt.InputEffectiveStatement;
58 import org.opendaylight.yangtools.yang.model.api.stmt.OutputEffectiveStatement;
59 import org.opendaylight.yangtools.yang.model.api.stmt.ReferenceEffectiveStatement;
60 import org.opendaylight.yangtools.yang.model.api.stmt.StatusEffectiveStatement;
61 import org.opendaylight.yangtools.yang.model.api.stmt.TypedefEffectiveStatement;
62 import org.opendaylight.yangtools.yang.model.api.stmt.WhenEffectiveStatement;
63 import org.opendaylight.yangtools.yang.model.spi.meta.EffectiveStatementMixins.EffectiveStatementWithFlags.FlagsBuilder;
64 import org.opendaylight.yangtools.yang.xpath.api.YangXPathExpression.QualifiedBound;
67 * Mix-in interfaces providing services required by SchemaNode et al. These interfaces provide implementations, or
68 * implementation helpers based on default methods, so the correct behavior can be logically centralized.
71 public final class EffectiveStatementMixins {
72 // Marker interface requiring all mixins to be derived from EffectiveStatement.
73 private interface Mixin<A, D extends DeclaredStatement<A>> extends EffectiveStatement<A, D> {
74 @SuppressWarnings("unchecked")
75 default <T> @NonNull Collection<? extends @NonNull T> filterEffectiveStatements(final Class<T> type) {
76 // Yeah, this is not nice, but saves one transformation
77 return (Collection<? extends T>) Collections2.filter(effectiveSubstatements(), type::isInstance);
82 * Bridge between {@link EffectiveStatement} and {@link AugmentationTarget}.
84 * @param <A> Argument type ({@link Void} if statement does not have argument.)
85 * @param <D> Class representing declared version of this statement.
87 public interface AugmentationTargetMixin<A, D extends DeclaredStatement<A>>
88 extends Mixin<A, D>, AugmentationTarget {
90 default Collection<? extends AugmentationSchemaNode> getAvailableAugmentations() {
91 return filterEffectiveStatements(AugmentationSchemaNode.class);
96 * Bridge between {@link EffectiveStatementWithFlags} and {@link AddedByUsesAware}.
98 * @param <A> Argument type ({@link Void} if statement does not have argument.)
99 * @param <D> Class representing declared version of this statement.
101 public interface AddedByUsesMixin<A, D extends DeclaredStatement<A>>
102 extends EffectiveStatementWithFlags<A, D>, AddedByUsesAware {
105 default boolean isAddedByUses() {
106 return (flags() & FlagsBuilder.ADDED_BY_USES) != 0;
111 * Bridge between {@link EffectiveStatementWithFlags} and {@link ActionNodeContainer}.
113 * @param <A> Argument type ({@link Void} if statement does not have argument.)
114 * @param <D> Class representing declared version of this statement.
116 public interface ActionNodeContainerMixin<A, D extends DeclaredStatement<A>>
117 extends Mixin<A, D>, ActionNodeContainer {
119 default Collection<? extends ActionDefinition> getActions() {
120 return filterEffectiveStatements(ActionDefinition.class);
125 * Bridge between {@link EffectiveStatementWithFlags} and {@link NotificationNodeContainer}.
127 * @param <A> Argument type ({@link Void} if statement does not have argument.)
128 * @param <D> Class representing declared version of this statement.
130 public interface NotificationNodeContainerMixin<A, D extends DeclaredStatement<A>>
131 extends Mixin<A, D>, NotificationNodeContainer {
133 default Collection<? extends NotificationDefinition> getNotifications() {
134 return filterEffectiveStatements(NotificationDefinition.class);
139 * Bridge between {@link EffectiveStatementWithFlags} and {@link MustConstraintAware}.
141 * @param <A> Argument type ({@link Void} if statement does not have argument.)
142 * @param <D> Class representing declared version of this statement.
144 public interface MustConstraintMixin<A, D extends DeclaredStatement<A>> extends Mixin<A, D>, MustConstraintAware {
146 default Collection<? extends @NonNull MustDefinition> getMustConstraints() {
147 return filterEffectiveStatements(MustDefinition.class);
152 * Bridge between {@link EffectiveStatementWithFlags} and {@link CopyableNode}.
154 * @param <A> Argument type ({@link Void} if statement does not have argument.)
155 * @param <D> Class representing declared version of this statement.
157 public interface CopyableMixin<A, D extends DeclaredStatement<A>> extends AddedByUsesMixin<A, D>, CopyableNode {
160 default boolean isAugmenting() {
161 return (flags() & FlagsBuilder.AUGMENTING) != 0;
166 * Bridge between {@link EffectiveStatementWithFlags} and {@link DataNodeContainer}.
168 * @param <A> Argument type ({@link Void} if statement does not have argument.)
169 * @param <D> Class representing declared version of this statement.
171 public interface DataNodeContainerMixin<A, D extends DeclaredStatement<A>> extends DataNodeContainer, Mixin<A, D> {
173 default Collection<? extends TypeDefinition<?>> getTypeDefinitions() {
174 return filterTypeDefinitions(this);
178 default Collection<? extends DataSchemaNode> getChildNodes() {
179 return filterEffectiveStatements(DataSchemaNode.class);
183 default Collection<? extends GroupingDefinition> getGroupings() {
184 return filterEffectiveStatements(GroupingDefinition.class);
188 default Collection<? extends UsesNode> getUses() {
189 return filterEffectiveStatements(UsesNode.class);
194 * Bridge between {@link EffectiveStatementWithFlags} and {@link DataSchemaNode}.
196 * @param <A> Argument type ({@link Void} if statement does not have argument.)
197 * @param <D> Class representing declared version of this statement.
199 public interface DataSchemaNodeMixin<A, D extends DeclaredStatement<A>>
200 extends DataSchemaNode, CopyableMixin<A, D>, SchemaNodeMixin<A, D>, WhenConditionMixin<A, D> {
202 default Optional<Boolean> effectiveConfig() {
203 final int fl = flags() & FlagsBuilder.MASK_CONFIG;
205 case FlagsBuilder.CONFIG_FALSE:
206 return Optional.of(Boolean.FALSE);
207 case FlagsBuilder.CONFIG_TRUE:
208 return Optional.of(Boolean.TRUE);
209 case FlagsBuilder.CONFIG_UNDEF:
210 return Optional.empty();
212 throw new IllegalStateException("Unhandled effective config flags " + fl);
218 * Bridge between {@link EffectiveStatementWithFlags} and {@link DocumentedNode}.
220 * @param <A> Argument type ({@link Void} if statement does not have argument.)
221 * @param <D> Class representing declared version of this statement.
223 public interface DocumentedNodeMixin<A, D extends DeclaredStatement<A>> extends Mixin<A, D>, DocumentedNode {
225 * Bridge between {@link EffectiveStatementWithFlags} and
226 * {@link org.opendaylight.yangtools.yang.model.api.DocumentedNode.WithStatus}.
228 * @param <A> Argument type ({@link Void} if statement does not have argument.)
229 * @param <D> Class representing declared version of this statement.
231 interface WithStatus<A, D extends DeclaredStatement<A>>
232 extends EffectiveStatementWithFlags<A, D>, DocumentedNodeMixin<A, D>, DocumentedNode.WithStatus {
234 default Status getStatus() {
235 final int status = flags() & FlagsBuilder.MASK_STATUS;
237 case FlagsBuilder.STATUS_CURRENT:
238 return Status.CURRENT;
239 case FlagsBuilder.STATUS_DEPRECATED:
240 return Status.DEPRECATED;
241 case FlagsBuilder.STATUS_OBSOLETE:
242 return Status.OBSOLETE;
244 throw new IllegalStateException("Illegal status " + status);
250 default Optional<String> getDescription() {
251 return findFirstEffectiveSubstatementArgument(DescriptionEffectiveStatement.class);
255 default Optional<String> getReference() {
256 return findFirstEffectiveSubstatementArgument(ReferenceEffectiveStatement.class);
260 default Collection<? extends UnknownSchemaNode> getUnknownSchemaNodes() {
261 return filterEffectiveStatements(UnknownSchemaNode.class);
266 * Bridge between {@link EffectiveStatementWithFlags} and {@link ConstraintMetaDefinition}.
268 * @param <A> Argument type ({@link Void} if statement does not have argument.)
269 * @param <D> Class representing declared version of this statement.
271 public interface ConstraintMetaDefinitionMixin<A, D extends DeclaredStatement<A>> extends DocumentedNodeMixin<A, D>,
272 ConstraintMetaDefinition {
274 default Optional<String> getErrorAppTag() {
275 return findFirstEffectiveSubstatementArgument(ErrorAppTagEffectiveStatement.class);
279 default Optional<String> getErrorMessage() {
280 return findFirstEffectiveSubstatementArgument(ErrorMessageEffectiveStatement.class);
285 * Bridge between {@link EffectiveStatementWithFlags} and {@link MandatoryAware}.
287 * @param <A> Argument type ({@link Void} if statement does not have argument.)
288 * @param <D> Class representing declared version of this statement.
290 public interface MandatoryMixin<A, D extends DeclaredStatement<A>>
291 extends EffectiveStatementWithFlags<A, D>, MandatoryAware {
293 default boolean isMandatory() {
294 return (flags() & FlagsBuilder.MANDATORY) != 0;
299 * Bridge between {@link EffectiveStatementWithFlags} and {@code presence} statement.
301 * @param <A> Argument type ({@link Void} if statement does not have argument.)
302 * @param <D> Class representing declared version of this statement.
304 public interface PresenceMixin<A, D extends DeclaredStatement<A>> extends EffectiveStatementWithFlags<A, D> {
305 default boolean presence() {
306 return (flags() & FlagsBuilder.PRESENCE) != 0;
311 * Bridge between {@link EffectiveStatementWithFlags} and {@link SchemaNode}.
313 * @param <A> Argument type ({@link Void} if statement does not have argument.)
314 * @param <D> Class representing declared version of this statement.
316 public interface SchemaNodeMixin<A, D extends DeclaredStatement<A>>
317 extends DocumentedNodeMixin.WithStatus<A, D>, SchemaNode {
318 // FIXME: ditch all this complexity once we do not require SchemaPath
320 default QName getQName() {
321 return SchemaNodeDefaults.extractQName(pathObject());
326 default SchemaPath getPath() {
327 return SchemaNodeDefaults.extractPath(this, pathObject());
330 @NonNull Immutable pathObject();
334 * Bridge between {@link EffectiveStatementWithFlags} and {@link UnknownSchemaNode}.
336 * @param <A> Argument type ({@link Void} if statement does not have argument.)
337 * @param <D> Class representing declared version of this statement.
339 public interface UnknownSchemaNodeMixin<A, D extends DeclaredStatement<A>>
340 extends SchemaNodeMixin<A, D>, CopyableMixin<A, D>, UnknownSchemaNode {
343 default String getNodeParameter() {
344 return Strings.nullToEmpty(getDeclared().rawArgument());
349 * Bridge between {@link EffectiveStatementWithFlags} and {@code ordered-by} statement.
351 * @param <A> Argument type ({@link Void} if statement does not have argument.)
352 * @param <D> Class representing declared version of this statement.
354 public interface UserOrderedMixin<A, D extends DeclaredStatement<A>> extends EffectiveStatementWithFlags<A, D> {
355 default boolean userOrdered() {
356 return (flags() & FlagsBuilder.USER_ORDERED) != 0;
361 * Helper used to locate the effective {@code when} statement and exposing its argument as per
362 * {@link WhenConditionAware}.
364 * @param <A> Argument type ({@link Void} if statement does not have argument.)
365 * @param <D> Class representing declared version of this statement.
367 public interface WhenConditionMixin<A, D extends DeclaredStatement<A>> extends Mixin<A, D>, WhenConditionAware {
369 default Optional<QualifiedBound> getWhenCondition() {
370 return findFirstEffectiveSubstatementArgument(WhenEffectiveStatement.class);
375 * Helper bridge for operation containers ({@code input} and {@code output}).
377 * @param <D> Class representing declared version of this statement.
379 public interface OperationContainerMixin<D extends DeclaredStatement<QName>>
380 extends ContainerLike, DocumentedNodeMixin.WithStatus<QName, D>, DataNodeContainerMixin<QName, D>,
381 MustConstraintMixin<QName, D>, WhenConditionMixin<QName, D>, AugmentationTargetMixin<QName, D>,
382 SchemaNodeMixin<QName, D>, CopyableMixin<QName, D> {
384 default @NonNull QName argument() {
389 default Optional<ActionDefinition> findAction(final QName qname) {
390 return Optional.empty();
394 default Optional<NotificationDefinition> findNotification(final QName qname) {
395 return Optional.empty();
399 default Collection<? extends ActionDefinition> getActions() {
400 return ImmutableSet.of();
404 default Collection<? extends NotificationDefinition> getNotifications() {
405 return ImmutableSet.of();
409 default Optional<Boolean> effectiveConfig() {
410 return Optional.empty();
413 default String defaultToString() {
414 return MoreObjects.toStringHelper(this).add("qname", getQName()).toString();
419 * Helper bridge for {@code anydata} and {@code anyxml} opaque data.
421 * @param <D> Class representing declared version of this statement.
423 public interface OpaqueDataSchemaNodeMixin<D extends DeclaredStatement<QName>>
424 extends DerivableSchemaNode, DataSchemaNodeMixin<QName, D>, DocumentedNodeMixin.WithStatus<QName, D>,
425 MandatoryMixin<QName, D>, MustConstraintMixin<QName, D>, WhenConditionMixin<QName, D> {
427 default @NonNull QName argument() {
433 * Helper bridge for {@code rpc} and {@code action} operations.
435 * @param <D> Class representing declared version of this statement.
437 public interface OperationDefinitionMixin<D extends DeclaredStatement<QName>>
438 extends SchemaNodeMixin<QName, D>, OperationDefinition {
440 default @NonNull QName argument() {
445 default Collection<? extends @NonNull TypeDefinition<?>> getTypeDefinitions() {
446 return filterTypeDefinitions(this);
450 default Collection<? extends @NonNull GroupingDefinition> getGroupings() {
451 return filterEffectiveStatements(GroupingDefinition.class);
455 default InputSchemaNode getInput() {
456 return findAsContainer(this, InputEffectiveStatement.class, InputSchemaNode.class);
460 default OutputSchemaNode getOutput() {
461 return findAsContainer(this, OutputEffectiveStatement.class, OutputSchemaNode.class);
466 * Support interface for various mixins. Implementations are required to store 32bits worth of flags, which are
467 * globally assigned to sub-interfaces -- thus providing storage for many low-cardinality properties.
469 * @param <A> Argument type ({@link Void} if statement does not have argument.)
470 * @param <D> Class representing declared version of this statement.
472 public interface EffectiveStatementWithFlags<A, D extends DeclaredStatement<A>> extends Mixin<A, D> {
474 * Return flags associated with this statements. Flags can be built using {@link FlagsBuilder}.
476 * @return Flag field value (32 bits).
481 final class FlagsBuilder implements Mutable {
482 // We still have 23 flags remaining
483 static final int STATUS_CURRENT = 0x0001;
484 static final int STATUS_DEPRECATED = 0x0002;
485 static final int STATUS_OBSOLETE = 0x0003;
486 static final int MASK_STATUS = 0x0003;
488 static final int MANDATORY = 0x0004;
490 static final int AUGMENTING = 0x0010;
491 static final int ADDED_BY_USES = 0x0020;
492 private static final int MASK_HISTORY = 0x0030;
494 static final int USER_ORDERED = 0x0040;
495 static final int PRESENCE = 0x0080;
497 static final int CONFIG_UNDEF = 0x0100;
498 static final int CONFIG_FALSE = 0x0200;
499 static final int CONFIG_TRUE = 0x0300;
500 static final int MASK_CONFIG = CONFIG_TRUE;
504 public FlagsBuilder setConfiguration(final @Nullable Boolean config) {
506 if (config != null) {
507 fl = config ? CONFIG_TRUE : CONFIG_FALSE;
511 flags = flags & ~MASK_CONFIG | fl;
515 public FlagsBuilder setHistory(final CopyableNode history) {
516 flags = flags & ~MASK_HISTORY
517 | (history.isAugmenting() ? AUGMENTING : 0) | (history.isAddedByUses() ? ADDED_BY_USES : 0);
521 public FlagsBuilder setMandatory(final boolean mandatory) {
530 public FlagsBuilder setPresence(final boolean presence) {
539 public FlagsBuilder setStatus(final Status status) {
543 bits = STATUS_CURRENT;
546 bits = STATUS_DEPRECATED;
549 bits = STATUS_OBSOLETE;
552 throw new IllegalStateException("Unhandled status " + status);
555 flags = flags & ~MASK_STATUS | bits;
559 public FlagsBuilder setUserOrdered(final boolean userOrdered) {
561 flags |= USER_ORDERED;
563 flags &= ~USER_ORDERED;
568 public int toFlags() {
574 private EffectiveStatementMixins() {
577 static <T extends ContainerLike> T findAsContainer(final EffectiveStatement<?, ?> stmt,
578 final Class<? extends EffectiveStatement<QName, ?>> type, final Class<T> target) {
579 return target.cast(stmt.findFirstEffectiveSubstatement(type).get());
582 static Collection<? extends @NonNull TypeDefinition<?>> filterTypeDefinitions(final Mixin<?, ?> stmt) {
583 return Collections2.transform(stmt.filterEffectiveStatements(TypedefEffectiveStatement.class),
584 TypedefEffectiveStatement::getTypeDefinition);
587 public static int historyAndStatusFlags(final CopyableNode history,
588 final Collection<? extends EffectiveStatement<?, ?>> substatements) {
589 return new FlagsBuilder()
591 .setStatus(substatements.stream()
592 .filter(StatusEffectiveStatement.class::isInstance)
594 .map(stmt -> ((StatusEffectiveStatement) stmt).argument())
595 .orElse(Status.CURRENT))