Package convex.core.data

package convex.core.data

Data structures and algorithms, including a complete set of classes required to implement immutable, decentralised data objects.

Related Packages

Package	Description
convex.core	Fundamental Convex classes used for the decentralised network
convex.core.data.impl
convex.core.data.prim	Implementation of CVM Primitive Data types
convex.core.data.type	CVM type system implementation.
convex.core.data.util

Class	Description
AArrayBlob	Abstract base class for binary data stored in Java arrays.
ABlob	Abstract base class for data objects containing immutable chunks of binary data.
ABlobLike<T extends ACell>	Abstract base class for Blob-like objects, which conceptually behave as a sequence of bytes.
AccountKey	Immutable class representing an Ed25519 Public Key for an Account
AccountStatus	Class representing the current on-chain status of an account.
ACell	Abstract base class for Cells.
ACollection<T extends ACell>	Abstract base class for Persistent Merkle Collections
ACountable<E extends ACell>	Abstract base class for Countable objects, supporting `count`, `nth`, `empty?` and `slice` Countable values support a count of elements and the ability to get by an element index.
ADataStructure<E extends ACell>	Abstract base class for Persistent data structures.
Address	Immutable class representing an Address, generally used to uniquely identify an Account.
ADerivedBlob	Abstract Blob base base for Blobs that derive their functionality from other sources.
AHashMap<K extends ACell,V extends ACell>
AHashSet<T extends ACell>
AIndex<K extends ABlobLike<?>,V extends ACell>	Abstract base class for Indexes: a sorted radix-tree map of Blobs to Values.
AList<T extends ACell>	Abstract base class for lists.
ALongBlob
AMap<K extends ACell,V extends ACell>	Abstract base class for maps.
AMapEntry<K extends ACell,V extends ACell>
AObject
ARecord	Base class for Record data types.
ARecordGeneric	Abstract base class for generic records.
ASequence<T extends ACell>	Abstract base class for concrete sequential data structure (immutable persistent lists and vectors etc.)
ASet<T extends ACell>	Abstract based class for sets.
ASpecialVector<T extends ACell>	BAse class for specialised vector implementations
AString	Abstract base Class representing a CVM String.
ASymbolic	Abstract based class for symbolic objects (Keywords, Symbols)
AVector<T extends ACell>	Abstract base class for vectors.
Blob	General purpose immutable wrapper for byte array data.
Blobs
BlobTree	Implementation of a large Blob data structure consisting of 2 or more chunks.
Cells	Static utility class for dealing with cells
Encoder	Encoder for stores
Format	Static utility class for message format encoding "Standards are always out of date.
Hash	Class used to represent an immutable 32-byte Hash value.
IAssociative<K extends ACell,V extends ACell>	Interface for associative data structures
Index<K extends ABlobLike<?>,V extends ACell>	Index node implementation, providing an efficient radix tree based immutable data structure for indexed access and sorting.
IRefFunction	Functional interface for operations on Cell Refs that may throw a MissingDataException In general, IRefFunction is used to provide a visitor for data objects containing nested Refs.
IValidated	Interface for classes that can be validated
IWriteable
Keyword	Keyword data type.
Keywords	Static Keyword values for configuration maps, records etc.
List<T extends ACell>	Implementation of a list wrapping a vector.
Lists
LongBlob	Wrapper for an 8-byte long as a Blob We use this mainly for efficient management of indexes using Longs in Indexes.
MapEntry<K extends ACell,V extends ACell>	Map.Entry implementation for persistent maps.
MapLeaf<K extends ACell,V extends ACell>	Limited size Persistent Merkle Map implemented as a small sorted list of Key/Value pairs Must be sorted by Key hash value to ensure uniqueness of representation
Maps	Utility class for map functions
MapTree<K extends ACell,V extends ACell>	Persistent Map for large hash maps requiring tree structure.
PeerStatus	Class describing the on-chain state of a Peer declared on the network.
Ref<T extends ACell>	Class representing a smart reference to a decentralised data value.
RefDirect<T extends ACell>	Ref subclass for direct in-memory references.
Refs	Static utilities for working with Refs
Refs.RefTreeStats
RefSoft<T extends ACell>	Reference class implemented via a soft reference and store lookup.
SetLeaf<T extends ACell>	Limited size Persistent Merkle Set implemented as a small sorted list of Values Must be sorted by Key hash value to ensure uniqueness of representation
Sets
SetTree<T extends ACell>	Persistent Set for large hash sets requiring tree structure.
SignedData<T extends ACell>	Node representing a signed data object.
Strings
StringShort	Class representing a short CVM string, backed by a flat Blob Used for most small strings, and acts as the leaf chunk for StringTrees
StringSlice	AString subclass representing a view some String data.
StringTree	String implementation class wrapping a BlobTree.
Symbol	Class representing a Symbol.
Syntax	Class representing a Syntax Object.
Tag	Class containing constant Tag values.
VectorArray<T extends ACell>	Non-canonical vector implementation designed to make operations on small temporary vectors more efficient.
VectorLeaf<T extends ACell>	A Persistent Vector implementation representing 0-16 elements with a packed Vector prefix.
Vectors	Static utility functions for working with Vectors
VectorTree<T extends ACell>	Persistent Vector implemented as a merkle tree of chunks shift indicates the level of the tree: 4 = 1st level, 8 = second etc.