com.atlassian.dbexporter.node

Interface NodeStreamReader

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

StaxStreamReader

public interface NodeStreamReader
extends Closeable

Provides streaming read access to a node graph.

Author:

Erik van Zijst

Method Summary

Modifier and Type	Method and Description
void	close() Closes all resources of the underlying document.
NodeParser	getRootNode() Returns the root node of the object tree.

Method Detail

getRootNode

NodeParser getRootNode()
                throws IllegalStateException

Returns the root node of the object tree. The method can only be invoked once. Subsequent calls will raise an IllegalStateException.

Returns:

the root node of the graph.

Throws:

IllegalStateException - when the root node has already been returned.

ImportExportException - when the document could not be parsed.

close

void close()

Closes all resources of the underlying document.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

ImportExportException - if the reader could not be closed