yang/yang-model-spi/src/main/java/org/opendaylight/yangtools/yang/model/spi/meta/EffectiveStatementMixins.java

   1 /*
   2  * Copyright (c) 2020 PANTHEON.tech, s.r.o. and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.yangtools.yang.model.spi.meta;
   9
  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;
  65
  66 /**
  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.
  69  */
  70 @Beta
  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);
  78         }
  79     }
  80
  81     /**
  82      * Bridge between {@link EffectiveStatement} and {@link AugmentationTarget}.
  83      *
  84      * @param <A> Argument type ({@link Void} if statement does not have argument.)
  85      * @param <D> Class representing declared version of this statement.
  86      */
  87     public interface AugmentationTargetMixin<A, D extends DeclaredStatement<A>>
  88             extends Mixin<A, D>, AugmentationTarget {
  89         @Override
  90         default Collection<? extends AugmentationSchemaNode> getAvailableAugmentations() {
  91             return filterEffectiveStatements(AugmentationSchemaNode.class);
  92         }
  93     }
  94
  95     /**
  96      * Bridge between {@link EffectiveStatementWithFlags} and {@link AddedByUsesAware}.
  97      *
  98      * @param <A> Argument type ({@link Void} if statement does not have argument.)
  99      * @param <D> Class representing declared version of this statement.
 100      */
 101     public interface AddedByUsesMixin<A, D extends DeclaredStatement<A>>
 102             extends EffectiveStatementWithFlags<A, D>, AddedByUsesAware {
 103         @Override
 104         default boolean isAddedByUses() {
 105             return (flags() & FlagsBuilder.ADDED_BY_USES) != 0;
 106         }
 107     }
 108
 109     /**
 110      * Bridge between {@link EffectiveStatementWithFlags} and {@link ActionNodeContainer}.
 111      *
 112      * @param <A> Argument type ({@link Void} if statement does not have argument.)
 113      * @param <D> Class representing declared version of this statement.
 114      */
 115     public interface ActionNodeContainerMixin<A, D extends DeclaredStatement<A>>
 116             extends Mixin<A, D>, ActionNodeContainer {
 117         @Override
 118         default Collection<? extends ActionDefinition> getActions() {
 119             return filterEffectiveStatements(ActionDefinition.class);
 120         }
 121     }
 122
 123     /**
 124      * Bridge between {@link EffectiveStatementWithFlags} and {@link NotificationNodeContainer}.
 125      *
 126      * @param <A> Argument type ({@link Void} if statement does not have argument.)
 127      * @param <D> Class representing declared version of this statement.
 128      */
 129     public interface NotificationNodeContainerMixin<A, D extends DeclaredStatement<A>>
 130             extends Mixin<A, D>, NotificationNodeContainer {
 131         @Override
 132         default Collection<? extends NotificationDefinition> getNotifications() {
 133             return filterEffectiveStatements(NotificationDefinition.class);
 134         }
 135     }
 136
 137     /**
 138      * Bridge between {@link EffectiveStatementWithFlags} and {@link MustConstraintAware}.
 139      *
 140      * @param <A> Argument type ({@link Void} if statement does not have argument.)
 141      * @param <D> Class representing declared version of this statement.
 142      */
 143     public interface MustConstraintMixin<A, D extends DeclaredStatement<A>> extends Mixin<A, D>, MustConstraintAware {
 144         @Override
 145         default Collection<? extends @NonNull MustDefinition> getMustConstraints() {
 146             return filterEffectiveStatements(MustDefinition.class);
 147         }
 148     }
 149
 150     /**
 151      * Bridge between {@link EffectiveStatementWithFlags} and {@link CopyableNode}.
 152      *
 153      * @param <A> Argument type ({@link Void} if statement does not have argument.)
 154      * @param <D> Class representing declared version of this statement.
 155      */
 156     public interface CopyableMixin<A, D extends DeclaredStatement<A>> extends AddedByUsesMixin<A, D>, CopyableNode {
 157         @Override
 158         default boolean isAugmenting() {
 159             return (flags() & FlagsBuilder.AUGMENTING) != 0;
 160         }
 161     }
 162
 163     /**
 164      * Bridge between {@link EffectiveStatementWithFlags} and {@link DataNodeContainer}.
 165      *
 166      * @param <A> Argument type ({@link Void} if statement does not have argument.)
 167      * @param <D> Class representing declared version of this statement.
 168      */
 169     public interface DataNodeContainerMixin<A, D extends DeclaredStatement<A>> extends DataNodeContainer, Mixin<A, D> {
 170         @Override
 171         default Collection<? extends TypeDefinition<?>> getTypeDefinitions() {
 172             return filterTypeDefinitions(this);
 173         }
 174
 175         @Override
 176         default Collection<? extends DataSchemaNode> getChildNodes() {
 177             return filterEffectiveStatements(DataSchemaNode.class);
 178         }
 179
 180         @Override
 181         default Collection<? extends GroupingDefinition> getGroupings() {
 182             return filterEffectiveStatements(GroupingDefinition.class);
 183         }
 184
 185         @Override
 186         default Collection<? extends UsesNode> getUses() {
 187             return filterEffectiveStatements(UsesNode.class);
 188         }
 189     }
 190
 191     /**
 192      * Bridge between {@link EffectiveStatementWithFlags} and {@link DataSchemaNode}.
 193      *
 194      * @param <A> Argument type ({@link Void} if statement does not have argument.)
 195      * @param <D> Class representing declared version of this statement.
 196      */
 197     public interface DataSchemaNodeMixin<A, D extends DeclaredStatement<A>>
 198             extends DataSchemaNode, CopyableMixin<A, D>, SchemaNodeMixin<A, D>, WhenConditionMixin<A, D> {
 199         @Override
 200         default Optional<Boolean> effectiveConfig() {
 201             final int fl = flags() & FlagsBuilder.MASK_CONFIG;
 202             switch (fl) {
 203                 case FlagsBuilder.CONFIG_FALSE:
 204                     return Optional.of(Boolean.FALSE);
 205                 case FlagsBuilder.CONFIG_TRUE:
 206                     return Optional.of(Boolean.TRUE);
 207                 case FlagsBuilder.CONFIG_UNDEF:
 208                     return Optional.empty();
 209                 default:
 210                     throw new IllegalStateException("Unhandled effective config flags " + fl);
 211             }
 212         }
 213     }
 214
 215     /**
 216      * Bridge between {@link EffectiveStatementWithFlags} and {@link DocumentedNode}.
 217      *
 218      * @param <A> Argument type ({@link Void} if statement does not have argument.)
 219      * @param <D> Class representing declared version of this statement.
 220      */
 221     public interface DocumentedNodeMixin<A, D extends DeclaredStatement<A>> extends Mixin<A, D>, DocumentedNode {
 222         /**
 223          * Bridge between {@link EffectiveStatementWithFlags} and
 224          * {@link org.opendaylight.yangtools.yang.model.api.DocumentedNode.WithStatus}.
 225          *
 226          * @param <A> Argument type ({@link Void} if statement does not have argument.)
 227          * @param <D> Class representing declared version of this statement.
 228          */
 229         interface WithStatus<A, D extends DeclaredStatement<A>>
 230                 extends EffectiveStatementWithFlags<A, D>, DocumentedNodeMixin<A, D>, DocumentedNode.WithStatus {
 231             @Override
 232             default Status getStatus() {
 233                 final int status = flags() & FlagsBuilder.MASK_STATUS;
 234                 switch (status) {
 235                     case FlagsBuilder.STATUS_CURRENT:
 236                         return Status.CURRENT;
 237                     case FlagsBuilder.STATUS_DEPRECATED:
 238                         return Status.DEPRECATED;
 239                     case FlagsBuilder.STATUS_OBSOLETE:
 240                         return Status.OBSOLETE;
 241                     default:
 242                         throw new IllegalStateException("Illegal status " + status);
 243                 }
 244             }
 245         }
 246
 247         @Override
 248         default Optional<String> getDescription() {
 249             return findFirstEffectiveSubstatementArgument(DescriptionEffectiveStatement.class);
 250         }
 251
 252         @Override
 253         default Optional<String> getReference() {
 254             return findFirstEffectiveSubstatementArgument(ReferenceEffectiveStatement.class);
 255         }
 256
 257         @Override
 258         default Collection<? extends UnknownSchemaNode> getUnknownSchemaNodes() {
 259             return filterEffectiveStatements(UnknownSchemaNode.class);
 260         }
 261     }
 262
 263     /**
 264      * Bridge between {@link EffectiveStatementWithFlags} and {@link ConstraintMetaDefinition}.
 265      *
 266      * @param <A> Argument type ({@link Void} if statement does not have argument.)
 267      * @param <D> Class representing declared version of this statement.
 268      */
 269     public interface ConstraintMetaDefinitionMixin<A, D extends DeclaredStatement<A>> extends DocumentedNodeMixin<A, D>,
 270             ConstraintMetaDefinition {
 271         @Override
 272         default Optional<String> getErrorAppTag() {
 273             return findFirstEffectiveSubstatementArgument(ErrorAppTagEffectiveStatement.class);
 274         }
 275
 276         @Override
 277         default Optional<String> getErrorMessage() {
 278             return findFirstEffectiveSubstatementArgument(ErrorMessageEffectiveStatement.class);
 279         }
 280     }
 281
 282     /**
 283      * Bridge between {@link EffectiveStatementWithFlags} and {@link MandatoryAware}.
 284      *
 285      * @param <A> Argument type ({@link Void} if statement does not have argument.)
 286      * @param <D> Class representing declared version of this statement.
 287      */
 288     public interface MandatoryMixin<A, D extends DeclaredStatement<A>>
 289             extends EffectiveStatementWithFlags<A, D>, MandatoryAware {
 290         @Override
 291         default boolean isMandatory() {
 292             return (flags() & FlagsBuilder.MANDATORY) != 0;
 293         }
 294     }
 295
 296     /**
 297      * Bridge between {@link EffectiveStatementWithFlags} and {@code presence} statement.
 298      *
 299      * @param <A> Argument type ({@link Void} if statement does not have argument.)
 300      * @param <D> Class representing declared version of this statement.
 301      */
 302     public interface PresenceMixin<A, D extends DeclaredStatement<A>> extends EffectiveStatementWithFlags<A, D> {
 303         default boolean presence() {
 304             return (flags() & FlagsBuilder.PRESENCE) != 0;
 305         }
 306     }
 307
 308     /**
 309      * Bridge between {@link EffectiveStatementWithFlags} and {@link SchemaNode}.
 310      *
 311      * @param <A> Argument type ({@link Void} if statement does not have argument.)
 312      * @param <D> Class representing declared version of this statement.
 313      */
 314     public interface SchemaNodeMixin<A, D extends DeclaredStatement<A>>
 315             extends DocumentedNodeMixin.WithStatus<A, D>, SchemaNode {
 316         // FIXME: ditch all this complexity once we do not require SchemaPath
 317         @Override
 318         default QName getQName() {
 319             return SchemaNodeDefaults.extractQName(pathObject());
 320         }
 321
 322         @Override
 323         @Deprecated
 324         default SchemaPath getPath() {
 325             return SchemaNodeDefaults.extractPath(this, pathObject());
 326         }
 327
 328         @NonNull Immutable pathObject();
 329     }
 330
 331     /**
 332      * Bridge between {@link EffectiveStatementWithFlags} and {@link UnknownSchemaNode}.
 333      *
 334      * @param <A> Argument type ({@link Void} if statement does not have argument.)
 335      * @param <D> Class representing declared version of this statement.
 336      */
 337     public interface UnknownSchemaNodeMixin<A, D extends DeclaredStatement<A>>
 338             extends SchemaNodeMixin<A, D>, CopyableMixin<A, D>, UnknownSchemaNode {
 339
 340         @Override
 341         default String getNodeParameter() {
 342             return Strings.nullToEmpty(getDeclared().rawArgument());
 343         }
 344     }
 345
 346     /**
 347      * Bridge between {@link EffectiveStatementWithFlags} and {@code ordered-by} statement.
 348      *
 349      * @param <A> Argument type ({@link Void} if statement does not have argument.)
 350      * @param <D> Class representing declared version of this statement.
 351      */
 352     public interface UserOrderedMixin<A, D extends DeclaredStatement<A>> extends EffectiveStatementWithFlags<A, D> {
 353         default boolean userOrdered() {
 354             return (flags() & FlagsBuilder.USER_ORDERED) != 0;
 355         }
 356     }
 357
 358     /**
 359      * Helper used to locate the effective {@code when} statement and exposing its argument as per
 360      * {@link WhenConditionAware}.
 361      *
 362      * @param <A> Argument type ({@link Void} if statement does not have argument.)
 363      * @param <D> Class representing declared version of this statement.
 364      */
 365     public interface WhenConditionMixin<A, D extends DeclaredStatement<A>> extends Mixin<A, D>, WhenConditionAware {
 366         @Override
 367         default Optional<QualifiedBound> getWhenCondition() {
 368             return findFirstEffectiveSubstatementArgument(WhenEffectiveStatement.class);
 369         }
 370     }
 371
 372     /**
 373      * Helper bridge for operation containers ({@code input} and {@code output}).
 374      *
 375      * @param <D> Class representing declared version of this statement.
 376      */
 377     public interface OperationContainerMixin<D extends DeclaredStatement<QName>>
 378             extends ContainerLike, DocumentedNodeMixin.WithStatus<QName, D>, DataNodeContainerMixin<QName, D>,
 379                     MustConstraintMixin<QName, D>, WhenConditionMixin<QName, D>, AugmentationTargetMixin<QName, D>,
 380                     SchemaNodeMixin<QName, D>, CopyableMixin<QName, D> {
 381         @Override
 382         default @NonNull QName argument() {
 383             return getQName();
 384         }
 385
 386         @Override
 387         default Optional<ActionDefinition> findAction(final QName qname) {
 388             return Optional.empty();
 389         }
 390
 391         @Override
 392         default Optional<NotificationDefinition> findNotification(final QName qname) {
 393             return Optional.empty();
 394         }
 395
 396         @Override
 397         default Collection<? extends ActionDefinition> getActions() {
 398             return ImmutableSet.of();
 399         }
 400
 401         @Override
 402         default Collection<? extends NotificationDefinition> getNotifications() {
 403             return ImmutableSet.of();
 404         }
 405
 406         @Override
 407         default Optional<Boolean> effectiveConfig() {
 408             return Optional.empty();
 409         }
 410
 411         default String defaultToString() {
 412             return MoreObjects.toStringHelper(this).add("qname", getQName()).toString();
 413         }
 414     }
 415
 416     /**
 417      * Helper bridge for {@code anydata} and {@code anyxml} opaque data.
 418      *
 419      * @param <D> Class representing declared version of this statement.
 420      */
 421     public interface OpaqueDataSchemaNodeMixin<D extends DeclaredStatement<QName>>
 422             extends DerivableSchemaNode, DataSchemaNodeMixin<QName, D>, DocumentedNodeMixin.WithStatus<QName, D>,
 423                     MandatoryMixin<QName, D>, MustConstraintMixin<QName, D>, WhenConditionMixin<QName, D> {
 424         @Override
 425         default @NonNull QName argument() {
 426             return getQName();
 427         }
 428     }
 429
 430     /**
 431      * Helper bridge for {@code rpc} and {@code action} operations.
 432      *
 433      * @param <D> Class representing declared version of this statement.
 434      */
 435     public interface OperationDefinitionMixin<D extends DeclaredStatement<QName>>
 436             extends SchemaNodeMixin<QName, D>, OperationDefinition {
 437         @Override
 438         default @NonNull QName argument() {
 439             return getQName();
 440         }
 441
 442         @Override
 443         default Collection<? extends @NonNull TypeDefinition<?>> getTypeDefinitions() {
 444             return filterTypeDefinitions(this);
 445         }
 446
 447         @Override
 448         default Collection<? extends @NonNull GroupingDefinition> getGroupings() {
 449             return filterEffectiveStatements(GroupingDefinition.class);
 450         }
 451
 452         @Override
 453         default InputSchemaNode getInput() {
 454             return findAsContainer(this, InputEffectiveStatement.class, InputSchemaNode.class);
 455         }
 456
 457         @Override
 458         default OutputSchemaNode getOutput() {
 459             return findAsContainer(this, OutputEffectiveStatement.class, OutputSchemaNode.class);
 460         }
 461     }
 462
 463     /**
 464      * Support interface for various mixins. Implementations are required to store 32bits worth of flags, which are
 465      * globally assigned to sub-interfaces -- thus providing storage for many low-cardinality properties.
 466      *
 467      * @param <A> Argument type ({@link Void} if statement does not have argument.)
 468      * @param <D> Class representing declared version of this statement.
 469      */
 470     public interface EffectiveStatementWithFlags<A, D extends DeclaredStatement<A>> extends Mixin<A, D> {
 471         /**
 472          * Return flags associated with this statements. Flags can be built using {@link FlagsBuilder}.
 473          *
 474          * @return Flag field value (32 bits).
 475          */
 476         int flags();
 477
 478         @NonNullByDefault
 479         final class FlagsBuilder implements Mutable {
 480             // We still have 23 flags remaining
 481             static final int STATUS_CURRENT       = 0x0001;
 482             static final int STATUS_DEPRECATED    = 0x0002;
 483             static final int STATUS_OBSOLETE      = 0x0003;
 484             static final int MASK_STATUS          = 0x0003;
 485
 486             static final int MANDATORY            = 0x0004;
 487
 488             static final int AUGMENTING           = 0x0010;
 489             static final int ADDED_BY_USES        = 0x0020;
 490             private static final int MASK_HISTORY = 0x0030;
 491
 492             static final int USER_ORDERED         = 0x0040;
 493             static final int PRESENCE             = 0x0080;
 494
 495             static final int CONFIG_UNDEF         = 0x0100;
 496             static final int CONFIG_FALSE         = 0x0200;
 497             static final int CONFIG_TRUE          = 0x0300;
 498             static final int MASK_CONFIG          = CONFIG_TRUE;
 499
 500             private int flags;
 501
 502             public FlagsBuilder setConfiguration(final @Nullable Boolean config) {
 503                 final int fl;
 504                 if (config != null) {
 505                     fl = config ? CONFIG_TRUE : CONFIG_FALSE;
 506                 } else {
 507                     fl = CONFIG_UNDEF;
 508                 }
 509                 flags = flags & ~MASK_CONFIG | fl;
 510                 return this;
 511             }
 512
 513             public FlagsBuilder setHistory(final CopyableNode history) {
 514                 flags = flags & ~MASK_HISTORY
 515                     | (history.isAugmenting() ? AUGMENTING : 0) | (history.isAddedByUses() ? ADDED_BY_USES : 0);
 516                 return this;
 517             }
 518
 519             public FlagsBuilder setMandatory(final boolean mandatory) {
 520                 if (mandatory) {
 521                     flags |= MANDATORY;
 522                 } else {
 523                     flags &= ~MANDATORY;
 524                 }
 525                 return this;
 526             }
 527
 528             public FlagsBuilder setPresence(final boolean presence) {
 529                 if (presence) {
 530                     flags |= PRESENCE;
 531                 } else {
 532                     flags &= ~PRESENCE;
 533                 }
 534                 return this;
 535             }
 536
 537             public FlagsBuilder setStatus(final Status status) {
 538                 final int bits;
 539                 switch (status) {
 540                     case CURRENT:
 541                         bits = STATUS_CURRENT;
 542                         break;
 543                     case DEPRECATED:
 544                         bits = STATUS_DEPRECATED;
 545                         break;
 546                     case OBSOLETE:
 547                         bits = STATUS_OBSOLETE;
 548                         break;
 549                     default:
 550                         throw new IllegalStateException("Unhandled status " + status);
 551                 }
 552
 553                 flags = flags & ~MASK_STATUS | bits;
 554                 return this;
 555             }
 556
 557             public FlagsBuilder setUserOrdered(final boolean userOrdered) {
 558                 if (userOrdered) {
 559                     flags |= USER_ORDERED;
 560                 } else {
 561                     flags &= ~USER_ORDERED;
 562                 }
 563                 return this;
 564             }
 565
 566             public int toFlags() {
 567                 return flags;
 568             }
 569         }
 570     }
 571
 572     private EffectiveStatementMixins() {
 573     }
 574
 575     static <T extends ContainerLike> T findAsContainer(final EffectiveStatement<?, ?> stmt,
 576             final Class<? extends EffectiveStatement<QName, ?>> type, final Class<T> target) {
 577         return target.cast(stmt.findFirstEffectiveSubstatement(type).get());
 578     }
 579
 580     static Collection<? extends @NonNull TypeDefinition<?>> filterTypeDefinitions(final Mixin<?, ?> stmt) {
 581         return Collections2.transform(stmt.filterEffectiveStatements(TypedefEffectiveStatement.class),
 582             TypedefEffectiveStatement::getTypeDefinition);
 583     }
 584
 585     public static int historyAndStatusFlags(final CopyableNode history,
 586             final Collection<? extends EffectiveStatement<?, ?>> substatements) {
 587         return new FlagsBuilder()
 588                 .setHistory(history)
 589                 .setStatus(substatements.stream()
 590                     .filter(StatusEffectiveStatement.class::isInstance)
 591                     .findAny()
 592                     .map(stmt -> ((StatusEffectiveStatement) stmt).argument())
 593                     .orElse(Status.CURRENT))
 594                 .toFlags();
 595     }
 596 }