Package net.carcdr.ycrdt.jni

Class JniYText

java.lang.Object

net.carcdr.ycrdt.jni.JniYText

All Implemented Interfaces:

AutoCloseable, net.carcdr.ycrdt.YText

public class JniYText
extends Object
implements net.carcdr.ycrdt.YText

YText represents a collaborative text type in a Y-CRDT document.

YText provides efficient collaborative text editing with automatic conflict resolution. Multiple users can edit the same text simultaneously, and changes will be merged automatically using CRDT algorithms.

This class implements Closeable and should be used with try-with-resources to ensure proper cleanup of native resources.

Example usage:

 try (YDoc doc = new YDoc();
      YText text = doc.getText("mytext")) {
     text.insert(0, "Hello");
     text.push(" World");
     System.out.println(text.toString()); // "Hello World"
 }
 

See Also:

• YDoc

Method Summary

Modifier and Type	Method	Description
void	close()	Closes this YText and releases native resources.
void	delete(int index, int length)	Deletes a range of text (creates implicit transaction).
void	delete(net.carcdr.ycrdt.YTransaction txn, int index, int length)	Deletes a range of text within an existing transaction.
void	insert(int index, String chunk)	Inserts text at the specified index (creates implicit transaction).
void	insert(net.carcdr.ycrdt.YTransaction txn, int index, String chunk)	Inserts text at the specified index within an existing transaction.
boolean	isClosed()	Checks if this YText has been closed.
int	length()	Returns the length of the text.
int	length(net.carcdr.ycrdt.YTransaction txn)	Returns the length of the text.
net.carcdr.ycrdt.YSubscription	observe(net.carcdr.ycrdt.YObserver observer)	Registers an observer to be notified of changes to this text.
void	push(String chunk)	Appends text to the end (creates implicit transaction).
void	push(net.carcdr.ycrdt.YTransaction txn, String chunk)	Appends text to the end within an existing transaction.
String	toString()	Returns the text content as a string.
void	unobserveById(long subscriptionId)	Package-private method to unobserve by subscription ID.

Methods inherited from class java.lang.Object

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

Method Details

length

public int length()

Returns the length of the text.

Specified by:

length in interface net.carcdr.ycrdt.YText

Returns:

The number of characters in the text

Throws:

IllegalStateException - if the text has been closed

length

public int length(net.carcdr.ycrdt.YTransaction txn)

Returns the length of the text.

Specified by:

length in interface net.carcdr.ycrdt.YText

Parameters:

txn - The transaction to use for this operation

Returns:

The number of characters in the text

Throws:

IllegalStateException - if the text has been closed

toString

public String toString()

Returns the text content as a string.

Specified by:

toString in interface net.carcdr.ycrdt.YText

Overrides:

toString in class Object

Returns:

The current text content

Throws:

IllegalStateException - if the text has been closed

insert

public void insert(net.carcdr.ycrdt.YTransaction txn,
 int index,
 String chunk)

Inserts text at the specified index within an existing transaction.

Use this method to batch multiple operations:

 try (JniYTransaction txn = doc.beginTransaction()) {
     text.insert(txn, 0, "Hello");
     text.insert(txn, 5, " World");
 }
 

Specified by:

insert in interface net.carcdr.ycrdt.YText

Parameters:

txn - The transaction to use for this operation

index - The position at which to insert the text (0-based)

chunk - The text to insert

Throws:

IllegalArgumentException - if txn or chunk is null

IllegalStateException - if the text has been closed

IndexOutOfBoundsException - if index is negative or greater than the current length

insert

public void insert(int index,
 String chunk)

Inserts text at the specified index (creates implicit transaction).

Specified by:

insert in interface net.carcdr.ycrdt.YText

Parameters:

index - The position at which to insert the text (0-based)

chunk - The text to insert

Throws:

IllegalArgumentException - if chunk is null

IllegalStateException - if the text has been closed

IndexOutOfBoundsException - if index is negative or greater than the current length

push

public void push(net.carcdr.ycrdt.YTransaction txn,
 String chunk)

Appends text to the end within an existing transaction.

Use this method to batch multiple operations:

 try (JniYTransaction txn = doc.beginTransaction()) {
     text.push(txn, "Hello");
     text.push(txn, " World");
 }
 

Specified by:

push in interface net.carcdr.ycrdt.YText

Parameters:

txn - The transaction to use for this operation

chunk - The text to append

Throws:

IllegalArgumentException - if txn or chunk is null

IllegalStateException - if the text has been closed

push

public void push(String chunk)

Appends text to the end (creates implicit transaction).

Specified by:

push in interface net.carcdr.ycrdt.YText

Parameters:

chunk - The text to append

Throws:

IllegalArgumentException - if chunk is null

IllegalStateException - if the text has been closed

delete

public void delete(net.carcdr.ycrdt.YTransaction txn,
 int index,
 int length)

Deletes a range of text within an existing transaction.

Use this method to batch multiple operations:

 try (JniYTransaction txn = doc.beginTransaction()) {
     text.insert(txn, 0, "Hello World");
     text.delete(txn, 5, 6); // Delete " World"
 }
 

Specified by:

delete in interface net.carcdr.ycrdt.YText

Parameters:

txn - The transaction to use for this operation

index - The starting position (0-based)

length - The number of characters to delete

Throws:

IllegalArgumentException - if txn is null

IllegalStateException - if the text has been closed

IndexOutOfBoundsException - if the range is invalid

delete

public void delete(int index,
 int length)

Deletes a range of text (creates implicit transaction).

Specified by:

delete in interface net.carcdr.ycrdt.YText

Parameters:

index - The starting position (0-based)

length - The number of characters to delete

Throws:

IllegalStateException - if the text has been closed

IndexOutOfBoundsException - if the range is invalid

isClosed

public boolean isClosed()

Checks if this YText has been closed.

Specified by:

isClosed in interface net.carcdr.ycrdt.YText

Returns:

true if this YText has been closed, false otherwise

observe

public net.carcdr.ycrdt.YSubscription observe(net.carcdr.ycrdt.YObserver observer)

Registers an observer to be notified of changes to this text.

The observer will be called whenever this text is modified. Multiple observers can be registered on the same text.

Example:

 try (YSubscription sub = text.observe(event -> {
     System.out.println("Text changed!");
     for (YChange change : event.getChanges()) {
         System.out.println("  " + change);
     }
 })) {
     text.insert(0, "Hello"); // Triggers observer
 }
 

Specified by:

observe in interface net.carcdr.ycrdt.YText

Parameters:

observer - the observer to register

Returns:

a subscription handle that can be used to unobserve

Throws:

IllegalArgumentException - if observer is null

IllegalStateException - if this text has been closed

unobserveById

public void unobserveById(long subscriptionId)

Package-private method to unobserve by subscription ID. Called by YSubscription.close().

Parameters:

subscriptionId - the subscription ID to remove

close

public void close()

Closes this YText and releases native resources.

After calling this method, any operations on this YText will throw IllegalStateException.

This method is idempotent - calling it multiple times has no effect after the first call.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface net.carcdr.ycrdt.YText