Package io.permazen.encoding

Class BitSetEncoding

java.lang.Object
io.permazen.encoding.AbstractEncoding<BitSet>
io.permazen.encoding.BitSetEncoding
All Implemented Interfaces:
Encoding<BitSet>, NaturalSortAware, Serializable, Comparator<BitSet>
public class BitSetEncoding extends AbstractEncoding<BitSet>
BitSet type. Null values are not supported by this class.

Instances are ordered as if they were giant unsigned integers, i.e., whichever instance has the highest bit set to one where the other instance has it set to zero is considered bigger. So the empty instance is the smallest possible.

See Also:

  • Constructor Details

    • BitSetEncoding

      public BitSetEncoding(EncodingId encodingId)

  • Method Details

    • withEncodingId

      public BitSetEncoding withEncodingId(EncodingId encodingId)
      Description copied from interface: Encoding
      Build an encoding that has the given EncodingId but is otherwise equivalent to this encoding.

      If this encoding already has encodingId, then this method may (but is not required to) return this same instance.

      Parameters:
      encodingId - new encoding's EncodingId, or null for an anonymized encoding
      Returns:
      a version of this encoding with the given EncodingId

    • hasPrefix0xff

      public boolean hasPrefix0xff()
      Description copied from interface: Encoding
      Determine whether any of this encoding's encoded values start with a 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 result of this method may result in an incompatible encoding if this encoding is wrapped in another class.

      The implementation in Encoding returns true.

      Returns:
      true if an encoded value starting with 0xff exists

    • read

      public BitSet read(ByteReader reader)
      Description copied from interface: Encoding
      Read a value from the given input.
      Parameters:
      reader - byte input
      Returns:
      field value (possibly null)

    • write

      public void write(ByteWriter writer, BitSet bitSet)
      Description copied from interface: Encoding
      Write a value to the given output.
      Parameters:
      writer - byte output
      bitSet - value to write (possibly null)

    • skip

      public void skip(ByteReader reader)
      Description copied from interface: Encoding
      Read and discard a byte[] encoded value from the given input.
      Parameters:
      reader - byte input

    • toString

      public String toString(BitSet bitSet)
      Description copied from interface: Encoding
      Encode a non-null value as a 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 - \ufffd).

      Parameters:
      bitSet - actual value, never null
      Returns:
      string encoding of value acceptable to fromString()
      See Also:

    • fromString

      public BitSet fromString(String string)
      Description copied from interface: Encoding
      Parse a non-null value previously encoded by toString(T).
      Parameters:
      string - non-null value previously encoded as a String by toString(T)
      Returns:
      actual value

    • compare

      public int compare(BitSet bitSet1, BitSet bitSet2)
      Description copied from interface: Encoding
      Order two field values.

      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 this method 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.