Package convex.core

Class Result

java.lang.Object

convex.core.data.AObject

convex.core.data.ACell

convex.core.data.ACountable<E>

convex.core.data.ADataStructure<MapEntry<K,V>>

convex.core.data.AMap<Keyword,ACell>

convex.core.data.ARecord

convex.core.data.ARecordGeneric

convex.core.Result

All Implemented Interfaces:

IAssociative<Keyword,ACell>, IValidated, IWriteable, Map<Keyword,ACell>

public final class Result
extends ARecordGeneric

Class representing the result of a Query or Transaction. A Result is typically used to communicate the outcome of a Query or a Transaction from a Peer to a Client. Contains:

1. Message ID
2. Result value
3. Error Code
4. Additional info

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K extends Object,V extends Object>

Field Summary

Fields inherited from class convex.core.data.ARecordGeneric

format, values

Fields inherited from class convex.core.data.ARecord

DEFAULT_VALUE

Fields inherited from class convex.core.data.ADataStructure

count

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
static Result	create(CVMLong id, ACell value)	Create a Result
static Result	create(CVMLong id, ACell value, ACell errorCode)	Create a Result
static Result	create(CVMLong id, ACell value, ACell errorCode, AMap<Keyword,ACell> info)	Create a Result
int	encode(byte[] bs, int pos)	Writes this Cell's encoding to a byte array, including a tag byte which will be written first.
static Result	fromContext(CVMLong id, Context<?> ctx)	Constructs a Result from a Context
static Result	fromContext(Context<?> ctx)	Constructs a Result from a Context
static Result	fromException(Throwable e)
ACell	getErrorCode()	Returns the Error Code from this Result.
RecordFormat	getFormat()	Gets the RecordFormat instance that describes this Record's layout
ACell	getID()	Returns the message ID for this result.
AMap<Keyword,ACell>	getInfo()	Returns the info for this Result.
byte	getTag()	Gets the tag byte for this record type.
AVector<AString>	getTrace()	Returns the stack trace for this result.
<T extends ACell> T	getValue()	Returns the value for this result.
boolean	isError()	Tests is the Result represents an Error
static Result	read(Blob b, int pos)
static Result	read(ByteBuffer bb)	Reads a Result from a ByteBuffer encoding.
void	validate()	Validates the complete structure of this object.
AVector<ACell>	values()	Gets a vector of values for this Record, in format-determined order
Result	withID(ACell id)	Updates result with a given message ID.
protected Result	withValues(AVector<ACell> newValues)	Updates the record with a new set of values.

Methods inherited from class convex.core.data.ARecordGeneric

entryAt, equals, equals, get, getRef, getRefCount, updateRefs, validateCell

Methods inherited from class convex.core.data.ARecord

accumulateEntrySet, accumulateKeySet, accumulateValues, assoc, assocEntry, containsKey, containsValue, dissoc, dissoc, empty, encodeRaw, entrySet, estimatedEncodingSize, forEach, get, getEntry, getEntryByHash, getKeyRefEntry, getKeys, getType, getValuesArray, isCanonical, isCVMValue, keySet, reduceEntries, reduceValues, toCanonical, toHashMap

Methods inherited from class convex.core.data.AMap

clear, conj, containsKey, containsKeyRef, containsValue, entryVector, filterValues, get, get, getElementRef, merge, print, put, putAll, remove, slice, slice

Methods inherited from class convex.core.data.ADataStructure

conjAll, count, isEmpty, size, toCVMString

Methods inherited from class convex.core.data.ACell

announce, announce, attachMemorySize, attachRef, cachedEncoding, cachedHash, calcMemorySize, createAnnounced, createEncoding, createPersisted, createPersisted, createRef, equals, getCanonical, getChildRefs, getEncoding, getEncodingLength, getHash, getMemorySize, getRef, hashCode, isCompletelyEncoded, isEmbedded, mark, mark, toString, 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 java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, getOrDefault, hashCode, isEmpty, merge, putIfAbsent, remove, replace, replace, replaceAll, size

Method Details

create

public static Result create(CVMLong id,
 ACell value,
 ACell errorCode,
 AMap<Keyword,ACell> info)

Create a Result

Parameters:

id - ID of Result message

value - Result Value

errorCode - Error Code (may be null for success)

info - Additional info

Returns:

Result instance

create

public static Result create(CVMLong id,
 ACell value,
 ACell errorCode)

Create a Result

Parameters:

id - ID of Result message

value - Result Value

errorCode - Error Code (may be null for success)

Returns:

Result instance

create

public static Result create(CVMLong id,
 ACell value)

Create a Result

Parameters:

id - ID of Result message

value - Result Value

Returns:

Result instance

getID

public ACell getID()

Returns the message ID for this result. Message ID is an arbitrary ID assigned by a client requesting a transaction.

Returns:

ID from this result

getValue

public <T extends ACell> T getValue()

Returns the value for this result. The value is the result of transaction execution (may be an error message if the transaction failed)

Type Parameters:

T - Type of Value

Returns:

ID from this result

getTrace

public AVector<AString> getTrace()

Returns the stack trace for this result. May be null

Returns:

Trace vector from this result

getInfo

public AMap<Keyword,ACell> getInfo()

Returns the info for this Result. May be null

Returns:

Info map from this result

getErrorCode

public ACell getErrorCode()

Returns the Error Code from this Result. Normally this should be a Keyword. Will be null if no error occurred.

Returns:

ID from this result

values

public AVector<ACell> values()

Description copied from class: ARecord

Gets a vector of values for this Record, in format-determined order

Specified by:

values in interface Map<Keyword,ACell>

Overrides:

values in class ARecordGeneric

Returns:

Vector of Values

withValues

protected Result withValues(AVector<ACell> newValues)

Description copied from class: ARecordGeneric

Updates the record with a new set of values. Returns this if and only if values vector is identical.

Specified by:

withValues in class ARecordGeneric

Parameters:

newValues - New values to use

Returns:

Updated Record

validate

public void validate()
              throws InvalidDataException

Description copied from interface: IValidated

Validates the complete structure of this object. It is necessary to ensure all child Refs are validated, so the general contract for validate is:

1. Call super.validate() - which will indirectly call validateCell()
2. Call validate() on any contained cells in this class

Specified by:

validate in interface IValidated

Overrides:

validate in class ACell

Throws:

InvalidDataException - If the data Value is invalid in any way

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

read

public static Result read(ByteBuffer bb)
                   throws BadFormatException

Reads a Result from a ByteBuffer encoding. Assumes tag byte already read.

Parameters:

bb - ByteBuffer to read from

Returns:

The Result read

Throws:

BadFormatException - If a Result could not be read

read

public static Result read(Blob b,
 int pos)
                   throws BadFormatException

Throws:

BadFormatException

isError

public boolean isError()

Tests is the Result represents an Error

Returns:

True if error, false otherwise

fromContext

public static Result fromContext(CVMLong id,
 Context<?> ctx)

Constructs a Result from a Context

Parameters:

id - Id for Result

ctx - Context

Returns:

New Result instance

fromContext

public static Result fromContext(Context<?> ctx)

Constructs a Result from a Context

Parameters:

ctx - Context

Returns:

New Result instance

withID

public Result withID(ACell id)

Updates result with a given message ID. Used to tag Results for return to Clients

Parameters:

id - New Result message ID

Returns:

Updated Result

getTag

public byte getTag()

Description copied from class: ARecord

Gets the tag byte for this record type. The Tag is the byte used to identify the record in the binary encoding.

Specified by:

getTag in class ARecordGeneric

Returns:

Record tag byte

getFormat

public RecordFormat getFormat()

Description copied from class: ARecord

Gets the RecordFormat instance that describes this Record's layout

Specified by:

getFormat in class ARecord

Returns:

RecordFormat instance

fromException

public static Result fromException(Throwable e)