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.Mutable;
21 import org.opendaylight.yangtools.yang.common.Empty;
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.Status;
46 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
47 import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;
48 import org.opendaylight.yangtools.yang.model.api.UsesNode;
49 import org.opendaylight.yangtools.yang.model.api.WhenConditionAware;
50 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
51 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
52 import org.opendaylight.yangtools.yang.model.api.stmt.DescriptionEffectiveStatement;
53 import org.opendaylight.yangtools.yang.model.api.stmt.ErrorAppTagEffectiveStatement;
54 import org.opendaylight.yangtools.yang.model.api.stmt.ErrorMessageEffectiveStatement;
55 import org.opendaylight.yangtools.yang.model.api.stmt.InputEffectiveStatement;
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")
99 public interface AddedByUsesMixin<A, D extends DeclaredStatement<A>>
100 extends EffectiveStatementWithFlags<A, D>, AddedByUsesAware {
102 @Deprecated(since = "7.0.9")
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.
155 public interface CopyableMixin<A, D extends DeclaredStatement<A>> extends AddedByUsesMixin<A, D>, CopyableNode {
157 default boolean isAugmenting() {
158 return (flags() & FlagsBuilder.AUGMENTING) != 0;
163 * Bridge between {@link EffectiveStatementWithFlags} and {@link DataNodeContainer}.
165 * @param <A> Argument type ({@link Empty} if statement does not have argument.)
166 * @param <D> Class representing declared version of this statement.
168 public interface DataNodeContainerMixin<A, D extends DeclaredStatement<A>> extends DataNodeContainer, Mixin<A, D> {
170 default Collection<? extends TypeDefinition<?>> getTypeDefinitions() {
171 return filterTypeDefinitions(this);
175 default Collection<? extends DataSchemaNode> getChildNodes() {
176 return filterEffectiveStatements(DataSchemaNode.class);
180 default Collection<? extends GroupingDefinition> getGroupings() {
181 return filterEffectiveStatements(GroupingDefinition.class);
185 default Collection<? extends UsesNode> getUses() {
186 return filterEffectiveStatements(UsesNode.class);
191 * Bridge between {@link EffectiveStatementWithFlags} and {@link DataSchemaNode}.
193 * @param <D> Class representing declared version of this statement.
195 public interface DataSchemaNodeMixin<D extends DeclaredStatement<QName>>
196 extends DataSchemaNode, CopyableMixin<QName, D>, SchemaNodeMixin<D>, WhenConditionMixin<QName, D> {
198 default Optional<Boolean> effectiveConfig() {
199 final int fl = flags() & FlagsBuilder.MASK_CONFIG;
201 case FlagsBuilder.CONFIG_FALSE:
202 return Optional.of(Boolean.FALSE);
203 case FlagsBuilder.CONFIG_TRUE:
204 return Optional.of(Boolean.TRUE);
205 case FlagsBuilder.CONFIG_UNDEF:
206 return Optional.empty();
208 throw new IllegalStateException("Unhandled effective config flags " + fl);
214 * Bridge between {@link EffectiveStatementWithFlags} and {@link DocumentedNode}.
216 * @param <A> Argument type ({@link Empty} if statement does not have argument.)
217 * @param <D> Class representing declared version of this statement.
219 public interface DocumentedNodeMixin<A, D extends DeclaredStatement<A>> extends Mixin<A, D>, DocumentedNode {
221 * Bridge between {@link EffectiveStatementWithFlags} and
222 * {@link org.opendaylight.yangtools.yang.model.api.DocumentedNode.WithStatus}.
224 * @param <A> Argument type ({@link Empty} if statement does not have argument.)
225 * @param <D> Class representing declared version of this statement.
227 interface WithStatus<A, D extends DeclaredStatement<A>>
228 extends EffectiveStatementWithFlags<A, D>, DocumentedNodeMixin<A, D>, DocumentedNode.WithStatus {
230 default Status getStatus() {
231 final int status = flags() & FlagsBuilder.MASK_STATUS;
233 case FlagsBuilder.STATUS_CURRENT:
234 return Status.CURRENT;
235 case FlagsBuilder.STATUS_DEPRECATED:
236 return Status.DEPRECATED;
237 case FlagsBuilder.STATUS_OBSOLETE:
238 return Status.OBSOLETE;
240 throw new IllegalStateException("Illegal status " + status);
246 default Optional<String> getDescription() {
247 return findFirstEffectiveSubstatementArgument(DescriptionEffectiveStatement.class);
251 default Optional<String> getReference() {
252 return findFirstEffectiveSubstatementArgument(ReferenceEffectiveStatement.class);
256 default Collection<? extends UnknownSchemaNode> getUnknownSchemaNodes() {
257 return filterEffectiveStatements(UnknownSchemaNode.class);
262 * Bridge between {@link EffectiveStatementWithFlags} and {@link ConstraintMetaDefinition}.
264 * @param <A> Argument type ({@link Empty} if statement does not have argument.)
265 * @param <D> Class representing declared version of this statement.
267 public interface ConstraintMetaDefinitionMixin<A, D extends DeclaredStatement<A>> extends DocumentedNodeMixin<A, D>,
268 ConstraintMetaDefinition {
270 default Optional<String> getErrorAppTag() {
271 return findFirstEffectiveSubstatementArgument(ErrorAppTagEffectiveStatement.class);
275 default Optional<String> getErrorMessage() {
276 return findFirstEffectiveSubstatementArgument(ErrorMessageEffectiveStatement.class);
281 * Bridge between {@link EffectiveStatementWithFlags} and {@link MandatoryAware}.
283 * @param <A> Argument type ({@link Empty} if statement does not have argument.)
284 * @param <D> Class representing declared version of this statement.
286 public interface MandatoryMixin<A, D extends DeclaredStatement<A>>
287 extends EffectiveStatementWithFlags<A, D>, MandatoryAware {
289 default boolean isMandatory() {
290 return (flags() & FlagsBuilder.MANDATORY) != 0;
295 * Bridge between {@link EffectiveStatementWithFlags} and {@code presence} statement.
297 * @param <A> Argument type ({@link Empty} if statement does not have argument.)
298 * @param <D> Class representing declared version of this statement.
300 public interface PresenceMixin<A, D extends DeclaredStatement<A>> extends EffectiveStatementWithFlags<A, D> {
301 default boolean presence() {
302 return (flags() & FlagsBuilder.PRESENCE) != 0;
307 * Bridge between {@link EffectiveStatementWithFlags} and {@link SchemaNode}.
309 * @param <D> Class representing declared version of this statement.
311 public interface SchemaNodeMixin<D extends DeclaredStatement<QName>>
312 extends DocumentedNodeMixin.WithStatus<QName, D>, SchemaNode {
314 default QName getQName() {
320 * Bridge between {@link EffectiveStatementWithFlags} and {@link UnknownSchemaNode}.
322 * @param <A> Argument type ({@link Empty} if statement does not have argument.)
323 * @param <D> Class representing declared version of this statement.
325 public interface UnknownSchemaNodeMixin<A, D extends DeclaredStatement<A>>
326 extends DocumentedNodeMixin.WithStatus<A, D>, CopyableMixin<A, D>, UnknownSchemaNode {
328 default String getNodeParameter() {
329 return Strings.nullToEmpty(getDeclared().rawArgument());
334 * Bridge between {@link EffectiveStatementWithFlags} and {@code ordered-by} statement.
336 * @param <A> Argument type ({@link Empty} if statement does not have argument.)
337 * @param <D> Class representing declared version of this statement.
339 public interface UserOrderedMixin<A, D extends DeclaredStatement<A>> extends EffectiveStatementWithFlags<A, D> {
340 default boolean userOrdered() {
341 return (flags() & FlagsBuilder.USER_ORDERED) != 0;
346 * Helper used to locate the effective {@code when} statement and exposing its argument as per
347 * {@link WhenConditionAware}.
349 * @param <A> Argument type ({@link Empty} if statement does not have argument.)
350 * @param <D> Class representing declared version of this statement.
352 public interface WhenConditionMixin<A, D extends DeclaredStatement<A>> extends Mixin<A, D>, WhenConditionAware {
354 default Optional<QualifiedBound> getWhenCondition() {
355 return findFirstEffectiveSubstatementArgument(WhenEffectiveStatement.class);
360 * Helper bridge for operation containers ({@code input} and {@code output}).
362 * @param <D> Class representing declared version of this statement.
364 public interface OperationContainerMixin<D extends DeclaredStatement<QName>>
365 extends ContainerLike, DocumentedNodeMixin.WithStatus<QName, D>, DataNodeContainerMixin<QName, D>,
366 MustConstraintMixin<QName, D>, WhenConditionMixin<QName, D>, AugmentationTargetMixin<QName, D>,
367 SchemaNodeMixin<D>, CopyableMixin<QName, D> {
369 default Optional<ActionDefinition> findAction(final QName qname) {
370 return Optional.empty();
374 default Optional<NotificationDefinition> findNotification(final QName qname) {
375 return Optional.empty();
379 default Collection<? extends ActionDefinition> getActions() {
380 return ImmutableSet.of();
384 default Collection<? extends NotificationDefinition> getNotifications() {
385 return ImmutableSet.of();
389 default Optional<Boolean> effectiveConfig() {
390 return Optional.empty();
393 default String defaultToString() {
394 return MoreObjects.toStringHelper(this).add("qname", getQName()).toString();
399 * Helper bridge for {@code anydata} and {@code anyxml} opaque data.
401 * @param <D> Class representing declared version of this statement.
403 public interface OpaqueDataSchemaNodeMixin<D extends DeclaredStatement<QName>, S extends DerivableSchemaNode<S>>
404 extends DerivableSchemaNode<S>, DataSchemaNodeMixin<D>, DocumentedNodeMixin.WithStatus<QName, D>,
405 MandatoryMixin<QName, D>, MustConstraintMixin<QName, D>, WhenConditionMixin<QName, D> {
407 default QName getQName() {
413 * Helper bridge for {@code rpc} and {@code action} operations.
415 * @param <D> Class representing declared version of this statement.
417 public interface OperationDefinitionMixin<D extends DeclaredStatement<QName>>
418 extends SchemaNodeMixin<D>, OperationDefinition {
420 default Collection<? extends @NonNull TypeDefinition<?>> getTypeDefinitions() {
421 return filterTypeDefinitions(this);
425 default Collection<? extends @NonNull GroupingDefinition> getGroupings() {
426 return filterEffectiveStatements(GroupingDefinition.class);
430 default InputSchemaNode getInput() {
431 return findAsContainer(this, InputEffectiveStatement.class, InputSchemaNode.class);
435 default OutputSchemaNode getOutput() {
436 return findAsContainer(this, OutputEffectiveStatement.class, OutputSchemaNode.class);
441 * Support interface for various mixins. Implementations are required to store 32bits worth of flags, which are
442 * globally assigned to sub-interfaces -- thus providing storage for many low-cardinality properties.
444 * @param <A> Argument type ({@link Empty} if statement does not have argument.)
445 * @param <D> Class representing declared version of this statement.
447 public interface EffectiveStatementWithFlags<A, D extends DeclaredStatement<A>> extends Mixin<A, D> {
449 * Return flags associated with this statements. Flags can be built using {@link FlagsBuilder}.
451 * @return Flag field value (32 bits).
456 final class FlagsBuilder implements Mutable {
457 // We still have 23 flags remaining
458 static final int STATUS_CURRENT = 0x0001;
459 static final int STATUS_DEPRECATED = 0x0002;
460 static final int STATUS_OBSOLETE = 0x0003;
461 static final int MASK_STATUS = 0x0003;
463 static final int MANDATORY = 0x0004;
465 static final int AUGMENTING = 0x0010;
466 @Deprecated(since = "7.0.9")
467 static final int ADDED_BY_USES = 0x0020;
468 private static final int MASK_HISTORY = 0x0030;
470 static final int USER_ORDERED = 0x0040;
471 static final int PRESENCE = 0x0080;
473 static final int CONFIG_UNDEF = 0x0100;
474 static final int CONFIG_FALSE = 0x0200;
475 static final int CONFIG_TRUE = 0x0300;
476 static final int MASK_CONFIG = CONFIG_TRUE;
480 public FlagsBuilder setConfiguration(final @Nullable Boolean config) {
482 if (config != null) {
483 fl = config ? CONFIG_TRUE : CONFIG_FALSE;
487 flags = flags & ~MASK_CONFIG | fl;
491 public FlagsBuilder setHistory(final CopyableNode history) {
492 flags = flags & ~MASK_HISTORY
493 | (history.isAugmenting() ? AUGMENTING : 0) | (history.isAddedByUses() ? ADDED_BY_USES : 0);
497 public FlagsBuilder setMandatory(final boolean mandatory) {
506 public FlagsBuilder setPresence(final boolean presence) {
515 public FlagsBuilder setStatus(final Status status) {
519 bits = STATUS_CURRENT;
522 bits = STATUS_DEPRECATED;
525 bits = STATUS_OBSOLETE;
528 throw new IllegalStateException("Unhandled status " + status);
531 flags = flags & ~MASK_STATUS | bits;
535 public FlagsBuilder setUserOrdered(final boolean userOrdered) {
537 flags |= USER_ORDERED;
539 flags &= ~USER_ORDERED;
544 public int toFlags() {
550 private EffectiveStatementMixins() {
554 static <T extends ContainerLike> T findAsContainer(final EffectiveStatement<?, ?> stmt,
555 final Class<? extends EffectiveStatement<QName, ?>> type, final Class<T> target) {
556 return target.cast(stmt.findFirstEffectiveSubstatement(type).get());
559 static Collection<? extends @NonNull TypeDefinition<?>> filterTypeDefinitions(final Mixin<?, ?> stmt) {
560 return Collections2.transform(stmt.filterEffectiveStatements(TypedefEffectiveStatement.class),
561 TypedefEffectiveStatement::getTypeDefinition);