Libsoftphone/cz.acrobits.ali/Xml

Xml

class Xml : Pointer, Cloneable

Wrapper for a native XML tree.

This class is an implementation of a simple XML tree. It is not XML DOM-compliant, cannot mix text nodes with tags and does not support comments. It does not support XML validation against DTD or RELAX NG either. However, it is much faster.

Since it is based on Pointer, all methods in this class do not require to be run on the main thread, however they require you to run them always on the same thread. To pass it to a different thread, you can change its thread but beware of the possible consequences.

Please read documentation of Pointer on how you should manage pointers lifetime.

Constructors

constructor(@NonNull name: String)

Construct an empty XML root.

constructor(@NonNull name: String, @Nullable value: String)

Construct XML root with a value.

Functions

open fun changeThread()

Change thread this pointer can be accessed from to the current one.

open fun clone(): Xml

Deep-copy the XML tree.

open fun close()

Close the native pointer.

abstract fun close()

open fun copyChild(@NonNull child: Xml): Xml

Deep copy a child into the tree.

open fun createChild(@NonNull name: String): Xml

Create an empty child node.

open fun <T> createChild(@NonNull name: String, @NonNull value: T): Xml

open fun createChild(@NonNull name: String, @NonNull value: Boolean): Xml

open fun createChild(@NonNull name: String, @Nullable value: String): Xml

Create a child node with a value.

open fun <T> createChildren(@NonNull name: String, @NonNull values: Array<T>): Array<Xml>

open fun <T> createChildren(@NonNull name: String, @NonNull values: AbstractCollection<T>): Array<Xml>

Create child nodes with values.

open fun dump(@NonNull stream: OutputStream)

Dump the XML tree to an output stream.

open fun equals(@Nullable o: Any): Boolean

Check if this XML tree is equal to another object.

open fun getAttribute(@NonNull name: String): String

Get an attribute from the tree.

open fun getAttributes(): Map<String, String>

Get all attributes.

open fun getChild(@NonNull name: String): Xml

Get a child node by name.

open fun getChildAtPath(@NonNull path: String): Xml

Get child node at path.

getChildAtPathCreating

open fun getChildAtPathCreating(@NonNull path: Array<String>): Xml

Opinionated version of getOrCreateChild which created empty nodes if the children don't exist.

open fun getChildren(): Array<Xml>

Get all children.

open fun getChildValue(@NonNull name: String): String

Get a child's value.

getChildWithAttribute

open fun getChildWithAttribute(@NonNull name: String, @NonNull attributeName: String, @Nullable attributeValue: String): Xml

Get first child with a specified attribute.

open fun getName(): String

Get name of the node.

getOrCreateChild

open fun <T> getOrCreateChild(@NonNull name: String, @NonNull defaultValueSupplier: Supplier<T>): Xml

Create a child node with a value.

open fun getRoot(): Xml

Get the tree root.

open fun getValue(): String

Get value of the node.

open fun getValueAtPath(@NonNull path: String): String

Get child node value or child node attribute value at path.

open fun hasAttribute(@NonNull name: String): Boolean

Check if the node has an attribute.

open fun hasAttribute(@NonNull name: String, @NonNull value: String): Boolean

Check if this node has an attribute with a specified value.

open fun hashCode(): Int

Get hash code.

open fun isClosed(): Boolean

Check if the native pointer is closed.

open fun isMutable(): Boolean

Check if the native pointer is mutable.

open fun isRoot(): Boolean

Check if this tree is the root.

open fun isSamePointer(@NonNull other: Pointer): Boolean

Check if the pointer is the same as in another pointer.

open fun load(@NonNull file: File): Xml

open fun load(@NonNull file: String): Xml

Load a XML file into a tree.

open fun parse(@Nullable stream: InputStream): Xml

Parse a XML stream into a tree.

open fun parse(@Nullable xml: String): Xml

Parse a XML string into a tree.

removeAttribute

open fun removeAttribute(@NonNull name: String)

Remove an attribute.

open fun removeChild(@NonNull name: String): Boolean

Remove a child from the tree.

removeChildAtIndex

open fun removeChildAtIndex(index: Int): Boolean

Remove a child from the tree.

open fun replaceChild(@NonNull child: Xml): Boolean

open fun replaceChild(@NonNull name: String, @Nullable value: String): Boolean

Replace a child.

open fun save(@NonNull file: File): Boolean

open fun save(@NonNull file: String): Boolean

Save a XML tree into a file.

open fun setAttribute(@NonNull name: String, @Nullable value: String)

Set an attribute.

open fun setChild(@NonNull child: Xml): Xml

Move a child into the tree.

open fun setChildValue(@NonNull name: String, @Nullable value: String)

Set a child's value.

open fun setValue(@Nullable value: String)

Set value of the node.

open fun toString(): String

open fun toString(pretty: Boolean): String

Return the XML tree as a XML string.

open fun toXml(@NonNull name: String, @Nullable object: Any): Xml

Create XML tree from Java object.

open fun withAttribute(name: String, value: String): Xml

Fluent wrapper for setAttribute.

open fun withAttributes(attributes: Map<String, String>): Xml

Fluent wrapper for setAttribute.