hu.akarnokd.xml

Class XNElement

java.lang.Object

hu.akarnokd.xml.XElementBase

hu.akarnokd.xml.XNElement

public class XNElement
extends XElementBase

A simplified XML element model with namespace support.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XNElement.XAttributeName The namespace:name record.
static class	XNElement.XRepresentationRecord The representation record.
static class	XNElement.XRepresentationState The representation state.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<XNElement.XAttributeName,java.lang.String>	attributes The attribute map.
protected java.util.List<XNElement>	children The child elements.
java.lang.String	namespace The optional associated namespace uri.
XNElement	parent The parent element.
java.lang.String	prefix The prefix used by this element.

Fields inherited from class hu.akarnokd.xml.XElementBase

content, name, userObject, XSD, XSI

Constructor Summary

Constructors

Constructor and Description
XNElement(java.lang.String name) Constructor.
XNElement(java.lang.String name, java.lang.Object value) Creates a new XElement and sets its content according to the supplied value.
XNElement(java.lang.String name, java.lang.String namespace) Constructor.
XNElement(java.lang.String name, java.lang.String namespace, java.lang.Object value) Creates a new XElement and sets its content according to the supplied value.

Method Summary

Modifier and Type	Method and Description
XNElement	add(java.lang.String name) Add a new XElement with the given local name and no namespace.
XNElement	add(java.lang.String name, java.lang.String namespace) Add a new XElement with the given local name and namespace.
XNElement	add(XNElement child) Add the given existing child to this element.
java.util.Map<XNElement.XAttributeName,java.lang.String>	attributes()
XNElement	childElement(java.lang.String name) Returns the first child element with the given name.
XNElement	childElement(java.lang.String name, java.lang.String namespace) Returns the first child element with the given name.
java.util.List<XNElement>	children()
java.util.List<XNElement>	childrenWithName(java.lang.String name) Returns an iterator which enumerates all children with the given name.
java.util.List<XNElement>	childrenWithName(java.lang.String name, java.lang.String namespace) Returns an iterator which enumerates all children with the given name.
java.lang.String	childValue(java.lang.String name) Returns the content of the first child which has the given name.
java.lang.String	childValue(java.lang.String name, java.lang.String namespace) Returns the content of the first child which has the given name.
XNElement	copy()
void	copyFrom(XNElement other) Copy the attributes and child elements from the other element.
protected hu.akarnokd.xml.XNElement.Pair<java.lang.String,java.lang.String>	createPrefix(java.util.Map<java.lang.String,java.lang.String> nss, java.lang.String currentNamespace, java.lang.String currentPrefix) Generate a new prefix if the current is empty or already exists but with a different URI.
void	detach() Breaks the link with its parent XElement if any.
double	doubleValue(java.lang.String name, java.lang.String namespace) Returns a double value of the supplied child or throws an exception if missing.
double	doubleValue(java.lang.String name, java.lang.String namespace, double defaultValue) Returns a double value or the default value if the element is missing or empty.
boolean	equals(java.lang.Object obj)
<T> T	get() Retrieve the currently associated user object.
java.lang.String	get(java.lang.String attributeName) Retrieve the first attribute which has the given local attribute name.
java.lang.String	get(java.lang.String attributeName, java.lang.String attributeNamespace) Retrieve the specific attribute.
java.util.List<XNElement.XAttributeName>	getAttributeNames() Retrieve the attribute names.
boolean	getBoolean(java.lang.String attribute) Retrieve a value of a boolean attribute.
boolean	getBoolean(java.lang.String attribute, boolean defaultValue) Retrieve a value of a boolean attribute.
boolean	getBoolean(java.lang.String attribute, java.lang.String namespace) Retrieve a value of a boolean attribute.
boolean	getBoolean(java.lang.String attribute, java.lang.String namespace, boolean defaultValue) Retrieve a value of a boolean attribute.
double	getDouble(java.lang.String name) Returns the attribute as a double value.
double	getDouble(java.lang.String name, double defaultValue) Returns the attribute as a double value or the default.
double	getDouble(java.lang.String name, java.lang.String namespace) Returns the attribute as a double value.
double	getDouble(java.lang.String name, java.lang.String namespace, double defaultValue) Returns the attribute as a double value or the default.
int	getInt(java.lang.String attribute) Retrieve an integer attribute.
int	getInt(java.lang.String attribute, int defaultValue) Retrieve an integer attribute or the default value if not exists.
int	getInt(java.lang.String attribute, java.lang.String namespace) Retrieve an integer attribute or the default value if not exists.
int	getInt(java.lang.String attribute, java.lang.String namespace, int defaultValue) Retrieve an integer attribute or the default value if not exists.
long	getLong(java.lang.String attribute) Retrieve an long attribute or throw an exception if not exists.
long	getLong(java.lang.String attribute, long defaultValue) Retrieve an long attribute or the default value if not exists.
long	getLong(java.lang.String attribute, java.lang.String namespace) Retrieve an integer attribute or throw an exception if not exists.
long	getLong(java.lang.String attribute, java.lang.String namespace, long defaultValue) Retrieve an integer attribute or the default value if not exists.
java.lang.String	getXPath()
boolean	hasAttribute(java.lang.String name) Check if the simply-named attribute exists.
boolean	hasAttribute(java.lang.String name, java.lang.String namespace) Check if the attribute exists.
boolean	hasAttributes()
boolean	hasChildren()
int	hashCode()
boolean	hasName(java.lang.String name) Test if this XElement has the given name.
boolean	hasName(java.lang.String name, java.lang.String namespace) Test if this XElement has the given name and namespace.
int	intValue(java.lang.String name, java.lang.String namespace) Returns an integer value of the supplied child or throws an exception if missing.
int	intValue(java.lang.String name, java.lang.String namespace, int defaultValue) Returns an integer value or the default value if the element is missing or empty.
long	longValue(java.lang.String name, java.lang.String namespace) Returns a long value of the supplied child or throws an exception if missing.
long	longValue(java.lang.String name, java.lang.String namespace, long defaultValue) Returns a long value or the default value if the element is missing or empty.
static XNElement	parseXML(byte[] data) Parse an XML from the binary data.
static XNElement	parseXML(java.io.File file) Parse an XML from the given file.
static XNElement	parseXML(java.io.InputStream in) Parse XML from the input stream.
static XNElement	parseXML(java.io.Reader in) Parse an XML from the given Reader.
static XNElement	parseXML(java.sql.ResultSet rs, int index) Reads the contents of a indexed column as an XML.
static XNElement	parseXML(java.sql.ResultSet rs, java.lang.String column) Reads the contents of a named column as an XML.
static XNElement	parseXML(java.lang.String fileName) Parse an XML from the given file.
static XNElement	parseXML(java.net.URL url) Parse an XML from the supplied URL.
static XNElement	parseXML(javax.xml.stream.XMLStreamReader in) Parse an XML from the given XML Stream reader.
static XNElement	parseXMLFragment(javax.xml.stream.XMLStreamReader in) Parses the stream until the end element of the start element is reached, then returns.
static XNElement	parseXMLGZ(java.io.File file) Parse an XML file compressed by GZIP.
static XNElement	parseXMLGZ(java.lang.String fileName) Parse an XML file compressed by GZIP.
void	save(java.io.File file) Save this XML into the given file.
void	save(java.io.OutputStream stream) Save this XML into the given output stream.
void	save(java.lang.String fileName) Save this XML into the given file.
void	save(java.io.Writer stream) Save this XML into the given writer.
void	save(javax.xml.stream.XMLStreamWriter stream) Save the tree into the given XML stream writer.
protected void	saveInternal(javax.xml.stream.XMLStreamWriter stream) Store the element's content and recursively call itself for children.
void	set(java.lang.Object... nameValues) Set a multitude of attribute names and values.
void	set(java.lang.String name, java.lang.Object value) Set an attribute value identified by a local name and no namespace.
void	set(java.lang.String name, java.lang.String namespace, java.lang.Object value) Set an attribute value identified by a local name and namespace.
<T> T	set(T newUserObject) Replace the associated user object with a new object.
java.lang.String	toString()
void	toStringRep(java.lang.String indent, java.util.Map<java.lang.String,java.lang.String> nss, XNAppender out, java.util.function.Consumer<? super XNElement.XRepresentationRecord> callback) Convert the element into a pretty printed string representation.

Methods inherited from class hu.akarnokd.xml.XElementBase

doubleValue, doubleValue, formatDateTime, formatDateTime, intValue, intValue, longValue, longValue, parseDateTime, sanitize, setValue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

attributes

protected final java.util.Map<XNElement.XAttributeName,java.lang.String> attributes

The attribute map.

children

protected final java.util.List<XNElement> children

The child elements.

namespace

public java.lang.String namespace

The optional associated namespace uri.

parent

public XNElement parent

The parent element.

prefix

public java.lang.String prefix

The prefix used by this element.

Constructor Detail

XNElement

public XNElement(java.lang.String name)

Constructor. Sets the name.

Parameters:

name - the element name

XNElement

public XNElement(java.lang.String name,
                 java.lang.Object value)

Creates a new XElement and sets its content according to the supplied value.

Parameters:

name - the element name

value - the content value

XNElement

public XNElement(java.lang.String name,
                 java.lang.String namespace)

Constructor. Sets the name and namespace.

Parameters:

name - the element name

namespace - the element namespace

XNElement

public XNElement(java.lang.String name,
                 java.lang.String namespace,
                 java.lang.Object value)

Creates a new XElement and sets its content according to the supplied value.

Parameters:

name - the element name

namespace - the namespace

value - the content value

Method Detail

parseXML

public static XNElement parseXML(byte[] data)
                          throws javax.xml.stream.XMLStreamException

Parse an XML from the binary data.

Parameters:

data - the XML data

Returns:

the parsed xml

Throws:

javax.xml.stream.XMLStreamException - on error

parseXML

public static XNElement parseXML(java.io.File file)
                          throws java.io.IOException,
                                 javax.xml.stream.XMLStreamException

Parse an XML from the given file.

Parameters:

file - the file

Returns:

the parsed XElement tree

Throws:

javax.xml.stream.XMLStreamException - if an error occurs

java.io.IOException - if the file could not be found or other I/O error occurs

parseXML

public static XNElement parseXML(java.io.InputStream in)
                          throws javax.xml.stream.XMLStreamException

Parse XML from the input stream. Does not close the stream.

Parameters:

in - the InputStream object

Returns:

the parsed XElement tree

Throws:

javax.xml.stream.XMLStreamException - if an error occurs

parseXML

public static XNElement parseXML(java.io.Reader in)
                          throws javax.xml.stream.XMLStreamException

Parse an XML from the given Reader.

Parameters:

in - the Reader

Returns:

the parsed XElement tree

Throws:

javax.xml.stream.XMLStreamException - if an error occurs

parseXML

public static XNElement parseXML(java.sql.ResultSet rs,
                                 int index)
                          throws java.sql.SQLException,
                                 java.io.IOException,
                                 javax.xml.stream.XMLStreamException

Reads the contents of a indexed column as an XML.

Parameters:

rs - the result set to read from

index - the column index

Returns:

the parsed XNElement or null if the column contained null

Throws:

java.sql.SQLException - on SQL error

java.io.IOException - on IO error

javax.xml.stream.XMLStreamException - on parsing error

parseXML

public static XNElement parseXML(java.sql.ResultSet rs,
                                 java.lang.String column)
                          throws java.sql.SQLException,
                                 java.io.IOException,
                                 javax.xml.stream.XMLStreamException

Reads the contents of a named column as an XML.

Parameters:

rs - the result set to read from

column - the column name

Returns:

the parsed XNElement or null if the column contained null

Throws:

java.sql.SQLException - on SQL error

java.io.IOException - on IO error

javax.xml.stream.XMLStreamException - on parsing error

parseXML

public static XNElement parseXML(java.lang.String fileName)
                          throws java.io.IOException,
                                 javax.xml.stream.XMLStreamException

Parse an XML from the given file.

Parameters:

fileName - the file name

Returns:

the parsed XElement tree

Throws:

javax.xml.stream.XMLStreamException - if an error occurs

java.io.IOException - if the file could not be found or other I/O error occurs

parseXML

public static XNElement parseXML(java.net.URL url)
                          throws java.io.IOException,
                                 javax.xml.stream.XMLStreamException

Parse an XML from the supplied URL.

Parameters:

url - the target URL

Returns:

the parsed XML

Throws:

java.io.IOException - if an I/O error occurs

javax.xml.stream.XMLStreamException - if a parser error occurs

parseXML

public static XNElement parseXML(javax.xml.stream.XMLStreamReader in)
                          throws javax.xml.stream.XMLStreamException

Parse an XML from the given XML Stream reader. Closes the in stream.

Parameters:

in - the XMLStreamReader

Returns:

the parsed XElement tree

Throws:

javax.xml.stream.XMLStreamException - if an error occurs

parseXMLFragment

public static XNElement parseXMLFragment(javax.xml.stream.XMLStreamReader in)
                                  throws javax.xml.stream.XMLStreamException

Parses the stream until the end element of the start element is reached, then returns. The method can be used to parse streamed fragment XML on a per node basis. It does not close the in reader.

Parameters:

in - the input reader

Returns:

the parsed XElement tree

Throws:

javax.xml.stream.XMLStreamException - if an error occurs

parseXMLGZ

public static XNElement parseXMLGZ(java.io.File file)
                            throws javax.xml.stream.XMLStreamException

Parse an XML file compressed by GZIP.

Parameters:

file - the file

Returns:

the parsed XML

Throws:

javax.xml.stream.XMLStreamException - on error

parseXMLGZ

public static XNElement parseXMLGZ(java.lang.String fileName)
                            throws javax.xml.stream.XMLStreamException

Parse an XML file compressed by GZIP.

Parameters:

fileName - the filename

Returns:

the parsed XML

Throws:

javax.xml.stream.XMLStreamException - on error

add

public XNElement add(java.lang.String name)

Add a new XElement with the given local name and no namespace.

Parameters:

name - the name of the new element

Returns:

the created XElement child

add

public XNElement add(java.lang.String name,
                     java.lang.String namespace)

Add a new XElement with the given local name and namespace.

Parameters:

name - the name of the new element

namespace - the namespace of the new element

Returns:

the created XElement child

add

public XNElement add(XNElement child)

Add the given existing child to this element.

Parameters:

child - the child element

Returns:

the child element

attributes

public java.util.Map<XNElement.XAttributeName,java.lang.String> attributes()

Returns:

the attribute map

childElement

public XNElement childElement(java.lang.String name)

Returns the first child element with the given name.

Parameters:

name - the child name

Returns:

the XElement or null if not present

childElement

public XNElement childElement(java.lang.String name,
                              java.lang.String namespace)

Returns the first child element with the given name.

Parameters:

name - the child name

namespace - the namespace

Returns:

the XElement or null if not present

children

public java.util.List<XNElement> children()

Returns:

the iterable for all children.

childrenWithName

public java.util.List<XNElement> childrenWithName(java.lang.String name)

Returns an iterator which enumerates all children with the given name.

Parameters:

name - the name of the children to select

Returns:

the iterator

childrenWithName

public java.util.List<XNElement> childrenWithName(java.lang.String name,
                                                  java.lang.String namespace)

Returns an iterator which enumerates all children with the given name.

Parameters:

name - the name of the children to select

namespace - the namespace URI

Returns:

the iterator

childValue

public java.lang.String childValue(java.lang.String name)

Description copied from class: XElementBase

Returns the content of the first child which has the given name.

Specified by:

childValue in class XElementBase

Parameters:

name - the child name

Returns:

the content or null if no such child

childValue

public java.lang.String childValue(java.lang.String name,
                                   java.lang.String namespace)

Returns the content of the first child which has the given name.

Parameters:

name - the child name

namespace - the namespace URI

Returns:

the content or null if no such child

copy

public XNElement copy()

Specified by:

copy in class XElementBase

Returns:

Creates a deep copy of this element.

copyFrom

public void copyFrom(XNElement other)

Copy the attributes and child elements from the other element.

Parameters:

other - the other element

createPrefix

protected hu.akarnokd.xml.XNElement.Pair<java.lang.String,java.lang.String> createPrefix(java.util.Map<java.lang.String,java.lang.String> nss,
                                                                                         java.lang.String currentNamespace,
                                                                                         java.lang.String currentPrefix)

Generate a new prefix if the current is empty or already exists but with a different URI.

Parameters:

nss - the namespace to prefix cache.

currentNamespace - the current namespace

currentPrefix - the current prefix

Returns:

a pair of the derived prefix and (the xmlns declaration if needed, null otherwise)

detach

public void detach()

Breaks the link with its parent XElement if any.

doubleValue

public double doubleValue(java.lang.String name,
                          java.lang.String namespace)

Returns a double value of the supplied child or throws an exception if missing.

Parameters:

name - the child element name

namespace - the element namespace

Returns:

the value

doubleValue

public double doubleValue(java.lang.String name,
                          java.lang.String namespace,
                          double defaultValue)

Returns a double value or the default value if the element is missing or empty.

Parameters:

name - the element name

namespace - the element namespace

defaultValue - the default value

Returns:

the value

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

get

public <T> T get()

Retrieve the currently associated user object.

Type Parameters:

T - the expected object type

Returns:

the user object

get

public java.lang.String get(java.lang.String attributeName)

Retrieve the first attribute which has the given local attribute name.

Parameters:

attributeName - the attribute name

Returns:

the attribute value or null if no such attribute

get

public java.lang.String get(java.lang.String attributeName,
                            java.lang.String attributeNamespace)

Retrieve the specific attribute.

Parameters:

attributeName - the attribute name

attributeNamespace - the attribute namespace URI

Returns:

the attribute value or null if not present

getAttributeNames

public java.util.List<XNElement.XAttributeName> getAttributeNames()

Retrieve the attribute names.

Returns:

the list of attribute names

getBoolean

public boolean getBoolean(java.lang.String attribute)

Retrieve a value of a boolean attribute. Throws IllegalArgumentException if the attribute is missing or not of type boolean.

Parameters:

attribute - the attribute name

Returns:

the value

getBoolean

public boolean getBoolean(java.lang.String attribute,
                          boolean defaultValue)

Retrieve a value of a boolean attribute.

Parameters:

attribute - the attribute name

defaultValue - the value to return if no such attribute

Returns:

the value

getBoolean

public boolean getBoolean(java.lang.String attribute,
                          java.lang.String namespace)

Retrieve a value of a boolean attribute. Throws IllegalArgumentException if the attribute is missing or not of type boolean.

Parameters:

attribute - the attribute name

namespace - the attribute namespace

Returns:

the value

getBoolean

public boolean getBoolean(java.lang.String attribute,
                          java.lang.String namespace,
                          boolean defaultValue)

Retrieve a value of a boolean attribute. Throws IllegalArgumentException if the attribute is missing or not of type boolean.

Parameters:

attribute - the attribute name

namespace - the attribute namespace

defaultValue - the value to return if no such attribute

Returns:

the value

getDouble

public double getDouble(java.lang.String name)

Returns the attribute as a double value.

Parameters:

name - the attribute name

Returns:

the value

getDouble

public double getDouble(java.lang.String name,
                        double defaultValue)

Returns the attribute as a double value or the default.

Parameters:

name - the attribute name

defaultValue - the default if the attribute is missing

Returns:

the value

getDouble

public double getDouble(java.lang.String name,
                        java.lang.String namespace)

Returns the attribute as a double value.

Parameters:

name - the attribute name

namespace - the attribute namespace

Returns:

the value

getDouble

public double getDouble(java.lang.String name,
                        java.lang.String namespace,
                        double defaultValue)

Returns the attribute as a double value or the default.

Parameters:

name - the attribute name

namespace - the attribute namespace

defaultValue - the default if the attribute is missing

Returns:

the value

getInt

public int getInt(java.lang.String attribute)

Retrieve an integer attribute. Throws exception if the attribute is missing.

Parameters:

attribute - the attribute name

Returns:

the value

getInt

public int getInt(java.lang.String attribute,
                  int defaultValue)

Retrieve an integer attribute or the default value if not exists.

Parameters:

attribute - the attribute name

defaultValue - the default value to return

Returns:

the value

getInt

public int getInt(java.lang.String attribute,
                  java.lang.String namespace)

Retrieve an integer attribute or the default value if not exists.

Parameters:

attribute - the attribute name

namespace - the attribute namespace URI

Returns:

the value

getInt

public int getInt(java.lang.String attribute,
                  java.lang.String namespace,
                  int defaultValue)

Retrieve an integer attribute or the default value if not exists.

Parameters:

attribute - the attribute name

namespace - the namespace URI

defaultValue - the default value to return

Returns:

the value

getLong

public long getLong(java.lang.String attribute)

Retrieve an long attribute or throw an exception if not exists.

Parameters:

attribute - the attribute name

Returns:

the value

getLong

public long getLong(java.lang.String attribute,
                    long defaultValue)

Retrieve an long attribute or the default value if not exists.

Parameters:

attribute - the attribute name

defaultValue - the default value to return

Returns:

the value

getLong

public long getLong(java.lang.String attribute,
                    java.lang.String namespace)

Retrieve an integer attribute or throw an exception if not exists.

Parameters:

attribute - the attribute name

namespace - the attribute namespace URI

Returns:

the value

getLong

public long getLong(java.lang.String attribute,
                    java.lang.String namespace,
                    long defaultValue)

Retrieve an integer attribute or the default value if not exists.

Parameters:

attribute - the attribute name

namespace - the attribute namespace URI

defaultValue - the default value to return

Returns:

the value

getXPath

public java.lang.String getXPath()

Returns:

Construct the XPath expression to locate this element.

hasAttribute

public boolean hasAttribute(java.lang.String name)

Check if the simply-named attribute exists.

Parameters:

name - the name of the attribute

Returns:

true if the attribute exists

hasAttribute

public boolean hasAttribute(java.lang.String name,
                            java.lang.String namespace)

Check if the attribute exists.

Parameters:

name - the attribute name

namespace - the attribute namespace

Returns:

true if the attribute exists

hasAttributes

public boolean hasAttributes()

Returns:

if this node has attributes or not.

hasChildren

public boolean hasChildren()

Returns:

if this node has children or not.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

hasName

public boolean hasName(java.lang.String name)

Test if this XElement has the given name.

Parameters:

name - the name to test against

Returns:

true if the names equal

hasName

public boolean hasName(java.lang.String name,
                       java.lang.String namespace)

Test if this XElement has the given name and namespace.

Parameters:

name - the name to test against

namespace - the namespace to test against

Returns:

true if the names and namespaces equal

intValue

public int intValue(java.lang.String name,
                    java.lang.String namespace)

Returns an integer value of the supplied child or throws an exception if missing.

Parameters:

name - the child element name

namespace - the element namespace

Returns:

the value

intValue

public int intValue(java.lang.String name,
                    java.lang.String namespace,
                    int defaultValue)

Returns an integer value or the default value if the element is missing or empty.

Parameters:

name - the element name

namespace - the element namespace

defaultValue - the default value

Returns:

the value

longValue

public long longValue(java.lang.String name,
                      java.lang.String namespace)

Returns a long value of the supplied child or throws an exception if missing.

Parameters:

name - the child element name

namespace - the element namespace

Returns:

the value

longValue

public long longValue(java.lang.String name,
                      java.lang.String namespace,
                      long defaultValue)

Returns a long value or the default value if the element is missing or empty.

Parameters:

name - the element name

namespace - the element namespace

defaultValue - the default value

Returns:

the value

save

public void save(java.io.File file)
          throws java.io.IOException

Save this XML into the given file.

Parameters:

file - the file

Throws:

java.io.IOException - on error

save

public void save(java.io.OutputStream stream)
          throws java.io.IOException

Save this XML into the given output stream. Does not close the given stream

Parameters:

stream - the output stream

Throws:

java.io.IOException - on error

save

public void save(java.lang.String fileName)
          throws java.io.IOException

Save this XML into the given file.

Parameters:

fileName - the file name

Throws:

java.io.IOException - on error

save

public void save(java.io.Writer stream)
          throws java.io.IOException

Save this XML into the given writer. Does not close the writer.

Parameters:

stream - the output writer

Throws:

java.io.IOException - on error

save

public void save(javax.xml.stream.XMLStreamWriter stream)
          throws javax.xml.stream.XMLStreamException

Save the tree into the given XML stream writer.

Parameters:

stream - the stream writer

Throws:

javax.xml.stream.XMLStreamException - if an error occurs

saveInternal

protected void saveInternal(javax.xml.stream.XMLStreamWriter stream)
                     throws javax.xml.stream.XMLStreamException

Store the element's content and recursively call itself for children.

Parameters:

stream - the stream output

Throws:

javax.xml.stream.XMLStreamException - if an error occurs

set

public void set(java.lang.Object... nameValues)

Set a multitude of attribute names and values.

Parameters:

nameValues - the attribute name and attribute value pairs.

set

public void set(java.lang.String name,
                java.lang.Object value)

Set an attribute value identified by a local name and no namespace.

Parameters:

name - the attribute name

value - the value, if null, the attribute will be removed

set

public void set(java.lang.String name,
                java.lang.String namespace,
                java.lang.Object value)

Set an attribute value identified by a local name and namespace.

Parameters:

name - the attribute name

namespace - the attribute namespace

value - the value, if null, the attribute will be removed

set

public <T> T set(T newUserObject)

Replace the associated user object with a new object.

Type Parameters:

T - the object type

Parameters:

newUserObject - the new user object

Returns:

the original user object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toStringRep

public void toStringRep(java.lang.String indent,
                        java.util.Map<java.lang.String,java.lang.String> nss,
                        XNAppender out,
                        java.util.function.Consumer<? super XNElement.XRepresentationRecord> callback)

Convert the element into a pretty printed string representation.

Parameters:

indent - the current line indentation

nss - the namespace cache

out - the output

callback - the callback for each element and text position.