Package org.jboss.staxmapper
Interface XMLMapper
-
- All Known Implementing Classes:
XMLMapperImpl
public interface XMLMapper
An XML mapper. Allows the creation of extensible streaming XML parsers.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
XMLMapper.Factory
A factory for creating an instance ofXMLMapper
.
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description void
deparseDocument(XMLContentWriter contentWriter, javax.xml.stream.XMLStreamWriter streamWriter)
Deprecated.void
deparseDocument(XMLElementWriter<?> writer, java.lang.Object rootObject, javax.xml.stream.XMLStreamWriter streamWriter)
Format the element writer's output on to an XML stream writer.void
parseDocument(java.lang.Object rootObject, javax.xml.stream.XMLStreamReader reader)
Parse a document.void
registerRootAttribute(javax.xml.namespace.QName name, XMLAttributeReader<?> reader)
Add a known root attribute which can be read byXMLExtendedStreamReader.handleAttribute(Object, int)
.void
registerRootElement(javax.xml.namespace.QName name, XMLElementReader<?> reader)
Add a known root element which can be read byXMLExtendedStreamReader.handleAny(Object)
.void
unregisterRootAttribute(javax.xml.namespace.QName name)
Removes apreviously registered root attribute
.void
unregisterRootElement(javax.xml.namespace.QName name)
Removes apreviously registered root element
.
-
-
-
Method Detail
-
registerRootElement
void registerRootElement(javax.xml.namespace.QName name, XMLElementReader<?> reader)
Add a known root element which can be read byXMLExtendedStreamReader.handleAny(Object)
.- Parameters:
name
- the element namereader
- the reader which handles the element
-
unregisterRootElement
void unregisterRootElement(javax.xml.namespace.QName name)
Removes apreviously registered root element
.- Parameters:
name
- the element name
-
registerRootAttribute
void registerRootAttribute(javax.xml.namespace.QName name, XMLAttributeReader<?> reader)
Add a known root attribute which can be read byXMLExtendedStreamReader.handleAttribute(Object, int)
.- Parameters:
name
- the attribute namereader
- the reader which handles the attribute
-
unregisterRootAttribute
void unregisterRootAttribute(javax.xml.namespace.QName name)
Removes apreviously registered root attribute
.- Parameters:
name
- the element name
-
parseDocument
void parseDocument(java.lang.Object rootObject, javax.xml.stream.XMLStreamReader reader) throws javax.xml.stream.XMLStreamException
Parse a document. The document must have a known, registered root element which can accept the given root object.- Parameters:
rootObject
- the root object to send inreader
- the reader from which the document should be read- Throws:
javax.xml.stream.XMLStreamException
- if an error occurs
-
deparseDocument
void deparseDocument(XMLElementWriter<?> writer, java.lang.Object rootObject, javax.xml.stream.XMLStreamWriter streamWriter) throws javax.xml.stream.XMLStreamException
Format the element writer's output on to an XML stream writer.- Parameters:
writer
- the element writerrootObject
- the root object to send instreamWriter
- the stream writer- Throws:
javax.xml.stream.XMLStreamException
- if an exception occurs
-
deparseDocument
@Deprecated void deparseDocument(XMLContentWriter contentWriter, javax.xml.stream.XMLStreamWriter streamWriter) throws javax.xml.stream.XMLStreamException
Deprecated.Format the content writer's output on to an XML stream writer.- Parameters:
contentWriter
- the content writerstreamWriter
- the stream writer- Throws:
javax.xml.stream.XMLStreamException
- if an exception occurs
-
-