Package convex.core.data.prim

Class CVMByte

java.lang.Object

convex.core.data.AObject

convex.core.data.ACell

convex.core.data.prim.APrimitive

convex.core.data.prim.CVMByte

All Implemented Interfaces:

INumeric, IValidated, IWriteable

public final class CVMByte
extends APrimitive
implements INumeric

Class for CVM Byte instances. Bytes are unsigned 8-bit integers which upcast to long for numerical operations.

Field Summary

Fields

Modifier and Type	Field	Description
static CVMByte	ONE
static CVMByte	ZERO

Fields inherited from class convex.core.data.ACell

cachedRef, EMPTY_ARRAY

Fields inherited from class convex.core.data.AObject

encoding

Method Summary

Modifier and Type	Method	Description
byte	byteValue()
static CVMByte	create(long value)
double	doubleValue()
int	encode(byte[] bs, int pos)	Writes this Cell's encoding to a byte array, including a tag byte which will be written first
int	encodeRaw(byte[] bs, int pos)	Writes this Cell's encoding to a byte array, excluding the tag byte
int	estimatedEncodingSize()	Estimate the encoded data size for this Cell.
byte	getTag()	Gets the tag byte for this cell.
AType	getType()	Gets the most specific known runtime Type for this Cell.
long	longValue()
Class<?>	numericType()	Gets the numeric type that should be used as for calculations
void	print(StringBuilder sb)	Prints this Object to a readable String Representation
CVMLong	signum()	Gets the signum of this numerical value.
CVMDouble	toDouble()
CVMLong	toLong()
INumeric	toStandardNumber()
void	validateCell()	Validates the local structure and invariants of this cell.

Methods inherited from class convex.core.data.prim.APrimitive

calcMemorySize, createRef, getRefCount, isCanonical, isCVMValue, isEmbedded, toCanonical

Methods inherited from class convex.core.data.ACell

announce, announce, attachMemorySize, attachRef, cachedEncoding, cachedHash, createAnnounced, createEncoding, createPersisted, createPersisted, equals, equals, getChildRefs, getEncoding, getEncodingLength, getHash, getMemorySize, getRef, getRef, hashCode, toString, updateRefs, validate, write

Methods inherited from class convex.core.data.AObject

attachEncoding, print

Methods inherited from class java.lang.Object

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

Field Details

ZERO

public static final CVMByte ZERO

ONE

public static final CVMByte ONE

Method Details

create

public static CVMByte create(long value)

getType

public AType getType()

Description copied from class: ACell

Gets the most specific known runtime Type for this Cell.

Overrides:

getType in class ACell

Returns:

The Type of this Call

longValue

public long longValue()

Specified by:

longValue in class APrimitive

Returns:

long value representing primitive

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 likely to contain the entire object when represented in binary format, including the tag byte.

Specified by:

estimatedEncodingSize in interface IWriteable

Returns:

The estimated size for the binary representation of this object.

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.

Specified by:

validateCell in class ACell

Throws:

InvalidDataException - If the Cell is invalid

encode

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

Description copied from class: ACell

Writes this Cell's encoding to a byte array, including a tag byte which will be written first

Specified by:

encode in interface IWriteable

Specified by:

encode in class ACell

Parameters:

bs - A byte array to which to write the encoding

pos - The offset into the byte array

Returns:

New position after writing

encodeRaw

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

Description copied from class: ACell

Writes this Cell's encoding to a byte array, excluding the tag byte

Specified by:

encodeRaw in class ACell

Parameters:

bs - A byte array to which to write the encoding

pos - The offset into the byte array

Returns:

New position after writing

print

public void print(StringBuilder sb)

Description copied from class: AObject

Prints this Object to a readable String Representation

Specified by:

print in class AObject

Parameters:

sb - StringBuilder to append to

numericType

public Class<?> numericType()

Description copied from interface: INumeric

Gets the numeric type that should be used as for calculations

Specified by:

numericType in interface INumeric

Returns:

Double.class or Long.class, or null if not a numeric type

doubleValue

public double doubleValue()

Specified by:

doubleValue in interface INumeric

Specified by:

doubleValue in class APrimitive

Returns:

double value representing primitive

getTag

public byte getTag()

Description copied from class: ACell

Gets the tag byte for this cell. The tag byte is always written as the first byte of the Cell's Encoding

Specified by:

getTag in class ACell

Returns:

Tag byte for this Cell

toLong

public CVMLong toLong()

Specified by:

toLong in interface INumeric

toDouble

public CVMDouble toDouble()

Specified by:

toDouble in interface INumeric

signum

public CVMLong signum()

Description copied from interface: INumeric

Gets the signum of this numerical value. Will be -1, 0 or 1 for Longs, -1.0, 0.0 , 1.0 or ##NaN for doubles.

Specified by:

signum in interface INumeric

Returns:

Signum of the numeric value

byteValue

public byte byteValue()

toStandardNumber

public INumeric toStandardNumber()

Specified by:

toStandardNumber in interface INumeric