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

Class ReadmeReader

java.lang.Object

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

Direct Known Subclasses:

HtmlReadmeReader, MarkdownReadmeReader, TextReadmeReader

public abstract class ReadmeReader
extends Object

The class ReadmeReader contains the function to read a file and return the contents as HTML.

Constructor Summary

Constructors

Constructor	Description
ReadmeReader()

Method Summary

Modifier and Type	Method	Description
static TexArchiveService.ReadmeTo	findIndex(File dir)	The method findIndex provides means to retrieve a readme file according to a search list.
abstract String	read(File file)	Read the contents.

Methods inherited from class java.lang.Object

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

Constructor Details

ReadmeReader

public ReadmeReader()

Method Details

findIndex

public static TexArchiveService.ReadmeTo findIndex(File dir)

The method findIndex provides means to retrieve a readme file according to a search list.

Parameters:

dir - the directory

Returns:

the transport object for the index

read

public abstract String read(File file)
                     throws UnsupportedEncodingException,
IOException

Read the contents.

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