Top Description Inners Fields Constructors Methods
jdk.internal.util

public Class ImmutableBitSetPredicate

extends Object
implements IntPredicate
Class Inheritance
All Implemented Interfaces
java.util.function.IntPredicate
Annotations
@ValueBased
Imports
jdk.internal.ValueBased, jdk.internal.vm.annotation.Stable, java.util.BitSet, java.util.function.IntPredicate

Class for working with immutable BitSets.

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static record
ImmutableBitSetPredicate.SmallImmutableBitSetPredicate

Specialization for small sets of 128 bits or less

Field Summary

Modifier and TypeField and Description
private final long[]

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public static IntPredicate

Returns:

a new IntPredicate representing the BitSet#get(int) method applied on an immutable snapshot of the current state of this BitSet
of
(BitSet original)

Returns a new IntPredicate representing the BitSet#get(int) method applied on an immutable snapshot of the current state of this BitSet.

public boolean

Returns:

true if the bit is in the range of the BitSet and the bit is set, otherwise false
test
(int
the bit index to test
bitIndex
)

Implements java.util.function.IntPredicate.test.

Evaluates this predicate on the given argument.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

wordsback to summary
private final long[] words
Annotations
@Stable

Constructor Detail

ImmutableBitSetPredicateback to summary
private ImmutableBitSetPredicate(BitSet original)

Method Detail

ofback to summary
public static IntPredicate of(BitSet original)

Returns a new IntPredicate representing the BitSet#get(int) method applied on an immutable snapshot of the current state of this BitSet. .

If the returned predicate is invoked with a bitIndex that is negative, the predicate will throw an IndexOutOfBoundsException just as the BitSet#get(int) method would.

Returned predicates are threadsafe and can be used without external synchronisation.

Implementation Note

The method is free to return a ValueBased implementation.

Returns:IntPredicate

a new IntPredicate representing the BitSet#get(int) method applied on an immutable snapshot of the current state of this BitSet

Since
22
testback to summary
public boolean test(int bitIndex)

Implements java.util.function.IntPredicate.test.

Doc from java.util.function.IntPredicate.test.

Evaluates this predicate on the given argument.

Parameters
bitIndex:int

the bit index to test

Returns:boolean

true if the bit is in the range of the BitSet and the bit is set, otherwise false

Annotations
@Override
jdk.internal.util back to summary

public final Record ImmutableBitSetPredicate.SmallImmutableBitSetPredicate

extends Record
implements IntPredicate
Class Inheritance
All Implemented Interfaces
java.util.function.IntPredicate
Record Components
first:long
- bits index 0 through 63, inclusive
second:long
- bits index 64 through 127, inclusive

Specialization for small sets of 128 bits or less

Field Summary

Modifier and TypeField and Description
private final long
first

Record Component accessed by first().

- bits index 0 through 63, inclusive
private final long
second

Record Component accessed by second().

- bits index 64 through 127, inclusive

Constructor Summary

AccessConstructor and Description
public
SmallImmutableBitSetPredicate(long first, long second)

Method Summary

Modifier and TypeMethod and Description
public final boolean
equals(Object
the reference object with which to compare.
o
)

Implements abstract java.lang.Record.equals.

Indicates whether some other object is "equal to" this one.

public long
first()

Record Component getter of first.

Record Component - bits index 0 through 63, inclusive

public final int
hashCode()

Implements abstract java.lang.Record.hashCode.

Returns a hash code value for the record.

public long
second()

Record Component getter of second.

Record Component - bits index 64 through 127, inclusive

public boolean

Returns:

true if the bit is in the range of the BitSet and the bit is set, otherwise false
test
(int
the bit index to test
bitIndex
)

Implements java.util.function.IntPredicate.test.

Evaluates this predicate on the given argument.

public final String
toString()

Implements abstract java.lang.Record.toString.

Returns a string representation of the record.

Field Detail

firstback to summary
private final long first

Record Component accessed by first().

- bits index 0 through 63, inclusive

secondback to summary
private final long second

Record Component accessed by second().

- bits index 64 through 127, inclusive

Constructor Detail

SmallImmutableBitSetPredicateback to summary
public SmallImmutableBitSetPredicate(long first, long second)

Method Detail

equalsback to summary
public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

Indicates whether some other object is "equal to" this one. In addition to the general contract of Object.equals, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows:

    R copy = new R(r.c1(), r.c2(), ..., r.cn());
then it must be the case that r.equals(copy).
Parameters
o:Object

the reference object with which to compare.

Returns:boolean

true if this record is equal to the argument; false otherwise.

firstback to summary
public long first()

Record Component getter of first.

Record Component
- bits index 0 through 63, inclusive
hashCodeback to summary
public final int hashCode()

Implements abstract java.lang.Record.hashCode.

Doc from java.lang.Record.hashCode.

Returns a hash code value for the record. Obeys the general contract of Object.hashCode. For records, hashing behavior is constrained by the refined contract of Record.equals, so that any two records created from the same components must have the same hash code.

Returns:int

a hash code value for this record.

secondback to summary
public long second()

Record Component getter of second.

Record Component
- bits index 64 through 127, inclusive
testback to summary
public boolean test(int bitIndex)

Implements java.util.function.IntPredicate.test.

Doc from java.util.function.IntPredicate.test.

Evaluates this predicate on the given argument.

Parameters
bitIndex:int

the bit index to test

Returns:boolean

true if the bit is in the range of the BitSet and the bit is set, otherwise false

Annotations
@Override
toStringback to summary
public final String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.

Returns a string representation of the record. In accordance with the general contract of Object#toString(), the toString method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read.

In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.

Returns:String

a string representation of the object.