Package convex.core.data

Class AArrayBlob

java.lang.Object

convex.core.data.AObject

convex.core.data.ACell

convex.core.data.ACountable<CVMLong>

convex.core.data.ABlob

convex.core.data.AArrayBlob

All Implemented Interfaces:

IValidated, IWriteable, Comparable<ABlob>

Direct Known Subclasses:

AccountKey, ASignature, Blob, Hash

public abstract class AArrayBlob
extends ABlob

Abstract base class for binary data stored in Java arrays.

Field Summary

Fields

Modifier and Type	Field	Description
protected final int	length
protected final int	offset
protected final byte[]	store

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AArrayBlob(byte[] bytes, int offset, int length)

Method Summary

Modifier and Type	Method	Description
ABlob	append(ABlob d)	Append an additional Blob to this, creating a new Blob as needed.
final boolean	appendHex(BlobBuilder bb, long hexLength)	Append hex string up to the given length in hex digits (a multiple of two)
protected ABlob	appendSmall(ABlob d)
final byte	byteAt(long i)	Gets the byte at the specified position in this blob
long	commonHexPrefixLength(ABlob b)	Computes the length of the longest common hex prefix between two blobs
final int	compareTo(AArrayBlob b)
final int	compareTo(ABlob b)	Compares this Blob to another Blob, in lexicographic order sorting by first bytes (unsigned).
final long	count()	Gets the length of this Blob
int	encodeRaw(byte[] bs, int pos)	Encodes this Blob, excluding tag byte (will include count)
boolean	equals(ABlob o)	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
boolean	equalsBytes(ABlob k)	Tests if this Blob has exactly the same bytes as another Blob
ByteBuffer	getByteBuffer()	Gets a byte buffer containing this Blob's raw data.
final void	getBytes(byte[] dest, int destOffset)	Copies the bytes from this blob to a given destination
int	getHexDigit(long digitPos)	Gets the specified hex digit from this data object.
byte[]	getInternalArray()	Gets the internal array backing this Blob.
int	getInternalOffset()	Gets this offset into the internal array backing this Blob.
final int	getRefCount()	Gets the number of Refs contained within this Cell.
byte	getTag()	Gets the tag byte for this cell.
final byte	getUnchecked(long i)	Gets the byte at the specified position in this data object, without bounds checking.
boolean	hexMatches(ABlob key, int start, int end)	Tests if a specific range of hex digits are exactly equal.
long	hexMatchLength(ABlob b, long start, long length)	Returns the number of matching hex digits in the given hex range of another Blob.
long	longAt(long i)
long	longValue()	Converts this Blob to the corresponding long value.
boolean	rangeMatches(AArrayBlob b, int start, int end)	Tests if a specific range of bytes are exactly equal from this Blob with another Blob
boolean	rangeMatches(ABlob b, int start, int end)	Tests if a specific range of bytes are exactly equal.
final short	shortAt(long i)
Blob	slice(long start, long end)	Gets a contiguous slice of this Blob, as a new Blob.
long	toExactLong()	Gets the long value of this Blob if the length is exactly 8 bytes, otherwise throws an Exception
Blob	toFlatBlob()	Converts this object to a flat array-backed Blob instance.
void	updateDigest(MessageDigest digest)
void	validate()	Validates the complete structure of this object.
void	validateCell()	Validates the local structure and invariants of this cell.
int	writeToBuffer(byte[] bs, int pos)	Writes the byte contents of this blob to a byte array.
ByteBuffer	writeToBuffer(ByteBuffer bb)	Writes the byte contents of this Blob to a ByteBuffer.

Methods inherited from class convex.core.data.ABlob

computeHash, empty, equals, get, getBytes, getChunk, getContentHash, getElementRef, getType, hashCode, hexEquals, hexEquals, hexLength, isCVMValue, isRegularBlob, print, slice, toByteBuffer, toCanonical, toHexString, toHexString

Methods inherited from class convex.core.data.ACountable

isEmpty, size

Methods inherited from class convex.core.data.ACell

announce, announce, attachMemorySize, attachRef, cachedEncoding, cachedHash, calcMemorySize, createAnnounced, createEncoding, createPersisted, createPersisted, createRef, encode, equals, getCanonical, getChildRefs, getEncoding, getEncodingLength, getHash, getMemorySize, getRef, getRef, isCanonical, isCompletelyEncoded, isEmbedded, 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

Methods inherited from interface convex.core.data.IWriteable

estimatedEncodingSize

Field Details

store

protected final byte[] store

offset

protected final int offset

length

protected final int length

Constructor Details

AArrayBlob

protected AArrayBlob(byte[] bytes,
 int offset,
 int length)

Method Details

updateDigest

public void updateDigest(MessageDigest digest)

Specified by:

updateDigest in class ABlob

slice

public Blob 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 ABlob

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.

append

public ABlob append(ABlob d)

Description copied from class: ABlob

Append an additional Blob to this, creating a new Blob as needed. New Blob will be canonical.

Specified by:

append in class ABlob

Parameters:

d - Blob to append

Returns:

A new Blob, containing the additional data appended to this blob.

appendSmall

protected ABlob appendSmall(ABlob d)

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 ABlob

Returns:

A Blob instance containing the same data as this Blob.

compareTo

public final int compareTo(ABlob b)

Description copied from class: ABlob

Compares this Blob to another Blob, in lexicographic order sorting by first bytes (unsigned). Note: This means that compareTo does not precisely match equality, because specialised Blob types may be lexicographically equal but represent different values.

Specified by:

compareTo in interface Comparable<ABlob>

Overrides:

compareTo in class ABlob

compareTo

public final int compareTo(AArrayBlob b)

getBytes

public final 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

writeToBuffer

public ByteBuffer writeToBuffer(ByteBuffer bb)

Description copied from class: ABlob

Writes the byte contents of this Blob to a ByteBuffer. May be big!

Specified by:

writeToBuffer in class ABlob

Parameters:

bb - ByteBuffer to write to

Returns:

The passed ByteBuffer, after writing byte content

writeToBuffer

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

Description copied from class: ABlob

Writes the byte contents of this blob to a byte array. Assumes buffer has enough space for all bytes.

Specified by:

writeToBuffer in class ABlob

Parameters:

bs - Byte array to write to

pos - Starting position in byte array to write to

Returns:

Updated position in the array after writing

encodeRaw

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

Encodes this Blob, excluding tag byte (will include count)

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

appendHex

public final boolean appendHex(BlobBuilder bb,
 long hexLength)

Description copied from class: ABlob

Append hex string up to the given length in hex digits (a multiple of two)

Specified by:

appendHex in class ABlob

Parameters:

bb - BlobBuilder instance to append to

hexLength - Length in Hex digits to append

Returns:

true if Blob fully appended, false if more more hex digits remain

count

public final long count()

Description copied from class: ABlob

Gets the length of this Blob

Specified by:

count in class ABlob

Returns:

The length in bytes of this data object

byteAt

public final byte byteAt(long i)

Description copied from class: ABlob

Gets the byte at the specified position in this blob

Overrides:

byteAt in class ABlob

Parameters:

i - Index of the byte to get

Returns:

The byte at the specified position

shortAt

public final short shortAt(long i)

Overrides:

shortAt in class ABlob

longAt

public long longAt(long i)

getUnchecked

public final byte getUnchecked(long i)

Description copied from class: ABlob

Gets the byte at the specified position in this data object, without bounds checking. Only safe if index is known to be in bounds, otherwise result is undefined.

Specified by:

getUnchecked in class ABlob

Parameters:

i - Index of the byte to get

Returns:

The byte at the specified position

getHexDigit

public int getHexDigit(long digitPos)

Description copied from class: ABlob

Gets the specified hex digit from this data object. WARNING: Result is undefined if index is out of bounds, but probably an IndexOutOfBoundsException.

Overrides:

getHexDigit in class ABlob

Parameters:

digitPos - The position of the hex digit

Returns:

The value of the hex digit, in the range 0-15 inclusive

getInternalArray

public byte[] getInternalArray()

Gets the internal array backing this Blob. Use with caution!

Returns:

Byte array backing this blob

getInternalOffset

public int getInternalOffset()

Gets this offset into the internal array backing this Blob.

Returns:

Offset into backing array

getByteBuffer

public ByteBuffer getByteBuffer()

Description copied from class: ABlob

Gets a byte buffer containing this Blob's raw data. Will have remaining bytes equal to this Blob's size.

Specified by:

getByteBuffer in class ABlob

Returns:

A ByteBuffer containing the Blob's data.

equals

public boolean equals(ABlob o)

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 ABlob

Parameters:

o - Blob to compare with

Returns:

true if Blobs are equal, false otherwise

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

equalsBytes

public boolean equalsBytes(ABlob k)

Description copied from class: ABlob

Tests if this Blob has exactly the same bytes as another Blob

Specified by:

equalsBytes in class ABlob

Parameters:

k - Blob to compare with

Returns:

True if byte content is exactly equal, false otherwise

rangeMatches

public boolean rangeMatches(ABlob b,
 int start,
 int end)

Tests if a specific range of bytes are exactly equal.

Parameters:

b - Blob to compare with

start - Start index of range (inclusive)

end - End index of range (exclusive)

Returns:

true if digits are equal, false otherwise

rangeMatches

public boolean rangeMatches(AArrayBlob b,
 int start,
 int end)

Tests if a specific range of bytes are exactly equal from this Blob with another Blob

Parameters:

b - Blob with which to compare

start - Start index in both Blobs

end - End index in both Blobs

Returns:

true if digits are equal, false otherwise

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.

Specified by:

hexMatchLength in class ABlob

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

hexMatches

public boolean hexMatches(ABlob key,
 int start,
 int end)

Tests if a specific range of hex digits are exactly equal.

Parameters:

key - Blob to compare with

start - Start hex digit index (inclusive)

end - End hex digit index (Exclusive)

Returns:

true if digits are equal, false otherwise

commonHexPrefixLength

public long commonHexPrefixLength(ABlob b)

Description copied from class: ABlob

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

Specified by:

commonHexPrefixLength in class ABlob

Parameters:

b - Blob to compare with

Returns:

The length of the longest common prefix in hex digits

validate

public void validate()
              throws InvalidDataException

Description copied from interface: IValidated

Validates the complete structure of this object. It is necessary to ensure all child Refs are validated, so the general contract for validate is:

1. Call super.validate() - which will indirectly call validateCell()
2. Call validate() on any contained cells in this class

Specified by:

validate in interface IValidated

Overrides:

validate in class ABlob

Throws:

InvalidDataException - If the data Value is invalid in any way

validateCell

public void validateCell()
                  throws InvalidDataException

Description copied from class: ACell

Validates the local structure and invariants of this cell. Called by validate() super implementation. Should validate directly contained data, but should not validate all other structure of this cell. In particular, should not traverse potentially missing child Refs.

Overrides:

validateCell in class ABlob

Throws:

InvalidDataException - If the Cell is invalid

toExactLong

public long toExactLong()

Description copied from class: ABlob

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

Specified by:

toExactLong in class ABlob

Returns:

The long value represented by the Blob

longValue

public long longValue()

Description copied from class: ABlob

Converts this Blob to the corresponding long value. Assumes big-endian format, as if the entire blob is interpreted as a big integer. Higher bytes outside the Long range will be ignored, i.e. the lowest 64 bits are taken

Specified by:

longValue in class ABlob

Returns:

long value of this blob

getTag

public byte getTag()

Description copied from class: ACell

Gets the tag byte for this cell. The tag byte is always equal to the first byte of the Cell's canonical Encoding, and is sufficient to distinguish how to read the rest of the encoding.

Specified by:

getTag in class ACell

Returns:

Tag byte for this Cell

getRefCount

public final int getRefCount()

Description copied from class: ACell

Gets the number of Refs contained within this Cell. This number is final / immutable for any given instance and is defined by the Cell encoding rules. WARNING: may not be valid id Cell is not canonical Contained Refs may be either external or embedded.

Specified by:

getRefCount in class ACell

Returns:

The number of Refs in this Cell