LongValueBitSet (OpenHFT/Chronicle-Wire 2.20.117 API)

java.lang.Object
- net.openhft.chronicle.core.io.AbstractCloseable
- - net.openhft.chronicle.wire.LongValueBitSet

All Implemented Interfaces:

Closeable, AutoCloseable, net.openhft.chronicle.bytes.CommonMarshallable, net.openhft.chronicle.core.io.CloseableTracer, net.openhft.chronicle.core.io.QueryCloseable, net.openhft.chronicle.core.io.ReferenceOwner, net.openhft.chronicle.core.io.Resettable, Marshallable, ReadMarshallable, WriteMarshallable, WriteValue
```
public class LongValueBitSet
extends net.openhft.chronicle.core.io.AbstractCloseable
implements Marshallable
```
This BitSet is intended to be shared between processes. To minimize locking constraints, it is implemented as a lock-free solution without support for resizing.

Field Summary
- Fields inherited from class net.openhft.chronicle.core.io.AbstractCloseable
  CHECK_THREAD_SAFETY, WARN_NS
- Fields inherited from interface net.openhft.chronicle.wire.WriteMarshallable
  EMPTY
- Fields inherited from interface net.openhft.chronicle.wire.ReadMarshallable
  DISCARD
- Fields inherited from interface net.openhft.chronicle.core.io.ReferenceOwner
  INIT

Constructor Summary

Constructors
Constructor and Description

LongValueBitSet(int maxNumberOfBits)

LongValueBitSet(int maxNumberOfBits, Wire w)

Constructors
Constructor and Description
`LongValueBitSet(int maxNumberOfBits)`
`LongValueBitSet(int maxNumberOfBits, Wire w)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`and(LongValueBitSet set)` Performs a logical AND of this target bit set with the argument bit set.
`void`	`andNot(LongValueBitSet set)` Clears all of the bits in this `BitSet` whose corresponding bit is set in the specified `BitSet`.
`int`	`cardinality()` Returns the number of bits set to `true` in this `BitSet`.
`void`	`clear()` Sets all of the bits in this BitSet to `false`.
`void`	`clear(int bitIndex)` Sets the bit specified by the index to `false`.
`void`	`clear(int fromIndex, int toIndex)` Sets the bits from the specified `fromIndex` (inclusive) to the specified `toIndex` (exclusive) to `false`.
`boolean`	`equals(Object obj)` Compares this object against the specified object.
`void`	`flip(int bitIndex)` Sets the bit at the specified index to the complement of its current value.
`void`	`flip(int fromIndex, int toIndex)` Sets each bit from the specified `fromIndex` (inclusive) to the specified `toIndex` (exclusive) to the complement of its current value.
`boolean`	`get(int bitIndex)` Returns the value of the bit with the specified index.
`int`	`hashCode()` Returns the hash code value for this bit set.
`boolean`	`intersects(LongValueBitSet set)` Returns true if the specified `BitSet` has any bits set to `true` that are also set to `true` in this `BitSet`.
`boolean`	`isEmpty()` Returns true if this `BitSet` contains no bits that are set to `true`.
`int`	`length()` Returns the "logical size" of this `BitSet`: the index of the highest set bit in the `BitSet` plus one.
`int`	`nextClearBit(int fromIndex)` Returns the index of the first bit that is set to `false` that occurs on or after the specified starting index.
`int`	`nextSetBit(int fromIndex)` Returns the index of the first bit that is set to `true` that occurs on or after the specified starting index.
`int`	`nextSetBit(int fromIndex, int toIndex)` Returns the index of the first bit that is set to `true` that occurs on or after the specified starting index.
`void`	`or(LongValueBitSet set)` Performs a logical OR of this bit set with the bit set argument.
`protected void`	`performClose()`
`int`	`previousClearBit(int fromIndex)` Returns the index of the nearest bit that is set to `false` that occurs on or before the specified starting index.
`int`	`previousSetBit(int fromIndex)` Returns the index of the nearest bit that is set to `true` that occurs on or before the specified starting index.
`void`	`readMarshallable(@NotNull WireIn wire)` Straight line ordered decoding.
`void`	`set(int bitIndex)` Sets the bit at the specified index to `true`.
`void`	`set(int bitIndex, boolean value)` Sets the bit at the specified index to the specified value.
`void`	`set(int fromIndex, int toIndex)` Sets the bits from the specified `fromIndex` (inclusive) to the specified `toIndex` (exclusive) to `true`.
`void`	`set(int fromIndex, int toIndex, boolean value)` Sets the bits from the specified `fromIndex` (inclusive) to the specified `toIndex` (exclusive) to the specified value.
`void`	`set(net.openhft.chronicle.core.values.LongValue word, long newValue)`
`void`	`set(net.openhft.chronicle.core.values.LongValue word, long param, net.openhft.chronicle.wire.LongValueBitSet.LongFunction function)`
`int`	`size()` Returns the number of bits of space actually in use by this `BitSet` to represent bit values.
`IntStream`	`stream()` Returns a stream of indices for which this `BitSet` contains a bit in the set state.
`protected boolean`	`threadSafetyCheck(boolean isUsed)`
`byte[]`	`toByteArray()` Returns a new byte array containing all the bits in this bit set.
`String`	`toString()` Returns a string representation of this bit set.
`static BitSet`	`valueOf(byte[] bytes)` Returns a new bit set containing all the bits in the given byte array.
`void`	`writeMarshallable(@NotNull WireOut wire)` Write data to the wire
`void`	`xor(LongValueBitSet set)` Performs a logical XOR of this bit set with the bit set argument.

Methods inherited from class net.openhft.chronicle.core.io.AbstractCloseable
assertCloseablesClosed, clearUsedByThread, close, createdHere, disableCloseableTracing, enableCloseableTracing, isClosed, isClosing, isInUserThread, performCloseInBackground, referenceId, resetUsedByThread, shouldPerformCloseInBackground, shouldWaitForClosed, throwExceptionIfClosed, throwExceptionIfClosedInSetter, unmonitor, waitForClosed, warnAndCloseIfNotClosed

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

Methods inherited from interface net.openhft.chronicle.wire.Marshallable
$equals, $fieldInfoMap, $fieldInfos, $hashCode, $toString, className, copyFrom, copyTo, deepCopy, fromFile, fromFile, fromFileAsMap, fromFileAsMap, fromHexString, fromString, fromString, fromString, getField, getLongField, mergeToMap, reset, setField, setLongField, streamFromFile, streamFromFile, usesSelfDescribingMessage

Methods inherited from interface net.openhft.chronicle.wire.WriteMarshallable
writeValue

Methods inherited from interface net.openhft.chronicle.wire.ReadMarshallable
unexpectedField

Methods inherited from interface net.openhft.chronicle.core.io.Closeable
closeQuietly, closeQuietly, notifyClosing

Methods inherited from interface net.openhft.chronicle.core.io.ReferenceOwner
referenceName, temporary

- Constructor Detail
  - LongValueBitSet
```
public LongValueBitSet(int maxNumberOfBits)
```
  - LongValueBitSet
```
public LongValueBitSet(int maxNumberOfBits,
                       Wire w)
```
- Method Detail
  - valueOf
```
public static BitSet valueOf(byte[] bytes)
```
    Returns a new bit set containing all the bits in the given byte array.
    More precisely,
    BitSet.valueOf(bytes).get(n) == ((bytes[n/8] & (1<<(n%8))) != 0)
    for all n < 8 * bytes.length.
    This method is equivalent to BitSet.valueOf(ByteBuffer.wrap(bytes)).
    
    Parameters:
    
    bytes - a byte array containing a little-endian representation of a sequence of bits to be used as the initial bits of the new bit set
    
    Returns:
    
    a BitSet containing all the bits in the byte array
    
    Since:
    
    1.7
  - threadSafetyCheck
```
protected boolean threadSafetyCheck(boolean isUsed)
```
    Overrides:
    
    threadSafetyCheck in class net.openhft.chronicle.core.io.AbstractCloseable
  - performClose
```
protected void performClose()
```
    Specified by:
    
    performClose in class net.openhft.chronicle.core.io.AbstractCloseable
  - set
```
public void set(net.openhft.chronicle.core.values.LongValue word,
                long param,
                net.openhft.chronicle.wire.LongValueBitSet.LongFunction function)
```
  - set
```
public void set(net.openhft.chronicle.core.values.LongValue word,
                long newValue)
```
  - toByteArray
```
public byte[] toByteArray()
```
    Returns a new byte array containing all the bits in this bit set.
    More precisely, if
    byte[] bytes = s.toByteArray();
    then bytes.length == (s.length()+7)/8 and
    s.get(n) == ((bytes[n/8] & (1<<(n%8))) != 0)
    for all n < 8 * bytes.length.
    
    Returns:
    
    a byte array containing a little-endian representation of all the bits in this bit set
    
    Since:
    
    1.7
  - flip
```
public void flip(int bitIndex)
```
    Sets the bit at the specified index to the complement of its current value.
    
    Parameters:
    
    bitIndex - the index of the bit to flip
    
    Throws:
    
    IndexOutOfBoundsException - if the specified index is negative
    
    Since:
    
    1.4
  - flip
```
public void flip(int fromIndex,
                 int toIndex)
```
    Sets each bit from the specified fromIndex (inclusive) to the specified toIndex (exclusive) to the complement of its current value.
    
    Parameters:
    
    fromIndex - index of the first bit to flip
    
    toIndex - index after the last bit to flip
    
    Throws:
    
    IndexOutOfBoundsException - if fromIndex is negative, or toIndex is negative, or fromIndex is larger than toIndex
    
    Since:
    
    1.4
  - set
```
public void set(int bitIndex)
```
    Sets the bit at the specified index to true.
    
    Parameters:
    
    bitIndex - a bit index
    
    Throws:
    
    IndexOutOfBoundsException - if the specified index is negative
    
    Since:
    
    JDK1.0
  - set
```
public void set(int bitIndex,
                boolean value)
```
    Sets the bit at the specified index to the specified value.
    
    Parameters:
    
    bitIndex - a bit index
    
    value - a boolean value to set
    
    Throws:
    
    IndexOutOfBoundsException - if the specified index is negative
    
    Since:
    
    1.4
  - set
```
public void set(int fromIndex,
                int toIndex)
```
    Sets the bits from the specified fromIndex (inclusive) to the specified toIndex (exclusive) to true.
    
    Parameters:
    
    fromIndex - index of the first bit to be set
    
    toIndex - index after the last bit to be set
    
    Throws:
    
    IndexOutOfBoundsException - if fromIndex is negative, or toIndex is negative, or fromIndex is larger than toIndex
    
    Since:
    
    1.4
  - set
```
public void set(int fromIndex,
                int toIndex,
                boolean value)
```
    Sets the bits from the specified fromIndex (inclusive) to the specified toIndex (exclusive) to the specified value.
    
    Parameters:
    
    fromIndex - index of the first bit to be set
    
    toIndex - index after the last bit to be set
    
    value - value to set the selected bits to
    
    Throws:
    
    IndexOutOfBoundsException - if fromIndex is negative, or toIndex is negative, or fromIndex is larger than toIndex
    
    Since:
    
    1.4
  - clear
```
public void clear(int bitIndex)
```
    Sets the bit specified by the index to false.
    
    Parameters:
    
    bitIndex - the index of the bit to be cleared
    
    Throws:
    
    IndexOutOfBoundsException - if the specified index is negative
    
    Since:
    
    JDK1.0
  - clear
```
public void clear(int fromIndex,
                  int toIndex)
```
    Sets the bits from the specified fromIndex (inclusive) to the specified toIndex (exclusive) to false.
    
    Parameters:
    
    fromIndex - index of the first bit to be cleared
    
    toIndex - index after the last bit to be cleared
    
    Throws:
    
    IndexOutOfBoundsException - if fromIndex is negative, or toIndex is negative, or fromIndex is larger than toIndex
    
    Since:
    
    1.4
  - clear
```
public void clear()
```
    Sets all of the bits in this BitSet to false.
    
    Since:
    
    1.4
  - get
```
public boolean get(int bitIndex)
```
    Returns the value of the bit with the specified index. The value is true if the bit with the index bitIndex is currently set in this BitSet; otherwise, the result is false.
    
    Parameters:
    
    bitIndex - the bit index
    
    Returns:
    
    the value of the bit with the specified index
    
    Throws:
    
    IndexOutOfBoundsException - if the specified index is negative
  - nextSetBit
```
public int nextSetBit(int fromIndex)
```
    Returns the index of the first bit that is set to true that occurs on or after the specified starting index. If no such bit exists then -1 is returned.
    To iterate over the true bits in a BitSet, use the following loop:
```
 
 for (int i = bs.nextSetBit(0); i >= 0; i = bs.nextSetBit(i+1)) {
     // operate on index i here
     if (i == Integer.MAX_VALUE) {
         break; // or (i+1) would overflow
     }
 }
```
    Parameters:
    
    fromIndex - the index to start checking from (inclusive)
    
    Returns:
    
    the index of the next set bit, or -1 if there is no such bit
    
    Throws:
    
    IndexOutOfBoundsException - if the specified index is negative
    
    Since:
    
    1.4
  - nextSetBit
```
public int nextSetBit(int fromIndex,
                      int toIndex)
```
    Returns the index of the first bit that is set to true that occurs on or after the specified starting index. If no such bit exists then -1 is returned.
    To iterate over the true bits in a BitSet, use the following loop:
```
 
 for (int i = bs.nextSetBit(0); i >= 0; i = bs.nextSetBit(i+1,to)) {
     // operate on index i here
     if (i == Integer.MAX_VALUE) {
         break; // or (i+1) would overflow
     }
 }
```
    Parameters:
    
    fromIndex - the index to start checking from (inclusive)
    
    toIndex - (inclusive) returns -1 if a bit is not found before this value
    
    Returns:
    
    the index of the next set bit, or -1 if there is no such bit
    
    Throws:
    
    IndexOutOfBoundsException - if the specified index is negative
    
    Since:
    
    1.4
  - nextClearBit
```
public int nextClearBit(int fromIndex)
```
    Returns the index of the first bit that is set to false that occurs on or after the specified starting index.
    
    Parameters:
    
    fromIndex - the index to start checking from (inclusive)
    
    Returns:
    
    the index of the next clear bit
    
    Throws:
    
    IndexOutOfBoundsException - if the specified index is negative
    
    Since:
    
    1.4
  - previousSetBit
```
public int previousSetBit(int fromIndex)
```
    Returns the index of the nearest bit that is set to true that occurs on or before the specified starting index. If no such bit exists, or if -1 is given as the starting index, then -1 is returned.
    To iterate over the true bits in a BitSet, use the following loop:
```
 
 for (int i = bs.length(); (i = bs.previousSetBit(i-1)) >= 0; ) {
     // operate on index i here
 }
```
    Parameters:
    
    fromIndex - the index to start checking from (inclusive)
    
    Returns:
    
    the index of the previous set bit, or -1 if there is no such bit
    
    Throws:
    
    IndexOutOfBoundsException - if the specified index is less than -1
    
    Since:
    
    1.7
  - previousClearBit
```
public int previousClearBit(int fromIndex)
```
    Returns the index of the nearest bit that is set to false that occurs on or before the specified starting index. If no such bit exists, or if -1 is given as the starting index, then -1 is returned.
    
    Parameters:
    
    fromIndex - the index to start checking from (inclusive)
    
    Returns:
    
    the index of the previous clear bit, or -1 if there is no such bit
    
    Throws:
    
    IndexOutOfBoundsException - if the specified index is less than -1
    
    Since:
    
    1.7
  - length
```
public int length()
```
    Returns the "logical size" of this BitSet: the index of the highest set bit in the BitSet plus one. Returns zero if the BitSet contains no set bits.
    
    Returns:
    
    the logical size of this BitSet
    
    Since:
    
    1.2
  - isEmpty
```
public boolean isEmpty()
```
    Returns true if this BitSet contains no bits that are set to true.
    
    Returns:
    
    boolean indicating whether this BitSet is empty
    
    Since:
    
    1.4
  - intersects
```
public boolean intersects(LongValueBitSet set)
```
    Returns true if the specified BitSet has any bits set to true that are also set to true in this BitSet.
    
    Parameters:
    
    set - BitSet to intersect with
    
    Returns:
    
    boolean indicating whether this BitSet intersects the specified BitSet
    
    Since:
    
    1.4
  - cardinality
```
public int cardinality()
```
    Returns the number of bits set to true in this BitSet.
    
    Returns:
    
    the number of bits set to true in this BitSet
    
    Since:
    
    1.4
  - and
```
public void and(LongValueBitSet set)
```
    Performs a logical AND of this target bit set with the argument bit set. This bit set is modified so that each bit in it has the value true if and only if it both initially had the value true and the corresponding bit in the bit set argument also had the value true.
    
    Parameters:
    
    set - a bit set
  - or
```
public void or(LongValueBitSet set)
```
    Performs a logical OR of this bit set with the bit set argument. This bit set is modified so that a bit in it has the value true if and only if it either already had the value true or the corresponding bit in the bit set argument has the value true.
    
    Parameters:
    
    set - a bit set
  - xor
```
public void xor(LongValueBitSet set)
```
    Performs a logical XOR of this bit set with the bit set argument. This bit set is modified so that a bit in it has the value true if and only if one of the following statements holds:
    - The bit initially has the value true, and the corresponding bit in the argument has the value false.
    - The bit initially has the value false, and the corresponding bit in the argument has the value true.
    Parameters:
    
    set - a bit set
  - andNot
```
public void andNot(LongValueBitSet set)
```
    Clears all of the bits in this BitSet whose corresponding bit is set in the specified BitSet.
    
    Parameters:
    
    set - the BitSet with which to mask this BitSet
    
    Since:
    
    1.2
  - hashCode
```
public int hashCode()
```
    Returns the hash code value for this bit set. The hash code depends only on which bits are set within this BitSet.
    The hash code is defined to be the result of the following calculation:
```
 
 public int hashCode() {
     long h = 1234;
     long[] words = toLongArray();
     for (int i = words.length; --i >= 0; )
         h ^= words[i] * (i + 1);
     return (int)((h >> 32) ^ h);
 }
```
    Note that the hash code changes if the set of bits is altered.
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    the hash code value for this bit set
  - size
```
public int size()
```
    Returns the number of bits of space actually in use by this BitSet to represent bit values. The maximum element in the set is the size - 1st element.
    
    Returns:
    
    the number of bits currently in this bit set
  - equals
```
public boolean equals(Object obj)
```
    Compares this object against the specified object. The result is true if and only if the argument is not null and is a Bitset object that has exactly the same set of bits set to true as this bit set. That is, for every nonnegative int index k,
```
((BitSet)obj).get(k) == this.get(k)
```
    must be true. The current sizes of the two bit sets are not compared.
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    obj - the object to compare with
    
    Returns:
    
    true if the objects are the same; false otherwise
    
    See Also:
    
    size()
  - toString
```
public String toString()
```
    Returns a string representation of this bit set. For every index for which this BitSet contains a bit in the set state, the decimal representation of that index is included in the result. Such indices are listed in order from lowest to highest, separated by ", " (a comma and a space) and surrounded by braces, resulting in the usual mathematical notation for a set of integers.
    Example:
```
 BitSet drPepper = new BitSet();
```
    Now drPepper.toString() returns "{}".
```
 drPepper.set(2);
```
    Now drPepper.toString() returns "{2}".
```
 drPepper.set(4);
 drPepper.set(10);
```
    Now drPepper.toString() returns "{2, 4, 10}".
    Overrides:
    
    toString in class net.openhft.chronicle.core.io.AbstractCloseable
    
    Returns:
    
    a string representation of this bit set
  - stream
```
public IntStream stream()
```
    Returns a stream of indices for which this BitSet contains a bit in the set state. The indices are returned in order, from lowest to highest. The size of the stream is the number of bits in the set state, equal to the value returned by the cardinality() method.
    The bit set must remain constant during the execution of the terminal stream operation. Otherwise, the result of the terminal stream operation is undefined.
    
    Returns:
    
    a stream of integers representing set indices
    
    Since:
    
    1.8
  - writeMarshallable
```
public void writeMarshallable(@NotNull
                              @NotNull WireOut wire)
```
    Description copied from interface: WriteMarshallable
    
    Write data to the wire
    
    Specified by:
    
    writeMarshallable in interface Marshallable
    
    Specified by:
    
    writeMarshallable in interface WriteMarshallable
    
    Parameters:
    
    wire - to write to.
  - readMarshallable
```
public void readMarshallable(@NotNull
                             @NotNull WireIn wire)
                      throws net.openhft.chronicle.core.io.IORuntimeException
```
    Description copied from interface: ReadMarshallable
    
    Straight line ordered decoding.
    
    Specified by:
    
    readMarshallable in interface Marshallable
    
    Specified by:
    
    readMarshallable in interface ReadMarshallable
    
    Parameters:
    
    wire - to read from in an ordered manner.
    
    Throws:
    
    net.openhft.chronicle.core.io.IORuntimeException - the stream wasn't ordered or formatted as expected.

Class LongValueBitSet

Field Summary

Fields inherited from class net.openhft.chronicle.core.io.AbstractCloseable

Fields inherited from interface net.openhft.chronicle.wire.WriteMarshallable

Fields inherited from interface net.openhft.chronicle.wire.ReadMarshallable

Fields inherited from interface net.openhft.chronicle.core.io.ReferenceOwner

Constructor Summary

Method Summary

Methods inherited from class net.openhft.chronicle.core.io.AbstractCloseable

Methods inherited from class java.lang.Object

Methods inherited from interface net.openhft.chronicle.wire.Marshallable

Methods inherited from interface net.openhft.chronicle.wire.WriteMarshallable

Methods inherited from interface net.openhft.chronicle.wire.ReadMarshallable

Methods inherited from interface net.openhft.chronicle.core.io.Closeable

Methods inherited from interface net.openhft.chronicle.core.io.ReferenceOwner

Constructor Detail

LongValueBitSet

LongValueBitSet

Method Detail

valueOf

threadSafetyCheck

performClose

set

set

toByteArray

flip

flip

set

set

set

set

clear

clear

clear

get

nextSetBit

nextSetBit

nextClearBit

previousSetBit

previousClearBit

length

isEmpty

intersects

cardinality

and

or

xor

andNot

hashCode

size

equals

toString

stream

writeMarshallable

readMarshallable