org.rhq.enterprise.server.sync.exporters
Interface ExportingIterator<E>

All Superinterfaces:

Iterator<E>

All Known Implementing Classes:

AbstractDelegatingExportingIterator, JAXBExportingIterator

public interface ExportingIterator<E>
extends Iterator<E>

Author:

Lukas Krejci

Method Summary

void	export(ExportWriter output) Exports the current entity using the provided writer.
String	getNotes() This is the opportunity for the exporter to submit some messages that will be transfered to the export file.

Methods inherited from interface java.util.Iterator

hasNext, next, remove

Method Detail

export

void export(ExportWriter output)
            throws XMLStreamException

Exports the current entity using the provided writer.

Can throw a runtime exception to denote a failure.

Parameters:

output -

Throws:

XMLStreamException

getNotes

String getNotes()

This is the opportunity for the exporter to submit some messages that will be transfered to the export file. This is to submit some human understandable information that is not otherwise formalized or to convey some other information about otherwise successful export of the single entity.

Returns: