br.eti.kinoshita.tap4j.consumer
Interface TapConsumer

All Known Implementing Classes:

AbstractTapConsumer, DefaultTapConsumer

public interface TapConsumer

TAP Consumer is the responsible for generating the TAP Stream.

Since:

1.0

Author:

Bruno P. Kinoshita - http://www.kinoshita.eti.br

Method Summary

Boolean	containsBailOut()
Boolean	containsNotOk()
Boolean	containsOk()
List<BailOut>	getBailOuts()
List<Comment>	getComments()
Footer	getFooter()
Header	getHeader()
Integer	getNumberOfBailOuts()
Integer	getNumberOfComments()
Integer	getNumberOfTapLines()
Integer	getNumberOfTestResults()
Plan	getPlan()
List<TapResult>	getTapLines()
TestResult	getTestResult(Integer testNumber)
List<TestResult>	getTestResults()
TestSet	getTestSet()
void	parseFile(File tapFile) Parses a Tap File.
void	parseLine(String tapLine) Parses a Test Result.
void	parseTapStream(String tapStream) Parses a Tap Stream.
void	printDetails(PrintStream ps) Prints the details of tests to a Print Stream.
void	printDetails(PrintWriter pw) Prints the details of tests to a Print Writer.
void	printSummary(PrintStream ps) Prints the summary of tests to a Print Stream.
void	printSummary(PrintWriter pw) Prints the summary of tests to a Print Writer.

Method Detail

parseLine

void parseLine(String tapLine)
               throws TapParserException

Parses a Test Result.

Parameters:

testResult - Test Result line

Throws:

TapParserException

parseTapStream

void parseTapStream(String tapStream)
                    throws TapParserException

Parses a Tap Stream.

Parameters:

tapStream - Tap Stream

Throws:

TapParserException

parseFile

void parseFile(File tapFile)
               throws TapParserException

Parses a Tap File.

Parameters:

tapFile - Tap File

Throws:

TapParserException

getHeader

Header getHeader()

Returns:

Header.

getPlan

Plan getPlan()

Returns:

Plan.

getTapLines

List<TapResult> getTapLines()

Returns:

List of TAP Lines.

getTestResults

List<TestResult> getTestResults()

Returns:

List of Test Results.

getBailOuts

List<BailOut> getBailOuts()

Returns:

List of Bail Outs.

getComments

List<Comment> getComments()

Returns:

List of Comments.

getNumberOfTapLines

Integer getNumberOfTapLines()

Returns:

Number of TAP Lines.

getNumberOfTestResults

Integer getNumberOfTestResults()

Returns:

Number of Test Results.

getNumberOfBailOuts

Integer getNumberOfBailOuts()

Returns:

Number of Bail Outs.

getNumberOfComments

Integer getNumberOfComments()

Returns:

Number of Comments.

getTestResult

TestResult getTestResult(Integer testNumber)

Parameters:

testNumber - Number of test to be retrieved.

Returns:

A single test result.

containsNotOk

Boolean containsNotOk()

Returns:

true if any not ok occurred.

containsOk

Boolean containsOk()

Returns:

true if any ok occurred.

containsBailOut

Boolean containsBailOut()

Returns:

true if the Stream contains any Bail Outs.

getFooter

Footer getFooter()

Returns:

Footer.

getTestSet

TestSet getTestSet()

Returns:

Test Set.

printSummary

void printSummary(PrintWriter pw)

Prints the summary of tests to a Print Writer.

Parameters:

pw - Print Writer.

printSummary

void printSummary(PrintStream ps)

Prints the summary of tests to a Print Stream.

Parameters:

ps - Print Stream.

printDetails

void printDetails(PrintWriter pw)

Prints the details of tests to a Print Writer.

Parameters:

pw - Print Writer.

printDetails

void printDetails(PrintStream ps)

Prints the details of tests to a Print Stream.

Parameters:

ps - Print Stream.