Package convex.core.data

Class LongBlob

java.lang.Object

convex.core.data.AObject

convex.core.data.ACell

convex.core.data.ACountable<CVMByte>

convex.core.data.ABlob

convex.core.data.ALongBlob

convex.core.data.LongBlob

All Implemented Interfaces:

IValidated, IWriteable, Comparable<ABlob>

public final class LongBlob
extends ALongBlob

Wrapper for an 8-byte long as a Blob We use this mainly for efficient management of indexes using Longs in BlobMaps.

Field Summary

Fields

Modifier and Type	Field	Description
static int	MAX_ENCODING_LENGTH
static LongBlob	ZERO

Fields inherited from class convex.core.data.ALongBlob

HEX_LENGTH, LENGTH, value

Fields inherited from class convex.core.data.ABlob

contentHash

Fields inherited from class convex.core.data.ACell

cachedRef, EMPTY_ARRAY

Fields inherited from class convex.core.data.AObject

encoding

Method Summary

Modifier and Type	Method	Description
long	commonHexPrefixLength(ABlob b)	Computes the length of the longest common hex prefix between two blobs
static LongBlob	create(long value)
static LongBlob	create(String string)
int	encode(byte[] bs, int pos)	Writes this Cell's encoding to a byte array, including a tag byte which will be written first.
int	encodeRaw(byte[] bs, int pos)	Writes this Blob's encoding to a byte array, excluding the tag byte
boolean	equals(ABlob a)	Determines if this Blob is equal to another Blob.
boolean	equalsBytes(byte[] bytes, int byteOffset)	Tests if this Blob is equal to a subset of a byte array
int	estimatedEncodingSize()	Estimate the encoded data size for this Cell.
void	getBytes(byte[] dest, int destOffset)	Copies the bytes from this blob to a given destination
byte	getTag()	Gets the tag byte for this cell.
long	hexMatchLength(ABlob b, long start, long length)	Returns the number of matching hex digits in the given hex range of another Blob.
boolean	isCanonical()	Returns true if this Cell is in a canonical representation for message writing.
long	longValue()	Gets the long value of this Blob if the length is exactly 8 bytes, otherwise throws an Exception
ABlob	slice(long start, long end)	Gets a contiguous slice of this Blob, as a new Blob.
Blob	toCanonical()	Converts this Cell to its canonical version.
Blob	toFlatBlob()	Converts this object to a flat array-backed Blob instance.
protected void	updateDigest(MessageDigest digest)

Methods inherited from class convex.core.data.ALongBlob

append, appendHex, byteAt, calcMemorySize, compareTo, compareTo, count, createRef, equalsBytes, getByteBuffer, getChunk, getHexDigit, getRefCount, getUnchecked, isEmbedded, toLong, writeToBuffer, writeToBuffer

Methods inherited from class convex.core.data.ABlob

computeHash, empty, encodeRawData, equals, get, getBytes, getContentHash, getElementRef, getType, hashCode, hexEquals, hexEquals, hexLength, isCVMValue, isRegularBlob, print, slice, toByteBuffer, toHexString, toHexString, validate, validateCell

Methods inherited from class convex.core.data.ACountable

isEmpty, size

Methods inherited from class convex.core.data.ACell

announce, announce, attachMemorySize, attachRef, cachedEncoding, cachedHash, createAnnounced, createEncoding, createPersisted, createPersisted, equals, getCanonical, getChildRefs, getEncoding, getEncodingLength, getHash, getMemorySize, getRef, getRef, isCompletelyEncoded, mark, mark, toCVMString, toString, updateRefs, write

Methods inherited from class convex.core.data.AObject

attachEncoding, print, print

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

MAX_ENCODING_LENGTH

public static final int MAX_ENCODING_LENGTH

See Also:

Constant Field Values

ZERO

public static final LongBlob ZERO

Method Details

create

public static LongBlob create(String string)

create

public static LongBlob create(long value)

getBytes

public void getBytes(byte[] dest,
 int destOffset)

Description copied from class: ABlob

Copies the bytes from this blob to a given destination

Specified by:

getBytes in class ABlob

Parameters:

dest - Destination array

destOffset - Offset into destination array

slice

public ABlob slice(long start,
 long end)

Description copied from class: ABlob

Gets a contiguous slice of this Blob, as a new Blob. Shares underlying backing data where possible

Specified by:

slice in class ALongBlob

Parameters:

start - Start position for the created slice (inclusive)

end - End of the slice (exclusive)

Returns:

A blob of the specified length, representing a slice of this blob.

toFlatBlob

public Blob toFlatBlob()

Description copied from class: ABlob

Converts this object to a flat array-backed Blob instance. Warning: might be O(n) in size of Blob, may not be canonical etc.

Specified by:

toFlatBlob in class ALongBlob

Returns:

A Blob instance containing the same data as this Blob.

updateDigest

protected void updateDigest(MessageDigest digest)

Specified by:

updateDigest in class ABlob

commonHexPrefixLength

public long commonHexPrefixLength(ABlob b)

Description copied from class: ABlob

Computes the length of the longest common hex prefix between two blobs

Overrides:

commonHexPrefixLength in class ALongBlob

Parameters:

b - Blob to compare with

Returns:

The length of the longest common prefix in hex digits

equals

public boolean equals(ABlob a)

Description copied from class: ABlob

Determines if this Blob is equal to another Blob. Blobs are defined to be equal if they have the same on-chain representation, i.e. if and only if all of the following are true: - Blob is of the same general type - Blobs are of the same length - All byte values are equal

Specified by:

equals in class ALongBlob

Parameters:

a - Blob to compare with

Returns:

true if Blobs are equal, false otherwise

encode

public int encode(byte[] bs,
 int pos)

Description copied from class: ACell

Writes this Cell's encoding to a byte array, including a tag byte which will be written first. Cell must be canonical, or else an error may occur.

Specified by:

encode in interface IWriteable

Specified by:

encode in class ACell

Parameters:

bs - A byte array to which to write the encoding

pos - The offset into the byte array

Returns:

New position after writing

encodeRaw

public int encodeRaw(byte[] bs,
 int pos)

Description copied from class: ABlob

Writes this Blob's encoding to a byte array, excluding the tag byte

Specified by:

encodeRaw in class ABlob

Parameters:

bs - A byte array to which to write the encoding

pos - The offset into the byte array

Returns:

New position after writing

estimatedEncodingSize

public int estimatedEncodingSize()

Description copied from interface: IWriteable

Estimate the encoded data size for this Cell. Used for quickly sizing buffers. Implementations should try to return a size that is likely to contain the entire object when represented in binary format, including the tag byte.

Returns:

The estimated size for the binary representation of this object.

longValue

public long longValue()

Description copied from class: ABlob

Gets the long value of this Blob if the length is exactly 8 bytes, otherwise throws an Exception

Overrides:

longValue in class ALongBlob

Returns:

The long value represented by the Blob

hexMatchLength

public long hexMatchLength(ABlob b,
 long start,
 long length)

Description copied from class: ABlob

Returns the number of matching hex digits in the given hex range of another Blob. Assumes range is valid for both blobs. Returns length if this Blob is exactly equal to the specified hex range.

Overrides:

hexMatchLength in class ALongBlob

Parameters:

b - Blob to compare with

start - Start position (in hex digits)

length - Length to compare (in hex digits)

Returns:

The number of matching hex characters

getTag

public byte getTag()

Description copied from class: ACell

Gets the tag byte for this cell. The tag byte is always written as the first byte of the Cell's Encoding

Specified by:

getTag in class ALongBlob

Returns:

Tag byte for this Cell

equalsBytes

public boolean equalsBytes(byte[] bytes,
 int byteOffset)

Description copied from class: ABlob

Tests if this Blob is equal to a subset of a byte array

Specified by:

equalsBytes in class ABlob

Parameters:

bytes - Byte array to compare with

byteOffset - Offset into byte array

Returns:

true if exactly equal, false otherwise

isCanonical

public boolean isCanonical()

Description copied from class: ACell

Returns true if this Cell is in a canonical representation for message writing. Non-canonical objects may be used on a temporary internal basis, they must always be converted to canonical representations for external use (e.g. Encoding).

Overrides:

isCanonical in class ALongBlob

Returns:

true if the object is in canonical format, false otherwise

toCanonical

public Blob toCanonical()

Description copied from class: ACell

Converts this Cell to its canonical version. Returns this Cell if already canonical, may be O(n) in size of value otherwise.

Specified by:

toCanonical in class ABlob

Returns:

Canonical version of Cell