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