Package convex.core.data

Class ALongBlob

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.ALongBlob

All Implemented Interfaces:

IValidated, IWriteable, Comparable<ABlobLike<?>>

Direct Known Subclasses:

LongBlob

public abstract class ALongBlob
extends ABlob

Field Summary

Fields

Modifier and Type	Field	Description
protected static final int	HEX_LENGTH
static final int	LENGTH
protected final long	value

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	ALongBlob(long value)

Method Summary

Modifier and Type	Method	Description
final ABlob	append(ABlob d)	Append an additional Blob to this, creating a new Blob as needed.
boolean	appendHex(BlobBuilder bb, long length)	Append hex string up to the given length in hex digits (a multiple of two)
final byte	byteAt(long i)	Gets the byte at the specified position
final byte	byteAtUnchecked(long i)	Gets the byte at the specified position in this data object, possibly skipping bounds checking.
protected final long	calcMemorySize()	Calculates the Memory Size for this Cell.
protected int	compareTo(long bvalue)
int	compareTo(ABlobLike<?> b)	Compares this Blob to another Blob, in lexicographic order sorting by first bytes (unsigned).
protected <R extends ACell> Ref<R>	createRef()	Creates a new Ref for this Cell
abstract boolean	equals(ABlob o)	Determines if this Blob is equal to another Blob.
boolean	equalsBytes(byte[] bytes, long byteOffset)	Tests if the byte contents of this instance are equal to a subset of a byte array
final boolean	equalsBytes(ABlob b)	Tests if this Blob has exactly the same bytes as another Blob
final ByteBuffer	getByteBuffer()	Gets a byte buffer containing this Blob's raw data.
final int	getBytes(byte[] bs, int pos)	Copies the bytes from this instance to a given destination array
final Blob	getChunk(long i)	Gets a chunk of this Blob, as a canonical flat Blob up to the maximum Blob chunk size.
int	getHexDigit(long i)	Gets the specified hex digit from this data object.
<R extends ACell> Ref<R>	getRef(int i)	Gets a numbered child Ref from within this Cell.
int	getRefCount()	Gets the number of Refs contained within this Cell.
final long	hexLength()	Gets the length of this value in hex digits
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	isChunkPacked()	Returns true if this Blob is a fully packed set of chunks
final boolean	isEmbedded()	Determines if this Cell Represents an embedded object.
boolean	isFullyPacked()	Returns true if this is a fully packed set of chunks
final 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
abstract ABlob	slice(long start, long end)	Gets a contiguous slice of this Blob, as a new Blob.
ABlob	toCanonical()	Converts this Cell to a canonical version.
abstract Blob	toFlatBlob()	Converts the contents of this value to a flat array-backed Blob instance.
ACell	updateRefs(IRefFunction func)	Updates all Refs in this object using the given function.

Methods inherited from class convex.core.data.ABlob

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

Methods inherited from class convex.core.data.ABlobLike

getBytes, hexEquals, 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, createEncoding, equals, genericEquals, getCanonical, getChildRefs, getEncoding, getEncodingLength, getHash, getMemorySize, getMemorySize, getRef, toCVMString, toString

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

LENGTH

public static final int LENGTH

See Also:

• Constant Field Values

HEX_LENGTH

protected static final int HEX_LENGTH

See Also:

• Constant Field Values

value

protected final long value

Constructor Details

ALongBlob

protected ALongBlob(long value)

Method Details

hexLength

public final long hexLength()

Description copied from class: ABlobLike

Gets the length of this value in hex digits

Overrides:

hexLength in class ABlobLike<CVMLong>

Returns:

Number of hex digits

createRef

protected <R extends ACell> Ref<R> createRef()

Description copied from class: ACell

Creates a new Ref for this Cell

Overrides:

createRef in class ACell

Type Parameters:

R - Type of Cell

Returns:

New Ref instance

appendHex

public boolean appendHex(BlobBuilder bb,
 long length)

Description copied from class: ABlobLike

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

Overrides:

appendHex in class ABlobLike<CVMLong>

Parameters:

bb - BlobBuilder instance to append to

length - Length in Hex digits to append

Returns:

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

getHexDigit

public int getHexDigit(long i)

Description copied from class: ABlobLike

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 ABlobLike<CVMLong>

Parameters:

i - The position of the hex digit

Returns:

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

slice

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

toFlatBlob

public abstract 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.

byteAt

public final byte byteAt(long i)

Description copied from class: ABlob

Gets the byte at the specified position

Overrides:

byteAt in class ABlob

Parameters:

i - Index of the byte to get

Returns:

The byte at the specified position

byteAtUnchecked

public final byte byteAtUnchecked(long i)

Description copied from class: ABlobLike

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

Overrides:

byteAtUnchecked in class ABlobLike<CVMLong>

Parameters:

i - Index of the byte to get

Returns:

The byte at the specified position

append

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

getBytes

public final int getBytes(byte[] bs,
 int pos)

Description copied from class: ABlobLike

Copies the bytes from this instance to a given destination array

Specified by:

getBytes in class ABlobLike<CVMLong>

Parameters:

bs - Destination array

pos - Offset into destination array

Returns:

End position in destination array after writing

getChunk

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

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

longValue

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

compareTo

public int compareTo(ABlobLike<?> 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<ABlobLike<?>>

Overrides:

compareTo in class ABlob

compareTo

protected int compareTo(long bvalue)

equalsBytes

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

equalsBytes

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

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

byteOffset - Offset into byte array from which to start comparison

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

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

getRef

public <R extends ACell> Ref<R> getRef(int i)

Description copied from class: ACell

Gets a numbered child Ref from within this Cell. WARNING: May need to convert to a canonical instance

Overrides:

getRef in class ACell

Type Parameters:

R - Type of referenced Cell

Parameters:

i - Index of ref to get

Returns:

The Ref at the specified index

updateRefs

public ACell updateRefs(IRefFunction func)

Description copied from class: ACell

Updates all Refs in this object using the given function. The function *must not* change the hash value of Refs, in order to ensure structural integrity of modified data structures. The implementation *should* re-attach any original encoding in order to prevent re-encoding or surplus hashing This is a building block for a very sneaky trick that enables use to do a lot of efficient operations on large trees of smart references. Must return the same object if no Refs are altered.

Overrides:

updateRefs in class ACell

Parameters:

func - Ref update function

Returns:

Cell with updated Refs

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

isEmbedded

public final boolean isEmbedded()

Description copied from class: ACell

Determines if this Cell Represents an embedded object. Embedded objects are encoded directly into the encoding of the containing Cell (avoiding the need for a hashed reference). Subclasses should override this if they have a cheap O(1) way to determine if they are embedded or otherwise.

Overrides:

isEmbedded in class ACell

Returns:

true if Cell is embedded, false otherwise

calcMemorySize

protected final long calcMemorySize()

Description copied from class: ACell

Calculates the Memory Size for this Cell. Assumes not already calculated Requires any child Refs to be either direct or of persisted in store at minimum, or you might get a MissingDataException

Overrides:

calcMemorySize in class ACell

Returns:

Memory Size of this Cell

isChunkPacked

public boolean isChunkPacked()

Description copied from class: ABlob

Returns true if this Blob is a fully packed set of chunks

Overrides:

isChunkPacked in class ABlob

Returns:

True if fully packed, 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