BitField (TrueZIP Kernel 7.2-rc-2 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:

java.io.Serializable, java.lang.Iterable<E>
```
@DefaultAnnotation(value=edu.umd.cs.findbugs.annotations.NonNull.class)
@Immutable
public final class BitField<E extends java.lang.Enum<E>>
extends java.lang.Object
implements java.lang.Iterable<E>, java.io.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.
TODO: Add more modifying methods.

Author:

Christian Schlichtherle

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

private java.util.EnumSet<E> bits

private static long serialVersionUID

Fields
Modifier and Type	Field and Description
`private java.util.EnumSet<E>`	`bits`
`private static long`	`serialVersionUID`

Constructor Summary

Constructors
Modifier	Constructor and Description
`private`	`BitField(java.lang.Class<E> elementType, boolean allOf)` Constructs a new bit field which contains all or none of the enums of the given element type.
`private`	`BitField(java.util.Collection<E> bits)` Constructs a new bit field by sharing the given set of enums.
`private`	`BitField(E bit)` Constructs a new bit field which contains the given bit.
`private`	`BitField(E bit, E... bits)` Constructs a new bit field which contains the given bits.

Method Summary

Methods
Modifier and Type	Method and Description
`static <E extends java.lang.Enum<E>> BitField<E>`	`allOf(java.lang.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 java.lang.Enum<E>> BitField<E>`	`copyOf(java.util.Collection<E> bits)` Returns a bit field which contains the same bits as the given set of enums.
`boolean`	`equals(java.lang.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.
`java.util.Iterator<E>`	`iterator()` Returns a read-only iterator for the bits in this field.
`static <E extends java.lang.Enum<E>> BitField<E>`	`noneOf(java.lang.Class<E> elementType)` Returns a bit field which can contain the given element type and is initially empty.
`BitField<E>`	`not()`
`static <E extends java.lang.Enum<E>> BitField<E>`	`of(java.lang.Class<E> elementType, java.lang.String list)`
`static <E extends java.lang.Enum<E>> BitField<E>`	`of(E bit)` Returns a bit field which contains the given bit.
`static <E extends java.lang.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.
`java.util.EnumSet<E>`	`toEnumSet()` Returns a new set of enums containing the same bits as this instance.
`java.lang.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

- Field Detail
  - serialVersionUID
```
private static final long serialVersionUID
```
    See Also:
    Constant Field Values
  - bits
```
private final java.util.EnumSet<E extends java.lang.Enum<E>> bits
```
- Constructor Detail
  - BitField
```
private BitField(java.lang.Class<E> elementType,
        boolean allOf)
```
    Constructs a new bit field which contains all or none of the enums of the given element type.
  - BitField
```
private BitField(E bit)
```
    Constructs a new bit field which contains the given bit.
  - BitField
```
private BitField(E bit,
        E... bits)
```
    Constructs a new bit field which contains the given bits.
  - BitField
```
private BitField(java.util.Collection<E> bits)
```
    Constructs a new bit field by sharing the given set of enums. Note that this constructor does NOT make a protective copy - use with care!
    
    Parameters:
    bits - the set of enums to share with this instance.
- Method Detail
  - noneOf
```
public static <E extends java.lang.Enum<E>> BitField<E> noneOf(java.lang.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.
  - allOf
```
public static <E extends java.lang.Enum<E>> BitField<E> allOf(java.lang.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.
  - of
```
public static <E extends java.lang.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 java.lang.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.
  - copyOf
```
public static <E extends java.lang.Enum<E>> BitField<E> copyOf(java.util.Collection<E> bits)
```
    Returns a bit field which contains the same bits as the given set of enums.
    This could be used like this:
```
BitField<Option> field = BitField.of(bits);
 
```
    where bits is an EnumSet<Option>.
  - of
```
public static <E extends java.lang.Enum<E>> BitField<E> of(java.lang.Class<E> elementType,
                                           java.lang.String list)
```
  - isEmpty
```
public boolean isEmpty()
```
    Returns true if and only if all bits are cleared in this bit field.
  - cardinality
```
public int cardinality()
```
    Returns the number of bits set in this field.
  - get
```
public boolean get(E bit)
```
    Returns true if and only if the given bit is set.
    
    Parameters:
    bit - The bit to test.
  - is
```
public boolean is(E bit)
```
    Equivalent to get(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.
  - set
```
public BitField<E> set(E bit)
```
    Sets the given bit.
  - clear
```
public BitField<E> clear(E bit)
```
    Clears the given bit.
  - not
```
public BitField<E> not()
```
  - and
```
public BitField<E> and(BitField<E> that)
```
  - or
```
public BitField<E> or(BitField<E> that)
```
  - iterator
```
public java.util.Iterator<E> iterator()
```
    Returns a read-only iterator for the bits in this field.
    
    Specified by:
    
    iterator in interface java.lang.Iterable<E extends java.lang.Enum<E>>
  - toEnumSet
```
public java.util.EnumSet<E> toEnumSet()
```
    Returns a new set of enums containing the same bits as this instance. The following boolean expression is always true for any non-null bit field bits: bits.equals(BitField.of(bits.toEnumSet())).
    
    Returns:
    a new set of enums containing the same bits as this instance.
  - toString
```
public java.lang.String toString()
```
    Returns a concatenation of the names of the bits in this field, separated by "|".
    
    Overrides:
    
    toString in class java.lang.Object
  - equals
```
public boolean equals(@CheckForNull
             java.lang.Object that)
```
    Returns true if and only if the given object is another BitField and contains the same bits.
    
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Returns a hash code which is consistent with equals(java.lang.Object).
    
    Overrides:
    
    hashCode in class java.lang.Object

Class BitField<E extends java.lang.Enum<E>>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

serialVersionUID

bits

Constructor Detail

BitField

BitField

BitField

BitField

Method Detail

noneOf

allOf

of

of

copyOf

of

isEmpty

cardinality

get

is

set

set

clear

not

and

or

iterator

toEnumSet

toString

equals

hashCode