jetbrains.exodus.env

Interface Bitmap

All Known Subinterfaces:

ContextualBitmap

public interface Bitmap

Method Summary

Modifier and Type	Method and Description
boolean	clear(@NotNull Transaction txn, long bit) Sets the specified bit to false.
long	count(@NotNull Transaction txn) Returns total number of bits with the value true.
long	count(@NotNull Transaction txn, long firstBit, long lastBit) Returns number of bits with the value true in the range [firstBit, lastBit].
boolean	get(@NotNull Transaction txn, long bit) Returns true if the specified bit is set.
@NotNull Environment	getEnvironment()
long	getFirst(@NotNull Transaction txn) Returns the first (the least) bit with the value true.
long	getLast(@NotNull Transaction txn) Returns the last (the greatest) bit with the value true.
@NotNull jetbrains.exodus.core.dataStructures.hash.LongIterator	iterator(@NotNull Transaction txn) Creates new instance of LongIterator which iterates bit numbers with the value true in ascending order.
@NotNull jetbrains.exodus.core.dataStructures.hash.LongIterator	reverseIterator(@NotNull Transaction txn) Creates new instance of LongIterator which iterates bit numbers with the value true in descending order.
boolean	set(@NotNull Transaction txn, long bit, boolean value) Sets value of the specified bit.

Method Detail

getEnvironment

@NotNull
@NotNull Environment getEnvironment()

Returns:

environment which the bitmap was opened for

get

boolean get(@NotNull
            @NotNull Transaction txn,
            long bit)

Returns true if the specified bit is set.

Parameters:

txn - transaction instance

bit - bit number

Returns:

true if specified bit is set

set

boolean set(@NotNull
            @NotNull Transaction txn,
            long bit,
            boolean value)

Sets value of the specified bit.

Parameters:

txn - transaction instance

bit - bit number

value - boolean value which will be set

Returns:

true if value was changed

clear

boolean clear(@NotNull
              @NotNull Transaction txn,
              long bit)

Sets the specified bit to false.

Parameters:

txn - transaction instance

bit - bit number

Returns:

true if value was changed

iterator

@NotNull
@NotNull jetbrains.exodus.core.dataStructures.hash.LongIterator iterator(@NotNull
                                                                                  @NotNull Transaction txn)

Creates new instance of LongIterator which iterates bit numbers with the value true in ascending order.

Parameters:

txn - transaction instance

Returns:

new instance of LongIterator

See Also:

LongIterator

reverseIterator

@NotNull
@NotNull jetbrains.exodus.core.dataStructures.hash.LongIterator reverseIterator(@NotNull
                                                                                         @NotNull Transaction txn)

Creates new instance of LongIterator which iterates bit numbers with the value true in descending order.

Parameters:

txn - transaction instance

Returns:

new instance of LongIterator

See Also:

LongIterator

getFirst

long getFirst(@NotNull
              @NotNull Transaction txn)

Returns the first (the least) bit with the value true.

Parameters:

txn - transaction instance

Returns:

number of the first set bit

getLast

long getLast(@NotNull
             @NotNull Transaction txn)

Returns the last (the greatest) bit with the value true.

Parameters:

txn - transaction instance

Returns:

number of the last set bit

count

long count(@NotNull
           @NotNull Transaction txn)

Returns total number of bits with the value true.

Parameters:

txn - transaction instance

Returns:

number of set bits

count

long count(@NotNull
           @NotNull Transaction txn,
           long firstBit,
           long lastBit)

Returns number of bits with the value true in the range [firstBit, lastBit]. The range includes both firstBit and lastBit.

Parameters:

txn - transaction instance

firstBit - the first (the least) bit of the range

lastBit - the last (the greatest) bit of the range

Returns:

number of set bits in the range