XMLChildrenIncluder

All Known Implementing Classes:

XMLIncluder, XMLNodeIncluder
```
public interface XMLChildrenIncluder
```
This interface process XML files by including the content of XInclude children.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`Charset`	`getCharset()` Return the charset to use to write the content.
`String`	`getContent()` Return a String representing the XML content.
`ErrorHandler`	`getErrorHandler()` Return the ErrorHandler which will be fired for warnings and errors when parsing the content.
`Reader`	`getReader()` Return a Reader to the XML content.
`boolean`	`isAddingComments()` Return true if a comment must be added for each included file.
`boolean`	`isEnablingDeepComments()` Return true if the comments in deep include declarations must be added.
`static void`	`resetSAXParserFactoryImplementation()` Reset the SAXParser factory implementation to the default.
`default void`	`setAddComments(boolean addComments)` Set if a comment must be added for each included file.
`void`	`setAddComments(boolean addComments, boolean deep)` Set if a comment must be added for each included file.
`void`	`setCharset(Charset charset)` Set the charset to use to write the content.
`void`	`setDefaultBaseDirectory(URL baseDir)` Set the default base directory for including files.
`void`	`setErrorHandler(ErrorHandler errorHandler)` Set the ErrorHandler which will be fired for warnings and errors when parsing the content.
`void`	`setFile(File file)` Set the includer file.
`void`	`setInputStream(InputStream stream)` Set the includer InputStream.
`default void`	`setSAXParserFactoryImplementation(String factoryClassName)` Set the SAXParser factory implementation.
`void`	`setURL(URL url)` Set the includer URL.
`void`	`write(File file)` Write the resulting XML to a File.
`void`	`write(URL url)` Write the resulting XML to an URL.

- Method Detail
  - setFile
```
void setFile(File file)
      throws MalformedURLException
```
    Set the includer file.
    
    Parameters:
    
    file - the file
    
    Throws:
    
    MalformedURLException
  - setURL
```
void setURL(URL url)
```
    Set the includer URL.
    
    Parameters:
    
    url - the URL
  - setInputStream
```
void setInputStream(InputStream stream)
```
    Set the includer InputStream.
    
    Parameters:
    
    stream - the InputStream
  - setAddComments
```
default void setAddComments(boolean addComments)
```
    Set if a comment must be added for each included file.
    
    Parameters:
    
    addComments - true if a comment must be added for each included file
  - setAddComments
```
void setAddComments(boolean addComments,
                    boolean deep)
```
    Set if a comment must be added for each included file.
    
    Parameters:
    
    addComments - true if a comment must be added for each included file
    
    deep - true if the comments in deep include declarations must be added
  - isAddingComments
```
boolean isAddingComments()
```
    Return true if a comment must be added for each included file.
    
    Returns:
    
    true if a comment must be added for each included file
  - setCharset
```
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
```
Charset getCharset()
```
    Return the charset to use to write the content.
    
    Returns:
    
    the charset
  - isEnablingDeepComments
```
boolean isEnablingDeepComments()
```
    Return true if the comments in deep include declarations must be added.
    
    Returns:
    
    true if the comments in deep include declarations must be added
  - setErrorHandler
```
void setErrorHandler(ErrorHandler errorHandler)
```
    Set the ErrorHandler which will be fired for warnings and errors when parsing the content.
    
    Parameters:
    
    errorHandler - the ErrorHandler
  - getErrorHandler
```
ErrorHandler getErrorHandler()
```
    Return the ErrorHandler which will be fired for warnings and errors when parsing the content.
    
    Returns:
    
    the ErrorHandler
  - setDefaultBaseDirectory
```
void setDefaultBaseDirectory(URL baseDir)
```
    Set the default base directory for including files. This is useful to detect relative XML files when applying the xinclude declarations if the input is an InputStream.
    
    Parameters:
    
    baseDir - the default base directory
  - setSAXParserFactoryImplementation
```
default void setSAXParserFactoryImplementation(String factoryClassName)
```
    Set the SAXParser factory implementation.
    
    Parameters:
    
    factoryClassName - the factory class name
  - resetSAXParserFactoryImplementation
```
static void resetSAXParserFactoryImplementation()
```
    Reset the SAXParser factory implementation to the default.
  - getContent
```
String getContent()
```
    Return a String representing the XML content.
    
    Returns:
    
    the StringReader
  - getReader
```
Reader getReader()
```
    Return a Reader to the XML content.
    
    Returns:
    
    the StringReader
  - write
```
void write(File file)
    throws IOException
```
    Write the resulting XML to a File.
    
    Parameters:
    
    file - the File
    
    Throws:
    
    IOException
  - write
```
void write(URL url)
    throws IOException
```
    Write the resulting XML to an URL.
    
    Parameters:
    
    url - the URL
    
    Throws:
    
    IOException

Interface XMLChildrenIncluder

Method Summary

Method Detail

setFile

setURL

setInputStream

setAddComments

setAddComments

isAddingComments

setCharset

getCharset

isEnablingDeepComments

setErrorHandler

getErrorHandler

setDefaultBaseDirectory

setSAXParserFactoryImplementation

resetSAXParserFactoryImplementation

getContent

getReader

write

write