Package net.carcdr.ycrdt

Interface YText

All Superinterfaces:

AutoCloseable

public interface YText
extends AutoCloseable

A collaborative text type that supports concurrent editing.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes this text and releases resources.
void	delete(int index, int length)	Deletes text at the specified range.
void	delete(YTransaction txn, int index, int length)	Deletes text at the specified range within a transaction.
void	insert(int index, String chunk)	Inserts text at the specified index.
void	insert(YTransaction txn, int index, String chunk)	Inserts text at the specified index within a transaction.
boolean	isClosed()	Checks if this text has been closed.
int	length()	Returns the length of the text.
int	length(YTransaction txn)	Returns the length of the text within a transaction.
YSubscription	observe(YObserver observer)	Registers an observer for changes to this text.
void	push(String chunk)	Appends text to the end.
void	push(YTransaction txn, String chunk)	Appends text to the end within a transaction.
String	toString()	Returns the text content.

Method Details

length

int length()

Returns the length of the text.

Returns:

the number of characters

length

int length(YTransaction txn)

Returns the length of the text within a transaction.

Parameters:

txn - the transaction

Returns:

the number of characters

toString

String toString()

Returns the text content.

Overrides:

toString in class Object

Returns:

the text as a string

insert

void insert(int index,
 String chunk)

Inserts text at the specified index.

Parameters:

index - the position to insert at

chunk - the text to insert

insert

void insert(YTransaction txn,
 int index,
 String chunk)

Inserts text at the specified index within a transaction.

Parameters:

txn - the transaction

index - the position to insert at

chunk - the text to insert

push

void push(String chunk)

Appends text to the end.

Parameters:

chunk - the text to append

push

void push(YTransaction txn,
 String chunk)

Appends text to the end within a transaction.

Parameters:

txn - the transaction

chunk - the text to append

delete

void delete(int index,
 int length)

Deletes text at the specified range.

Parameters:

index - the start position

length - the number of characters to delete

delete

void delete(YTransaction txn,
 int index,
 int length)

Deletes text at the specified range within a transaction.

Parameters:

txn - the transaction

index - the start position

length - the number of characters to delete

observe

YSubscription observe(YObserver observer)

Registers an observer for changes to this text.

Parameters:

observer - the observer to register

Returns:

a subscription handle for unregistering

close

void close()

Closes this text and releases resources.

Specified by:

close in interface AutoCloseable

isClosed

boolean isClosed()

Checks if this text has been closed.

Returns:

true if closed, false otherwise