org.infinispan.commands.FlagAffectedCommand Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of infinispan-core Show documentation

Infinispan core module

There is a newer version: 15.1.0.Dev04

package org.infinispan.commands;

import java.util.Set;

import org.infinispan.commons.util.EnumUtil;
import org.infinispan.context.Flag;
import org.infinispan.context.impl.FlagBitSets;

/**
 * Flags modify behavior of command such as whether or not to invoke certain commands remotely, check cache store etc.
 *
 * @author William Burns
 * @author Sanne Grinovero
 * @since 5.0
 */
public interface FlagAffectedCommand extends VisitableCommand {
   /**
    * @return The command flags - only valid to invoke after {@link #setFlagsBitSet(long)}. The set should
    * not be modified directly, only via the {@link #setFlagsBitSet(long)}, {@link #addFlags(long)} and {@link
    * #addFlags(long)} methods.
    */
   default Set getFlags() {
      return EnumUtil.enumSetOf(getFlagsBitSet(), Flag.class);
   }

   /**
    * @return The command flags. Flags can be modified with {@link #setFlagsBitSet(long)}, {@link #addFlags(long)}
    * and {@link #addFlags(long)} methods.
    */
   long getFlagsBitSet();

   /**
    * Set the flags, replacing any existing flags.
    */
   void setFlagsBitSet(long bitSet);

   /**
    * Add a set of flags to the command.
    *
    * @param flagsBitSet The flags to add, usually a {@link FlagBitSets} constant (or combination thereof).
    */
   default void addFlags(long flagsBitSet) {
      setFlagsBitSet(EnumUtil.mergeBitSets(getFlagsBitSet(), flagsBitSet));
   }

   /**
    * Check whether any of the flags in the {@code flagsBitSet} parameter is present in the command.
    * Should be used with the constants in {@link FlagBitSets}.
    */
   default boolean hasAnyFlag(long flagsBitSet) {
      return EnumUtil.containsAny(getFlagsBitSet(), flagsBitSet);
   }

   /**
    * Check whether all of the flags in the {@code flagsBitSet} parameter are present in the command.
    *
    * Should be used with the constants in {@link FlagBitSets}.
    */
   default boolean hasAllFlags(long flagBitSet) {
      return EnumUtil.containsAll(getFlagsBitSet(), flagBitSet);
   }
}