Uses of Class
convex.core.data.Ref

Packages that use Ref

Package	Description
convex.core	Fundamental Convex classes used for the decentralised network
convex.core.data	Data structures and algorithms, including a complete set of classes required to implement immutable, decentralised data objects.
convex.core.data.prim	Implementation of CVM Primitive Data types
convex.core.lang.impl	Internal CVM language implementation classes
convex.core.lang.ops	CVM Operations, effectively the "machine code" of the CVM
convex.core.store	Etch database for convergent immutable storage
convex.core.transactions	Convex network transaction types.
convex.core.util	Convex utility classes and miscellaneous functionality
etch	Convex network transaction types.

Uses of Ref in convex.core

Methods in convex.core that return Ref

Modifier and Type	Method	Description
<R extends ACell> Ref<R>	Order.getRef(int i)
<R extends ACell> Ref<R>	State.getRef(int i)

Method parameters in convex.core with type arguments of type Ref

Modifier and Type	Method	Description
Peer	Peer.persistState(Consumer<Ref<ACell>> noveltyHandler)	Persist the state of the Peer to the current store.

Uses of Ref in convex.core.data

Subclasses of Ref in convex.core.data

Modifier and Type	Class	Description
class	RefDirect<T extends ACell>	Ref subclass for direct in-memory references.
class	RefSoft<T extends ACell>	Reference class implemented via a soft reference and store lookup.

Fields in convex.core.data declared as Ref

Modifier and Type	Field	Description
protected Ref<ACell>	ACell.cachedRef	Cached Ref.
static Ref<List<?>>	List.EMPTY_REF
static Ref<SetLeaf>	Sets.EMPTY_REF
static Ref<VectorLeaf<?>>	VectorLeaf.EMPTY_REF

Methods in convex.core.data that return Ref

Modifier and Type	Method	Description
Ref<?>	IRefFunction.apply(Ref<?> t)
protected Ref<T>	AHashSet.applyOp(int setOp, Ref<T> a, Ref<T> b)
static <T extends ACell> Ref<T>[]	Ref.createArray(T[] values)
static <T extends ACell> Ref<T>	ACell.createPersisted(T value)	Creates a persisted Ref with the given value in the current store.
static <T extends ACell> Ref<T>	ACell.createPersisted(T value, Consumer<Ref<ACell>> noveltyHandler)	Creates a persisted Ref with the given value in the current store.
protected <R extends ACell> Ref<R>	AccountKey.createRef()
protected <R extends ACell> Ref<R>	ACell.createRef()	Creates a new Ref for this Cell
protected <R extends ACell> Ref<R>	ALongBlob.createRef()
protected <R extends ACell> Ref<R>	ASymbolic.createRef()
static <K extends ACell, V extends ACell, R extends AMap<K, V>> Ref<R>	Maps.emptyRef()
static <T extends ACell> Ref<SetLeaf<T>>	Sets.emptyRef()
abstract Ref<T>	Ref.ensureCanonical()	Ensures this Ref is canonical
Ref<T>	RefSoft.ensureCanonical()
static <T extends ACell> Ref<T>	Ref.get(Object value)
static <T extends ACell> Ref<T>	Ref.get(T value)	Returns a direct Ref wrapping the given value.
<R extends ACell> Ref<R>[]	ACell.getChildRefs()	Gets an array of child Refs for this Cell, in the same order as order accessible by getRef.
Ref<T>	SignedData.getDataRef()
Ref<CVMByte>	ABlob.getElementRef(long index)
abstract Ref<E>	ACountable.getElementRef(long index)	Gets a Ref to the element at the specified index in this collection
Ref<MapEntry<K,V>>	AMap.getElementRef(long index)
abstract Ref<T>	ASequence.getElementRef(long index)	Gets the element Ref at the specified index
Ref<CVMChar>	AString.getElementRef(long i)
Ref<T>	List.getElementRef(long i)
Ref<ACell>	MapEntry.getElementRef(long i)
Ref<T>	SetLeaf.getElementRef(long i)
Ref<T>	SetTree.getElementRef(long i)
Ref<T>	VectorArray.getElementRef(long index)
Ref<T>	VectorLeaf.getElementRef(long i)
Ref<T>	VectorTree.getElementRef(long i)
Ref<K>	MapEntry.getKeyRef()
abstract <R extends ACell> Ref<R>	ABlobMap.getRef(int i)
<R extends ACell> Ref<R>	AccountStatus.getRef(int i)
<R extends ACell> Ref<R>	ACell.getRef()	Gets the Ref for this Cell, creating a new direct reference if necessary
<R extends ACell> Ref<R>	ACell.getRef(int i)	Gets a numbered child Ref from within this Cell.
abstract <R extends ACell> Ref<R>	AMapEntry.getRef(int i)
<R extends ACell> Ref<R>	ARecord.getRef(int index)
<R extends ACell> Ref<R>	ARecordGeneric.getRef(int index)
<R extends ACell> Ref<R>	BlobMap.getRef(int i)
<R extends ACell> Ref<R>	BlobTree.getRef(int i)
<R extends ACell> Ref<R>	List.getRef(int i)
<R extends ACell> Ref<R>	MapEntry.getRef(int i)
<R extends ACell> Ref<R>	MapLeaf.getRef(int i)
<R extends ACell> Ref<R>	MapTree.getRef(int i)
Ref<T>	SetLeaf.getRef(int i)
<R extends ACell> Ref<R>	SetTree.getRef(int i)
<R extends ACell> Ref<R>	SignedData.getRef(int i)
<R extends ACell> Ref<R>	StringTree.getRef(int i)
<R extends ACell> Ref<R>	Syntax.getRef(int i)
<R extends ACell> Ref<R>	VectorLeaf.getRef(int i)
<R extends ACell> Ref<R>	VectorTree.getRef(int i)
protected abstract Ref<T>	ASet.getRefByHash(Hash hash)	Gets the Ref in the Set for a given hash, or null if not found
protected Ref<T>	SetLeaf.getRefByHash(Hash hash)
protected Ref<T>	SetTree.getRefByHash(Hash hash)
abstract Ref<T>	ASet.getValueRef(ACell k)	Gets the Ref in the Set for a given value, or null if not found
Ref<V>	MapEntry.getValueRef()
Ref<T>	SetLeaf.getValueRef(ACell k)
Ref<T>	SetTree.getValueRef(ACell k)
Ref<T>	Ref.markEmbedded(boolean isEmbedded)
<R extends ACell> Ref<R>	Ref.persist()	Persists this Ref in the current store if not embedded and not already persisted.
<R extends ACell> Ref<R>	Ref.persist(Consumer<Ref<ACell>> noveltyHandler)	Persists this Ref in the current store if not embedded and not already persisted.
<R extends ACell> Ref<R>	Ref.persistShallow()	Persists a Ref shallowly in the current store.
<R extends ACell> Ref<R>	Ref.persistShallow(Consumer<Ref<ACell>> noveltyHandler)	Persists a Ref shallowly in the current store.
static <T extends ACell> Ref<T>	Ref.readRaw(ByteBuffer data)	Reads a ref from the given ByteBuffer.
static <T extends ACell> Ref<T>	Format.readRef(ByteBuffer bb)	Reads a Ref or embedded Cell value from the ByteBuffer.
Ref<T>	Ref.setFlags(int newFlags)	Sets the Flags for this Ref.
Ref<T>	Ref.toDirect()	Converts this Ref to a RefDirect
Ref<T>	RefDirect.toDirect()
static <T extends ACell> Ref<T>[]	Ref.updateRefs(Ref<T>[] refs, IRefFunction func)	Updates an array of Refs with the given function.
abstract Ref<T>	Ref.withFlags(int newFlags)	Create a new Ref of the same type with updated flags
Ref<T>	Ref.withMinimumStatus(int newStatus)	Ensures the Ref has the given status, at minimum Assumes any necessary changes to storage will be made separately.
abstract Ref<T>	Ref.withValue(T newValue)	Updates the value stored within this Ref.
Ref<T>	RefDirect.withValue(T newValue)
Ref<T>	RefSoft.withValue(T newValue)

Methods in convex.core.data that return types with arguments of type Ref

Modifier and Type	Method	Description
static Set<Ref<?>>	Ref.accumulateRefSet(Object a)	Accumulates the set of all unique Refs in the given object.

Methods in convex.core.data with parameters of type Ref

Modifier and Type	Method	Description
Ref<?>	IRefFunction.apply(Ref<?> t)
protected Ref<T>	AHashSet.applyOp(int setOp, Ref<T> a, Ref<T> b)
abstract AHashMap<K,V>	AHashMap.assocRef(Ref<K> keyRef, V value)
protected abstract AHashMap<K,V>	AHashMap.assocRef(Ref<K> keyRef, V value, int shift)
AHashMap<K,V>	MapLeaf.assocRef(Ref<K> keyRef, V value)
protected AHashMap<K,V>	MapLeaf.assocRef(Ref<K> keyRef, V value, int shift)
MapTree<K,V>	MapTree.assocRef(Ref<K> keyRef, V value)
protected MapTree<K,V>	MapTree.assocRef(Ref<K> keyRef, V value, int shift)
void	ACell.attachRef(Ref<?> ref)	Updates the cached ref of this Cell
int	Ref.compareTo(Ref<T> a)
boolean	AMap.containsKeyRef(Ref<ACell> ref)
static <V extends ACell> SetLeaf<V>	SetLeaf.create(Ref<V>... elements)	Creates a SetLeaf with the specified elements.
protected static <V extends ACell> SetLeaf<V>	SetLeaf.create(Ref<V>[] entries, int offset, int length)	Creates a SetLeaf with the specified elements.
static <V extends ACell> SetTree<V>	SetTree.create(Ref<V>[] elementRefs, int shift)	Create a SetTree given a number of element Refs to distribute among children.
static SignedData<ATransaction>	SignedData.create(AKeyPair kp, ASignature sig, Ref<ATransaction> ref)
static <T extends ACell> SignedData<T>	SignedData.create(AccountKey address, ASignature sig, Ref<T> ref)	Creates a SignedData object with the given parameters.
static <K extends ACell, V extends ACell> MapEntry<K,V>	MapEntry.createRef(Ref<? extends K> keyRef, Ref<? extends V> valueRef)
static <T extends ACell> SignedData<T>	SignedData.createWithRef(AKeyPair keyPair, Ref<T> ref)	Signs a data value Ref with the given keypair.
abstract AHashMap<K,V>	AHashMap.dissocRef(Ref<K> key)	Dissoc given a Ref to the key value.
MapLeaf<K,V>	MapLeaf.dissocRef(Ref<K> key)
AHashMap<K,V>	MapTree.dissocRef(Ref<K> keyRef)
abstract boolean	Ref.equals(Ref<T> a)	Checks if two Ref Values are equal.
boolean	RefDirect.equals(Ref<T> a)
boolean	RefSoft.equals(Ref<T> a)
abstract AHashSet<T>	AHashSet.excludeRef(Ref<T> valueRef)
SetLeaf<T>	SetLeaf.excludeRef(Ref<T> key)
AHashSet<T>	SetTree.excludeRef(Ref<T> keyRef)
MapEntry<K,V>	ABlobMap.getKeyRefEntry(Ref<ACell> ref)
abstract MapEntry<K,V>	AMap.getKeyRefEntry(Ref<ACell> ref)	Get an entry given a Ref to the key value.
MapEntry<Keyword,ACell>	ARecord.getKeyRefEntry(Ref<ACell> ref)
MapEntry<K,V>	MapLeaf.getKeyRefEntry(Ref<ACell> ref)
MapEntry<K,V>	MapTree.getKeyRefEntry(Ref<ACell> ref)
abstract AHashSet<T>	AHashSet.includeRef(Ref<T> ref)
protected abstract AHashSet<T>	AHashSet.includeRef(Ref<T> e, int i)
abstract ASet<T>	ASet.includeRef(Ref<T> ref)	Adds a value to this set using a Ref to the value
AHashSet<T>	SetLeaf.includeRef(Ref<T> ref)
protected AHashSet<T>	SetLeaf.includeRef(Ref<T> e, int shift)
AHashSet<T>	SetTree.includeRef(Ref<T> ref)
protected SetTree<T>	SetTree.includeRef(Ref<T> e, int shift)
protected AHashSet<T>	SetTree.replaceChild(int i, Ref<AHashSet<T>> newChild)	Replaces the child ref at a given index position.
static <V extends ACell> SetLeaf<V>	SetLeaf.unsafeCreate(Ref<V>... refs)	Create a SetLeaf with raw element Refs.
static <T extends ACell> SetTree<T>	SetTree.unsafeCreate(Ref<AHashSet<T>>[] children, int shift, short mask, long count)
static <T extends ACell> Ref<T>[]	Ref.updateRefs(Ref<T>[] refs, IRefFunction func)	Updates an array of Refs with the given function.

Method parameters in convex.core.data with type arguments of type Ref

Modifier and Type	Method	Description
<T extends ACell> T	ACell.announce(Consumer<Ref<ACell>> noveltyHandler)
static <T extends ACell> T	ACell.createAnnounced(T value, Consumer<Ref<ACell>> noveltyHandler)	Creates an ANNOUNCED Ref with the given value in the current store.
static <T extends ACell> Ref<T>	ACell.createPersisted(T value, Consumer<Ref<ACell>> noveltyHandler)	Creates a persisted Ref with the given value in the current store.
static <T extends ACell> AHashSet<T>	Sets.createWithShift(int shift, ArrayList<Ref<T>> values)
<T extends ACell> T	ACell.mark(Consumer<Ref<ACell>> noveltyHandler)
<R extends ACell> Ref<R>	Ref.persist(Consumer<Ref<ACell>> noveltyHandler)	Persists this Ref in the current store if not embedded and not already persisted.
<R extends ACell> Ref<R>	Ref.persistShallow(Consumer<Ref<ACell>> noveltyHandler)	Persists a Ref shallowly in the current store.
abstract void	ASequence.visitElementRefs(Consumer<Ref<T>> f)	Visits all elements in this sequence, calling the specified consumer for each.
void	List.visitElementRefs(Consumer<Ref<T>> f)
void	MapEntry.visitElementRefs(Consumer<Ref<ACell>> f)
void	VectorArray.visitElementRefs(Consumer<Ref<T>> f)
void	VectorLeaf.visitElementRefs(Consumer<Ref<T>> f)
void	VectorTree.visitElementRefs(Consumer<Ref<T>> f)

Constructors in convex.core.data with parameters of type Ref

Modifier	Constructor	Description
protected	BlobMap(long depth, long prefixLength, MapEntry<K,V> entry, Ref<BlobMap>[] entries, short mask, long count)

Uses of Ref in convex.core.data.prim

Methods in convex.core.data.prim that return Ref

Modifier and Type	Method	Description
protected <R extends ACell> Ref<R>	APrimitive.createRef()

Uses of Ref in convex.core.lang.impl

Methods in convex.core.lang.impl that return Ref

Modifier and Type	Method	Description
<R extends ACell> Ref<R>	CoreFn.getRef(int i)
<R extends ACell> Ref<R>	Fn.getRef(int i)
<R extends ACell> Ref<R>	MultiFn.getRef(int i)

Uses of Ref in convex.core.lang.ops

Methods in convex.core.lang.ops that return Ref

Modifier and Type	Method	Description
<R extends ACell> Ref<R>	AMultiOp.getRef(int i)
<R extends ACell> Ref<R>	Constant.getRef(int i)
Ref<AOp<T>>	Def.getRef(int i)
<R extends ACell> Ref<R>	Lambda.getRef(int i)
<R extends ACell> Ref<R>	Let.getRef(int i)
<R extends ACell> Ref<R>	Lookup.getRef(int i)
Ref<AOp<T>>	Set.getRef(int i)

Methods in convex.core.lang.ops with parameters of type Ref

Modifier and Type	Method	Description
static <T extends ACell> Def<T>	Def.create(ACell key, Ref<AOp<T>> op)
static <T extends ACell> Def<T>	Def.create(Syntax key, Ref<AOp<T>> op)
static <T extends ACell> Constant<T>	Constant.createFromRef(Ref<T> valueRef)

Constructors in convex.core.lang.ops with parameters of type Ref

Modifier	Constructor	Description
protected	Lambda(Ref<AClosure<T>> newFunction)

Uses of Ref in convex.core.store

Methods in convex.core.store that return Ref

Modifier and Type	Method	Description
<T extends ACell> Ref<T>	MemoryStore.persistRef(Ref<T> ref, Consumer<Ref<ACell>> noveltyHandler, int requiredStatus, boolean topLevel)
abstract <T extends ACell> Ref<T>	AStore.refForHash(Hash hash)	Gets the stored Ref for a given hash value, or null if not found.
<T extends ACell> Ref<T>	MemoryStore.refForHash(Hash hash)
abstract <T extends ACell> Ref<T>	AStore.storeRef(Ref<T> ref, int status, Consumer<Ref<ACell>> noveltyHandler)	Stores a @Ref in long term storage as defined by this store implementation.
<T extends ACell> Ref<T>	MemoryStore.storeRef(Ref<T> r2, int status, Consumer<Ref<ACell>> noveltyHandler)
abstract <T extends ACell> Ref<T>	AStore.storeTopRef(Ref<T> ref, int status, Consumer<Ref<ACell>> noveltyHandler)	Stores a top level @Ref in long term storage as defined by this store implementation.
<T extends ACell> Ref<T>	MemoryStore.storeTopRef(Ref<T> ref, int status, Consumer<Ref<ACell>> noveltyHandler)

Methods in convex.core.store with parameters of type Ref

Modifier and Type	Method	Description
<T extends ACell> Ref<T>	MemoryStore.persistRef(Ref<T> ref, Consumer<Ref<ACell>> noveltyHandler, int requiredStatus, boolean topLevel)
abstract <T extends ACell> Ref<T>	AStore.storeRef(Ref<T> ref, int status, Consumer<Ref<ACell>> noveltyHandler)	Stores a @Ref in long term storage as defined by this store implementation.
<T extends ACell> Ref<T>	MemoryStore.storeRef(Ref<T> r2, int status, Consumer<Ref<ACell>> noveltyHandler)
abstract <T extends ACell> Ref<T>	AStore.storeTopRef(Ref<T> ref, int status, Consumer<Ref<ACell>> noveltyHandler)	Stores a top level @Ref in long term storage as defined by this store implementation.
<T extends ACell> Ref<T>	MemoryStore.storeTopRef(Ref<T> ref, int status, Consumer<Ref<ACell>> noveltyHandler)

Method parameters in convex.core.store with type arguments of type Ref

Modifier and Type	Method	Description
<T extends ACell> Ref<T>	MemoryStore.persistRef(Ref<T> ref, Consumer<Ref<ACell>> noveltyHandler, int requiredStatus, boolean topLevel)
abstract <T extends ACell> Ref<T>	AStore.storeRef(Ref<T> ref, int status, Consumer<Ref<ACell>> noveltyHandler)	Stores a @Ref in long term storage as defined by this store implementation.
<T extends ACell> Ref<T>	MemoryStore.storeRef(Ref<T> r2, int status, Consumer<Ref<ACell>> noveltyHandler)
abstract <T extends ACell> Ref<T>	AStore.storeTopRef(Ref<T> ref, int status, Consumer<Ref<ACell>> noveltyHandler)	Stores a top level @Ref in long term storage as defined by this store implementation.
<T extends ACell> Ref<T>	MemoryStore.storeTopRef(Ref<T> ref, int status, Consumer<Ref<ACell>> noveltyHandler)

Uses of Ref in convex.core.transactions

Methods in convex.core.transactions that return Ref

Modifier and Type	Method	Description
<T extends ACell> Ref<T>	Call.getRef(int i)
<R extends ACell> Ref<R>	Invoke.getRef(int i)

Uses of Ref in convex.core.util

Methods in convex.core.util that return Ref

Modifier and Type	Method	Description
static <R extends ACell> Ref<R>	Utils.getRef(ACell o, int i)

Uses of Ref in etch

Methods in etch that return Ref

Modifier and Type	Method	Description
Ref<ACell>	Etch.read(AArrayBlob key)	Reads a Blob from the database, returning null if not found
<T extends ACell> Ref<T>	EtchStore.refForHash(Hash hash)
<T extends ACell> Ref<T>	EtchStore.storeRef(Ref<T> ref, int status, Consumer<Ref<ACell>> noveltyHandler)
<T extends ACell> Ref<T>	EtchStore.storeRef(Ref<T> ref, Consumer<Ref<ACell>> noveltyHandler, int requiredStatus, boolean topLevel)
<T extends ACell> Ref<T>	EtchStore.storeTopRef(Ref<T> ref, int status, Consumer<Ref<ACell>> noveltyHandler)
Ref<ACell>	Etch.write(AArrayBlob key, Ref<ACell> value)	Writes a key / value pair to the immutable store.

Methods in etch with parameters of type Ref

Modifier and Type	Method	Description
<T extends ACell> Ref<T>	EtchStore.storeRef(Ref<T> ref, int status, Consumer<Ref<ACell>> noveltyHandler)
<T extends ACell> Ref<T>	EtchStore.storeRef(Ref<T> ref, Consumer<Ref<ACell>> noveltyHandler, int requiredStatus, boolean topLevel)
<T extends ACell> Ref<T>	EtchStore.storeTopRef(Ref<T> ref, int status, Consumer<Ref<ACell>> noveltyHandler)
Ref<ACell>	Etch.write(AArrayBlob key, Ref<ACell> value)	Writes a key / value pair to the immutable store.

Method parameters in etch with type arguments of type Ref

Modifier and Type	Method	Description
void	EtchStore.mark(Collection<ACell> roots, Consumer<Ref<ACell>> handler)	Mark GC roots for retention during garbage collection
<T extends ACell> Ref<T>	EtchStore.storeRef(Ref<T> ref, int status, Consumer<Ref<ACell>> noveltyHandler)
<T extends ACell> Ref<T>	EtchStore.storeRef(Ref<T> ref, Consumer<Ref<ACell>> noveltyHandler, int requiredStatus, boolean topLevel)
<T extends ACell> Ref<T>	EtchStore.storeTopRef(Ref<T> ref, int status, Consumer<Ref<ACell>> noveltyHandler)