Package net.carcdr.ycrdt

Interface YDoc

All Superinterfaces:

AutoCloseable

public interface YDoc
extends AutoCloseable

A collaborative document containing shared types. YDoc is the root container for all Y-CRDT data structures.

Method Summary

Modifier and Type	Method	Description
void	applyUpdate(byte[] update)	Applies an update to this document.
void	applyUpdate(YTransaction txn, byte[] update)	Applies an update to this document within a transaction.
YTransaction	beginTransaction()	Begins a new transaction for batching operations.
void	close()	Closes this document and releases all resources.
byte[]	encodeDiff(byte[] stateVector)	Encodes the difference between this document and the given state vector.
byte[]	encodeDiff(YTransaction txn, byte[] stateVector)	Encodes the difference between this document and the given state vector within a transaction.
byte[]	encodeStateAsUpdate()	Encodes the entire document state as an update.
byte[]	encodeStateAsUpdate(YTransaction txn)	Encodes the entire document state as an update within a transaction.
byte[]	encodeStateVector()	Encodes the state vector of this document.
byte[]	encodeStateVector(YTransaction txn)	Encodes the state vector of this document within a transaction.
YArray	getArray(String name)	Gets or creates a collaborative array with the given name.
long	getClientId()	Returns the client ID for this document.
String	getGuid()	Returns the globally unique identifier for this document.
YMap	getMap(String name)	Gets or creates a collaborative map with the given name.
ObserverErrorHandler	getObserverErrorHandler()	Gets the current error handler for observer exceptions.
YText	getText(String name)	Gets or creates a collaborative text with the given name.
YXmlElement	getXmlElement(String name)	Gets or creates a collaborative XML element with the given name.
YXmlFragment	getXmlFragment(String name)	Gets or creates a collaborative XML fragment with the given name.
YXmlText	getXmlText(String name)	Gets or creates a collaborative XML text with the given name.
boolean	isClosed()	Checks if this document has been closed.
YSubscription	observeUpdateV1(UpdateObserver observer)	Registers an observer for document updates.
void	setObserverErrorHandler(ObserverErrorHandler handler)	Sets the error handler for observer exceptions.
void	transaction(Consumer<YTransaction> fn)	Executes a function within a transaction.

Method Details

getClientId

long getClientId()

Returns the client ID for this document.

Returns:

the client ID

getGuid

String getGuid()

Returns the globally unique identifier for this document.

Returns:

the GUID

encodeStateAsUpdate

byte[] encodeStateAsUpdate()

Encodes the entire document state as an update.

Returns:

the encoded update

encodeStateAsUpdate

byte[] encodeStateAsUpdate(YTransaction txn)

Encodes the entire document state as an update within a transaction.

Parameters:

txn - the transaction

Returns:

the encoded update

applyUpdate

void applyUpdate(byte[] update)

Applies an update to this document.

Parameters:

update - the update to apply

applyUpdate

void applyUpdate(YTransaction txn,
 byte[] update)

Applies an update to this document within a transaction.

Parameters:

txn - the transaction

update - the update to apply

encodeStateVector

byte[] encodeStateVector()

Encodes the state vector of this document.

Returns:

the encoded state vector

encodeStateVector

byte[] encodeStateVector(YTransaction txn)

Encodes the state vector of this document within a transaction.

Parameters:

txn - the transaction

Returns:

the encoded state vector

encodeDiff

byte[] encodeDiff(byte[] stateVector)

Encodes the difference between this document and the given state vector.

Parameters:

stateVector - the remote state vector

Returns:

the encoded diff

encodeDiff

byte[] encodeDiff(YTransaction txn,
 byte[] stateVector)

Encodes the difference between this document and the given state vector within a transaction.

Parameters:

txn - the transaction

stateVector - the remote state vector

Returns:

the encoded diff

getText

YText getText(String name)

Gets or creates a collaborative text with the given name.

Parameters:

name - the name of the text

Returns:

the text instance

getArray

YArray getArray(String name)

Gets or creates a collaborative array with the given name.

Parameters:

name - the name of the array

Returns:

the array instance

getMap

YMap getMap(String name)

Gets or creates a collaborative map with the given name.

Parameters:

name - the name of the map

Returns:

the map instance

getXmlText

YXmlText getXmlText(String name)

Gets or creates a collaborative XML text with the given name.

Parameters:

name - the name of the XML text

Returns:

the XML text instance

getXmlElement

YXmlElement getXmlElement(String name)

Gets or creates a collaborative XML element with the given name.

Parameters:

name - the name of the XML element

Returns:

the XML element instance

getXmlFragment

YXmlFragment getXmlFragment(String name)

Gets or creates a collaborative XML fragment with the given name.

Parameters:

name - the name of the XML fragment

Returns:

the XML fragment instance

beginTransaction

YTransaction beginTransaction()

Begins a new transaction for batching operations.

Returns:

the transaction

transaction

void transaction(Consumer<YTransaction> fn)

Executes a function within a transaction.

Parameters:

fn - the function to execute

observeUpdateV1

YSubscription observeUpdateV1(UpdateObserver observer)

Registers an observer for document updates.

Parameters:

observer - the observer to register

Returns:

a subscription handle for unregistering

setObserverErrorHandler

void setObserverErrorHandler(ObserverErrorHandler handler)

Sets the error handler for observer exceptions.

When an observer throws an exception, this handler will be called instead of letting the exception propagate. The default handler prints to stderr for backwards compatibility.

Parameters:

handler - the error handler to use, or null to use the default handler

See Also:

• ObserverErrorHandler
• DefaultObserverErrorHandler

getObserverErrorHandler

ObserverErrorHandler getObserverErrorHandler()

Gets the current error handler for observer exceptions.

Returns:

the current error handler (never null)

close

void close()

Closes this document and releases all resources.

Specified by:

close in interface AutoCloseable

isClosed

boolean isClosed()

Checks if this document has been closed.

Returns:

true if closed, false otherwise