Package convex.core.data

Class ADerivedBlob

java.lang.Object

convex.core.data.AObject

convex.core.data.ACell

convex.core.data.ACountable<CVMLong>

convex.core.data.ABlobLike<CVMLong>

convex.core.data.ABlob

convex.core.data.ADerivedBlob

All Implemented Interfaces:

IValidated, IWriteable, Comparable<ABlobLike<?>>

Direct Known Subclasses:

ZeroBlob

public abstract class ADerivedBlob
extends ABlob

Abstract Blob base base for Blobs that derive their functionality from other sources. Allows extension of ABlob interface to various backing stores.

Field Summary

Fields inherited from class convex.core.data.ABlob

count

Fields inherited from class convex.core.data.ACell

cachedRef, memorySize

Fields inherited from class convex.core.data.AObject

encoding

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ADerivedBlob(long count)

Method Summary

Modifier and Type	Method	Description
ABlob	append(ABlob d)	Append an additional Blob to this, creating a new Blob as needed.
int	encodeRaw(byte[] bs, int pos)	Writes this Blob's encoding to a byte array, excluding the tag byte
boolean	equals(ABlob o)	Determines if this Blob is equal to another Blob.
boolean	equalsBytes(byte[] bytes, long offset)	Tests if the byte contents of this instance are equal to a subset of a byte array
boolean	equalsBytes(ABlob b)	Tests if this Blob has exactly the same bytes as another Blob
int	estimatedEncodingSize()	Estimate the encoded data size for this Cell.
ByteBuffer	getByteBuffer()	Gets a byte buffer containing this Blob's raw data.
abstract int	getBytes(byte[] dest, int destOffset)	Copies the bytes from this instance to a given destination array
Blob	getChunk(long i)	Gets a chunk of this Blob, as a canonical flat Blob up to the maximum Blob chunk size.
int	getRefCount()	Gets the number of Refs contained within this Cell.
long	hexMatch(ABlobLike<?> 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.
boolean	isFullyPacked()	Returns true if this is a fully packed set of chunks
long	longValue()	Converts this BlobLike to the corresponding long value.
int	read(long offset, long count, ByteBuffer dest)	Gets bytes from this Blob into a ByteBuffer
final ABlob	slice(long start, long end)	Gets a contiguous slice of this Blob, as a new Blob.
protected abstract ABlob	sliceImpl(long start, long end)	Constructs a slice of this Blob as the same type.
ABlob	toCanonical()	Converts this Cell to a canonical version.
Blob	toFlatBlob()	Converts the contents of this value to a flat array-backed Blob instance.
protected void	updateDigest(MessageDigest digest)

Methods inherited from class convex.core.data.ABlob

byteAt, compareTo, computeHash, count, empty, encode, equals, get, getContentHash, getElementRef, getTag, getType, hashCode, isChunkPacked, isCVMValue, print, read, replaceSlice, shortAt, size, slice, toBlob, toByteBuffer, validate, validateCell

Methods inherited from class convex.core.data.ABlobLike

appendHex, byteAtUnchecked, getBytes, getHexDigit, hexEquals, hexLength, hexMatch, isDataValue, toHexString, toHexString

Methods inherited from class convex.core.data.ACountable

isEmpty

Methods inherited from class convex.core.data.ACell

attachMemorySize, attachRef, cachedEncoding, cachedHash, calcMemorySize, createEncoding, createRef, equals, genericEquals, getCanonical, getChildRefs, getEncoding, getEncodingLength, getHash, getMemorySize, getMemorySize, getRef, getRef, isEmbedded, toCVMString, toString, updateRefs

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

Constructor Details

ADerivedBlob

protected ADerivedBlob(long count)

Method Details

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 highly likely to contain the entire object when encoded, including the tag byte. Should not traverse soft Refs, i.e. must be usable on arbitrary partial data structures

Returns:

The estimated size for the binary representation of this object.

slice

public final 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 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, or null if the slice is invalid

sliceImpl

protected abstract ABlob sliceImpl(long start,
 long end)

Constructs a slice of this Blob as the same type. Assumes a new slice must be constructed and that bounds have already been checked.

Parameters:

start - Start of slice

end - End of slice

Returns:

New slice instance

toFlatBlob

public Blob toFlatBlob()

Description copied from class: ABlobLike

Converts the contents of this value 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 value. Might be `this` if already a flat Blob.

updateDigest

protected void updateDigest(MessageDigest digest)

Specified by:

updateDigest in class ABlob

append

public ABlob append(ABlob d)

Description copied from class: ABlob

Append an additional Blob to this, creating a new Blob as needed.

Specified by:

append in class ABlob

Parameters:

d - Blob to append

Returns:

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

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 encoded representation, i.e. if and only if all of the following are true: - 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

toCanonical

public ABlob toCanonical()

Description copied from class: ACell

Converts this Cell to a canonical version. Must return this Cell if already canonical, may be O(n) in size of value otherwise. Callers should usually use getCanonical(), which caches canonical instances once created

Specified by:

toCanonical in class ABlob

Returns:

Canonical version of Cell

equalsBytes

public boolean equalsBytes(byte[] bytes,
 long offset)

Description copied from class: ABlob

Tests if the byte contents of this instance are equal to a subset of a byte array

Specified by:

equalsBytes in class ABlob

Parameters:

bytes - Byte array to compare with

offset - Offset into byte array from which to start comparison

Returns:

true if exactly equal, false otherwise

getChunk

public Blob getChunk(long i)

Description copied from class: ABlob

Gets a chunk of this Blob, as a canonical flat Blob up to the maximum Blob chunk size. Returns empty Blob if and only if referencing the end of a Blob with fully packed chunks

Specified by:

getChunk in class ABlob

Parameters:

i - Index of chunk

Returns:

A Blob containing the specified chunk data.

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.

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

equalsBytes

public boolean equalsBytes(ABlob b)

Description copied from class: ABlob

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

Specified by:

equalsBytes in class ABlob

Parameters:

b - Blob to compare with

Returns:

True if byte content is exactly equal, false otherwise

isFullyPacked

public boolean isFullyPacked()

Description copied from class: ABlob

Returns true if this is a fully packed set of chunks

Specified by:

isFullyPacked in class ABlob

Returns:

True if fully packed, false otherwise

read

public int read(long offset,
 long count,
 ByteBuffer dest)

Description copied from class: ABlob

Gets bytes from this Blob into a ByteBuffer

Specified by:

read in class ABlob

Parameters:

offset - Offset into this Blob to read from

count - Number of bytes to read. Must be in bounds

dest - Destination byte buffer

Returns:

Number of bytes read

hexMatch

public long hexMatch(ABlobLike<?> b,
 long start,
 long length)

Description copied from class: ABlobLike

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:

hexMatch in class ABlobLike<CVMLong>

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

getBytes

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

Description copied from class: ABlobLike

Copies the bytes from this instance to a given destination array

Specified by:

getBytes in class ABlobLike<CVMLong>

Parameters:

dest - Destination array

destOffset - Offset into destination array

Returns:

End position in destination array after writing

longValue

public long longValue()

Description copied from class: ABlobLike

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

Specified by:

longValue in class ABlobLike<CVMLong>

Returns:

long value of this blob

isCanonical

public boolean isCanonical()

Description copied from class: ACell

Returns true if this Cell is in a canonical representation. Non-canonical objects may be used on a temporary internal basis, they should be converted to canonical representations for general purpose use.

Specified by:

isCanonical in class ACell

Returns:

true if the object is in canonical format, false otherwise

getRefCount

public 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. Contained Refs may be either external or embedded.

Overrides:

getRefCount in class ACell

Returns:

The number of Refs in this Cell