BitField (TrueZIP Kernel 7.7.8 API)

java.lang.Object
- de.schlichtherle.truezip.util.BitField<E>

Type Parameters:
E - The type of Enum objects contained in this set.

All Implemented Interfaces:

Serializable, Iterable<E>
```
@Immutable
public final class BitField<E extends Enum<E>>
extends Object
implements Iterable<E>, Serializable
```
A type-safe, immutable set of enums which emulates the concept of a bit field, i.e. a set of predefined bits. As an immutable class, it's inherently thread-safe. All modifying methods return a modified clone of this instance.

Author:

Christian Schlichtherle

See Also:
Serialized Form

Method Summary

Methods
Modifier and Type	Method and Description
`static <E extends Enum<E>> BitField<E>`	`allOf(Class<E> elementType)` Returns a bit field which contains all enums of the given element type.
`BitField<E>`	`and(BitField<E> that)`
`int`	`cardinality()` Returns the number of bits set in this field.
`BitField<E>`	`clear(E bit)` Clears the given bit.
`static <E extends Enum<E>> BitField<E>`	`copyOf(Collection<E> bits)` Returns a bit field which contains the same bits as the given collection of enums.
`boolean`	`equals(Object that)` Returns `true` if and only if the given object is another `BitField` and contains the same bits.
`boolean`	`get(E bit)` Returns `true` if and only if the given bit is set.
`int`	`hashCode()` Returns a hash code which is consistent with `equals(java.lang.Object)`.
`boolean`	`is(E bit)` Equivalent to `get(bit)`.
`boolean`	`isEmpty()` Returns `true` if and only if all bits are cleared in this bit field.
`Iterator<E>`	`iterator()` Returns a read-only iterator for the bits in this field.
`static <E extends Enum<E>> BitField<E>`	`noneOf(Class<E> elementType)` Returns a bit field which can contain the given element type and is initially empty.
`BitField<E>`	`not()`
`static <E extends Enum<E>> BitField<E>`	`of(Class<E> elementType, String list)`
`static <E extends Enum<E>> BitField<E>`	`of(E bit)` Returns a bit field which contains the given bit.
`static <E extends Enum<E>> BitField<E>`	`of(E bit, E... bits)` Returns a bit field which contains the given bits.
`BitField<E>`	`or(BitField<E> that)`
`BitField<E>`	`set(E bit)` Sets the given bit.
`BitField<E>`	`set(E bit, boolean set)` Sets or clears the given bit.
`EnumSet<E>`	`toEnumSet()` Returns a new set of enums containing the same bits as this instance.
`String`	`toString()` Returns a concatenation of the names of the bits in this field, separated by `"\|"`.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - allOf
```
public static <E extends Enum<E>> BitField<E> allOf(Class<E> elementType)
```
    Returns a bit field which contains all enums of the given element type.
    This could be used like this:
```
BitField<Option> field = BitField.allOf(Option.class);
 
```
    where Option is an arbitrary enum type.
  - and
```
public BitField<E> and(BitField<E> that)
```
  - cardinality
```
public int cardinality()
```
    Returns the number of bits set in this field.
  - clear
```
public BitField<E> clear(E bit)
```
    Clears the given bit.
  - copyOf
```
public static <E extends Enum<E>> BitField<E> copyOf(Collection<E> bits)
```
    Returns a bit field which contains the same bits as the given collection of enums.
    This could be used like this:
```
BitField<Option> field = BitField.of(bits);
 
```
    where bits is an EnumSet<Option>.
  - equals
```
public boolean equals(@CheckForNull
             Object that)
```
    Returns true if and only if the given object is another BitField and contains the same bits.
    
    Overrides:
    
    equals in class Object
  - get
```
public boolean get(E bit)
```
    Returns true if and only if the given bit is set.
    
    Parameters:
    bit - The bit to test.
  - hashCode
```
public int hashCode()
```
    Returns a hash code which is consistent with equals(java.lang.Object).
    
    Overrides:
    
    hashCode in class Object
  - is
```
public boolean is(E bit)
```
    Equivalent to get(bit).
  - isEmpty
```
public boolean isEmpty()
```
    Returns true if and only if all bits are cleared in this bit field.
  - iterator
```
public Iterator<E> iterator()
```
    Returns a read-only iterator for the bits in this field.
    
    Specified by:
    
    iterator in interface Iterable<E extends Enum<E>>
  - noneOf
```
public static <E extends Enum<E>> BitField<E> noneOf(Class<E> elementType)
```
    Returns a bit field which can contain the given element type and is initially empty.
    This could be used like this:
```
BitField<Option> field = BitField.noneOf(Option.class);
 
```
    where Option is an arbitrary enum type.
  - not
```
public BitField<E> not()
```
  - of
```
public static <E extends Enum<E>> BitField<E> of(Class<E> elementType,
                                 String list)
```
  - of
```
public static <E extends Enum<E>> BitField<E> of(E bit)
```
    Returns a bit field which contains the given bit.
    This could be used like this:
```
BitField<Option> field = BitField.of(Option.ONE);
 
```
    where Option.ONE is an arbitrary enum.
  - of
```
public static <E extends Enum<E>> BitField<E> of(E bit,
                                 E... bits)
```
    Returns a bit field which contains the given bits.
    This could be used like this:
```
BitField<Option> field = BitField.of(Option.ONE, Option.TWO);
 
```
    where Option.ONE and Option.TWO are arbitrary enums.
  - or
```
public BitField<E> or(BitField<E> that)
```
  - set
```
public BitField<E> set(E bit)
```
    Sets the given bit.
  - set
```
public BitField<E> set(E bit,
              boolean set)
```
    Sets or clears the given bit.
    Subclasses could override this method in order to cache frequently used results, such as a null bit field, a single bit field etc.
    
    Parameters:
    bit - The bit to set or clear.
    set - Whether the bit shall get set or cleared.
  - toEnumSet
```
public EnumSet<E> toEnumSet()
```
    Returns a new set of enums containing the same bits as this instance. The following boolean identity expression is always true for any non-null bit field bits: bits.equals(BitField.copyOf(bits.toEnumSet())).
    
    Returns:
    a new set of enums containing the same bits as this instance.
  - toString
```
public String toString()
```
    Returns a concatenation of the names of the bits in this field, separated by "|".
    
    Overrides:
    
    toString in class Object

Class BitField<E extends Enum<E>>

Method Summary

Methods inherited from class java.lang.Object

Method Detail

allOf

and

cardinality

clear

copyOf

equals

get

hashCode

is

isEmpty

iterator

noneOf

not

of

of

of

or

set

set

toEnumSet

toString