Package convex.core.data.prim

Class APrimitive

java.lang.Object

convex.core.data.AObject

convex.core.data.ACell

convex.core.data.prim.APrimitive

All Implemented Interfaces:

IValidated, IWriteable

Direct Known Subclasses:

CVMBool, CVMByte, CVMChar, CVMDouble, CVMLong

public abstract class APrimitive
extends ACell

Abstract base class for small CVM primitive values. Primitives never contain Refs, are always embedded, and are always canonical

Field Summary

Fields inherited from class convex.core.data.ACell

cachedRef, EMPTY_ARRAY

Fields inherited from class convex.core.data.AObject

encoding

Constructor Summary

Constructors

Constructor	Description
APrimitive()

Method Summary

Modifier and Type	Method	Description
protected long	calcMemorySize()	Calculates the Memory Size for this Cell.
protected <R extends ACell> Ref<R>	createRef()	Creates a new Ref for this Cell
abstract double	doubleValue()
int	getRefCount()	Gets the number of Refs contained within this Cell.
boolean	isCanonical()	Returns true if this Cell is in a canonical format for message writing.
boolean	isCVMValue()	Returns true if this object represents a first class CVM Value.
boolean	isEmbedded()	Determines if this Cell Represents an embedded object.
abstract long	longValue()
ACell	toCanonical()	Converts this Cell to its canonical version.

Methods inherited from class convex.core.data.ACell

announce, announce, attachMemorySize, attachRef, cachedEncoding, cachedHash, createAnnounced, createEncoding, createPersisted, createPersisted, encode, encodeRaw, equals, equals, getChildRefs, getEncoding, getEncodingLength, getHash, getMemorySize, getRef, getRef, getTag, getType, hashCode, toString, updateRefs, validate, validateCell, 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

Constructor Details

APrimitive

public APrimitive()

Method Details

isCanonical

public final boolean isCanonical()

Description copied from class: ACell

Returns true if this Cell is in a canonical format for message writing. Reading or writing a non-canonical value should be considered illegal, but non-canonical objects may be used on a temporary internal basis.

Specified by:

isCanonical in class ACell

Returns:

true if the object is in canonical format, false otherwise

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

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

Specified by:

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

isCVMValue

public final boolean isCVMValue()

Description copied from class: ACell

Returns true if this object represents a first class CVM Value. Sub-structural cells that are not themselves first class values should return false. 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

calcMemorySize

protected long calcMemorySize()

Description copied from class: ACell

Calculates the Memory Size for this Cell. Requires any child Refs to be either Direct or of persisted status at minimum, or you might get a MissingDataException

Overrides:

calcMemorySize in class ACell

Returns:

Memory Size of this Cell

longValue

public abstract long longValue()

Returns:

long value representing primitive

doubleValue

public abstract double doubleValue()

Returns:

double value representing primitive

toCanonical

public ACell toCanonical()

Description copied from class: ACell

Converts this Cell to its canonical version. Returns this if already canonical

Specified by:

toCanonical in class ACell

Returns:

Canonical version of Cell