Package net.carcdr.ycrdt

Interface YBinding

public interface YBinding

Factory for creating Y-CRDT documents. Implementations are discovered via ServiceLoader.

Method Summary

Modifier and Type	Method	Description
YDoc	createDoc()	Creates a new document with a random client ID.
YDoc	createDoc(long clientId)	Creates a new document with the specified client ID.
byte[]	encodeStateVectorFromUpdate(byte[] update)	Extracts a state vector from an encoded update.
static YBinding	getInstance()	Returns the default binding discovered via ServiceLoader.
byte[]	mergeUpdates(byte[][] updates)	Merges multiple updates into a single update.

Method Details

createDoc

YDoc createDoc()

Creates a new document with a random client ID.

Returns:

the new document

createDoc

YDoc createDoc(long clientId)

Creates a new document with the specified client ID.

Parameters:

clientId - the client ID

Returns:

the new document

mergeUpdates

byte[] mergeUpdates(byte[][] updates)

Merges multiple updates into a single update.

Parameters:

updates - the updates to merge

Returns:

the merged update

encodeStateVectorFromUpdate

byte[] encodeStateVectorFromUpdate(byte[] update)

Extracts a state vector from an encoded update.

Parameters:

update - the encoded update

Returns:

the state vector

getInstance

static YBinding getInstance()

Returns the default binding discovered via ServiceLoader.

Returns:

the binding instance

Throws:

IllegalStateException - if no binding is found