com.atlassian.instrumentation.export

Interface InstrumentExporter

All Known Implementing Classes:

CsvInstrumentExporter, JsonInstrumentExporter, XmlInstrumentExporter

public interface InstrumentExporter

InstrumentExporter is able to export a list of Instruments to a specific file format, such as XML or JSON.

Since:

v4.0

Method Summary

Modifier and Type	Method and Description
String	export(Instrument instrument) Converts a single Instrument to a string representation
void	export(List<Instrument> instruments, Writer writer) Called to export the list of Instruments into a specific format
String	getMimeType() Returns the mime type for the export

Method Detail

export

void export(List<Instrument> instruments,
            Writer writer)
     throws IOException

Called to export the list of Instruments into a specific format

Parameters:

instruments - the list of Instruments

writer - the writer to export the list to

Throws:

IOException - if things go badly in the IO wold

export

String export(Instrument instrument)

Converts a single Instrument to a string representation

Parameters:

instrument - an Instrument to export

Returns:

A string representation of a single instrument as determined by the exporter implementation

getMimeType

String getMimeType()

Returns the mime type for the export

Returns:

the mime type for the export