Package org.concordion.api

Interface SpecificationConverter

All Known Implementing Classes:

MarkdownConverter, XhtmlConverter

public interface SpecificationConverter

Converts specifications from one type to another. For example, from Markdown to HTML.

Since:

2.0.0

Method Summary

Modifier and Type	Method	Description
InputStream	convert(InputStream inputStream, String specificationName)	Convert the specification's input stream to an HTML input stream.

Method Details

convert

InputStream convert(InputStream inputStream,
 String specificationName)
             throws IOException

Convert the specification's input stream to an HTML input stream.

Parameters:

inputStream - the input stream containing the content of the specification

specificationName - the filename of the specification (without the path)

Returns:

converted specification content

Throws:

IOException - on i/o error