org.scribble.protocol.export
Interface ProtocolExporter

All Known Implementing Classes:

TextProtocolExporter

public interface ProtocolExporter

This interface provides an export mechanism for converting a Protocol Model into a range of other representations.

Method Summary

void	export(ProtocolModel model, org.scribble.common.logging.Journal journal, OutputStream os) This method exports the supplied protocol model, in the implementation specific format, to the specified output stream.
String	getId() This method returns the id of the exporter.
String	getName() This method returns the name of the exporter for use in user based selectors.

Method Detail

getId

String getId()

This method returns the id of the exporter.

Returns:

The exporter id

getName

String getName()

This method returns the name of the exporter for use in user based selectors.

Returns:

The name of the exporter

export

void export(ProtocolModel model,
            org.scribble.common.logging.Journal journal,
            OutputStream os)
            throws IOException

This method exports the supplied protocol model, in the implementation specific format, to the specified output stream. If any issues occur during the export process, they will be reported to the journal.

Parameters:

model - The protocol model to be exported

journal - The journal

os - The output stream

Throws:

IOException - Failed to export