com.github.spuchmann.xml.splitter.stax.XmlDocumentEventHandler Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of xml-splitter Show documentation

A simple java library which makes it easy to split xml files into fragments.

The newest version!

package com.github.spuchmann.xml.splitter.stax;

import javax.xml.stream.XMLStreamException;
import javax.xml.stream.XMLStreamWriter;

/**
 * event handler which provides hooks inside the splitting process
 *
 * @since 0.1.0
 */
public interface XmlDocumentEventHandler {

    /**
     * will be called after the document and the xml header is written
     *
     * @since 0.2.0
     */
    void afterStartDocument(XMLStreamWriter streamWriter, SplitContext context) throws XMLStreamException;

    /**
     * will be called before the document ends and will be closed
     */
    void beforeEndDocument(XMLStreamWriter streamWriter) throws XMLStreamException;

    /**
     * will be called if the document is closed
     */
    void finishedDocument();
}