Package org.ctan.site.services.texarchive.readme

Class MarkdownReadmeReader

java.lang.Object

org.ctan.site.services.texarchive.readme.ReadmeReader

org.ctan.site.services.texarchive.readme.MarkdownReadmeReader

public class MarkdownReadmeReader
extends ReadmeReader

The class TextReadmeReader contains the reader for markdown.

Constructor Summary

Constructors

Constructor	Description
MarkdownReadmeReader(String name)	This is the constructor for MarkdownReadmeReader.

Method Summary

Modifier and Type	Method	Description
String	read(File file)	Read the contents.

Methods inherited from class org.ctan.site.services.texarchive.readme.ReadmeReader

findIndex

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

MarkdownReadmeReader

public MarkdownReadmeReader(String name)

This is the constructor for MarkdownReadmeReader.

Parameters:

name - the file name

Method Details

read

public String read(File file)
            throws UnsupportedEncodingException,
IOException

Read the contents.

Specified by:

read in class ReadmeReader

Parameters:

file - the file to read

Returns:

the file contents as HTML

Throws:

UnsupportedEncodingException - in case of an error

IOException - in case of an I/O error

See Also:

• ReadmeReader.read(java.io.File)