com.mcdermottroe.exemplar.input
Interface InputModule

All Known Implementing Classes:

Parser

public interface InputModule

An interface to which all input modules must conform.

Since:

0.1

Method Summary

XMLDocumentType	parse(File inputFile) Given an input file, produce an XMLDocumentType object representing the vocabulary described by the input file.
XMLDocumentType	parse(InputStream input) Given an input source, produce an XMLDocumentType object representing the vocabulary described by the input file.
XMLDocumentType	parse(String inputFilePath) Given an input file path, produce an XMLDocumentType object representing the vocabulary described by the input file.
String	toString() Describe the InputModule for documentation purposes.

Method Detail

parse

XMLDocumentType parse(String inputFilePath)
                      throws ParserException

Given an input file path, produce an XMLDocumentType object representing the vocabulary described by the input file.

Parameters:

inputFilePath - The path to the input file to parse.

Returns:

An XMLDocumentType object which describes the vocabulary of XML defined in the input file.

Throws:

ParserException - If anything fails in the parsing process.

parse

XMLDocumentType parse(File inputFile)
                      throws ParserException

Given an input file, produce an XMLDocumentType object representing the vocabulary described by the input file.

Parameters:

inputFile - The file to parse as input.

Returns:

An XMLDocumentType object which describes the vocabulary of XML defined in the input file.

Throws:

ParserException - If anything fails in the parsing process.

parse

XMLDocumentType parse(InputStream input)
                      throws ParserException

Given an input source, produce an XMLDocumentType object representing the vocabulary described by the input file.

Parameters:

input - The source material to parse.

Returns:

An XMLDocumentType object which describes the vocabulary of XML defined in the input file.

Throws:

ParserException - If anything fails in the parsing process.

toString

String toString()

Describe the InputModule for documentation purposes.

Overrides:

toString in class Object

Returns:

A String describing the language that the implementing class parses.