Package net.carcdr.ycrdt

Interface YArray

All Superinterfaces:

AutoCloseable

public interface YArray
extends AutoCloseable

A collaborative array type that supports concurrent editing.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes this array and releases resources.
YDoc	getDoc(int index)	Gets a subdocument at the specified index.
YDoc	getDoc(YTransaction txn, int index)	Gets a subdocument at the specified index within a transaction.
double	getDouble(int index)	Gets a double value at the specified index.
double	getDouble(YTransaction txn, int index)	Gets a double value at the specified index within a transaction.
String	getString(int index)	Gets a string value at the specified index.
String	getString(YTransaction txn, int index)	Gets a string value at the specified index within a transaction.
void	insertDoc(int index, YDoc subdoc)	Inserts a subdocument at the specified index.
void	insertDoc(YTransaction txn, int index, YDoc subdoc)	Inserts a subdocument at the specified index within a transaction.
void	insertDouble(int index, double value)	Inserts a double at the specified index.
void	insertDouble(YTransaction txn, int index, double value)	Inserts a double at the specified index within a transaction.
void	insertString(int index, String value)	Inserts a string at the specified index.
void	insertString(YTransaction txn, int index, String value)	Inserts a string at the specified index within a transaction.
boolean	isClosed()	Checks if this array has been closed.
int	length()	Returns the length of the array.
int	length(YTransaction txn)	Returns the length of the array within a transaction.
YSubscription	observe(YObserver observer)	Registers an observer for changes to this array.
void	pushDoc(YDoc subdoc)	Appends a subdocument to the end.
void	pushDoc(YTransaction txn, YDoc subdoc)	Appends a subdocument to the end within a transaction.
void	pushDouble(double value)	Appends a double to the end.
void	pushDouble(YTransaction txn, double value)	Appends a double to the end within a transaction.
void	pushString(String value)	Appends a string to the end.
void	pushString(YTransaction txn, String value)	Appends a string to the end within a transaction.
void	remove(int index, int length)	Removes elements at the specified range.
void	remove(YTransaction txn, int index, int length)	Removes elements at the specified range within a transaction.
String	toJson()	Returns a JSON representation of this array.
String	toJson(YTransaction txn)	Returns a JSON representation of this array within a transaction.

Method Details

length

int length()

Returns the length of the array.

Returns:

the number of elements

length

int length(YTransaction txn)

Returns the length of the array within a transaction.

Parameters:

txn - the transaction

Returns:

the number of elements

getString

String getString(int index)

Gets a string value at the specified index.

Parameters:

index - the index

Returns:

the string value

getString

String getString(YTransaction txn,
 int index)

Gets a string value at the specified index within a transaction.

Parameters:

txn - the transaction

index - the index

Returns:

the string value

insertString

void insertString(int index,
 String value)

Inserts a string at the specified index.

Parameters:

index - the index

value - the value to insert

insertString

void insertString(YTransaction txn,
 int index,
 String value)

Inserts a string at the specified index within a transaction.

Parameters:

txn - the transaction

index - the index

value - the value to insert

pushString

void pushString(String value)

Appends a string to the end.

Parameters:

value - the value to append

pushString

void pushString(YTransaction txn,
 String value)

Appends a string to the end within a transaction.

Parameters:

txn - the transaction

value - the value to append

getDouble

double getDouble(int index)

Gets a double value at the specified index.

Parameters:

index - the index

Returns:

the double value

getDouble

double getDouble(YTransaction txn,
 int index)

Gets a double value at the specified index within a transaction.

Parameters:

txn - the transaction

index - the index

Returns:

the double value

insertDouble

void insertDouble(int index,
 double value)

Inserts a double at the specified index.

Parameters:

index - the index

value - the value to insert

insertDouble

void insertDouble(YTransaction txn,
 int index,
 double value)

Inserts a double at the specified index within a transaction.

Parameters:

txn - the transaction

index - the index

value - the value to insert

pushDouble

void pushDouble(double value)

Appends a double to the end.

Parameters:

value - the value to append

pushDouble

void pushDouble(YTransaction txn,
 double value)

Appends a double to the end within a transaction.

Parameters:

txn - the transaction

value - the value to append

getDoc

YDoc getDoc(int index)

Gets a subdocument at the specified index.

Parameters:

index - the index

Returns:

the subdocument

getDoc

YDoc getDoc(YTransaction txn,
 int index)

Gets a subdocument at the specified index within a transaction.

Parameters:

txn - the transaction

index - the index

Returns:

the subdocument

insertDoc

void insertDoc(int index,
 YDoc subdoc)

Inserts a subdocument at the specified index.

Parameters:

index - the index

subdoc - the subdocument to insert

insertDoc

void insertDoc(YTransaction txn,
 int index,
 YDoc subdoc)

Inserts a subdocument at the specified index within a transaction.

Parameters:

txn - the transaction

index - the index

subdoc - the subdocument to insert

pushDoc

void pushDoc(YDoc subdoc)

Appends a subdocument to the end.

Parameters:

subdoc - the subdocument to append

pushDoc

void pushDoc(YTransaction txn,
 YDoc subdoc)

Appends a subdocument to the end within a transaction.

Parameters:

txn - the transaction

subdoc - the subdocument to append

remove

void remove(int index,
 int length)

Removes elements at the specified range.

Parameters:

index - the start index

length - the number of elements to remove

remove

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

Removes elements at the specified range within a transaction.

Parameters:

txn - the transaction

index - the start index

length - the number of elements to remove

toJson

String toJson()

Returns a JSON representation of this array.

Returns:

the JSON string

toJson

String toJson(YTransaction txn)

Returns a JSON representation of this array within a transaction.

Parameters:

txn - the transaction

Returns:

the JSON string

observe

YSubscription observe(YObserver observer)

Registers an observer for changes to this array.

Parameters:

observer - the observer to register

Returns:

a subscription handle for unregistering

close

void close()

Closes this array and releases resources.

Specified by:

close in interface AutoCloseable

isClosed

boolean isClosed()

Checks if this array has been closed.

Returns:

true if closed, false otherwise