model/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.Empty;
  23 import org.opendaylight.yangtools.yang.common.QName;
  24 import org.opendaylight.yangtools.yang.model.api.ActionDefinition;
  25 import org.opendaylight.yangtools.yang.model.api.ActionNodeContainer;
  26 import org.opendaylight.yangtools.yang.model.api.AddedByUsesAware;
  27 import org.opendaylight.yangtools.yang.model.api.AugmentationSchemaNode;
  28 import org.opendaylight.yangtools.yang.model.api.AugmentationTarget;
  29 import org.opendaylight.yangtools.yang.model.api.ConstraintMetaDefinition;
  30 import org.opendaylight.yangtools.yang.model.api.ContainerLike;
  31 import org.opendaylight.yangtools.yang.model.api.CopyableNode;
  32 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
  33 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  34 import org.opendaylight.yangtools.yang.model.api.DerivableSchemaNode;
  35 import org.opendaylight.yangtools.yang.model.api.DocumentedNode;
  36 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
  37 import org.opendaylight.yangtools.yang.model.api.InputSchemaNode;
  38 import org.opendaylight.yangtools.yang.model.api.MandatoryAware;
  39 import org.opendaylight.yangtools.yang.model.api.MustConstraintAware;
  40 import org.opendaylight.yangtools.yang.model.api.MustDefinition;
  41 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
  42 import org.opendaylight.yangtools.yang.model.api.NotificationNodeContainer;
  43 import org.opendaylight.yangtools.yang.model.api.OperationDefinition;
  44 import org.opendaylight.yangtools.yang.model.api.OutputSchemaNode;
  45 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
  46 import org.opendaylight.yangtools.yang.model.api.SchemaNodeDefaults;
  47 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  48 import org.opendaylight.yangtools.yang.model.api.Status;
  49 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
  50 import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;
  51 import org.opendaylight.yangtools.yang.model.api.UsesNode;
  52 import org.opendaylight.yangtools.yang.model.api.WhenConditionAware;
  53 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  54 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  55 import org.opendaylight.yangtools.yang.model.api.stmt.DescriptionEffectiveStatement;
  56 import org.opendaylight.yangtools.yang.model.api.stmt.ErrorAppTagEffectiveStatement;
  57 import org.opendaylight.yangtools.yang.model.api.stmt.ErrorMessageEffectiveStatement;
  58 import org.opendaylight.yangtools.yang.model.api.stmt.InputEffectiveStatement;
  59 import org.opendaylight.yangtools.yang.model.api.stmt.OutputEffectiveStatement;
  60 import org.opendaylight.yangtools.yang.model.api.stmt.ReferenceEffectiveStatement;
  61 import org.opendaylight.yangtools.yang.model.api.stmt.StatusEffectiveStatement;
  62 import org.opendaylight.yangtools.yang.model.api.stmt.TypedefEffectiveStatement;
  63 import org.opendaylight.yangtools.yang.model.api.stmt.WhenEffectiveStatement;
  64 import org.opendaylight.yangtools.yang.model.spi.meta.EffectiveStatementMixins.EffectiveStatementWithFlags.FlagsBuilder;
  65 import org.opendaylight.yangtools.yang.xpath.api.YangXPathExpression.QualifiedBound;
  66
  67 /**
  68  * Mix-in interfaces providing services required by SchemaNode et al. These interfaces provide implementations, or
  69  * implementation helpers based on default methods, so the correct behavior can be logically centralized.
  70  */
  71 @Beta
  72 public final class EffectiveStatementMixins {
  73     // Marker interface requiring all mixins to be derived from EffectiveStatement.
  74     private interface Mixin<A, D extends DeclaredStatement<A>> extends EffectiveStatement<A, D> {
  75         @SuppressWarnings("unchecked")
  76         default <T> @NonNull Collection<? extends @NonNull T> filterEffectiveStatements(final Class<T> type) {
  77             // Yeah, this is not nice, but saves one transformation
  78             return (Collection<? extends T>) Collections2.filter(effectiveSubstatements(), type::isInstance);
  79         }
  80     }
  81
  82     /**
  83      * Bridge between {@link EffectiveStatement} and {@link AugmentationTarget}.
  84      *
  85      * @param <A> Argument type ({@link Empty} if statement does not have argument.)
  86      * @param <D> Class representing declared version of this statement.
  87      */
  88     public interface AugmentationTargetMixin<A, D extends DeclaredStatement<A>>
  89             extends Mixin<A, D>, AugmentationTarget {
  90         @Override
  91         default Collection<? extends AugmentationSchemaNode> getAvailableAugmentations() {
  92             return filterEffectiveStatements(AugmentationSchemaNode.class);
  93         }
  94     }
  95
  96     /**
  97      * Bridge between {@link EffectiveStatementWithFlags} and {@link AddedByUsesAware}.
  98      *
  99      * @param <A> Argument type ({@link Empty} if statement does not have argument.)
 100      * @param <D> Class representing declared version of this statement.
 101      */
 102     public interface AddedByUsesMixin<A, D extends DeclaredStatement<A>>
 103             extends EffectiveStatementWithFlags<A, D>, AddedByUsesAware {
 104         @Override
 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 Empty} 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 Empty} 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 Empty} 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 Empty} 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         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 Empty} 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 Empty} 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 Empty} 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 Empty} 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 Empty} 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 Empty} 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 Empty} 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 Empty} 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         // FIXME: ditch all this complexity once we do not require SchemaPath
 318         @Override
 319         default QName getQName() {
 320             return SchemaNodeDefaults.extractQName(pathObject());
 321         }
 322
 323         @Override
 324         @Deprecated
 325         default SchemaPath getPath() {
 326             return SchemaNodeDefaults.extractPath(this, pathObject());
 327         }
 328
 329         @NonNull Immutable pathObject();
 330     }
 331
 332     /**
 333      * Bridge between {@link EffectiveStatementWithFlags} and {@link UnknownSchemaNode}.
 334      *
 335      * @param <A> Argument type ({@link Empty} if statement does not have argument.)
 336      * @param <D> Class representing declared version of this statement.
 337      */
 338     public interface UnknownSchemaNodeMixin<A, D extends DeclaredStatement<A>>
 339             extends SchemaNodeMixin<A, D>, CopyableMixin<A, D>, UnknownSchemaNode {
 340
 341         @Override
 342         default String getNodeParameter() {
 343             return Strings.nullToEmpty(getDeclared().rawArgument());
 344         }
 345     }
 346
 347     /**
 348      * Bridge between {@link EffectiveStatementWithFlags} and {@code ordered-by} statement.
 349      *
 350      * @param <A> Argument type ({@link Empty} if statement does not have argument.)
 351      * @param <D> Class representing declared version of this statement.
 352      */
 353     public interface UserOrderedMixin<A, D extends DeclaredStatement<A>> extends EffectiveStatementWithFlags<A, D> {
 354         default boolean userOrdered() {
 355             return (flags() & FlagsBuilder.USER_ORDERED) != 0;
 356         }
 357     }
 358
 359     /**
 360      * Helper used to locate the effective {@code when} statement and exposing its argument as per
 361      * {@link WhenConditionAware}.
 362      *
 363      * @param <A> Argument type ({@link Empty} if statement does not have argument.)
 364      * @param <D> Class representing declared version of this statement.
 365      */
 366     public interface WhenConditionMixin<A, D extends DeclaredStatement<A>> extends Mixin<A, D>, WhenConditionAware {
 367         @Override
 368         default Optional<QualifiedBound> getWhenCondition() {
 369             return findFirstEffectiveSubstatementArgument(WhenEffectiveStatement.class);
 370         }
 371     }
 372
 373     /**
 374      * Helper bridge for operation containers ({@code input} and {@code output}).
 375      *
 376      * @param <D> Class representing declared version of this statement.
 377      */
 378     public interface OperationContainerMixin<D extends DeclaredStatement<QName>>
 379             extends ContainerLike, DocumentedNodeMixin.WithStatus<QName, D>, DataNodeContainerMixin<QName, D>,
 380                     MustConstraintMixin<QName, D>, WhenConditionMixin<QName, D>, AugmentationTargetMixin<QName, D>,
 381                     SchemaNodeMixin<QName, D>, CopyableMixin<QName, D> {
 382         @Override
 383         default @NonNull QName argument() {
 384             return getQName();
 385         }
 386
 387         @Override
 388         default Optional<ActionDefinition> findAction(final QName qname) {
 389             return Optional.empty();
 390         }
 391
 392         @Override
 393         default Optional<NotificationDefinition> findNotification(final QName qname) {
 394             return Optional.empty();
 395         }
 396
 397         @Override
 398         default Collection<? extends ActionDefinition> getActions() {
 399             return ImmutableSet.of();
 400         }
 401
 402         @Override
 403         default Collection<? extends NotificationDefinition> getNotifications() {
 404             return ImmutableSet.of();
 405         }
 406
 407         @Override
 408         default Optional<Boolean> effectiveConfig() {
 409             return Optional.empty();
 410         }
 411
 412         default String defaultToString() {
 413             return MoreObjects.toStringHelper(this).add("qname", getQName()).toString();
 414         }
 415     }
 416
 417     /**
 418      * Helper bridge for {@code anydata} and {@code anyxml} opaque data.
 419      *
 420      * @param <D> Class representing declared version of this statement.
 421      */
 422     public interface OpaqueDataSchemaNodeMixin<D extends DeclaredStatement<QName>>
 423             extends DerivableSchemaNode, DataSchemaNodeMixin<QName, D>, DocumentedNodeMixin.WithStatus<QName, D>,
 424                     MandatoryMixin<QName, D>, MustConstraintMixin<QName, D>, WhenConditionMixin<QName, D> {
 425         @Override
 426         default @NonNull QName argument() {
 427             return getQName();
 428         }
 429     }
 430
 431     /**
 432      * Helper bridge for {@code rpc} and {@code action} operations.
 433      *
 434      * @param <D> Class representing declared version of this statement.
 435      */
 436     public interface OperationDefinitionMixin<D extends DeclaredStatement<QName>>
 437             extends SchemaNodeMixin<QName, D>, OperationDefinition {
 438         @Override
 439         default @NonNull QName argument() {
 440             return getQName();
 441         }
 442
 443         @Override
 444         default Collection<? extends @NonNull TypeDefinition<?>> getTypeDefinitions() {
 445             return filterTypeDefinitions(this);
 446         }
 447
 448         @Override
 449         default Collection<? extends @NonNull GroupingDefinition> getGroupings() {
 450             return filterEffectiveStatements(GroupingDefinition.class);
 451         }
 452
 453         @Override
 454         default InputSchemaNode getInput() {
 455             return findAsContainer(this, InputEffectiveStatement.class, InputSchemaNode.class);
 456         }
 457
 458         @Override
 459         default OutputSchemaNode getOutput() {
 460             return findAsContainer(this, OutputEffectiveStatement.class, OutputSchemaNode.class);
 461         }
 462     }
 463
 464     /**
 465      * Support interface for various mixins. Implementations are required to store 32bits worth of flags, which are
 466      * globally assigned to sub-interfaces -- thus providing storage for many low-cardinality properties.
 467      *
 468      * @param <A> Argument type ({@link Empty} if statement does not have argument.)
 469      * @param <D> Class representing declared version of this statement.
 470      */
 471     public interface EffectiveStatementWithFlags<A, D extends DeclaredStatement<A>> extends Mixin<A, D> {
 472         /**
 473          * Return flags associated with this statements. Flags can be built using {@link FlagsBuilder}.
 474          *
 475          * @return Flag field value (32 bits).
 476          */
 477         int flags();
 478
 479         @NonNullByDefault
 480         final class FlagsBuilder implements Mutable {
 481             // We still have 23 flags remaining
 482             static final int STATUS_CURRENT       = 0x0001;
 483             static final int STATUS_DEPRECATED    = 0x0002;
 484             static final int STATUS_OBSOLETE      = 0x0003;
 485             static final int MASK_STATUS          = 0x0003;
 486
 487             static final int MANDATORY            = 0x0004;
 488
 489             static final int AUGMENTING           = 0x0010;
 490             static final int ADDED_BY_USES        = 0x0020;
 491             private static final int MASK_HISTORY = 0x0030;
 492
 493             static final int USER_ORDERED         = 0x0040;
 494             static final int PRESENCE             = 0x0080;
 495
 496             static final int CONFIG_UNDEF         = 0x0100;
 497             static final int CONFIG_FALSE         = 0x0200;
 498             static final int CONFIG_TRUE          = 0x0300;
 499             static final int MASK_CONFIG          = CONFIG_TRUE;
 500
 501             private int flags;
 502
 503             public FlagsBuilder setConfiguration(final @Nullable Boolean config) {
 504                 final int fl;
 505                 if (config != null) {
 506                     fl = config ? CONFIG_TRUE : CONFIG_FALSE;
 507                 } else {
 508                     fl = CONFIG_UNDEF;
 509                 }
 510                 flags = flags & ~MASK_CONFIG | fl;
 511                 return this;
 512             }
 513
 514             public FlagsBuilder setHistory(final CopyableNode history) {
 515                 flags = flags & ~MASK_HISTORY
 516                     | (history.isAugmenting() ? AUGMENTING : 0) | (history.isAddedByUses() ? ADDED_BY_USES : 0);
 517                 return this;
 518             }
 519
 520             public FlagsBuilder setMandatory(final boolean mandatory) {
 521                 if (mandatory) {
 522                     flags |= MANDATORY;
 523                 } else {
 524                     flags &= ~MANDATORY;
 525                 }
 526                 return this;
 527             }
 528
 529             public FlagsBuilder setPresence(final boolean presence) {
 530                 if (presence) {
 531                     flags |= PRESENCE;
 532                 } else {
 533                     flags &= ~PRESENCE;
 534                 }
 535                 return this;
 536             }
 537
 538             public FlagsBuilder setStatus(final Status status) {
 539                 final int bits;
 540                 switch (status) {
 541                     case CURRENT:
 542                         bits = STATUS_CURRENT;
 543                         break;
 544                     case DEPRECATED:
 545                         bits = STATUS_DEPRECATED;
 546                         break;
 547                     case OBSOLETE:
 548                         bits = STATUS_OBSOLETE;
 549                         break;
 550                     default:
 551                         throw new IllegalStateException("Unhandled status " + status);
 552                 }
 553
 554                 flags = flags & ~MASK_STATUS | bits;
 555                 return this;
 556             }
 557
 558             public FlagsBuilder setUserOrdered(final boolean userOrdered) {
 559                 if (userOrdered) {
 560                     flags |= USER_ORDERED;
 561                 } else {
 562                     flags &= ~USER_ORDERED;
 563                 }
 564                 return this;
 565             }
 566
 567             public int toFlags() {
 568                 return flags;
 569             }
 570         }
 571     }
 572
 573     private EffectiveStatementMixins() {
 574     }
 575
 576     static <T extends ContainerLike> T findAsContainer(final EffectiveStatement<?, ?> stmt,
 577             final Class<? extends EffectiveStatement<QName, ?>> type, final Class<T> target) {
 578         return target.cast(stmt.findFirstEffectiveSubstatement(type).get());
 579     }
 580
 581     static Collection<? extends @NonNull TypeDefinition<?>> filterTypeDefinitions(final Mixin<?, ?> stmt) {
 582         return Collections2.transform(stmt.filterEffectiveStatements(TypedefEffectiveStatement.class),
 583             TypedefEffectiveStatement::getTypeDefinition);
 584     }
 585
 586     public static int historyAndStatusFlags(final CopyableNode history,
 587             final Collection<? extends EffectiveStatement<?, ?>> substatements) {
 588         return new FlagsBuilder()
 589                 .setHistory(history)
 590                 .setStatus(substatements.stream()
 591                     .filter(StatusEffectiveStatement.class::isInstance)
 592                     .findAny()
 593                     .map(stmt -> ((StatusEffectiveStatement) stmt).argument())
 594                     .orElse(Status.CURRENT))
 595                 .toFlags();
 596     }
 597 }