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.Strings;
12 import com.google.common.collect.Collections2;
13 import com.google.common.collect.ImmutableSet;
14 import java.util.Collection;
15 import java.util.Optional;
16 import org.eclipse.jdt.annotation.NonNull;
17 import org.eclipse.jdt.annotation.NonNullByDefault;
18 import org.eclipse.jdt.annotation.Nullable;
19 import org.opendaylight.yangtools.concepts.Mutable;
20 import org.opendaylight.yangtools.yang.common.Empty;
21 import org.opendaylight.yangtools.yang.common.QName;
22 import org.opendaylight.yangtools.yang.model.api.ActionDefinition;
23 import org.opendaylight.yangtools.yang.model.api.ActionNodeContainer;
24 import org.opendaylight.yangtools.yang.model.api.AddedByUsesAware;
25 import org.opendaylight.yangtools.yang.model.api.AugmentationSchemaNode;
26 import org.opendaylight.yangtools.yang.model.api.AugmentationTarget;
27 import org.opendaylight.yangtools.yang.model.api.ConstraintMetaDefinition;
28 import org.opendaylight.yangtools.yang.model.api.ContainerLike;
29 import org.opendaylight.yangtools.yang.model.api.CopyableNode;
30 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
31 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
32 import org.opendaylight.yangtools.yang.model.api.DocumentedNode;
33 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
34 import org.opendaylight.yangtools.yang.model.api.InputSchemaNode;
35 import org.opendaylight.yangtools.yang.model.api.MandatoryAware;
36 import org.opendaylight.yangtools.yang.model.api.MustConstraintAware;
37 import org.opendaylight.yangtools.yang.model.api.MustDefinition;
38 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
39 import org.opendaylight.yangtools.yang.model.api.NotificationNodeContainer;
40 import org.opendaylight.yangtools.yang.model.api.OperationDefinition;
41 import org.opendaylight.yangtools.yang.model.api.OutputSchemaNode;
42 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
43 import org.opendaylight.yangtools.yang.model.api.Status;
44 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
45 import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;
46 import org.opendaylight.yangtools.yang.model.api.UserOrderedAware;
47 import org.opendaylight.yangtools.yang.model.api.UsesNode;
48 import org.opendaylight.yangtools.yang.model.api.WhenConditionAware;
49 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
50 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
51 import org.opendaylight.yangtools.yang.model.api.stmt.DescriptionEffectiveStatement;
52 import org.opendaylight.yangtools.yang.model.api.stmt.ErrorAppTagEffectiveStatement;
53 import org.opendaylight.yangtools.yang.model.api.stmt.ErrorMessageEffectiveStatement;
54 import org.opendaylight.yangtools.yang.model.api.stmt.InputEffectiveStatement;
55 import org.opendaylight.yangtools.yang.model.api.stmt.OrderedByAwareEffectiveStatement;
56 import org.opendaylight.yangtools.yang.model.api.stmt.OutputEffectiveStatement;
57 import org.opendaylight.yangtools.yang.model.api.stmt.ReferenceEffectiveStatement;
58 import org.opendaylight.yangtools.yang.model.api.stmt.TypedefEffectiveStatement;
59 import org.opendaylight.yangtools.yang.model.api.stmt.WhenEffectiveStatement;
60 import org.opendaylight.yangtools.yang.xpath.api.YangXPathExpression.QualifiedBound;
63 * Mix-in interfaces providing services required by SchemaNode et al. These interfaces provide implementations, or
64 * implementation helpers based on default methods, so the correct behavior can be logically centralized.
67 public final class EffectiveStatementMixins {
68 // Marker interface requiring all mixins to be derived from EffectiveStatement.
69 private interface Mixin<A, D extends DeclaredStatement<A>> extends EffectiveStatement<A, D> {
70 @SuppressWarnings("unchecked")
71 default <T> @NonNull Collection<? extends @NonNull T> filterEffectiveStatements(final Class<T> type) {
72 // Yeah, this is not nice, but saves one transformation
73 return (Collection<? extends T>) Collections2.filter(effectiveSubstatements(), type::isInstance);
78 * Bridge between {@link EffectiveStatement} and {@link AugmentationTarget}.
80 * @param <A> Argument type ({@link Empty} if statement does not have argument.)
81 * @param <D> Class representing declared version of this statement.
83 public interface AugmentationTargetMixin<A, D extends DeclaredStatement<A>>
84 extends Mixin<A, D>, AugmentationTarget {
86 default Collection<? extends AugmentationSchemaNode> getAvailableAugmentations() {
87 return filterEffectiveStatements(AugmentationSchemaNode.class);
92 * Bridge between {@link EffectiveStatementWithFlags} and {@link AddedByUsesAware}.
94 * @param <A> Argument type ({@link Empty} if statement does not have argument.)
95 * @param <D> Class representing declared version of this statement.
96 * @deprecated See deprecation notice in {@link AddedByUsesAware}
98 @Deprecated(since = "7.0.9", forRemoval = true)
99 public interface AddedByUsesMixin<A, D extends DeclaredStatement<A>>
100 extends EffectiveStatementWithFlags<A, D>, AddedByUsesAware {
102 @Deprecated(since = "7.0.9", forRemoval = true)
103 default boolean isAddedByUses() {
104 return (flags() & FlagsBuilder.ADDED_BY_USES) != 0;
109 * Bridge between {@link EffectiveStatementWithFlags} and {@link ActionNodeContainer}.
111 * @param <A> Argument type ({@link Empty} if statement does not have argument.)
112 * @param <D> Class representing declared version of this statement.
114 public interface ActionNodeContainerMixin<A, D extends DeclaredStatement<A>>
115 extends Mixin<A, D>, ActionNodeContainer {
117 default Collection<? extends ActionDefinition> getActions() {
118 return filterEffectiveStatements(ActionDefinition.class);
123 * Bridge between {@link EffectiveStatementWithFlags} and {@link NotificationNodeContainer}.
125 * @param <A> Argument type ({@link Empty} if statement does not have argument.)
126 * @param <D> Class representing declared version of this statement.
128 public interface NotificationNodeContainerMixin<A, D extends DeclaredStatement<A>>
129 extends Mixin<A, D>, NotificationNodeContainer {
131 default Collection<? extends NotificationDefinition> getNotifications() {
132 return filterEffectiveStatements(NotificationDefinition.class);
137 * Bridge between {@link EffectiveStatementWithFlags} and {@link MustConstraintAware}.
139 * @param <A> Argument type ({@link Empty} if statement does not have argument.)
140 * @param <D> Class representing declared version of this statement.
142 public interface MustConstraintMixin<A, D extends DeclaredStatement<A>> extends Mixin<A, D>, MustConstraintAware {
144 default Collection<? extends @NonNull MustDefinition> getMustConstraints() {
145 return filterEffectiveStatements(MustDefinition.class);
150 * Bridge between {@link EffectiveStatementWithFlags} and {@link CopyableNode}.
152 * @param <A> Argument type ({@link Empty} if statement does not have argument.)
153 * @param <D> Class representing declared version of this statement.
154 * @deprecated Scheduled for removal with {@link CopyableNode}.
156 @Deprecated(since = "8.0.0")
157 public interface CopyableMixin<A, D extends DeclaredStatement<A>> extends AddedByUsesMixin<A, D>, CopyableNode {
159 @Deprecated(since = "8.0.0")
160 default boolean isAugmenting() {
161 return (flags() & FlagsBuilder.AUGMENTING) != 0;
166 * Bridge between {@link EffectiveStatementWithFlags} and {@link DataNodeContainer}.
168 * @param <A> Argument type ({@link Empty} 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 <D> Class representing declared version of this statement.
198 public interface DataSchemaNodeMixin<D extends DeclaredStatement<QName>>
199 extends DataSchemaNode, CopyableMixin<QName, D>, SchemaNodeMixin<D>, WhenConditionMixin<QName, D> {
201 default Optional<Boolean> effectiveConfig() {
202 final int fl = flags() & FlagsBuilder.MASK_CONFIG;
204 case FlagsBuilder.CONFIG_FALSE:
205 return Optional.of(Boolean.FALSE);
206 case FlagsBuilder.CONFIG_TRUE:
207 return Optional.of(Boolean.TRUE);
208 case FlagsBuilder.CONFIG_UNDEF:
209 return Optional.empty();
211 throw new IllegalStateException("Unhandled effective config flags " + fl);
217 * Bridge between {@link EffectiveStatementWithFlags} and {@link DocumentedNode}.
219 * @param <A> Argument type ({@link Empty} if statement does not have argument.)
220 * @param <D> Class representing declared version of this statement.
222 public interface DocumentedNodeMixin<A, D extends DeclaredStatement<A>> extends Mixin<A, D>, DocumentedNode {
224 * Bridge between {@link EffectiveStatementWithFlags} and
225 * {@link org.opendaylight.yangtools.yang.model.api.DocumentedNode.WithStatus}.
227 * @param <A> Argument type ({@link Empty} if statement does not have argument.)
228 * @param <D> Class representing declared version of this statement.
230 interface WithStatus<A, D extends DeclaredStatement<A>>
231 extends EffectiveStatementWithFlags<A, D>, DocumentedNodeMixin<A, D>, DocumentedNode.WithStatus {
233 default Status getStatus() {
234 final int status = flags() & FlagsBuilder.MASK_STATUS;
236 case FlagsBuilder.STATUS_CURRENT:
237 return Status.CURRENT;
238 case FlagsBuilder.STATUS_DEPRECATED:
239 return Status.DEPRECATED;
240 case FlagsBuilder.STATUS_OBSOLETE:
241 return Status.OBSOLETE;
243 throw new IllegalStateException("Illegal status " + status);
249 default Optional<String> getDescription() {
250 return findFirstEffectiveSubstatementArgument(DescriptionEffectiveStatement.class);
254 default Optional<String> getReference() {
255 return findFirstEffectiveSubstatementArgument(ReferenceEffectiveStatement.class);
259 default Collection<? extends UnknownSchemaNode> getUnknownSchemaNodes() {
260 return filterEffectiveStatements(UnknownSchemaNode.class);
265 * Bridge between {@link EffectiveStatementWithFlags} and {@link ConstraintMetaDefinition}.
267 * @param <A> Argument type ({@link Empty} if statement does not have argument.)
268 * @param <D> Class representing declared version of this statement.
270 public interface ConstraintMetaDefinitionMixin<A, D extends DeclaredStatement<A>> extends DocumentedNodeMixin<A, D>,
271 ConstraintMetaDefinition {
273 default Optional<String> getErrorAppTag() {
274 return findFirstEffectiveSubstatementArgument(ErrorAppTagEffectiveStatement.class);
278 default Optional<String> getErrorMessage() {
279 return findFirstEffectiveSubstatementArgument(ErrorMessageEffectiveStatement.class);
284 * Bridge between {@link EffectiveStatementWithFlags} and {@link MandatoryAware}.
286 * @param <A> Argument type ({@link Empty} if statement does not have argument.)
287 * @param <D> Class representing declared version of this statement.
289 public interface MandatoryMixin<A, D extends DeclaredStatement<A>>
290 extends EffectiveStatementWithFlags<A, D>, MandatoryAware {
292 default boolean isMandatory() {
293 return (flags() & FlagsBuilder.MANDATORY) != 0;
298 * Bridge between {@link EffectiveStatementWithFlags} and {@code presence} statement.
300 * @param <A> Argument type ({@link Empty} if statement does not have argument.)
301 * @param <D> Class representing declared version of this statement.
303 public interface PresenceMixin<A, D extends DeclaredStatement<A>> extends EffectiveStatementWithFlags<A, D> {
304 default boolean presence() {
305 return (flags() & FlagsBuilder.PRESENCE) != 0;
310 * Bridge between {@link EffectiveStatementWithFlags} and {@link SchemaNode}.
312 * @param <D> Class representing declared version of this statement.
314 public interface SchemaNodeMixin<D extends DeclaredStatement<QName>>
315 extends DocumentedNodeMixin.WithStatus<QName, D>, SchemaNode {
317 default QName getQName() {
323 * Bridge between {@link EffectiveStatementWithFlags} and {@link UnknownSchemaNode}.
325 * @param <A> Argument type ({@link Empty} if statement does not have argument.)
326 * @param <D> Class representing declared version of this statement.
328 public interface UnknownSchemaNodeMixin<A, D extends DeclaredStatement<A>>
329 extends DocumentedNodeMixin.WithStatus<A, D>, CopyableMixin<A, D>, UnknownSchemaNode {
331 default String getNodeParameter() {
332 return Strings.nullToEmpty(getDeclared().rawArgument());
337 * Bridge between {@link EffectiveStatementWithFlags} and {@code ordered-by} statement.
339 * @param <A> Argument type ({@link Empty} if statement does not have argument.)
340 * @param <D> Class representing declared version of this statement.
341 * @param <E> Class representing effective version of this statement.
343 // FIXME: 9.0.0: remove this mixin once we have a properly-cached DataTree and JSON/XML codec tree and the speed
344 // of isUserOrdered() is not really critical.
345 public interface UserOrderedAwareMixin<A, D extends DeclaredStatement<A>,
346 E extends OrderedByAwareEffectiveStatement<A, D>>
347 extends EffectiveStatementWithFlags<A, D>, UserOrderedAware<E> {
349 default boolean isUserOrdered() {
350 return (flags() & FlagsBuilder.USER_ORDERED) != 0;
355 * Helper used to locate the effective {@code when} statement and exposing its argument as per
356 * {@link WhenConditionAware}.
358 * @param <A> Argument type ({@link Empty} if statement does not have argument.)
359 * @param <D> Class representing declared version of this statement.
361 public interface WhenConditionMixin<A, D extends DeclaredStatement<A>> extends Mixin<A, D>, WhenConditionAware {
363 default Optional<QualifiedBound> getWhenCondition() {
364 return findFirstEffectiveSubstatementArgument(WhenEffectiveStatement.class);
369 * Helper bridge for operation containers ({@code input} and {@code output}).
371 * @param <D> Class representing declared version of this statement.
373 public interface OperationContainerMixin<D extends DeclaredStatement<QName>>
374 extends ContainerLike, DocumentedNodeMixin.WithStatus<QName, D>, DataNodeContainerMixin<QName, D>,
375 MustConstraintMixin<QName, D>, WhenConditionMixin<QName, D>, AugmentationTargetMixin<QName, D>,
376 SchemaNodeMixin<D>, CopyableMixin<QName, D> {
378 default Optional<ActionDefinition> findAction(final QName qname) {
379 return Optional.empty();
383 default Optional<NotificationDefinition> findNotification(final QName qname) {
384 return Optional.empty();
388 default Collection<? extends ActionDefinition> getActions() {
389 return ImmutableSet.of();
393 default Collection<? extends NotificationDefinition> getNotifications() {
394 return ImmutableSet.of();
398 default Optional<Boolean> effectiveConfig() {
399 return Optional.empty();
404 * Helper bridge for {@code anydata} and {@code anyxml} opaque data.
406 * @param <D> Class representing declared version of this statement.
408 public interface OpaqueDataSchemaNodeMixin<D extends DeclaredStatement<QName>>
409 extends DataSchemaNodeMixin<D>, DocumentedNodeMixin.WithStatus<QName, D>, MandatoryMixin<QName, D>,
410 MustConstraintMixin<QName, D>, WhenConditionMixin<QName, D> {
412 default QName getQName() {
418 * Helper bridge for {@code rpc} and {@code action} operations.
420 * @param <D> Class representing declared version of this statement.
422 public interface OperationDefinitionMixin<D extends DeclaredStatement<QName>>
423 extends SchemaNodeMixin<D>, OperationDefinition {
425 default Collection<? extends @NonNull TypeDefinition<?>> getTypeDefinitions() {
426 return filterTypeDefinitions(this);
430 default Collection<? extends @NonNull GroupingDefinition> getGroupings() {
431 return filterEffectiveStatements(GroupingDefinition.class);
435 default InputSchemaNode getInput() {
436 return findAsContainer(this, InputEffectiveStatement.class, InputSchemaNode.class);
440 default OutputSchemaNode getOutput() {
441 return findAsContainer(this, OutputEffectiveStatement.class, OutputSchemaNode.class);
446 * Support interface for various mixins. Implementations are required to store 32bits worth of flags, which are
447 * globally assigned to sub-interfaces -- thus providing storage for many low-cardinality properties.
449 * @param <A> Argument type ({@link Empty} if statement does not have argument.)
450 * @param <D> Class representing declared version of this statement.
452 public interface EffectiveStatementWithFlags<A, D extends DeclaredStatement<A>> extends Mixin<A, D> {
454 * Return flags associated with this statements. Flags can be built using {@link FlagsBuilder}.
456 * @return Flag field value (32 bits).
461 final class FlagsBuilder implements Mutable {
462 // We still have 23 flags remaining
463 static final int STATUS_CURRENT = 0x0001;
464 static final int STATUS_DEPRECATED = 0x0002;
465 static final int STATUS_OBSOLETE = 0x0003;
466 static final int MASK_STATUS = 0x0003;
468 static final int MANDATORY = 0x0004;
470 static final int AUGMENTING = 0x0010;
471 @Deprecated(since = "7.0.9", forRemoval = true)
472 static final int ADDED_BY_USES = 0x0020;
473 private static final int MASK_HISTORY = 0x0030;
475 static final int USER_ORDERED = 0x0040;
476 static final int PRESENCE = 0x0080;
478 static final int CONFIG_UNDEF = 0x0100;
479 static final int CONFIG_FALSE = 0x0200;
480 static final int CONFIG_TRUE = 0x0300;
481 static final int MASK_CONFIG = CONFIG_TRUE;
485 public FlagsBuilder setConfiguration(final @Nullable Boolean config) {
487 if (config != null) {
488 fl = config ? CONFIG_TRUE : CONFIG_FALSE;
492 flags = flags & ~MASK_CONFIG | fl;
496 public FlagsBuilder setHistory(final CopyableNode history) {
497 flags = flags & ~MASK_HISTORY
498 | (history.isAugmenting() ? AUGMENTING : 0) | (history.isAddedByUses() ? ADDED_BY_USES : 0);
502 public FlagsBuilder setMandatory(final boolean mandatory) {
511 public FlagsBuilder setPresence(final boolean presence) {
520 public FlagsBuilder setStatus(final Status status) {
524 bits = STATUS_CURRENT;
527 bits = STATUS_DEPRECATED;
530 bits = STATUS_OBSOLETE;
533 throw new IllegalStateException("Unhandled status " + status);
536 flags = flags & ~MASK_STATUS | bits;
540 public FlagsBuilder setUserOrdered(final boolean userOrdered) {
542 flags |= USER_ORDERED;
544 flags &= ~USER_ORDERED;
549 public int toFlags() {
555 private EffectiveStatementMixins() {
559 static <T extends ContainerLike> T findAsContainer(final EffectiveStatement<?, ?> stmt,
560 final Class<? extends EffectiveStatement<QName, ?>> type, final Class<T> target) {
561 return target.cast(stmt.findFirstEffectiveSubstatement(type).get());
564 static Collection<? extends @NonNull TypeDefinition<?>> filterTypeDefinitions(final Mixin<?, ?> stmt) {
565 return Collections2.transform(stmt.filterEffectiveStatements(TypedefEffectiveStatement.class),
566 TypedefEffectiveStatement::getTypeDefinition);