public class BitSetType extends NonNullFieldType<BitSet>
BitSet
type. Null values are not supported by this class.
Instances are ordered like boolean numbers, i.e., lexicographically, with higher index bits being more significant.
name, NAME_PATTERN, REFERENCE_TYPE_NAME, signature, typeToken
Constructor and Description |
---|
BitSetType() |
Modifier and Type | Method and Description |
---|---|
int |
compare(BitSet bitSet1,
BitSet bitSet2)
Order two field values.
|
BitSet |
fromParseableString(ParseContext ctx)
Parse a value previously encoded by
toParseableString() as a self-delimited String
and positioned at the start of the given parsing context. |
BitSet |
fromString(String string)
Parse a non-null value previously encoded by
toString(T) . |
boolean |
hasPrefix0xff()
Determine whether any of this field type's encoded values start with a
0xff byte. |
BitSet |
read(ByteReader reader)
Read a value from the given input.
|
void |
skip(ByteReader reader)
Read and discard a value from the given input.
|
String |
toParseableString(BitSet bitSet)
Encode a possibly null value as a
String for later decoding by fromParseableString() . |
String |
toString(BitSet bitSet)
Encode a non-null value as a
String for later decoding by fromString() . |
void |
write(ByteWriter writer,
BitSet bitSet)
Write a value to the given output.
|
validate
convert, equals, genericizeForIndex, getDefaultValue, getDefaultValueObject, getEncodingSignature, getKeyRange, getName, getTypeToken, hashCode, hasPrefix0x00, toString, validateAndWrite
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
comparing, comparing, comparingDouble, comparingInt, comparingLong, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong
public boolean hasPrefix0xff()
FieldType
0xff
byte.
Certain optimizations are possible when this is not the case. It is safe for this method to always return true.
Note: changing the return value of this method usually means changing the binary encoding, resulting in an incompatible type.
The implementation in FieldType
returns true
.
hasPrefix0xff
in class FieldType<BitSet>
0xff
existspublic BitSet read(ByteReader reader)
FieldType
public void write(ByteWriter writer, BitSet bitSet)
FieldType
public void skip(ByteReader reader)
FieldType
public String toString(BitSet bitSet)
FieldType
String
for later decoding by fromString()
.
Each of the characters in the returned String
must be one of the valid XML characters
(tab, newline, carriage return, \u0020 - \ud7ff
, and \ue000 - \fffdf
).
The implementation in FieldType
checks that value
is not null, then delegates to FieldType.toParseableString(T)
.
Subclasses that override this method should also override fromString()
.
toString
in class FieldType<BitSet>
bitSet
- actual value, never nullvalue
acceptable to fromString()
public BitSet fromString(String string)
FieldType
toString(T)
.
The implementation in FieldType
creates a new ParseContext
based on string
,
delegates to FieldType.toParseableString(T)
to parse it, and verifies that all of string
was consumed
during the parse. Subclasses that override this method should also override toString(T)
.
fromString
in class FieldType<BitSet>
string
- non-null value previously encoded as a String
by toString(T)
public String toParseableString(BitSet bitSet)
FieldType
String
for later decoding by fromParseableString()
.
The string value must be self-delimiting, i.e., decodable even when followed by arbitrary additional characters,
and must not start with whitespace or closing square bracket ("]"
).
In addition, each of the characters in the returned String
must be one of the valid XML characters
(tab, newline, carriage return, \u0020 - \ud7ff
, and \ue000 - \fffdf
).
toParseableString
in class FieldType<BitSet>
bitSet
- actual value (possibly null)value
acceptable to fromParseableString()
public BitSet fromParseableString(ParseContext ctx)
FieldType
toParseableString()
as a self-delimited String
and positioned at the start of the given parsing context.fromParseableString
in class FieldType<BitSet>
ctx
- parse context starting with a string previously encoded via toParseableString()
public int compare(BitSet bitSet1, BitSet bitSet2)
FieldType
This method must provide a total ordering of all supported Java values that is consistent with the database ordering,
i.e., the unsigned lexicographical ordering of the corresponding byte[]
encoded field values.
If null is a supported Java value, then the returned Comparator
must accept null parameters without
throwing an exception (note, this is a stronger requirement than the Comparator
interface normally requires).
Note: by convention, null values usually sort last.
Copyright © 2022. All rights reserved.