Package net.carcdr.ycrdt

Interface YMap

All Superinterfaces:

AutoCloseable

public interface YMap
extends AutoCloseable

A collaborative map type that supports concurrent editing.

Method Summary

Modifier and Type	Method	Description
void	clear()	Removes all entries from the map.
void	clear(YTransaction txn)	Removes all entries from the map within a transaction.
void	close()	Closes this map and releases resources.
boolean	containsKey(String key)	Checks if the map contains the specified key.
boolean	containsKey(YTransaction txn, String key)	Checks if the map contains the specified key within a transaction.
YDoc	getDoc(String key)	Gets a subdocument for the specified key.
YDoc	getDoc(YTransaction txn, String key)	Gets a subdocument for the specified key within a transaction.
double	getDouble(String key)	Gets a double value for the specified key.
double	getDouble(YTransaction txn, String key)	Gets a double value for the specified key within a transaction.
String	getString(String key)	Gets a string value for the specified key.
String	getString(YTransaction txn, String key)	Gets a string value for the specified key within a transaction.
boolean	isClosed()	Checks if this map has been closed.
boolean	isEmpty()	Checks if the map is empty.
String[]	keys()	Returns all keys in the map.
String[]	keys(YTransaction txn)	Returns all keys in the map within a transaction.
YSubscription	observe(YObserver observer)	Registers an observer for changes to this map.
void	remove(String key)	Removes the specified key from the map.
void	remove(YTransaction txn, String key)	Removes the specified key from the map within a transaction.
void	setDoc(String key, YDoc subdoc)	Sets a subdocument for the specified key.
void	setDoc(YTransaction txn, String key, YDoc subdoc)	Sets a subdocument for the specified key within a transaction.
void	setDouble(String key, double value)	Sets a double value for the specified key.
void	setDouble(YTransaction txn, String key, double value)	Sets a double value for the specified key within a transaction.
void	setString(String key, String value)	Sets a string value for the specified key.
void	setString(YTransaction txn, String key, String value)	Sets a string value for the specified key within a transaction.
int	size()	Returns the number of entries in the map.
int	size(YTransaction txn)	Returns the number of entries in the map within a transaction.
String	toJson()	Returns a JSON representation of this map.
String	toJson(YTransaction txn)	Returns a JSON representation of this map within a transaction.

Method Details

size

int size()

Returns the number of entries in the map.

Returns:

the size

size

int size(YTransaction txn)

Returns the number of entries in the map within a transaction.

Parameters:

txn - the transaction

Returns:

the size

isEmpty

boolean isEmpty()

Checks if the map is empty.

Returns:

true if empty, false otherwise

getString

String getString(String key)

Gets a string value for the specified key.

Parameters:

key - the key

Returns:

the string value, or null if not present

getString

String getString(YTransaction txn,
 String key)

Gets a string value for the specified key within a transaction.

Parameters:

txn - the transaction

key - the key

Returns:

the string value, or null if not present

setString

void setString(String key,
 String value)

Sets a string value for the specified key.

Parameters:

key - the key

value - the value to set

setString

void setString(YTransaction txn,
 String key,
 String value)

Sets a string value for the specified key within a transaction.

Parameters:

txn - the transaction

key - the key

value - the value to set

getDouble

double getDouble(String key)

Gets a double value for the specified key.

Parameters:

key - the key

Returns:

the double value

getDouble

double getDouble(YTransaction txn,
 String key)

Gets a double value for the specified key within a transaction.

Parameters:

txn - the transaction

key - the key

Returns:

the double value

setDouble

void setDouble(String key,
 double value)

Sets a double value for the specified key.

Parameters:

key - the key

value - the value to set

setDouble

void setDouble(YTransaction txn,
 String key,
 double value)

Sets a double value for the specified key within a transaction.

Parameters:

txn - the transaction

key - the key

value - the value to set

getDoc

YDoc getDoc(String key)

Gets a subdocument for the specified key.

Parameters:

key - the key

Returns:

the subdocument, or null if not present

getDoc

YDoc getDoc(YTransaction txn,
 String key)

Gets a subdocument for the specified key within a transaction.

Parameters:

txn - the transaction

key - the key

Returns:

the subdocument, or null if not present

setDoc

void setDoc(String key,
 YDoc subdoc)

Sets a subdocument for the specified key.

Parameters:

key - the key

subdoc - the subdocument to set

setDoc

void setDoc(YTransaction txn,
 String key,
 YDoc subdoc)

Sets a subdocument for the specified key within a transaction.

Parameters:

txn - the transaction

key - the key

subdoc - the subdocument to set

containsKey

boolean containsKey(String key)

Checks if the map contains the specified key.

Parameters:

key - the key

Returns:

true if the key exists, false otherwise

containsKey

boolean containsKey(YTransaction txn,
 String key)

Checks if the map contains the specified key within a transaction.

Parameters:

txn - the transaction

key - the key

Returns:

true if the key exists, false otherwise

keys

String[] keys()

Returns all keys in the map.

Returns:

an array of keys

keys

String[] keys(YTransaction txn)

Returns all keys in the map within a transaction.

Parameters:

txn - the transaction

Returns:

an array of keys

remove

void remove(String key)

Removes the specified key from the map.

Parameters:

key - the key to remove

remove

void remove(YTransaction txn,
 String key)

Removes the specified key from the map within a transaction.

Parameters:

txn - the transaction

key - the key to remove

clear

void clear()

Removes all entries from the map.

clear

void clear(YTransaction txn)

Removes all entries from the map within a transaction.

Parameters:

txn - the transaction

toJson

String toJson()

Returns a JSON representation of this map.

Returns:

the JSON string

toJson

String toJson(YTransaction txn)

Returns a JSON representation of this map within a transaction.

Parameters:

txn - the transaction

Returns:

the JSON string

observe

YSubscription observe(YObserver observer)

Registers an observer for changes to this map.

Parameters:

observer - the observer to register

Returns:

a subscription handle for unregistering

close

void close()

Closes this map and releases resources.

Specified by:

close in interface AutoCloseable

isClosed

boolean isClosed()

Checks if this map has been closed.

Returns:

true if closed, false otherwise