Package convex.core.data

Class ASymbolic

java.lang.Object

convex.core.data.AObject

convex.core.data.ACell

convex.core.data.ACountable<CVMChar>

convex.core.data.ABlobLike<CVMChar>

convex.core.data.ASymbolic

All Implemented Interfaces:

IValidated, IWriteable, Comparable<ABlobLike<?>>

Direct Known Subclasses:

Keyword, Symbol

public abstract class ASymbolic
extends ABlobLike<CVMChar>

Abstract based class for symbolic objects (Keywords, Symbols)

Field Summary

Fields

Modifier and Type	Field	Description
protected final StringShort	name

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	ASymbolic(StringShort name)

Method Summary

Modifier and Type	Method	Description
byte	byteAt(long i)	Gets the byte at the specified position.
protected long	calcMemorySize()	Calculates the Memory Size for this Cell.
long	count()	Returns the number of elements in this value
protected <R extends ACell> Ref<R>	createRef()	Creates a new Ref for this Cell
ABlobLike<CVMChar>	empty()	Returns a canonical, singleton empty instance of the same type as this Countable value.
boolean	equalsBytes(ABlob b)	Compare the byte content of this BlobLike to a Blob value
final int	estimatedEncodingSize()	Estimate the encoded data size for this Cell.
CVMChar	get(long index)	Gets the element at the specified element index in this value
int	getBytes(byte[] dest, int destOffset)	Copies the bytes from this instance to a given destination array
Ref<CVMChar>	getElementRef(long index)	Gets a Ref to the element at the specified element index in this collection
final StringShort	getName()	Gets the name of this symbolic value
<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 int	hashCode()	Gets the Java hashCode for 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.
final boolean	isCVMValue()	Returns true if this cell is a first class CVM Value allowable in the CVM state Sub-structural cells that are not themselves first class values should return false Records and types that are not permissible on the CVM should return false.
final boolean	isDataValue()	Returns true if this cell instance is a first class value, i.e.
boolean	isEmbedded()	Determines if this Cell Represents an embedded object.
long	longValue()	Converts this BlobLike to the corresponding long value.
abstract ABlobLike<CVMChar>	slice(long start, long end)	Gets a slice of this data structure
ABlob	toBlob()	Convert this BlobLike object to an ABlob instance, in the most efficient way.
ACell	updateRefs(IRefFunction func)	Updates all Refs in this object using the given function.
abstract void	validateCell()	Validates this Symbolic value
protected static boolean	validateName(AString name)

Methods inherited from class convex.core.data.ABlobLike

appendHex, byteAtUnchecked, compareTo, getBytes, getHexDigit, hexEquals, hexLength, hexMatch, toFlatBlob, toHexString, toHexString

Methods inherited from class convex.core.data.ACountable

isEmpty, size, slice

Methods inherited from class convex.core.data.ACell

attachMemorySize, attachRef, cachedEncoding, cachedHash, createEncoding, encode, encodeRaw, equals, equals, genericEquals, getCanonical, getChildRefs, getEncoding, getEncodingLength, getHash, getMemorySize, getMemorySize, getRef, getTag, getType, isCanonical, toCanonical, toCVMString, toString, validate

Methods inherited from class convex.core.data.AObject

attachEncoding, print, print, print

Methods inherited from class java.lang.Object

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

Field Details

name

protected final StringShort name

Constructor Details

ASymbolic

protected ASymbolic(StringShort name)

Method Details

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

isCVMValue

public final boolean isCVMValue()

Description copied from class: ACell

Returns true if this cell is a first class CVM Value allowable in the CVM state Sub-structural cells that are not themselves first class values should return false Records and types that are not permissible on the CVM should return false. Pretty much everything else should return true. Note: CVM values might not be in a canonical format, e.g. temporary data structures

Specified by:

isCVMValue in class ACell

Returns:

true if the object is a CVM Value, false otherwise

isDataValue

public final boolean isDataValue()

Description copied from class: ACell

Returns true if this cell instance is a first class value, i.e. not a component of a larger data structure Sub-structural cells that are not themselves first class values should return false Everything else should return true.

Overrides:

isDataValue in class ABlobLike<CVMChar>

Returns:

true if the object is a Value, false otherwise

calcMemorySize

protected 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

estimatedEncodingSize

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

getName

public final StringShort getName()

Gets the name of this symbolic value

Returns:

Name as a short CVM String

validateName

protected static boolean validateName(AString name)

isEmbedded

public 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

hashCode

public final int hashCode()

Description copied from class: ACell

Gets the Java hashCode for this cell. Must be consistent with equals. Default is the hashCode of the Encoding blob, since this is consistent with encoding-based equality. However, different Types may provide more efficient hashcodes provided that the usual invariants are preserved

Overrides:

hashCode in class ACell

Returns:

integer hash code.

validateCell

public abstract void validateCell()
                           throws InvalidDataException

Validates this Symbolic value

Specified by:

validateCell in class ACell

Throws:

InvalidDataException - If the symbolic value is invalid

byteAt

public byte byteAt(long i)

Description copied from class: ABlobLike

Gets the byte at the specified position. Result is undefined if out of range.

Specified by:

byteAt in class ABlobLike<CVMChar>

Parameters:

i - Index of the byte to get

Returns:

The byte at the specified position

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

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

empty

public ABlobLike<CVMChar> empty()

Description copied from class: ACountable

Returns a canonical, singleton empty instance of the same type as this Countable value.

Specified by:

empty in class ABlobLike<CVMChar>

Returns:

An empty Countable value, or null if there is no empty instance

getBytes

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

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

Returns:

long value of this blob

toBlob

public ABlob toBlob()

Description copied from class: ABlobLike

Convert this BlobLike object to an ABlob instance, in the most efficient way. May return `this`.

Specified by:

toBlob in class ABlobLike<CVMChar>

Returns:

Blob instance

equalsBytes

public boolean equalsBytes(ABlob b)

Description copied from class: ABlobLike

Compare the byte content of this BlobLike to a Blob value

Specified by:

equalsBytes in class ABlobLike<CVMChar>

Parameters:

b - Blob value to compare with

Returns:

`true` if byte contents are exactly equal, `false` otherwise

count

public long count()

Description copied from class: ACountable

Returns the number of elements in this value

Specified by:

count in class ACountable<CVMChar>

Returns:

Number of elements

getElementRef

public Ref<CVMChar> getElementRef(long index)

Description copied from class: ACountable

Gets a Ref to the element at the specified element index in this collection

Overrides:

getElementRef in class ABlobLike<CVMChar>

Parameters:

index - Index of element to get

Returns:

Element at the specified index

get

public CVMChar get(long index)

Description copied from class: ACountable

Gets the element at the specified element index in this value

Specified by:

get in class ACountable<CVMChar>

Parameters:

index - Index of element to get

Returns:

Element at the specified index

slice

public abstract ABlobLike<CVMChar> slice(long start,
 long end)

Description copied from class: ACountable

Gets a slice of this data structure

Specified by:

slice in class ACountable<CVMChar>

Parameters:

start - Start index (inclusive)

end - end index (exclusive)

Returns:

Slice of data structure, or null if invalid slice

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