Interface XmlEventReaderFactory
-
- All Known Implementing Classes:
DefaultXmlEventReaderFactory
public interface XmlEventReaderFactory
Factory to create event readers over different types of Confluence XML (namely editor and storage XML).
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description XMLEventReader
createEditorXmlEventReader(Reader xml)
XMLEventReader
createStorageXmlEventReader(Reader xml)
XMLEventReader
createStorageXmlEventReader(Reader xml, boolean entityReplacing)
This method is experimental and may change at very short notice.XMLEventReader
createXmlEventReader(Reader xml)
XMLEventReader
createXMLEventReader(Reader xml, List<Namespace> namespaces, boolean entityReplacing)
A factory method providing more detailed control over the XMLEventReader you require.XMLEventReader
createXmlFragmentBodyEventReader(XMLEventReader delegate)
XMLEventReader
createXmlFragmentEventReader(Reader xml)
Create a fragment event reader which excludes the start and end document events.XMLEventReader
createXmlFragmentEventReader(XMLEventReader delegate)
-
-
-
Method Detail
-
createXmlEventReader
XMLEventReader createXmlEventReader(Reader xml) throws XMLStreamException
- Throws:
XMLStreamException
-
createXmlFragmentEventReader
XMLEventReader createXmlFragmentEventReader(Reader xml) throws XMLStreamException
Create a fragment event reader which excludes the start and end document events.- Throws:
XMLStreamException
-
createStorageXmlEventReader
XMLEventReader createStorageXmlEventReader(Reader xml) throws XMLStreamException
- Throws:
XMLStreamException
-
createStorageXmlEventReader
XMLEventReader createStorageXmlEventReader(Reader xml, boolean entityReplacing) throws XMLStreamException
This method is experimental and may change at very short notice.- Throws:
XMLStreamException
-
createEditorXmlEventReader
XMLEventReader createEditorXmlEventReader(Reader xml) throws XMLStreamException
- Throws:
XMLStreamException
-
createXMLEventReader
XMLEventReader createXMLEventReader(Reader xml, List<Namespace> namespaces, boolean entityReplacing) throws XMLStreamException
A factory method providing more detailed control over the XMLEventReader you require.- Parameters:
xml
- the XML formatted data to be readnamespaces
- a List of namespaces to be found within the supplied XML dataentityReplacing
- a flag indicating whether entities found within the XML data should be replaced with characters, or left as entities.- Returns:
- the required XMLEventReader.
- Throws:
XMLStreamException
-
createXmlFragmentEventReader
XMLEventReader createXmlFragmentEventReader(XMLEventReader delegate) throws XMLStreamException
- Throws:
XMLStreamException
-
createXmlFragmentBodyEventReader
XMLEventReader createXmlFragmentBodyEventReader(XMLEventReader delegate) throws XMLStreamException
- Throws:
XMLStreamException
-
-