Package net.carcdr.ycrdt

Interface YXmlFragment

All Superinterfaces:

AutoCloseable

public interface YXmlFragment
extends AutoCloseable

A collaborative XML fragment container that supports concurrent editing.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes this fragment and releases resources.
Object	getChild(int index)	Gets a child node at the specified index.
YXmlElement	getElement(int index)	Gets a child element at the specified index.
YXmlElement	getElement(YTransaction txn, int index)	Gets a child element at the specified index within a transaction.
YXmlNode.NodeType	getNodeType(int index)	Returns the type of the child node at the specified index.
YXmlNode.NodeType	getNodeType(YTransaction txn, int index)	Returns the type of the child node at the specified index within a transaction.
YXmlText	getText(int index)	Gets a child text node at the specified index.
YXmlText	getText(YTransaction txn, int index)	Gets a child text node at the specified index within a transaction.
void	insertElement(int index, String tag)	Inserts a child element at the specified index.
void	insertElement(YTransaction txn, int index, String tag)	Inserts a child element at the specified index within a transaction.
void	insertText(int index, String content)	Inserts a child text node at the specified index.
void	insertText(YTransaction txn, int index, String content)	Inserts a child text node at the specified index within a transaction.
boolean	isClosed()	Checks if this fragment has been closed.
int	length()	Returns the number of child nodes.
int	length(YTransaction txn)	Returns the number of child nodes within a transaction.
YSubscription	observe(YObserver observer)	Registers an observer for changes to this fragment.
void	remove(int index, int length)	Removes child nodes at the specified range.
void	remove(YTransaction txn, int index, int length)	Removes child nodes at the specified range within a transaction.
String	toString()	Returns the XML representation of this fragment.
String	toXmlString()	Returns the XML representation of this fragment.
String	toXmlString(YTransaction txn)	Returns the XML representation of this fragment within a transaction.

Method Details

length

int length()

Returns the number of child nodes.

Returns:

the child count

length

int length(YTransaction txn)

Returns the number of child nodes within a transaction.

Parameters:

txn - the transaction

Returns:

the child count

insertElement

void insertElement(int index,
 String tag)

Inserts a child element at the specified index.

Parameters:

index - the index to insert at

tag - the tag name of the new element

insertElement

void insertElement(YTransaction txn,
 int index,
 String tag)

Inserts a child element at the specified index within a transaction.

Parameters:

txn - the transaction

index - the index to insert at

tag - the tag name of the new element

insertText

void insertText(int index,
 String content)

Inserts a child text node at the specified index.

Parameters:

index - the index to insert at

content - the initial text content

insertText

void insertText(YTransaction txn,
 int index,
 String content)

Inserts a child text node at the specified index within a transaction.

Parameters:

txn - the transaction

index - the index to insert at

content - the initial text content

remove

void remove(int index,
 int length)

Removes child nodes at the specified range.

Parameters:

index - the start index

length - the number of nodes to remove

remove

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

Removes child nodes at the specified range within a transaction.

Parameters:

txn - the transaction

index - the start index

length - the number of nodes to remove

getNodeType

YXmlNode.NodeType getNodeType(int index)

Returns the type of the child node at the specified index.

Parameters:

index - the index

Returns:

the node type

getNodeType

YXmlNode.NodeType getNodeType(YTransaction txn,
 int index)

Returns the type of the child node at the specified index within a transaction.

Parameters:

txn - the transaction

index - the index

Returns:

the node type

getChild

Object getChild(int index)

Gets a child node at the specified index.

Parameters:

index - the index

Returns:

the child node (YXmlElement or YXmlText)

getElement

YXmlElement getElement(int index)

Gets a child element at the specified index.

Parameters:

index - the index

Returns:

the element

getElement

YXmlElement getElement(YTransaction txn,
 int index)

Gets a child element at the specified index within a transaction.

Parameters:

txn - the transaction

index - the index

Returns:

the element

getText

YXmlText getText(int index)

Gets a child text node at the specified index.

Parameters:

index - the index

Returns:

the text node

getText

YXmlText getText(YTransaction txn,
 int index)

Gets a child text node at the specified index within a transaction.

Parameters:

txn - the transaction

index - the index

Returns:

the text node

toXmlString

String toXmlString()

Returns the XML representation of this fragment.

Returns:

the XML string

toXmlString

String toXmlString(YTransaction txn)

Returns the XML representation of this fragment within a transaction.

Parameters:

txn - the transaction

Returns:

the XML string

toString

String toString()

Returns the XML representation of this fragment.

Overrides:

toString in class Object

Returns:

the XML string

observe

YSubscription observe(YObserver observer)

Registers an observer for changes to this fragment.

Parameters:

observer - the observer to register

Returns:

a subscription handle for unregistering

close

void close()

Closes this fragment and releases resources.

Specified by:

close in interface AutoCloseable

isClosed

boolean isClosed()

Checks if this fragment has been closed.

Returns:

true if closed, false otherwise