Package com.reallifedeveloper.common.resource.documentation

Interface HtmlProducer

All Known Implementing Classes:

Markdown4jHtmlProducer

public interface HtmlProducer

A producer of HTML.

Author:

RealLifeDeveloper

Method Summary

Modifier and Type	Method	Description
boolean	canHandle(String resourceName)	Shows if this HtmlProducer can handle the given resource or not.
String	produce(String resourceName)	Produces HTML from the named resource on classpath.

Method Details

produce

String produce(String resourceName)
        throws IOException

Produces HTML from the named resource on classpath.

Parameters:

resourceName - the name of the resource to convert to HTML

Returns:

the HTML produced

Throws:

IOException - if converting the resource failed

canHandle

boolean canHandle(String resourceName)

Shows if this HtmlProducer can handle the given resource or not.

Parameters:

resourceName - the name of the resource to check

Returns:

true if the resource can be handled, false otherwise