org.annotation.wordfreak.io
Interface SourceFileFormat

All Superinterfaces:

FileFormat, Plugin

All Known Implementing Classes:

TextFileFormat

public interface SourceFileFormat

extends FileFormat

This defines the interface for implementing new source file formats.

Method Summary

java.lang.String

read(java.lang.String source, java.lang.String encoding) Reads the source file specified by the parameter source.

Methods inherited from interface org.annotation.wordfreak.io.FileFormat

addProgressListener, getExtension, getFileFilter, getFormatName, getIcon, handlesFile, removeProgressListener, write

Method Detail

read

public java.lang.String read(java.lang.String source,
                             java.lang.String encoding)

Reads the source file specified by the parameter source.

Parameters:

source - the name of the file which contains the source.

encoding - the encoding which should be used to read the source file.

Returns:

A string containing the source.