XML Includer

Two classes allow to process the XInclude declarations in a XML file:

• The XMLIncluder class process the XInclude declarations in a XML file and creates a returning Reader
• The XMLNodeIncluder class does the same but uses the xml.tree nodes to create the tree structure

XMLIncluder

The XMLIncluder class process the XInclude declarations in a XML file and creates a returning Reader.

Note that if you want to parse and validate an XML file, you don't need to use this class directly, but you can directly configure the XML parser class.

For example:

   XMLIncluder includer = new XMLIncluder(<my XML file>);
   String content = includer.getContent();

XMLNodeIncluder

The XMLNodeIncluder class does the same but uses the xml.tree nodes to create the tree structure.

For example:

   XMLNodeIncluder includer = new XMLNodeIncluder(<my XML file>);
   includer.write(<my output XML file>);

XMLNodeIncluder specific configuration

Several methods allow to further configure the result:

• The XMLNodeIncluder.skipAllPrefixes(boolean) allows to specify that all binding prefixes declarations will be skipped
• The XMLNodeIncluder.skipPrefixes(String...) allows to specify that only some binding prefixes declarations will be skipped
• The XMLNodeIncluder.setIndentation(int) specifies the indentation of children nodes
• The XMLNodeIncluder.keepAttributesOrder(boolean) allows to specify if you want the order of attributes of each node in the result to be preserved after performing the inclusion. By default the order is preserved, but if the boolean is set to false, then the order will be alphabetical^[1]
  You can also specify this boolean property at the creation of the includer

It is also possible to customize the error handler and entity resolver of the underlying XMLSAXParser.

Includer configuration

Two methods allow to configure how the result will be created are available for the two includer classes:

• The XMLChildrenIncluder.setAddComments(boolean, boolean) allows to specify if the includer must add XML comments for each included file, and if comments in deep include declarations must be added
• The XMLChildrenIncluder.setAddComments(boolean) allows to specify if the includer must add XML comments for each included file. In this cases comments in deep include declarations are not added