org.mdiutil.xml.tree

Class XMLNodeUtilities

java.lang.Object

org.mdiutil.xml.tree.XMLNodeUtilities

All Implemented Interfaces:

XMLNodeUtilitiesOptions

public class XMLNodeUtilities
extends Object
implements XMLNodeUtilitiesOptions

Various utilities concerning XML content. Contrary to the XMLNodeUtilities2, class, all methods are static.

Field Summary

Fields inherited from interface org.mdiutil.xml.tree.XMLNodeUtilitiesOptions

ALLOW_INTERNAL_READERS, KEEP_LINE_NUMBERS, NAMESPACE_AWARE, PRESERVE_SPACE, SHOW_EXCEPTIONS, SHOW_WARNINGS

Method Summary

Modifier and Type	Method and Description
static Charset	getCharset() Return the charset to use to write the content.
static EntityListResolver	getEntityListResolver() Return the EntityListResolver which can manage entity resolution in XML files.
static ErrorHandler	getErrorHandler() Return the error handler wich will be fired for parsing errors detected by the underlying parser. null by default.
static Map<String,Boolean>	getFeatures() Return the underlying parser factory features.
static XMLNode	getNode(File file) Return the Node from a file.
static XMLNode	getNode(File file, boolean showExceptions, boolean showWarnings, boolean preserveSpace, boolean keepLineNumbers) Return the Node from a file.
static XMLNode	getNode(File file, boolean showExceptions, boolean showWarnings, boolean preserveSpace, boolean keepLineNumbers, boolean isNamespaceAware, boolean allowInternalReaders) Return the Node from a file.
static XMLNode	getNode(File file, int options) Return the root Node from a file.
static XMLNode	getNode(File file, XMLParserConfiguration config, boolean preserveSpace, boolean keepLineNumbers) Return the Node from a file.
static XMLNode	getNode(Reader reader) Return the root Node from a Reader.
static XMLNode	getNode(Reader reader, boolean showExceptions, boolean showWarnings, boolean preserveSpace, boolean keepLineNumbers) Return the root Node from a Reader.
static XMLNode	getNode(Reader reader, boolean showExceptions, boolean showWarnings, boolean preserveSpace, boolean keepLineNumbers, boolean isNamespaceAware, boolean allowInternalReaders) Return the Node from a Reader.
static XMLNode	getNode(Reader reader, int options) Return the Node from a Reader.
static XMLNode	getNode(Reader reader, XMLParserConfiguration config, boolean preserveSpace, boolean keepLineNumbers, boolean isNamespaceAware) Return the Node from a Reader.
static XMLNode	getNode(Reader reader, XMLParserConfiguration config, boolean preserveSpace, boolean keepLineNumbers, boolean isNamespaceAware, boolean allowInternalReaders) Return the Node from a Reader.
static XMLNode	getNode(String str) Return the Node from a String.
static XMLNode	getNode(String str, boolean showExceptions, boolean showWarnings, boolean preserveSpace, boolean keepLineNumbers) Return the Node from a String.
static XMLNode	getNode(String str, boolean showExceptions, boolean showWarnings, boolean preserveSpace, boolean keepLineNumbers, boolean isNamespaceAware) Return the Node from a String.
static XMLNode	getNode(String str, boolean showExceptions, boolean showWarnings, boolean preserveSpace, boolean keepLineNumbers, boolean isNamespaceAware, boolean allowInternalReaders) Return the Node from a String.
static XMLNode	getNode(String str, int options) Return the Node from a String.
static XMLNode	getNode(String str, XMLParserConfiguration config, boolean preserveSpace, boolean keepLineNumbers) Return the Node from a String.
static XMLNode	getNode(URL url) Return the Node from an URL.
static XMLNode	getNode(URL xmlURL, boolean showExceptions, boolean showWarnings, boolean preserveSpace, boolean keepLineNumbers) Return the Node from an XML URL.
static XMLNode	getNode(URL xmlURL, boolean showExceptions, boolean showWarnings, boolean preserveSpace, boolean keepLineNumbers, boolean isNamespaceAware) Return the Node from an XML URL.
static XMLNode	getNode(URL xmlURL, boolean showExceptions, boolean showWarnings, boolean preserveSpace, boolean keepLineNumbers, boolean isNamespaceAware, boolean allowInternalReaders) Return the Node from an XML URL.
static XMLNode	getNode(URL xmlURL, int options) Return the root Node from an XML URL.
static XMLNode	getNode(URL xmlURL, XMLParserConfiguration config, boolean preserveSpace, boolean keepLineNumbers) Return the Node from an XML URL.
static XMLNode	getNode(URL xmlURL, XMLParserConfiguration config, boolean preserveSpace, boolean keepLineNumbers, boolean isNamespaceAware) Return the Node from an XML URL.
static Map<String,Object>	getProperties() Return the underlying parser properties.
static XMLRoot	getRootNode(File file) Return the root Node from a file.
static XMLRoot	getRootNode(File file, boolean showExceptions, boolean showWarnings, boolean preserveSpace, boolean keepLineNumbers) Return the root Node from a file.
static XMLRoot	getRootNode(File file, boolean showExceptions, boolean showWarnings, boolean preserveSpace, boolean keepLineNumbers, boolean isNamespaceAware) Return the root Node from a file.
static XMLRoot	getRootNode(File file, boolean showExceptions, boolean showWarnings, boolean preserveSpace, boolean keepLineNumbers, boolean isNamespaceAware, boolean allowInternalReaders) Return the root Node from a file.
static XMLRoot	getRootNode(File file, int options) Return the root Node from a file.
static XMLRoot	getRootNode(File file, XMLParserConfiguration config, boolean preserveSpace, boolean keepLineNumbers) Return the root Node from a file.
static XMLRoot	getRootNode(File file, XMLParserConfiguration config, boolean preserveSpace, boolean keepLineNumbers, boolean isNamespaceAware) Return the root Node from a file.
static XMLRoot	getRootNode(Reader reader) Return the root Node from a Reader.
static XMLRoot	getRootNode(Reader reader, boolean showExceptions, boolean showWarnings, boolean preserveSpace, boolean keepLineNumbers) Return the root Node from a Reader.
static XMLRoot	getRootNode(Reader reader, boolean showExceptions, boolean showWarnings, boolean preserveSpace, boolean keepLineNumbers, boolean isNamespaceAware) Return the root Node from a Reader.
static XMLRoot	getRootNode(Reader reader, boolean showExceptions, boolean showWarnings, boolean preserveSpace, boolean keepLineNumbers, boolean isNamespaceAware, boolean allowInternalReaders) Return the root Node from a Reader.
static XMLRoot	getRootNode(Reader reader, int options) Return the root Node from a Reader.
static XMLRoot	getRootNode(Reader reader, XMLParserConfiguration config, boolean preserveSpace, boolean keepLineNumbers) Return the root Node from a Reader.
static XMLRoot	getRootNode(Reader reader, XMLParserConfiguration config, boolean preserveSpace, boolean keepLineNumbers, boolean isNamespaceAware) Return the root Node from a Reader.
static XMLRoot	getRootNode(Reader reader, XMLParserConfiguration config, boolean preserveSpace, boolean keepLineNumbers, boolean isNamespaceAware, boolean allowInternalReaders) Return the root Node from a Reader.
static XMLRoot	getRootNode(String str) Return the root Node from a String.
static XMLRoot	getRootNode(String str, boolean showExceptions, boolean showWarnings, boolean preserveSpace, boolean keepLineNumbers) Return the root Node from a String.
static XMLRoot	getRootNode(String str, boolean showExceptions, boolean showWarnings, boolean preserveSpace, boolean keepLineNumbers, boolean isNamespaceAware) Return the root Node from a String.
static XMLRoot	getRootNode(String str, boolean showExceptions, boolean showWarnings, boolean preserveSpace, boolean keepLineNumbers, boolean isNamespaceAware, boolean allowInternalReaders) Return the root Node from a String.
static XMLRoot	getRootNode(String str, int options) Return the root Node from a String.
static XMLRoot	getRootNode(String str, XMLParserConfiguration config, boolean preserveSpace, boolean keepLineNumbers) Return the root Node from a String.
static XMLRoot	getRootNode(URL xmlURL) Return the root Node from an XML URL.
static XMLRoot	getRootNode(URL xmlURL, boolean showExceptions, boolean showWarnings, boolean preserveSpace, boolean keepLineNumbers) Return the root Node from an XML URL.
static XMLRoot	getRootNode(URL xmlURL, boolean showExceptions, boolean showWarnings, boolean preserveSpace, boolean keepLineNumbers, boolean isNamespaceAware) Return the root Node from an XML URL.
static XMLRoot	getRootNode(URL xmlURL, boolean showExceptions, boolean showWarnings, boolean preserveSpace, boolean keepLineNumbers, boolean isNamespaceAware, boolean allowInternalReaders) Return the root Node from an XML URL.
static XMLRoot	getRootNode(URL xmlURL, int options) Return the root Node from an URL.
static XMLRoot	getRootNode(URL xmlURL, XMLParserConfiguration config, boolean preserveSpace, boolean keepLineNumbers) Return the root Node from an XML URL.
static XMLRoot	getRootNode(URL xmlURL, XMLParserConfiguration config, boolean preserveSpace, boolean keepLineNumbers, boolean isNamespaceAware) Return the root Node from an XML URL.
static String	print(XMLNode node, int indentation) Print as a String the content of an XML file under a root Node.
static void	print(XMLNode node, int indentation, File outputFile) Save in a File the content of an XML file under a root Node.
static void	print(XMLNode node, int indentation, File outputFile, String encoding) Save in a File the content of an XML file under a root Node.
static String	print(XMLNode node, int indentation, String encoding) Print as a String the content of an XML file under a root Node.
static void	print(XMLNode node, int indentation, URL outputURL) Save in an URL the content of an XML file under a root Node.
static void	resetConfiguration() Reset the configuration of the underlying parser (reatures and properties).
static List<XMLNode>	search(XMLNode node, List<QName> qnames, boolean deep) Search for the children nodes having a specified qualified name.
static List<XMLNode>	search(XMLNode node, QName[] qnames, boolean deep) Search for the children nodes having a specified qualified name.
static List<XMLNode>	search(XMLNode node, QName qname, boolean deep) Search for the children nodes having a specified qualified name.
static List<XMLNode>	search(XMLNode node, String name, boolean deep) Search for the children nodes having a specified name.
static XMLNode	searchFirst(XMLNode node, List<QName> qnames, boolean deep) Search for the first child node having qualified name among a list of specified names.
static XMLNode	searchFirst(XMLNode node, QName[] qnames, boolean deep) Search for the first child node having qualified name among a list of specified names.
static XMLNode	searchFirst(XMLNode node, QName qname, boolean deep) Search for the first child node having a specified qualified name.
static XMLNode	searchFirst(XMLNode node, String name, boolean deep) Search for the the first child node having a specified name.
static XMLNode	searchFirstForNames(XMLNode node, List<String> names, boolean deep) Search for the the first child node having a specified name among a list of names.
static XMLNode	searchFirstForNames(XMLNode node, String[] names, boolean deep) Search for the the first child node having a specified name among a list of names.
static List<XMLNode>	searchForNames(XMLNode node, List<String> names, boolean deep) Search for the children nodes having a specified name among a list of names.
static List<XMLNode>	searchForNames(XMLNode node, String[] names, boolean deep) Search for the children nodes having a specified name among a list of names.
static void	setCharset(Charset charset) Set the charset to use to write the content.
static void	setEntityListResolver(EntityListResolver resolver) Set the EntityListResolver which can manage entity resolution in XML files.
static void	setErrorHandler(ErrorHandler errorHandler) Set an error handler wich will be fired for parsing errors detected by the underlying parser.
static void	setFeature(String name, boolean value) Set a underlying parser factory feature.
static void	setProperty(String name, Object value) Set an underlying parser property.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setEntityListResolver

public static void setEntityListResolver(EntityListResolver resolver)

Set the EntityListResolver which can manage entity resolution in XML files.

Parameters:

resolver - the resolver

getEntityListResolver

public static EntityListResolver getEntityListResolver()

Return the EntityListResolver which can manage entity resolution in XML files.

Returns:

the resolver

setCharset

public static void setCharset(Charset charset)

Set the charset to use to write the content. The default charset is StandardCharsets.UTF_8.

Parameters:

charset - the charset

getCharset

public static Charset getCharset()

Return the charset to use to write the content.

Returns:

the charset

setErrorHandler

public static void setErrorHandler(ErrorHandler errorHandler)

Set an error handler wich will be fired for parsing errors detected by the underlying parser.

Parameters:

errorHandler - the error handler

getErrorHandler

public static ErrorHandler getErrorHandler()

Return the error handler wich will be fired for parsing errors detected by the underlying parser. null by default.

Returns:

the error handler

resetConfiguration

public static void resetConfiguration()

Reset the configuration of the underlying parser (reatures and properties).

setFeature

public static void setFeature(String name,
                              boolean value)

Set a underlying parser factory feature.

Parameters:

name - the feature name

value - the feature value

getFeatures

public static Map<String,Boolean> getFeatures()

Return the underlying parser factory features.

Returns:

the features

setProperty

public static void setProperty(String name,
                               Object value)

Set an underlying parser property.

Parameters:

name - the property name

value - the property value

getProperties

public static Map<String,Object> getProperties()

Return the underlying parser properties.

Returns:

the properties

search

public static List<XMLNode> search(XMLNode node,
                                   String name,
                                   boolean deep)

Search for the children nodes having a specified name.

Example

Suppose we have this XML file:

 <root desc="example">
   <element1 name="first" id="theID">
     <element2 name="second">
       <element3 name="fourth" />
       <element2 name="fith"/>
     </element2>
     <element3 name="third" />
   </element1>
 </root>
 

Then:

• If we execute search(root, "element2", false), the method will return one node, which is the first "element2" child
• If we execute search(root, "element2", true), the method will return two nodeq, which is the two "element2" children

Qualified name

If the name contains a colon, it will be considered as a qualified name with a prefix and a null URI. For example search(root, "h:element", false) is equivalent to search(root, new QName(XMLConstants.NULL_NS_URI, "element", "h"), false)

Parameters:

node - the root node

name - the name to search for

deep - if the search should continue for children of nodes found in the search

Returns:

the list of nodes with the specified name

searchForNames

public static List<XMLNode> searchForNames(XMLNode node,
                                           List<String> names,
                                           boolean deep)

Search for the children nodes having a specified name among a list of names.

Parameters:

node - the root node

names - the names to search for

deep - if the search should continue for children of nodes found in the search

Returns:

the list of nodes with the specified name

searchForNames

public static List<XMLNode> searchForNames(XMLNode node,
                                           String[] names,
                                           boolean deep)

Search for the children nodes having a specified name among a list of names.

Parameters:

node - the root node

names - the names to search for

deep - if the search should continue for children of nodes found in the search

Returns:

the list of nodes with the specified name

searchFirst

public static XMLNode searchFirst(XMLNode node,
                                  QName qname,
                                  boolean deep)

Search for the first child node having a specified qualified name.

Parameters:

node - the root node

qname - the qualified name to search for

deep - if the search should continue for children of nodes found in the search

Returns:

the first child node with the specified qualified name

searchFirst

public static XMLNode searchFirst(XMLNode node,
                                  List<QName> qnames,
                                  boolean deep)

Search for the first child node having qualified name among a list of specified names.

Parameters:

node - the root node

qnames - the list of qualified names to search for

deep - if the search should continue for children of nodes found in the search

Returns:

the first child node with the specified qualified name

searchFirst

public static XMLNode searchFirst(XMLNode node,
                                  QName[] qnames,
                                  boolean deep)

Search for the first child node having qualified name among a list of specified names.

Parameters:

node - the root node

qnames - the list of qualified names to search for

deep - if the search should continue for children of nodes found in the search

Returns:

the first child node with the specified qualified name

searchFirst

public static XMLNode searchFirst(XMLNode node,
                                  String name,
                                  boolean deep)

Search for the the first child node having a specified name.

Example

Suppose we have this XML file:

 <root desc="example">
   <element1 name="first" id="theID">
     <element2 name="second">
       <element3 name="fourth" />
       <element2 name="fith"/>
     </element2>
     <element3 name="third" />
   </element1>
 </root>
 

Then:

• If we execute searchFirst(root, "element2", false), the method will return one node, which is the first "element2" child
• If we execute searchFirst(root, "element2", true), the method will also return one node, which is the first "element2" child

Qualified name

If the name contains a colon, it will be considered as a qualified name with a prefix and a null URI. For example search(root, "h:element", false) is equivalent to searchFirst(root, new QName(XMLConstants.NULL_NS_URI, "element", "h"), false)

Parameters:

node - the root node

name - the name to search for

deep - if the search should continue for children of nodes found in the search

Returns:

the first child node with the specified name

searchFirstForNames

public static XMLNode searchFirstForNames(XMLNode node,
                                          List<String> names,
                                          boolean deep)

Search for the the first child node having a specified name among a list of names.

Parameters:

node - the root node

names - the names to search for

deep - if the search should continue for children of nodes found in the search

Returns:

the first child node with the specified name

searchFirstForNames

public static XMLNode searchFirstForNames(XMLNode node,
                                          String[] names,
                                          boolean deep)

Search for the the first child node having a specified name among a list of names.

Parameters:

node - the root node

names - the names to search for

deep - if the search should continue for children of nodes found in the search

Returns:

the first child node with the specified name

search

public static List<XMLNode> search(XMLNode node,
                                   QName qname,
                                   boolean deep)

Search for the children nodes having a specified qualified name.

Parameters:

node - the root node

qname - the qualified name to search for

deep - if the search should continue for children of nodes found in the search

Returns:

the list of nodes with the specified name

search

public static List<XMLNode> search(XMLNode node,
                                   List<QName> qnames,
                                   boolean deep)

Search for the children nodes having a specified qualified name.

Parameters:

node - the root node

qnames - the list of qualified names to search for

deep - if the search should continue for children of nodes found in the search

Returns:

the list of nodes with the specified name

search

public static List<XMLNode> search(XMLNode node,
                                   QName[] qnames,
                                   boolean deep)

Search for the children nodes having a specified qualified name.

Parameters:

node - the root node

qnames - the list of qualified names to search for

deep - if the search should continue for children of nodes found in the search

Returns:

the list of nodes with the specified name

getRootNode

public static XMLRoot getRootNode(Reader reader)

Return the root Node from a Reader.

Parameters:

reader - the Reader

Returns:

the root node

getRootNode

public static XMLRoot getRootNode(String str)

Return the root Node from a String.

Parameters:

str - the String

Returns:

the root node

getRootNode

public static XMLRoot getRootNode(String str,
                                  XMLParserConfiguration config,
                                  boolean preserveSpace,
                                  boolean keepLineNumbers)

Return the root Node from a String.

Parameters:

str - the String

config - the parser configuration

preserveSpace - true if space characters must be preserved

keepLineNumbers - true if line numbers in the XML File are kept

Returns:

the root node

getRootNode

public static XMLRoot getRootNode(String str,
                                  boolean showExceptions,
                                  boolean showWarnings,
                                  boolean preserveSpace,
                                  boolean keepLineNumbers,
                                  boolean isNamespaceAware)

Return the root Node from a String.

Parameters:

str - the String

showExceptions - true if the parsing must show exceptions

showWarnings - true if the parsing must show warnings

preserveSpace - true if space characters must be preserved

keepLineNumbers - true if line numbers in the XML File are kept

isNamespaceAware - true if the parser must keep the namespace information

Returns:

the root node

getRootNode

public static XMLRoot getRootNode(String str,
                                  boolean showExceptions,
                                  boolean showWarnings,
                                  boolean preserveSpace,
                                  boolean keepLineNumbers,
                                  boolean isNamespaceAware,
                                  boolean allowInternalReaders)

Return the root Node from a String.

Parameters:

str - the String

showExceptions - true if the parsing must show exceptions

showWarnings - true if the parsing must show warnings

preserveSpace - true if space characters must be preserved

keepLineNumbers - true if line numbers in the XML File are kept

isNamespaceAware - true if the parser must keep the namespace information

allowInternalReaders - true if internal readers are allowed

Returns:

the root node

getRootNode

public static XMLRoot getRootNode(String str,
                                  boolean showExceptions,
                                  boolean showWarnings,
                                  boolean preserveSpace,
                                  boolean keepLineNumbers)

Return the root Node from a String.

Parameters:

str - the String

showExceptions - true if the parsing must show exceptions

showWarnings - true if the parsing must show warnings

preserveSpace - true if space characters must be preserved

keepLineNumbers - true if line numbers in the XML File are kept

Returns:

the root node

getRootNode

public static XMLRoot getRootNode(File file)

Return the root Node from a file.

Parameters:

file - the file

Returns:

the root node

getRootNode

public static XMLRoot getRootNode(File file,
                                  int options)

Return the root Node from a file.

Parameters:

file - the file

options - the options

Returns:

the root node

getRootNode

public static XMLRoot getRootNode(File file,
                                  XMLParserConfiguration config,
                                  boolean preserveSpace,
                                  boolean keepLineNumbers)

Return the root Node from a file.

Parameters:

file - the file

config - the parser configuration

preserveSpace - true if space characters must be preserved

keepLineNumbers - true if line numbers in the XML File are kept

Returns:

the root node

getRootNode

public static XMLRoot getRootNode(File file,
                                  XMLParserConfiguration config,
                                  boolean preserveSpace,
                                  boolean keepLineNumbers,
                                  boolean isNamespaceAware)

Return the root Node from a file.

Parameters:

file - the file

config - the parser configuration

preserveSpace - true if space characters must be preserved

keepLineNumbers - true if line numbers in the XML File are kept

isNamespaceAware - true if the parser must keep the namespace information

Returns:

the root node

getRootNode

public static XMLRoot getRootNode(File file,
                                  boolean showExceptions,
                                  boolean showWarnings,
                                  boolean preserveSpace,
                                  boolean keepLineNumbers)

Return the root Node from a file.

Parameters:

file - the file

showExceptions - true if the parsing must show exceptions

showWarnings - true if the parsing must show warnings

preserveSpace - true if space characters must be preserved

keepLineNumbers - true if line numbers in the XML File are kept

Returns:

the root node

getRootNode

public static XMLRoot getRootNode(File file,
                                  boolean showExceptions,
                                  boolean showWarnings,
                                  boolean preserveSpace,
                                  boolean keepLineNumbers,
                                  boolean isNamespaceAware)

Return the root Node from a file.

Parameters:

file - the file

showExceptions - true if the parsing must show exceptions

showWarnings - true if the parsing must show warnings

preserveSpace - true if space characters must be preserved

keepLineNumbers - true if line numbers in the XML File are kept

isNamespaceAware - true if the parser must keep the namespace information

Returns:

the root node

getRootNode

public static XMLRoot getRootNode(File file,
                                  boolean showExceptions,
                                  boolean showWarnings,
                                  boolean preserveSpace,
                                  boolean keepLineNumbers,
                                  boolean isNamespaceAware,
                                  boolean allowInternalReaders)

Return the root Node from a file.

Parameters:

file - the file

showExceptions - true if the parsing must show exceptions

showWarnings - true if the parsing must show warnings

preserveSpace - true if space characters must be preserved

keepLineNumbers - true if line numbers in the XML File are kept

isNamespaceAware - true if the parser must keep the namespace information

allowInternalReaders - true if internal readers are allowed

Returns:

the root node

getRootNode

public static XMLRoot getRootNode(URL xmlURL)

Return the root Node from an XML URL.

Parameters:

xmlURL - the XML URL

Returns:

the root node

getRootNode

public static XMLRoot getRootNode(URL xmlURL,
                                  int options)

Return the root Node from an URL.

Parameters:

xmlURL - the URL

options - the options

Returns:

the root node

getRootNode

public static XMLRoot getRootNode(Reader reader,
                                  XMLParserConfiguration config,
                                  boolean preserveSpace,
                                  boolean keepLineNumbers)

Return the root Node from a Reader.

Parameters:

reader - the Reader

config - the parser configuration

preserveSpace - true if space characters must be preserved

keepLineNumbers - true if line numbers in the XML File are kept

Returns:

the root node

getRootNode

public static XMLRoot getRootNode(Reader reader,
                                  XMLParserConfiguration config,
                                  boolean preserveSpace,
                                  boolean keepLineNumbers,
                                  boolean isNamespaceAware)

Return the root Node from a Reader.

Parameters:

reader - the Reader

config - the parser configuration

preserveSpace - true if space characters must be preserved

keepLineNumbers - true if line numbers in the XML File are kept

isNamespaceAware - true if the parser must keep the namespace information

Returns:

the root node

getRootNode

public static XMLRoot getRootNode(Reader reader,
                                  XMLParserConfiguration config,
                                  boolean preserveSpace,
                                  boolean keepLineNumbers,
                                  boolean isNamespaceAware,
                                  boolean allowInternalReaders)

Return the root Node from a Reader.

Parameters:

reader - the Reader

config - the parser configuration

preserveSpace - true if space characters must be preserved

keepLineNumbers - true if line numbers in the XML File are kept

isNamespaceAware - true if the parser must keep the namespace information

allowInternalReaders - true if internal readers are allowed

Returns:

the root node

getRootNode

public static XMLRoot getRootNode(Reader reader,
                                  boolean showExceptions,
                                  boolean showWarnings,
                                  boolean preserveSpace,
                                  boolean keepLineNumbers)

Return the root Node from a Reader.

Parameters:

reader - the Reader

showExceptions - true if the parsing must show exceptions

showWarnings - true if the parsing must show warnings

preserveSpace - true if space characters must be preserved

keepLineNumbers - true if line numbers in the XML File are kept

Returns:

the root node

getRootNode

public static XMLRoot getRootNode(Reader reader,
                                  boolean showExceptions,
                                  boolean showWarnings,
                                  boolean preserveSpace,
                                  boolean keepLineNumbers,
                                  boolean isNamespaceAware)

Return the root Node from a Reader.

Parameters:

reader - the Reader

showExceptions - true if the parsing must show exceptions

showWarnings - true if the parsing must show warnings

preserveSpace - true if space characters must be preserved

keepLineNumbers - true if line numbers in the XML File are kept

isNamespaceAware - true if the parser must keep the namespace information

Returns:

the root node

getRootNode

public static XMLRoot getRootNode(Reader reader,
                                  boolean showExceptions,
                                  boolean showWarnings,
                                  boolean preserveSpace,
                                  boolean keepLineNumbers,
                                  boolean isNamespaceAware,
                                  boolean allowInternalReaders)

Return the root Node from a Reader.

Parameters:

reader - the Reader

showExceptions - true if the parsing must show exceptions

showWarnings - true if the parsing must show warnings

preserveSpace - true if space characters must be preserved

keepLineNumbers - true if line numbers in the XML File are kept

isNamespaceAware - true if the parser must keep the namespace information

allowInternalReaders - true if internal readers are allowed

Returns:

the root node

getRootNode

public static XMLRoot getRootNode(Reader reader,
                                  int options)

Return the root Node from a Reader.

Parameters:

reader - the Reader

options - the options

Returns:

the root node

getRootNode

public static XMLRoot getRootNode(String str,
                                  int options)

Return the root Node from a String.

Parameters:

str - the String

options - the options

Returns:

the root node

getRootNode

public static XMLRoot getRootNode(URL xmlURL,
                                  XMLParserConfiguration config,
                                  boolean preserveSpace,
                                  boolean keepLineNumbers)

Return the root Node from an XML URL.

Parameters:

xmlURL - the XML URL

config - the parser configuration

preserveSpace - true if space characters must be preserved

keepLineNumbers - true if line numbers in the XML File are kept

Returns:

the root node

getRootNode

public static XMLRoot getRootNode(URL xmlURL,
                                  XMLParserConfiguration config,
                                  boolean preserveSpace,
                                  boolean keepLineNumbers,
                                  boolean isNamespaceAware)

Return the root Node from an XML URL.

Parameters:

xmlURL - the XML URL

config - the parser configuration

preserveSpace - true if space characters must be preserved

keepLineNumbers - true if line numbers in the XML File are kept

isNamespaceAware - true if the parser must keep the namespace information

Returns:

the root node

getRootNode

public static XMLRoot getRootNode(URL xmlURL,
                                  boolean showExceptions,
                                  boolean showWarnings,
                                  boolean preserveSpace,
                                  boolean keepLineNumbers)

Return the root Node from an XML URL.

Parameters:

xmlURL - the XML URL

showExceptions - true if the parsing must show exceptions

showWarnings - true if the parsing must show warnings

preserveSpace - true if space characters must be preserved

keepLineNumbers - true if line numbers in the XML File are kept

Returns:

the root node

getRootNode

public static XMLRoot getRootNode(URL xmlURL,
                                  boolean showExceptions,
                                  boolean showWarnings,
                                  boolean preserveSpace,
                                  boolean keepLineNumbers,
                                  boolean isNamespaceAware)

Return the root Node from an XML URL.

Parameters:

xmlURL - the XML URL

showExceptions - true if the parsing must show exceptions

showWarnings - true if the parsing must show warnings

preserveSpace - true if space characters must be preserved

keepLineNumbers - true if line numbers in the XML File are kept

isNamespaceAware - true if the parser must keep the namespace information

Returns:

the root node

getRootNode

public static XMLRoot getRootNode(URL xmlURL,
                                  boolean showExceptions,
                                  boolean showWarnings,
                                  boolean preserveSpace,
                                  boolean keepLineNumbers,
                                  boolean isNamespaceAware,
                                  boolean allowInternalReaders)

Return the root Node from an XML URL.

Parameters:

xmlURL - the XML URL

showExceptions - true if the parsing must show exceptions

showWarnings - true if the parsing must show warnings

preserveSpace - true if space characters must be preserved

keepLineNumbers - true if line numbers in the XML File are kept

isNamespaceAware - true if the parser must keep the namespace information

allowInternalReaders - true if internal readers are allowed

Returns:

the root node

getNode

public static XMLNode getNode(String str)

Return the Node from a String.

Parameters:

str - the String

Returns:

the node

getNode

public static XMLNode getNode(String str,
                              int options)

Return the Node from a String.

Parameters:

str - the String

options - the options

Returns:

the node

getNode

public static XMLNode getNode(String str,
                              XMLParserConfiguration config,
                              boolean preserveSpace,
                              boolean keepLineNumbers)

Return the Node from a String.

Parameters:

str - the String

config - the parser configuration

preserveSpace - true if space characters must be preserved

keepLineNumbers - true if line numbers in the XML File are kept

Returns:

the root node

getNode

public static XMLNode getNode(String str,
                              boolean showExceptions,
                              boolean showWarnings,
                              boolean preserveSpace,
                              boolean keepLineNumbers)

Return the Node from a String.

Parameters:

str - the String

showExceptions - true if the parsing must show exceptions

showWarnings - true if the parsing must show warnings

preserveSpace - true if space characters must be preserved

keepLineNumbers - true if line numbers in the XML File are kept

Returns:

the node

getNode

public static XMLNode getNode(String str,
                              boolean showExceptions,
                              boolean showWarnings,
                              boolean preserveSpace,
                              boolean keepLineNumbers,
                              boolean isNamespaceAware)

Return the Node from a String.

Parameters:

str - the String

showExceptions - true if the parsing must show exceptions

showWarnings - true if the parsing must show warnings

preserveSpace - true if space characters must be preserved

keepLineNumbers - true if line numbers in the XML File are kept

isNamespaceAware - true if the parser must keep the namespace information

Returns:

the node

getNode

public static XMLNode getNode(String str,
                              boolean showExceptions,
                              boolean showWarnings,
                              boolean preserveSpace,
                              boolean keepLineNumbers,
                              boolean isNamespaceAware,
                              boolean allowInternalReaders)

Return the Node from a String.

Parameters:

str - the String

showExceptions - true if the parsing must show exceptions

showWarnings - true if the parsing must show warnings

preserveSpace - true if space characters must be preserved

keepLineNumbers - true if line numbers in the XML File are kept

isNamespaceAware - true if the parser must keep the namespace information

allowInternalReaders - true if internal readers are allowed

Returns:

the node

getNode

public static XMLNode getNode(Reader reader,
                              boolean showExceptions,
                              boolean showWarnings,
                              boolean preserveSpace,
                              boolean keepLineNumbers)

Return the root Node from a Reader.

Parameters:

reader - the Reader

showExceptions - true if the parsing must show exceptions

showWarnings - true if the parsing must show warnings

preserveSpace - true if space characters must be preserved

keepLineNumbers - true if line numbers in the XML File are kept

Returns:

the node

getNode

public static XMLNode getNode(Reader reader,
                              boolean showExceptions,
                              boolean showWarnings,
                              boolean preserveSpace,
                              boolean keepLineNumbers,
                              boolean isNamespaceAware,
                              boolean allowInternalReaders)

Return the Node from a Reader.

Parameters:

reader - the Reader

showExceptions - true if the parsing must show exceptions

showWarnings - true if the parsing must show warnings

preserveSpace - true if space characters must be preserved

keepLineNumbers - true if line numbers in the XML File are kept

isNamespaceAware - true if the parser must keep the namespace information

allowInternalReaders - true if internal readers are allowed

Returns:

the node

getNode

public static XMLNode getNode(URL url)

Return the Node from an URL.

Parameters:

url - the URL

Returns:

the URL

getNode

public static XMLNode getNode(URL xmlURL,
                              boolean showExceptions,
                              boolean showWarnings,
                              boolean preserveSpace,
                              boolean keepLineNumbers)

Return the Node from an XML URL.

Parameters:

xmlURL - the XML URL

showExceptions - true if the parsing must show exceptions

showWarnings - true if the parsing must show warnings

preserveSpace - true if space characters must be preserved

keepLineNumbers - true if line numbers in the XML File are kept

Returns:

the node

getNode

public static XMLNode getNode(URL xmlURL,
                              boolean showExceptions,
                              boolean showWarnings,
                              boolean preserveSpace,
                              boolean keepLineNumbers,
                              boolean isNamespaceAware)

Return the Node from an XML URL.

Parameters:

xmlURL - the XML URL

showExceptions - true if the parsing must show exceptions

showWarnings - true if the parsing must show warnings

preserveSpace - true if space characters must be preserved

keepLineNumbers - true if line numbers in the XML File are kept

isNamespaceAware - true if the parser must keep the namespace information

Returns:

the node

getNode

public static XMLNode getNode(URL xmlURL,
                              boolean showExceptions,
                              boolean showWarnings,
                              boolean preserveSpace,
                              boolean keepLineNumbers,
                              boolean isNamespaceAware,
                              boolean allowInternalReaders)

Return the Node from an XML URL.

Parameters:

xmlURL - the XML URL

showExceptions - true if the parsing must show exceptions

showWarnings - true if the parsing must show warnings

preserveSpace - true if space characters must be preserved

keepLineNumbers - true if line numbers in the XML File are kept

isNamespaceAware - true if the parser must keep the namespace information

allowInternalReaders - true if internal readers are allowed

Returns:

the node

getNode

public static XMLNode getNode(URL xmlURL,
                              int options)

Return the root Node from an XML URL.

Parameters:

xmlURL - the XML URL

options - the options

Returns:

the root node

getNode

public static XMLNode getNode(URL xmlURL,
                              XMLParserConfiguration config,
                              boolean preserveSpace,
                              boolean keepLineNumbers)

Return the Node from an XML URL.

Parameters:

xmlURL - the XML URL

config - the parser configuration

preserveSpace - true if space characters must be preserved

keepLineNumbers - true if line numbers in the XML File are kept

Returns:

the node

getNode

public static XMLNode getNode(URL xmlURL,
                              XMLParserConfiguration config,
                              boolean preserveSpace,
                              boolean keepLineNumbers,
                              boolean isNamespaceAware)

Return the Node from an XML URL.

Parameters:

xmlURL - the XML URL

config - the parser configuration

preserveSpace - true if space characters must be preserved

keepLineNumbers - true if line numbers in the XML File are kept

isNamespaceAware - true if the parser must keep the namespace information

Returns:

the node

getNode

public static XMLNode getNode(Reader reader,
                              int options)

Return the Node from a Reader.

Parameters:

reader - the Reader

options - the options

Returns:

the node

getNode

public static XMLNode getNode(Reader reader,
                              XMLParserConfiguration config,
                              boolean preserveSpace,
                              boolean keepLineNumbers,
                              boolean isNamespaceAware)

Return the Node from a Reader.

Parameters:

reader - the Reader

config - the parser configuration

preserveSpace - true if space characters must be preserved

keepLineNumbers - true if line numbers in the XML File are kept

isNamespaceAware - true if the parser must keep the namespace information

Returns:

the node

getNode

public static XMLNode getNode(Reader reader,
                              XMLParserConfiguration config,
                              boolean preserveSpace,
                              boolean keepLineNumbers,
                              boolean isNamespaceAware,
                              boolean allowInternalReaders)

Return the Node from a Reader.

Parameters:

reader - the Reader

config - the parser configuration

preserveSpace - true if space characters must be preserved

keepLineNumbers - true if line numbers in the XML File are kept

isNamespaceAware - true if the parser must keep the namespace information

allowInternalReaders - true if internal readers are allowed

Returns:

the node

getNode

public static XMLNode getNode(Reader reader)

Return the root Node from a Reader.

Parameters:

reader - the Reader

Returns:

the root node

getNode

public static XMLNode getNode(File file)

Return the Node from a file.

Parameters:

file - the file

Returns:

the node

getNode

public static XMLNode getNode(File file,
                              int options)

Return the root Node from a file.

Parameters:

file - the file

options - the options

Returns:

the root node

getNode

public static XMLNode getNode(File file,
                              XMLParserConfiguration config,
                              boolean preserveSpace,
                              boolean keepLineNumbers)

Return the Node from a file.

Parameters:

file - the file

config - the parser configuration

preserveSpace - true if space characters must be preserved

keepLineNumbers - true if line numbers in the XML File are kept

Returns:

the node

getNode

public static XMLNode getNode(File file,
                              boolean showExceptions,
                              boolean showWarnings,
                              boolean preserveSpace,
                              boolean keepLineNumbers)

Return the Node from a file.

Parameters:

file - the file

showExceptions - true if the parsing must show exceptions

showWarnings - true if the parsing must show warnings

preserveSpace - true if space characters must be preserved

keepLineNumbers - true if line numbers in the XML File are kept

Returns:

the node

getNode

public static XMLNode getNode(File file,
                              boolean showExceptions,
                              boolean showWarnings,
                              boolean preserveSpace,
                              boolean keepLineNumbers,
                              boolean isNamespaceAware,
                              boolean allowInternalReaders)

Return the Node from a file.

Parameters:

file - the file

showExceptions - true if the parsing must show exceptions

showWarnings - true if the parsing must show warnings

preserveSpace - true if space characters must be preserved

keepLineNumbers - true if line numbers in the XML File are kept

isNamespaceAware - true if the parser must keep the namespace information

allowInternalReaders - true if internal readers are allowed

Returns:

the node

print

public static void print(XMLNode node,
                         int indentation,
                         File outputFile)
                  throws IOException

Save in a File the content of an XML file under a root Node.

Parameters:

node - the root node

indentation - the indentation for the XML file for each child node

outputFile - the output file

Throws:

IOException

print

public static void print(XMLNode node,
                         int indentation,
                         File outputFile,
                         String encoding)
                  throws IOException

Save in a File the content of an XML file under a root Node.

Parameters:

node - the root node

indentation - the indentation for the XML file for each child node

outputFile - the output file

encoding - the encoding (can be null)

Throws:

IOException

print

public static void print(XMLNode node,
                         int indentation,
                         URL outputURL)
                  throws IOException

Save in an URL the content of an XML file under a root Node.

Parameters:

node - the root node

indentation - the indentation for the XML file for each child node

outputURL - the output URL

Throws:

IOException

print

public static String print(XMLNode node,
                           int indentation)

Print as a String the content of an XML file under a root Node.

Parameters:

node - the root node

indentation - the indentation for the XML file for each child node

Returns:

the String

print

public static String print(XMLNode node,
                           int indentation,
                           String encoding)

Print as a String the content of an XML file under a root Node.

Parameters:

node - the root node

indentation - the indentation for the XML file for each child node

encoding - the encoding (vcan be null)

Returns:

the String