de.caff.util

## Interface BitFlag

- All Known Implementing Classes:
    SimpleBitFlag, StatusFlag

      public interface BitFlag

  A single bit flag.
  Author:
    Rammi

- - ### Method Summary

    All Methods Instance Methods Abstract Methods
    Modifier and Type | Method and Description
    --- | ---
    `BitMask` | `clearIn(BitMask mask)` Clear this flag in the given bit mask.
    `boolean` | `isSetIn(BitMask mask)` Is this flag set in the given mask?
    `BitMask` | `setIn(BitMask mask)` Set this flag in the given bit mask.

- - ### Method Detail

    - #### isSetIn

          boolean isSetIn(@NotNull
                          BitMask mask)

      Is this flag set in the given mask?
      Parameters:
        `mask` - bit mask
      Returns:
        `true`: if the flag is set
        `false`: if the flag is not set

    - #### setIn

          @NotNull
          BitMask setIn(@NotNull
                                 BitMask mask)

      Set this flag in the given bit mask.
      Parameters:
        `mask` - bit mask
      Returns:
        new bit mask where this flag is set

    - #### clearIn

          @NotNull
          BitMask clearIn(@NotNull
                                   BitMask mask)

      Clear this flag in the given bit mask.
      Parameters:
        `mask` - bit mask
      Returns:
        new bit mask where this flag is cleared