Package net.carcdr.ycrdt

Interface YXmlElement

All Superinterfaces:

AutoCloseable, YXmlNode

public interface YXmlElement
extends YXmlNode, AutoCloseable

A collaborative XML element that supports concurrent editing.

Nested Class Summary

Nested classes/interfaces inherited from interface net.carcdr.ycrdt.YXmlNode

YXmlNode.NodeType

Method Summary

Modifier and Type	Method	Description
int	childCount()	Returns the number of child nodes.
int	childCount(YTransaction txn)	Returns the number of child nodes within a transaction.
void	close()	Closes this element and releases resources.
String	getAttribute(String name)	Gets an attribute value.
String	getAttribute(YTransaction txn, String name)	Gets an attribute value within a transaction.
String[]	getAttributeNames()	Returns all attribute names.
String[]	getAttributeNames(YTransaction txn)	Returns all attribute names within a transaction.
Object	getChild(int index)	Gets a child node at the specified index.
Object	getChild(YTransaction txn, int index)	Gets a child node at the specified index within a transaction.
int	getIndexInParent()	Returns the index of this element within its parent.
int	getIndexInParent(YTransaction txn)	Returns the index of this element within its parent, using a transaction.
Object	getParent()	Returns the parent element or fragment.
Object	getParent(YTransaction txn)	Returns the parent element or fragment within a transaction.
String	getTag()	Returns the tag name of this element.
String	getTag(YTransaction txn)	Returns the tag name of this element within a transaction.
YXmlElement	insertElement(int index, String tag)	Inserts a child element at the specified index.
YXmlElement	insertElement(YTransaction txn, int index, String tag)	Inserts a child element at the specified index within a transaction.
YXmlText	insertText(int index)	Inserts a child text node at the specified index.
YXmlText	insertText(YTransaction txn, int index)	Inserts a child text node at the specified index within a transaction.
boolean	isClosed()	Checks if this element has been closed.
YSubscription	observe(YObserver observer)	Registers an observer for changes to this element.
void	removeAttribute(String name)	Removes an attribute.
void	removeAttribute(YTransaction txn, String name)	Removes an attribute within a transaction.
void	removeChild(int index)	Removes a child node at the specified index.
void	removeChild(YTransaction txn, int index)	Removes a child node at the specified index within a transaction.
void	setAttribute(String name, String value)	Sets an attribute value.
void	setAttribute(YTransaction txn, String name, String value)	Sets an attribute value within a transaction.
String	toString()	Returns the XML representation of this element.
String	toString(YTransaction txn)	Returns the XML representation of this element within a transaction.

Methods inherited from interface net.carcdr.ycrdt.YXmlNode

asElement, asText, getNodeType

Method Details

getTag

String getTag()

Returns the tag name of this element.

Returns:

the tag name

getTag

String getTag(YTransaction txn)

Returns the tag name of this element within a transaction.

Parameters:

txn - the transaction

Returns:

the tag name

getAttribute

String getAttribute(String name)

Gets an attribute value.

Parameters:

name - the attribute name

Returns:

the attribute value, or null if not present

getAttribute

String getAttribute(YTransaction txn,
 String name)

Gets an attribute value within a transaction.

Parameters:

txn - the transaction

name - the attribute name

Returns:

the attribute value, or null if not present

setAttribute

void setAttribute(String name,
 String value)

Sets an attribute value.

Parameters:

name - the attribute name

value - the attribute value

setAttribute

void setAttribute(YTransaction txn,
 String name,
 String value)

Sets an attribute value within a transaction.

Parameters:

txn - the transaction

name - the attribute name

value - the attribute value

removeAttribute

void removeAttribute(String name)

Removes an attribute.

Parameters:

name - the attribute name

removeAttribute

void removeAttribute(YTransaction txn,
 String name)

Removes an attribute within a transaction.

Parameters:

txn - the transaction

name - the attribute name

getAttributeNames

String[] getAttributeNames()

Returns all attribute names.

Returns:

an array of attribute names

getAttributeNames

String[] getAttributeNames(YTransaction txn)

Returns all attribute names within a transaction.

Parameters:

txn - the transaction

Returns:

an array of attribute names

childCount

int childCount()

Returns the number of child nodes.

Returns:

the child count

childCount

int childCount(YTransaction txn)

Returns the number of child nodes within a transaction.

Parameters:

txn - the transaction

Returns:

the child count

insertElement

YXmlElement 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

Returns:

the new element

insertElement

YXmlElement 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

Returns:

the new element

insertText

YXmlText insertText(int index)

Inserts a child text node at the specified index.

Parameters:

index - the index to insert at

Returns:

the new text node

insertText

YXmlText insertText(YTransaction txn,
 int index)

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

Parameters:

txn - the transaction

index - the index to insert at

Returns:

the new text node

getChild

Object getChild(int index)

Gets a child node at the specified index.

Parameters:

index - the index

Returns:

the child node (YXmlElement or YXmlText)

getChild

Object getChild(YTransaction txn,
 int index)

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

Parameters:

txn - the transaction

index - the index

Returns:

the child node (YXmlElement or YXmlText)

removeChild

void removeChild(int index)

Removes a child node at the specified index.

Parameters:

index - the index

removeChild

void removeChild(YTransaction txn,
 int index)

Removes a child node at the specified index within a transaction.

Parameters:

txn - the transaction

index - the index

getParent

Object getParent()

Returns the parent element or fragment.

Returns:

the parent, or null if none

getParent

Object getParent(YTransaction txn)

Returns the parent element or fragment within a transaction.

Parameters:

txn - the transaction

Returns:

the parent, or null if none

getIndexInParent

int getIndexInParent()

Returns the index of this element within its parent.

Returns:

the index

getIndexInParent

int getIndexInParent(YTransaction txn)

Returns the index of this element within its parent, using a transaction.

Parameters:

txn - the transaction

Returns:

the index

toString

String toString()

Returns the XML representation of this element.

Overrides:

toString in class Object

Returns:

the XML string

toString

String toString(YTransaction txn)

Returns the XML representation of this element within a transaction.

Parameters:

txn - the transaction

Returns:

the XML string

observe

YSubscription observe(YObserver observer)

Registers an observer for changes to this element.

Parameters:

observer - the observer to register

Returns:

a subscription handle for unregistering

close

void close()

Closes this element and releases resources.

Specified by:

close in interface AutoCloseable

isClosed

boolean isClosed()

Checks if this element has been closed.

Returns:

true if closed, false otherwise