Package convex.core.data

Class Cells

java.lang.Object

convex.core.data.Cells

public class Cells
extends Object

Static utility class for dealing with cells

Field Summary

Fields

Modifier and Type	Field	Description
static final ACell[]	EMPTY_ARRAY	An empty Java array of cells

Constructor Summary

Constructors

Constructor	Description
Cells()

Method Summary

Modifier and Type	Method	Description
static <T extends ACell> T	announce(T a, Consumer<Ref<ACell>> noveltyHandler)	Announces a Cell, reporting as novelty any cells that have not been previously announced
static int	branchCount(ACell a)	Gets the number of Branches directly contained in a Cell (will be zero if the Cell is not a Ref container)
static boolean	equals(ACell a, ACell b)	Equality method allowing for nulls
static ABlobLike<CVMLong>	getEncoding(ACell a)
static Hash	getHash(ACell a)	Gets the Hash (Value ID of a cell)
static <R extends ACell> Ref<R>	getRef(ACell cell, int index)	Gets a Ref from a Cell by index
static boolean	isCompletelyEncoded(ACell a)	Checks if a Cell is completely encoded, i.e.
static boolean	isCVM(ACell a)	Checks if a Cell is a valid CVM value
static boolean	isValue(ACell a)	Checks if a Cell is a first class value
static <T extends ACell> T	persist(T a)	Persist a cell in the current store
static <T extends ACell> T	persist(T a, AStore store)	Persist a cell in the given store
static int	refCount(ACell a)	Gets the number of Refs directly contained in a Cell (will be zero if the Cell is not a Ref container)
static long	storageSize(ACell a)	Get the full storage size of a value, including size of an embedded encoding
static <T extends ACell> T	store(T a, AStore store)	Persist a cell in the given store
static ACell[]	toCellArray(Object anyArray)	Converts any array to an ACell[] array.
static void	visitBranches(ACell a, Consumer<ACell> visitor)	Visit all non-embedded branches from a Cell.
static void	visitBranchRefs(ACell a, Consumer<Ref<?>> visitor)	Visit all non-embedded branches from a Cell.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

EMPTY_ARRAY

public static final ACell[] EMPTY_ARRAY

An empty Java array of cells

Constructor Details

Cells

public Cells()

Method Details

equals

public static boolean equals(ACell a,
 ACell b)

Equality method allowing for nulls

Parameters:

a - First value

b - Second value

Returns:

true if arguments are equal, false otherwise

toCellArray

public static ACell[] toCellArray(Object anyArray)

Converts any array to an ACell[] array. Elements must be Cells.

Parameters:

anyArray - Array to convert

Returns:

ACell[] array

refCount

public static int refCount(ACell a)

Gets the number of Refs directly contained in a Cell (will be zero if the Cell is not a Ref container)

Parameters:

a - Cell to check (may be null)

Returns:

Number of Refs in the object.

branchCount

public static int branchCount(ACell a)

Gets the number of Branches directly contained in a Cell (will be zero if the Cell is not a Ref container)

Parameters:

a - Cell to check (may be null)

Returns:

Number of Refs in the object.

getRef

public static <R extends ACell> Ref<R> getRef(ACell cell,
 int index)

Gets a Ref from a Cell by index

Type Parameters:

R - Type of cell

Parameters:

cell - Cell to read Ref from

index - Numerical index of Ref

Returns:

Ref for cell

Throws:

IndexOutOfBoundsException - if the index is out of range for the Cell

isCVM

public static boolean isCVM(ACell a)

Checks if a Cell is a valid CVM value

Parameters:

a - Cell to check

Returns:

True if CVM VAlue, false otherwise

isCompletelyEncoded

public static boolean isCompletelyEncoded(ACell a)

Checks if a Cell is completely encoded, i.e. has not external Refs

Parameters:

a - Cell to check

Returns:

True if completely encoded, false otherwise

isValue

public static boolean isValue(ACell a)

Checks if a Cell is a first class value

Parameters:

a - Cell to check

Returns:

True if CVM VAlue, false otherwise

persist

public static <T extends ACell> T persist(T a)

Persist a cell in the current store

Parameters:

a - Cell to persist

Returns:

Cell after persisting (may be the same Cell if no change in cell hierarchy)

persist

public static <T extends ACell> T persist(T a,
 AStore store)

Persist a cell in the given store

Parameters:

a - Cell to persist

store - Store instance to persist in

Returns:

Cell after persisting (may be the same Cell if no change in cell hierarchy)

store

public static <T extends ACell> T store(T a,
 AStore store)

Persist a cell in the given store

Parameters:

a - Cell to persist

store - Store instance to persist in

Returns:

Cell after persisting (may be the same Cell if no change in cell hierarchy)

announce

public static <T extends ACell> T announce(T a,
 Consumer<Ref<ACell>> noveltyHandler)

Announces a Cell, reporting as novelty any cells that have not been previously announced

Parameters:

a - Cell to announce

noveltyHandler - Handler for novelty values

Returns:

Cell after announcing (may be the same Cell if no change in cell hierarchy)

getHash

public static Hash getHash(ACell a)

Gets the Hash (Value ID of a cell)

Parameters:

a - Cell to get hash from

Returns:

Hash value

getEncoding

public static ABlobLike<CVMLong> getEncoding(ACell a)

storageSize

public static long storageSize(ACell a)

Get the full storage size of a value, including size of an embedded encoding

Parameters:

a - Cell to get size for (may be null)

Returns:

Storage size

visitBranchRefs

public static void visitBranchRefs(ACell a,
 Consumer<Ref<?>> visitor)

Visit all non-embedded branches from a Cell. Recursively checks embedded children.

Parameters:

a - Cell within which to visit children.

visitor - Visitor instance

visitBranches

public static void visitBranches(ACell a,
 Consumer<ACell> visitor)

Visit all non-embedded branches from a Cell. Recursively checks embedded children. May cause store reads.

Parameters:

a - Cell within which to visit children.

visitor - Visitor instance