Package convex.core.data.prim

Class CVMBool

java.lang.Object

convex.core.data.AObject

convex.core.data.ACell

convex.core.data.prim.APrimitive

convex.core.data.prim.CVMBool

All Implemented Interfaces:

IValidated, IWriteable

public final class CVMBool
extends APrimitive

Class for CVM Boolean types. Two canonical values are provided, TRUE and FALSE. No other instances should exist.

Field Summary

Fields

Modifier and Type	Field	Description
static CVMBool	FALSE
static int	MAX_ENCODING_LENGTH
static CVMBool	TRUE

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
boolean	booleanValue()
static CVMBool	create(boolean 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()
static CVMBool	of(boolean b)	Get the canonical CVMBool value for true or false
static ACell	parse(String text)
boolean	print(BlobBuilder bb, long limit)	Prints this Object to a readable String Representation
AString	toCVMString(long limit)	Returns the CVM String representation of this Cell.
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, getCanonical, getChildRefs, getEncoding, getEncodingLength, getHash, getMemorySize, getRef, getRef, hashCode, isCompletelyEncoded, mark, mark, toString, updateRefs, validate, 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

Field Details

TRUE

public static final CVMBool TRUE

FALSE

public static final CVMBool FALSE

MAX_ENCODING_LENGTH

public static final int MAX_ENCODING_LENGTH

See Also:

Constant Field Values

Method Details

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

create

public static CVMBool create(boolean value)

of

public static CVMBool of(boolean b)

Get the canonical CVMBool value for true or false

Parameters:

b - Boolean specifying

Returns:

CVMBool value representing false or true

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.

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. Cell must be canonical, or else an error may occur.

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 boolean print(BlobBuilder bb,
 long limit)

Description copied from class: AObject

Prints this Object to a readable String Representation

Specified by:

print in class AObject

Parameters:

bb - StringBuilder to append to

limit - Limit of printing in string bytes

Returns:

True if fully printed, false otherwise

doubleValue

public double doubleValue()

Specified by:

doubleValue in class APrimitive

Returns:

double value representing primitive

booleanValue

public boolean booleanValue()

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

parse

public static ACell parse(String text)

toCVMString

public AString toCVMString(long limit)

Description copied from class: ACell

Returns the CVM String representation of this Cell. Normally, this is as printed, but may be different for some types. MUST return null in O(1) time if the length of the CVM String would exceed limit. The String representation is intended to be a easy-to-read textual representation of the Cell's data content.

Overrides:

toCVMString in class ACell

Parameters:

limit - Limit of CVM String length in UTF-8 bytes

Returns:

CVM String, or null if limit exceeded by too much