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.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.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.DerivableSchemaNode;
  33 import org.opendaylight.yangtools.yang.model.api.DocumentedNode;
  34 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
  35 import org.opendaylight.yangtools.yang.model.api.InputSchemaNode;
  36 import org.opendaylight.yangtools.yang.model.api.MandatoryAware;
  37 import org.opendaylight.yangtools.yang.model.api.MustConstraintAware;
  38 import org.opendaylight.yangtools.yang.model.api.MustDefinition;
  39 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
  40 import org.opendaylight.yangtools.yang.model.api.NotificationNodeContainer;
  41 import org.opendaylight.yangtools.yang.model.api.OperationDefinition;
  42 import org.opendaylight.yangtools.yang.model.api.OutputSchemaNode;
  43 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
  44 import org.opendaylight.yangtools.yang.model.api.Status;
  45 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
  46 import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;
  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.OutputEffectiveStatement;
  56 import org.opendaylight.yangtools.yang.model.api.stmt.ReferenceEffectiveStatement;
  57 import org.opendaylight.yangtools.yang.model.api.stmt.StatusEffectiveStatement;
  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.parser.rfc7950.stmt.EffectiveStatementMixins.EffectiveStatementWithFlags.FlagsBuilder;
  61 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStatementSupport;
  62 import org.opendaylight.yangtools.yang.parser.spi.meta.CopyHistory;
  63 import org.opendaylight.yangtools.yang.xpath.api.YangXPathExpression.QualifiedBound;
  64
  65 /**
  66  * Mix-in interfaces providing services required by SchemaNode et al. These interfaces provide implementations, or
  67  * implementation helpers based on default methods, so the correct behavior can be logically centralized.
  68  */
  69 @Beta
  70 public final class EffectiveStatementMixins {
  71     // Marker interface requiring all mixins to be derived from EffectiveStatement.
  72     private interface Mixin<A, D extends DeclaredStatement<A>> extends EffectiveStatement<A, D> {
  73         @SuppressWarnings("unchecked")
  74         default <T> @NonNull Collection<? extends @NonNull T> filterEffectiveStatements(final Class<T> type) {
  75             // Yeah, this is not nice, but saves one transformation
  76             return (Collection<? extends T>) Collections2.filter(effectiveSubstatements(), type::isInstance);
  77         }
  78     }
  79
  80     /**
  81      * Bridge between {@link EffectiveStatement} and {@link AugmentationTarget}.
  82      *
  83      * @param <A> Argument type ({@link Void} if statement does not have argument.)
  84      * @param <D> Class representing declared version of this statement.
  85      */
  86     public interface AugmentationTargetMixin<A, D extends DeclaredStatement<A>>
  87             extends Mixin<A, D>, AugmentationTarget {
  88         @Override
  89         default Collection<? extends AugmentationSchemaNode> getAvailableAugmentations() {
  90             return filterEffectiveStatements(AugmentationSchemaNode.class);
  91         }
  92     }
  93
  94     /**
  95      * Bridge between {@link EffectiveStatementWithFlags} and {@link AddedByUsesAware}.
  96      *
  97      * @param <A> Argument type ({@link Void} if statement does not have argument.)
  98      * @param <D> Class representing declared version of this statement.
  99      */
 100     public interface AddedByUsesMixin<A, D extends DeclaredStatement<A>>
 101             extends EffectiveStatementWithFlags<A, D>, AddedByUsesAware {
 102         @Override
 103         @Deprecated
 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         @Deprecated
 159         default boolean isAugmenting() {
 160             return (flags() & FlagsBuilder.AUGMENTING) != 0;
 161         }
 162     }
 163
 164     /**
 165      * Bridge between {@link EffectiveStatementWithFlags} and {@link DataNodeContainer}.
 166      *
 167      * @param <A> Argument type ({@link Void} if statement does not have argument.)
 168      * @param <D> Class representing declared version of this statement.
 169      */
 170     public interface DataNodeContainerMixin<A, D extends DeclaredStatement<A>> extends DataNodeContainer, Mixin<A, D> {
 171         @Override
 172         default Collection<? extends TypeDefinition<?>> getTypeDefinitions() {
 173             return filterTypeDefinitions(this);
 174         }
 175
 176         @Override
 177         default Collection<? extends DataSchemaNode> getChildNodes() {
 178             return filterEffectiveStatements(DataSchemaNode.class);
 179         }
 180
 181         @Override
 182         default Collection<? extends GroupingDefinition> getGroupings() {
 183             return filterEffectiveStatements(GroupingDefinition.class);
 184         }
 185
 186         @Override
 187         default Collection<? extends UsesNode> getUses() {
 188             return filterEffectiveStatements(UsesNode.class);
 189         }
 190     }
 191
 192     /**
 193      * Bridge between {@link EffectiveStatementWithFlags} and {@link DataSchemaNode}.
 194      *
 195      * @param <A> Argument type ({@link Void} if statement does not have argument.)
 196      * @param <D> Class representing declared version of this statement.
 197      */
 198     public interface DataSchemaNodeMixin<A, D extends DeclaredStatement<A>>
 199             extends DataSchemaNode, CopyableMixin<A, D>, SchemaNodeMixin<A, D>, WhenConditionMixin<A, D> {
 200         @Override
 201         default Optional<Boolean> effectiveConfig() {
 202             final int fl = flags() & FlagsBuilder.MASK_CONFIG;
 203             switch (fl) {
 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();
 210                 default:
 211                     throw new IllegalStateException("Unhandled effective config flags " + fl);
 212             }
 213         }
 214     }
 215
 216     /**
 217      * Bridge between {@link EffectiveStatementWithFlags} and {@link DocumentedNode}.
 218      *
 219      * @param <A> Argument type ({@link Void} if statement does not have argument.)
 220      * @param <D> Class representing declared version of this statement.
 221      */
 222     public interface DocumentedNodeMixin<A, D extends DeclaredStatement<A>> extends Mixin<A, D>, DocumentedNode {
 223         /**
 224          * Bridge between {@link EffectiveStatementWithFlags} and
 225          * {@link org.opendaylight.yangtools.yang.model.api.DocumentedNode.WithStatus}.
 226          *
 227          * @param <A> Argument type ({@link Void} if statement does not have argument.)
 228          * @param <D> Class representing declared version of this statement.
 229          */
 230         interface WithStatus<A, D extends DeclaredStatement<A>>
 231                 extends EffectiveStatementWithFlags<A, D>, DocumentedNodeMixin<A, D>, DocumentedNode.WithStatus {
 232             @Override
 233             default Status getStatus() {
 234                 final int status = flags() & FlagsBuilder.MASK_STATUS;
 235                 switch (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;
 242                     default:
 243                         throw new IllegalStateException("Illegal status " + status);
 244                 }
 245             }
 246         }
 247
 248         @Override
 249         default Optional<String> getDescription() {
 250             return findFirstEffectiveSubstatementArgument(DescriptionEffectiveStatement.class);
 251         }
 252
 253         @Override
 254         default Optional<String> getReference() {
 255             return findFirstEffectiveSubstatementArgument(ReferenceEffectiveStatement.class);
 256         }
 257
 258         @Override
 259         default Collection<? extends UnknownSchemaNode> getUnknownSchemaNodes() {
 260             return filterEffectiveStatements(UnknownSchemaNode.class);
 261         }
 262     }
 263
 264     /**
 265      * Bridge between {@link EffectiveStatementWithFlags} and {@link ConstraintMetaDefinition}.
 266      *
 267      * @param <A> Argument type ({@link Void} if statement does not have argument.)
 268      * @param <D> Class representing declared version of this statement.
 269      */
 270     public interface ConstraintMetaDefinitionMixin<A, D extends DeclaredStatement<A>> extends DocumentedNodeMixin<A, D>,
 271             ConstraintMetaDefinition {
 272         @Override
 273         default Optional<String> getErrorAppTag() {
 274             return findFirstEffectiveSubstatementArgument(ErrorAppTagEffectiveStatement.class);
 275         }
 276
 277         @Override
 278         default Optional<String> getErrorMessage() {
 279             return findFirstEffectiveSubstatementArgument(ErrorMessageEffectiveStatement.class);
 280         }
 281     }
 282
 283     /**
 284      * Bridge between {@link EffectiveStatementWithFlags} and {@link MandatoryAware}.
 285      *
 286      * @param <A> Argument type ({@link Void} if statement does not have argument.)
 287      * @param <D> Class representing declared version of this statement.
 288      */
 289     public interface MandatoryMixin<A, D extends DeclaredStatement<A>>
 290             extends EffectiveStatementWithFlags<A, D>, MandatoryAware {
 291         @Override
 292         default boolean isMandatory() {
 293             return (flags() & FlagsBuilder.MANDATORY) != 0;
 294         }
 295     }
 296
 297     /**
 298      * Bridge between {@link EffectiveStatementWithFlags} and {@code presence} statement.
 299      *
 300      * @param <A> Argument type ({@link Void} if statement does not have argument.)
 301      * @param <D> Class representing declared version of this statement.
 302      */
 303     public interface PresenceMixin<A, D extends DeclaredStatement<A>> extends EffectiveStatementWithFlags<A, D> {
 304         default boolean presence() {
 305             return (flags() & FlagsBuilder.PRESENCE) != 0;
 306         }
 307     }
 308
 309     /**
 310      * Bridge between {@link EffectiveStatementWithFlags} and {@link SchemaNode}.
 311      *
 312      * @param <A> Argument type ({@link Void} if statement does not have argument.)
 313      * @param <D> Class representing declared version of this statement.
 314      */
 315     public interface SchemaNodeMixin<A, D extends DeclaredStatement<A>>
 316             extends DocumentedNodeMixin.WithStatus<A, D>, SchemaNode {
 317         @Override
 318         default QName getQName() {
 319             return getPath().getLastComponent();
 320         }
 321     }
 322
 323     /**
 324      * Bridge between {@link EffectiveStatementWithFlags} and {@link UnknownSchemaNode}.
 325      *
 326      * @param <A> Argument type ({@link Void} if statement does not have argument.)
 327      * @param <D> Class representing declared version of this statement.
 328      */
 329     public interface UnknownSchemaNodeMixin<A, D extends DeclaredStatement<A>>
 330             extends SchemaNodeMixin<A, D>, CopyableMixin<A, D>, UnknownSchemaNode {
 331
 332         @Override
 333         default String getNodeParameter() {
 334             return Strings.nullToEmpty(getDeclared().rawArgument());
 335         }
 336     }
 337
 338     /**
 339      * Bridge between {@link EffectiveStatementWithFlags} and {@code ordered-by} statement.
 340      *
 341      * @param <A> Argument type ({@link Void} if statement does not have argument.)
 342      * @param <D> Class representing declared version of this statement.
 343      */
 344     public interface UserOrderedMixin<A, D extends DeclaredStatement<A>> extends EffectiveStatementWithFlags<A, D> {
 345         default boolean userOrdered() {
 346             return (flags() & FlagsBuilder.USER_ORDERED) != 0;
 347         }
 348     }
 349
 350     /**
 351      * Helper used to locate the effective {@code when} statement and exposing its argument as per
 352      * {@link WhenConditionAware}.
 353      *
 354      * @param <A> Argument type ({@link Void} if statement does not have argument.)
 355      * @param <D> Class representing declared version of this statement.
 356      */
 357     public interface WhenConditionMixin<A, D extends DeclaredStatement<A>> extends Mixin<A, D>, WhenConditionAware {
 358         @Override
 359         default Optional<QualifiedBound> getWhenCondition() {
 360             return findFirstEffectiveSubstatementArgument(WhenEffectiveStatement.class);
 361         }
 362     }
 363
 364     /**
 365      * Helper bridge for operation containers ({@code input} and {@code output}).
 366      *
 367      * @param <D> Class representing declared version of this statement.
 368      */
 369     public interface OperationContainerMixin<D extends DeclaredStatement<QName>>
 370             extends ContainerLike, DocumentedNodeMixin.WithStatus<QName, D>, DataNodeContainerMixin<QName, D>,
 371                     MustConstraintMixin<QName, D>, WhenConditionMixin<QName, D>, AugmentationTargetMixin<QName, D>,
 372                     SchemaNodeMixin<QName, D>, CopyableMixin<QName, D> {
 373         @Override
 374         default @NonNull QName argument() {
 375             return getQName();
 376         }
 377
 378         @Override
 379         default Optional<ActionDefinition> findAction(final QName qname) {
 380             return Optional.empty();
 381         }
 382
 383         @Override
 384         default Optional<NotificationDefinition> findNotification(final QName qname) {
 385             return Optional.empty();
 386         }
 387
 388         @Override
 389         default Collection<? extends ActionDefinition> getActions() {
 390             return ImmutableSet.of();
 391         }
 392
 393         @Override
 394         default Collection<? extends NotificationDefinition> getNotifications() {
 395             return ImmutableSet.of();
 396         }
 397
 398         @Override
 399         default Optional<Boolean> effectiveConfig() {
 400             return Optional.empty();
 401         }
 402
 403         default String defaultToString() {
 404             return MoreObjects.toStringHelper(this).add("path", getPath()).toString();
 405         }
 406     }
 407
 408     /**
 409      * Helper bridge for {@code anydata} and {@code anyxml} opaque data.
 410      *
 411      * @param <D> Class representing declared version of this statement.
 412      */
 413     public interface OpaqueDataSchemaNodeMixin<D extends DeclaredStatement<QName>>
 414             extends DerivableSchemaNode, DataSchemaNodeMixin<QName, D>, DocumentedNodeMixin.WithStatus<QName, D>,
 415                     MandatoryMixin<QName, D>, MustConstraintMixin<QName, D>, WhenConditionMixin<QName, D> {
 416         @Override
 417         default @NonNull QName argument() {
 418             return getQName();
 419         }
 420     }
 421
 422     /**
 423      * Helper bridge for {@code rpc} and {@code action} operations.
 424      *
 425      * @param <D> Class representing declared version of this statement.
 426      */
 427     public interface OperationDefinitionMixin<D extends DeclaredStatement<QName>>
 428             extends SchemaNodeMixin<QName, D>, OperationDefinition {
 429         @Override
 430         default @NonNull QName argument() {
 431             return getQName();
 432         }
 433
 434         @Override
 435         default Collection<? extends @NonNull TypeDefinition<?>> getTypeDefinitions() {
 436             return filterTypeDefinitions(this);
 437         }
 438
 439         @Override
 440         default Collection<? extends @NonNull GroupingDefinition> getGroupings() {
 441             return filterEffectiveStatements(GroupingDefinition.class);
 442         }
 443
 444         @Override
 445         default InputSchemaNode getInput() {
 446             return findAsContainer(this, InputEffectiveStatement.class, InputSchemaNode.class);
 447         }
 448
 449         @Override
 450         default OutputSchemaNode getOutput() {
 451             return findAsContainer(this, OutputEffectiveStatement.class, OutputSchemaNode.class);
 452         }
 453     }
 454
 455     /**
 456      * Support interface for various mixins. Implementations are required to store 32bits worth of flags, which are
 457      * globally assigned to sub-interfaces -- thus providing storage for many low-cardinality properties.
 458      *
 459      * @param <A> Argument type ({@link Void} if statement does not have argument.)
 460      * @param <D> Class representing declared version of this statement.
 461      */
 462     public interface EffectiveStatementWithFlags<A, D extends DeclaredStatement<A>> extends Mixin<A, D> {
 463         /**
 464          * Return flags assicated with this statements. Flags can be built using {@link FlagsBuilder}.
 465          *
 466          * @return Flag field value (32 bits).
 467          */
 468         int flags();
 469
 470         @NonNullByDefault
 471         final class FlagsBuilder implements Mutable {
 472             // We still have 23 flags remaining
 473             static final int STATUS_CURRENT       = 0x0001;
 474             static final int STATUS_DEPRECATED    = 0x0002;
 475             static final int STATUS_OBSOLETE      = 0x0003;
 476             static final int MASK_STATUS          = 0x0003;
 477
 478             static final int MANDATORY            = 0x0004;
 479
 480             static final int AUGMENTING           = 0x0010;
 481             static final int ADDED_BY_USES        = 0x0020;
 482             private static final int MASK_HISTORY = 0x0030;
 483
 484             static final int USER_ORDERED         = 0x0040;
 485             static final int PRESENCE             = 0x0080;
 486
 487             static final int CONFIG_UNDEF         = 0x0100;
 488             static final int CONFIG_FALSE         = 0x0200;
 489             static final int CONFIG_TRUE          = 0x0300;
 490             static final int MASK_CONFIG          = CONFIG_TRUE;
 491
 492             private int flags;
 493
 494             public FlagsBuilder setConfiguration(final @Nullable Boolean config) {
 495                 final int fl;
 496                 if (config != null) {
 497                     fl = config ? CONFIG_TRUE : CONFIG_FALSE;
 498                 } else {
 499                     fl = CONFIG_UNDEF;
 500                 }
 501                 flags = flags & ~MASK_CONFIG | fl;
 502                 return this;
 503             }
 504
 505             public FlagsBuilder setHistory(final CopyHistory history) {
 506                 flags = flags & ~MASK_HISTORY
 507                     | (history.isAugmenting() ? AUGMENTING : 0) | (history.isAddedByUses() ? ADDED_BY_USES : 0);
 508                 return this;
 509             }
 510
 511             public FlagsBuilder setMandatory(final boolean mandatory) {
 512                 if (mandatory) {
 513                     flags |= MANDATORY;
 514                 } else {
 515                     flags &= ~MANDATORY;
 516                 }
 517                 return this;
 518             }
 519
 520             public FlagsBuilder setPresence(final boolean presence) {
 521                 if (presence) {
 522                     flags |= PRESENCE;
 523                 } else {
 524                     flags &= ~PRESENCE;
 525                 }
 526                 return this;
 527             }
 528
 529             public FlagsBuilder setStatus(final Status status) {
 530                 final int bits;
 531                 switch (status) {
 532                     case CURRENT:
 533                         bits = STATUS_CURRENT;
 534                         break;
 535                     case DEPRECATED:
 536                         bits = STATUS_DEPRECATED;
 537                         break;
 538                     case OBSOLETE:
 539                         bits = STATUS_OBSOLETE;
 540                         break;
 541                     default:
 542                         throw new IllegalStateException("Unhandled status " + status);
 543                 }
 544
 545                 flags = flags & ~MASK_STATUS | bits;
 546                 return this;
 547             }
 548
 549             public FlagsBuilder setUserOrdered(final boolean userOrdered) {
 550                 if (userOrdered) {
 551                     flags |= USER_ORDERED;
 552                 } else {
 553                     flags &= ~USER_ORDERED;
 554                 }
 555                 return this;
 556             }
 557
 558             public int toFlags() {
 559                 return flags;
 560             }
 561         }
 562     }
 563
 564     private EffectiveStatementMixins() {
 565     }
 566
 567     static <T extends ContainerLike> T findAsContainer(final EffectiveStatement<?, ?> stmt,
 568             final Class<? extends EffectiveStatement<QName, ?>> type, final Class<T> target) {
 569         return target.cast(stmt.findFirstEffectiveSubstatement(type).get());
 570     }
 571
 572     static Collection<? extends @NonNull TypeDefinition<?>> filterTypeDefinitions(final Mixin<?, ?> stmt) {
 573         return Collections2.transform(stmt.filterEffectiveStatements(TypedefEffectiveStatement.class),
 574             TypedefEffectiveStatement::getTypeDefinition);
 575     }
 576
 577     public static int historyAndStatusFlags(final CopyHistory history,
 578             final Collection<? extends EffectiveStatement<?, ?>> substatements) {
 579         return new FlagsBuilder()
 580                 .setHistory(history)
 581                 .setStatus(AbstractStatementSupport.findFirstArgument(substatements,
 582                     StatusEffectiveStatement.class, Status.CURRENT))
 583                 .toFlags();
 584     }
 585 }