Modifier and Type	Class and Description
private class	JAXBModifier.JAXBElementModifier

Modifier and Type	Field and Description
private SAXModifier	modifier
private HashMap<String, JAXBObjectModifier>	modifiers
private OutputFormat	outputFormat
private boolean	pruneElements
private XMLWriter	xmlWriter

Access	Constructor and Description
public	JAXBModifier(String JAXB context path to be used contextPath) Creates a new JAXBModifier for the given JAXB context path.
public	JAXBModifier(String JAXB context path to be used contextPath, ClassLoader the classloader to use classloader) Creates a new JAXBModifier for the given JAXB context path, using the given `java.lang.ClassLoader`.
public	JAXBModifier(String JAXB context path to be used contextPath, OutputFormat the DOM4J `org.dom4j.io.OutputFormat`to be used outputFormat) Creates a new JAXBModifier for the given JAXB context path.
public	JAXBModifier(String JAXB context path to be used contextPath, ClassLoader the class loader to be used to load JAXB classloader, OutputFormat the DOM4J `org.dom4j.io.OutputFormat`to be used outputFormat) Creates a new JAXBModifier for the given JAXB context path, using the specified `java.lang.ClassLoader`.

Method Summary

Modifier and Type	Method and Description
public void	addObjectModifier(String the element path to listen for path, JAXBObjectModifier the modifier to register mod) Adds the `JAXBObjectModifier`to be called when the specified xml path is encounted while parsing the source.
private XMLWriter	createXMLWriter()
private SAXModifier	getModifier()
private XMLWriter	getXMLWriter()
private SAXModifier	installModifier()
public boolean	Returns: Returns true if elements are pruned. isPruneElements() Returns true when the modified `org.dom4j.Document`is not kept in memory.
public Document	Returns: the resulting DOM4J document modify(File the file to parse source) Parses the specified `java.io.File`with SAX
public Document	Returns: the resulting DOM4J document modify(File the file to parse source, Charset the character set to use charset) Parses the specified `java.io.File`with SAX, using the given `java.nio.charset.Charset`.
public Document	Returns: the resulting DOM4J document modify(InputSource the input source to parse source) Parses the specified `org.xml.sax.InputSource`with SAX.
public Document	Returns: the resulting DOM4J document modify(InputStream the inputstream to parse source) Parses the specified `java.io.InputStream`with SAX.
public Document	Returns: the resulting DOM4J document modify(InputStream the inputstream to parse source, String the URI of the given inputstream systemId) Parses the specified `java.io.InputStream`with SAX.
public Document	Returns: the resulting DOM4J document modify(Reader the reader to use for parsing r) Parses the specified `java.io.Reader`with SAX.
public Document	Returns: the resulting DOM4J document modify(Reader the reader to parse source, String the URI of the given reader systemId) Parses the specified `java.io.Reader`with SAX.
public Document	Returns: the resulting DOM4J document modify(String the URL or filename to parse url) Parses the the given URL or filename.
public Document	Returns: the resulting DOM4J document modify(URL the URL to parse source) Parses the the given URL.
public void	removeObjectModifier(String the xml path to remove the modifier for path) Removes the `JAXBObjectModifier`from the event based processor, for the specified element path.
public void	resetObjectModifiers() Removes all registered `JAXBObjectModifier`instances from the event based processor.
public void	setOutput(File the `java.io.File`to write to file) Sets the Output to write the (modified) xml document to.
public void	setOutput(OutputStream the `java.io.OutputStream`to write to outputStream) Sets the Output to write the (modified) xml document to.
public void	setOutput(Writer the `java.io.Writer`to write to writer) Sets the Output to write the (modified) xml document to.
public void	setPruneElements(boolean When true, elements will not be kept in memory pruneElements) Define whether the modified `org.dom4j.Document`must only be written to the output and pruned from the DOM4J tree.

Inherited from org.dom4j.jaxb.JAXBSupport:: marshal unmarshal

Field Detail

modifier	back to summary
private SAXModifier modifier

modifiers	back to summary
private HashMap<String, JAXBObjectModifier> modifiers

outputFormat	back to summary
private OutputFormat outputFormat

pruneElements	back to summary
private boolean pruneElements

xmlWriter	back to summary
private XMLWriter xmlWriter

Constructor Detail

JAXBModifier back to summary

JAXBModifier	back to summary
public JAXBModifier(String contextPath) Creates a new JAXBModifier for the given JAXB context path. This is the Java package where JAXB can find the generated XML classes. This package MUST contain jaxb.properties! Parameters contextPath:String JAXB context path to be used See Also `javax.xml.bind.JAXBContext`

public JAXBModifier(String contextPath)

Creates a new JAXBModifier for the given JAXB context path. This is the Java package where JAXB can find the generated XML classes. This package MUST contain jaxb.properties!

Parameters

contextPath:String: JAXB context path to be used

See Also

javax.xml.bind.JAXBContext

JAXBModifier back to summary

JAXBModifier	back to summary
public JAXBModifier(String contextPath, ClassLoader classloader) Creates a new JAXBModifier for the given JAXB context path, using the given `java.lang.ClassLoader`. This is the Java package where JAXB can find the generated XML classes. This package MUST contain jaxb.properties! Parameters contextPath:String JAXB context path to be used classloader:ClassLoader the classloader to use See Also `javax.xml.bind.JAXBContext`

public JAXBModifier(String contextPath, ClassLoader classloader)

Creates a new JAXBModifier for the given JAXB context path, using the given java.lang.ClassLoader. This is the Java package where JAXB can find the generated XML classes. This package MUST contain jaxb.properties!

Parameters

contextPath:String: JAXB context path to be used
classloader:ClassLoader: the classloader to use

See Also

javax.xml.bind.JAXBContext

JAXBModifier back to summary

JAXBModifier	back to summary
public JAXBModifier(String contextPath, OutputFormat outputFormat) Creates a new JAXBModifier for the given JAXB context path. The specified `org.dom4j.io.OutputFormat`will be used while writing the XML stream. Parameters contextPath:String JAXB context path to be used outputFormat:OutputFormat the DOM4J `org.dom4j.io.OutputFormat`to be used See Also `javax.xml.bind.JAXBContext`

public JAXBModifier(String contextPath, OutputFormat outputFormat)

Creates a new JAXBModifier for the given JAXB context path. The specified org.dom4j.io.OutputFormatwill be used while writing the XML stream.

Parameters

contextPath:String: JAXB context path to be used
outputFormat:OutputFormat: the DOM4J org.dom4j.io.OutputFormatto be used

See Also

javax.xml.bind.JAXBContext

JAXBModifier back to summary

JAXBModifier	back to summary
public JAXBModifier(String contextPath, ClassLoader classloader, OutputFormat outputFormat) Creates a new JAXBModifier for the given JAXB context path, using the specified `java.lang.ClassLoader`. The specified `org.dom4j.io.OutputFormat` will be used while writing the XML stream. Parameters contextPath:String JAXB context path to be used classloader:ClassLoader the class loader to be used to load JAXB outputFormat:OutputFormat the DOM4J `org.dom4j.io.OutputFormat`to be used See Also `javax.xml.bind.JAXBContext`

public JAXBModifier(String contextPath, ClassLoader classloader, OutputFormat outputFormat)

Creates a new JAXBModifier for the given JAXB context path, using the specified java.lang.ClassLoader. The specified org.dom4j.io.OutputFormat will be used while writing the XML stream.

Parameters

contextPath:String: JAXB context path to be used
classloader:ClassLoader: the class loader to be used to load JAXB
outputFormat:OutputFormat: the DOM4J org.dom4j.io.OutputFormatto be used

See Also

javax.xml.bind.JAXBContext

Method Detail

addObjectModifier back to summary

addObjectModifier	back to summary
public void addObjectModifier(String path, JAXBObjectModifier mod) Adds the `JAXBObjectModifier`to be called when the specified xml path is encounted while parsing the source. Parameters path:String the element path to listen for mod:JAXBObjectModifier the modifier to register

public void addObjectModifier(String path, JAXBObjectModifier mod)

Adds the JAXBObjectModifierto be called when the specified xml path is encounted while parsing the source.

Parameters

path:String: the element path to listen for
mod:JAXBObjectModifier: the modifier to register

createXMLWriter	back to summary
private XMLWriter createXMLWriter() throws IOException

getModifier	back to summary
private SAXModifier getModifier()

getXMLWriter	back to summary
private XMLWriter getXMLWriter()

installModifier	back to summary
private SAXModifier installModifier() throws IOException

isPruneElements back to summary

isPruneElements	back to summary
public boolean isPruneElements() Returns true when the modified `org.dom4j.Document`is not kept in memory. Returns:boolean Returns true if elements are pruned.

public boolean isPruneElements()

Returns true when the modified org.dom4j.Documentis not kept in memory.

Returns:boolean: Returns true if elements are pruned.

modify back to summary

modify	back to summary
public Document modify(File source) throws DocumentException, IOException Parses the specified `java.io.File`with SAX Parameters source:File the file to parse Returns:Document the resulting DOM4J document Exceptions DocumentException: when an error occurs while parsing IOException: when an error occurs while writing to the `org.dom4j.io.XMLWriter`

public Document modify(File source) throws DocumentException, IOException

Parses the specified java.io.Filewith SAX

Parameters

source:File: the file to parse

Returns:Document

the resulting DOM4J document

Exceptions

DocumentException:: when an error occurs while parsing
IOException:: when an error occurs while writing to the org.dom4j.io.XMLWriter

modify back to summary

modify	back to summary
public Document modify(File source, Charset charset) throws DocumentException, IOException Parses the specified `java.io.File`with SAX, using the given `java.nio.charset.Charset`. Parameters source:File the file to parse charset:Charset the character set to use Returns:Document the resulting DOM4J document Exceptions DocumentException: when an error occurs while parsing IOException: when an error occurs while writing to the `org.dom4j.io.XMLWriter`

public Document modify(File source, Charset charset) throws DocumentException, IOException

Parses the specified java.io.Filewith SAX, using the given java.nio.charset.Charset.

Parameters

source:File: the file to parse
charset:Charset: the character set to use

Returns:Document

the resulting DOM4J document

Exceptions

DocumentException:: when an error occurs while parsing
IOException:: when an error occurs while writing to the org.dom4j.io.XMLWriter

modify back to summary

modify	back to summary
public Document modify(InputSource source) throws DocumentException, IOException Parses the specified `org.xml.sax.InputSource`with SAX. Parameters source:InputSource the input source to parse Returns:Document the resulting DOM4J document Exceptions DocumentException: when an error occurs while parsing IOException: when an error occurs while writing to the `org.dom4j.io.XMLWriter`

public Document modify(InputSource source) throws DocumentException, IOException

Parses the specified org.xml.sax.InputSourcewith SAX.

Parameters

source:InputSource: the input source to parse

Returns:Document

the resulting DOM4J document

Exceptions

DocumentException:: when an error occurs while parsing
IOException:: when an error occurs while writing to the org.dom4j.io.XMLWriter

modify back to summary

modify	back to summary
public Document modify(InputStream source) throws DocumentException, IOException Parses the specified `java.io.InputStream`with SAX. Parameters source:InputStream the inputstream to parse Returns:Document the resulting DOM4J document Exceptions DocumentException: when an error occurs while parsing IOException: when an error occurs while writing to the `org.dom4j.io.XMLWriter`

public Document modify(InputStream source) throws DocumentException, IOException

Parses the specified java.io.InputStreamwith SAX.

Parameters

source:InputStream: the inputstream to parse

Returns:Document

the resulting DOM4J document

Exceptions

DocumentException:: when an error occurs while parsing
IOException:: when an error occurs while writing to the org.dom4j.io.XMLWriter

modify back to summary

modify	back to summary
public Document modify(InputStream source, String systemId) throws DocumentException, IOException Parses the specified `java.io.InputStream`with SAX. Parameters source:InputStream the inputstream to parse systemId:String the URI of the given inputstream Returns:Document the resulting DOM4J document Exceptions DocumentException: when an error occurs while parsing IOException: when an error occurs while writing to the `org.dom4j.io.XMLWriter`

public Document modify(InputStream source, String systemId) throws DocumentException, IOException

Parses the specified java.io.InputStreamwith SAX.

Parameters

source:InputStream: the inputstream to parse
systemId:String: the URI of the given inputstream

Returns:Document

the resulting DOM4J document

Exceptions

DocumentException:: when an error occurs while parsing
IOException:: when an error occurs while writing to the org.dom4j.io.XMLWriter

modify back to summary

modify	back to summary
public Document modify(Reader r) throws DocumentException, IOException Parses the specified `java.io.Reader`with SAX. Parameters r:Reader the reader to use for parsing Returns:Document the resulting DOM4J document Exceptions DocumentException: when an error occurs while parsing IOException: when an error occurs while writing to the `org.dom4j.io.XMLWriter`

public Document modify(Reader r) throws DocumentException, IOException

Parses the specified java.io.Readerwith SAX.

Parameters

r:Reader: the reader to use for parsing

Returns:Document

the resulting DOM4J document

Exceptions

DocumentException:: when an error occurs while parsing
IOException:: when an error occurs while writing to the org.dom4j.io.XMLWriter

modify back to summary

modify	back to summary
public Document modify(Reader source, String systemId) throws DocumentException, IOException Parses the specified `java.io.Reader`with SAX. Parameters source:Reader the reader to parse systemId:String the URI of the given reader Returns:Document the resulting DOM4J document Exceptions DocumentException: when an error occurs while parsing IOException: when an error occurs while writing to the `org.dom4j.io.XMLWriter`

public Document modify(Reader source, String systemId) throws DocumentException, IOException

Parses the specified java.io.Readerwith SAX.

Parameters

source:Reader: the reader to parse
systemId:String: the URI of the given reader

Returns:Document

the resulting DOM4J document

Exceptions

DocumentException:: when an error occurs while parsing
IOException:: when an error occurs while writing to the org.dom4j.io.XMLWriter

modify back to summary

modify	back to summary
public Document modify(String url) throws DocumentException, IOException Parses the the given URL or filename. Parameters url:String the URL or filename to parse Returns:Document the resulting DOM4J document Exceptions DocumentException: when an error occurs while parsing IOException: when an error occurs while writing to the `org.dom4j.io.XMLWriter`

public Document modify(String url) throws DocumentException, IOException

Parses the the given URL or filename.

Parameters

url:String: the URL or filename to parse

Returns:Document

the resulting DOM4J document

Exceptions

DocumentException:: when an error occurs while parsing
IOException:: when an error occurs while writing to the org.dom4j.io.XMLWriter

modify back to summary

modify	back to summary
public Document modify(URL source) throws DocumentException, IOException Parses the the given URL. Parameters source:URL the URL to parse Returns:Document the resulting DOM4J document Exceptions DocumentException: when an error occurs while parsing IOException: when an error occurs while writing to the `org.dom4j.io.XMLWriter`

public Document modify(URL source) throws DocumentException, IOException

Parses the the given URL.

Parameters

source:URL: the URL to parse

Returns:Document

the resulting DOM4J document

Exceptions

DocumentException:: when an error occurs while parsing
IOException:: when an error occurs while writing to the org.dom4j.io.XMLWriter

removeObjectModifier back to summary

removeObjectModifier	back to summary
public void removeObjectModifier(String path) Removes the `JAXBObjectModifier`from the event based processor, for the specified element path. Parameters path:String the xml path to remove the modifier for

public void removeObjectModifier(String path)

Removes the JAXBObjectModifierfrom the event based processor, for the specified element path.

Parameters

path:String: the xml path to remove the modifier for

resetObjectModifiers	back to summary
public void resetObjectModifiers() Removes all registered `JAXBObjectModifier`instances from the event based processor.

setOutput back to summary

setOutput	back to summary
public void setOutput(File file) throws IOException Sets the Output to write the (modified) xml document to. Parameters file:File the `java.io.File`to write to Exceptions IOException: when the file cannot be found or when the outputformat

public void setOutput(File file) throws IOException

Sets the Output to write the (modified) xml document to.

Parameters

file:File: the java.io.Fileto write to

Exceptions

IOException:: when the file cannot be found or when the outputformat

setOutput back to summary

setOutput	back to summary
public void setOutput(OutputStream outputStream) throws IOException Sets the Output to write the (modified) xml document to. Parameters outputStream:OutputStream the `java.io.OutputStream`to write to Exceptions IOException: when an error occurs

public void setOutput(OutputStream outputStream) throws IOException

Sets the Output to write the (modified) xml document to.

Parameters

outputStream:OutputStream: the java.io.OutputStreamto write to

Exceptions

IOException:: when an error occurs

setOutput back to summary

setOutput	back to summary
public void setOutput(Writer writer) throws IOException Sets the Output to write the (modified) xml document to. Parameters writer:Writer the `java.io.Writer`to write to Exceptions IOException: when an error occurs

public void setOutput(Writer writer) throws IOException

Sets the Output to write the (modified) xml document to.

Parameters

writer:Writer: the java.io.Writerto write to

Exceptions

IOException:: when an error occurs

setPruneElements back to summary

setPruneElements	back to summary
public void setPruneElements(boolean pruneElements) Define whether the modified `org.dom4j.Document`must only be written to the output and pruned from the DOM4J tree. Parameters pruneElements:boolean When true, elements will not be kept in memory

public void setPruneElements(boolean pruneElements)

Define whether the modified org.dom4j.Documentmust only be written to the output and pruned from the DOM4J tree.

Parameters

pruneElements:boolean: When true, elements will not be kept in memory

org.dom4j.jaxb back to summary

private Class JAXBModifier.JAXBElementModifier

Class Inheritance

extends Object
implements ElementModifier

java.lang.Object
org.dom4j.jaxb.JAXBModifier.JAXBElementModifier

All Implemented Interfaces

org.dom4j.io.ElementModifier

Field Summary

Modifier and Type	Field and Description
private JAXBModifier	jaxbModifier
private JAXBObjectModifier	objectModifier

Constructor Summary

Access	Constructor and Description
public	JAXBElementModifier(JAXBModifier jaxbModifier, JAXBObjectModifier objectModifier)

Method Summary

Modifier and Type	Method and Description
public Element	modifyElement(Element `org.dom4j.Element`to be parsed element) Implements org.dom4j.io.ElementModifier.modifyElement. Called by an event based processor when an elements closing tag is encountered.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

jaxbModifier	back to summary
private JAXBModifier jaxbModifier

objectModifier	back to summary
private JAXBObjectModifier objectModifier

Constructor Detail

JAXBElementModifier	back to summary
public JAXBElementModifier(JAXBModifier jaxbModifier, JAXBObjectModifier objectModifier)

Method Detail

modifyElement back to summary

modifyElement	back to summary
public Element modifyElement(Element element) throws Exception Implements org.dom4j.io.ElementModifier.modifyElement. Doc from org.dom4j.io.ElementModifier.modifyElement. Called by an event based processor when an elements closing tag is encountered. This method must return the modified version of the provided `org.dom4j.Element`or null if it has to be removed from the document. The incoming `org.dom4j.Element`is disconnected from the DOM4J tree. This means that navigation to the elements parent `org.dom4j.Element` and `org.dom4j.Document`are not available. Only the element itself can be modified! Parameters element:Element `org.dom4j.Element`to be parsed Returns:Element the modified `org.dom4j.Element` Exceptions Exception: of any kind

public Element modifyElement(Element element) throws Exception

Implements org.dom4j.io.ElementModifier.modifyElement.

Doc from org.dom4j.io.ElementModifier.modifyElement.

Called by an event based processor when an elements closing tag is encountered. This method must return the modified version of the provided org.dom4j.Elementor null if it has to be removed from the document.
The incoming org.dom4j.Elementis disconnected from the DOM4J tree. This means that navigation to the elements parent org.dom4j.Element and org.dom4j.Documentare not available. Only the element itself can be modified!

Parameters

element:Element: org.dom4j.Elementto be parsed

Returns:Element

the modified org.dom4j.Element

Exceptions

Exception:: of any kind

public Class JAXBModifier

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class JAXBModifier.JAXBElementModifier

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail