org.tap4j.model
Class Plan

java.lang.Object
  org.tap4j.model.AbstractTapElementDiagnostic
      org.tap4j.model.Plan

All Implemented Interfaces:

Serializable, TapElement

public class Plan
extends AbstractTapElementDiagnostic

TAP Plan. The TAP Plan gives details about the execution of the tests such as initial test number, last test number, flag to skip all tests and a reason for this.

Since:

1.0

See Also:

Serialized Form

Constructor Summary

Plan(Integer amountOfTests)
Constructor with parameters.

Plan(Integer initialTestNumber, Integer lastTestNumber)
Constructor with parameters.

Plan(Integer initialTestNumber, Integer lastTestNumber, SkipPlan skip)
Constructor with parameters

Plan(Integer amountOfTests, SkipPlan skip)
Constructor with parameters

Method Summary

Comment	getComment()
Integer	getInitialTestNumber()
Integer	getLastTestNumber()
SkipPlan	getSkip()
Boolean	isSkip()
void	setComment(Comment comment) Sets a comment into the Plan.
void	setSkip(SkipPlan skip) Defines whether we should skip all tests or not.

Methods inherited from class org.tap4j.model.AbstractTapElementDiagnostic

getDiagnostic, setDiagnostic

Methods inherited from class java.lang.Object

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

Constructor Detail

Plan

public Plan(Integer initialTestNumber,
            Integer lastTestNumber)

Constructor with parameters.

Parameters:

initialTestNumber - Initial test number (usually is 1).

lastTestNumber - Last test number (may be 0 if to skip all tests).

Plan

public Plan(Integer amountOfTests)

Constructor with parameters.

Parameters:

amountOfTests - How many tests we have in the plan.

Plan

public Plan(Integer amountOfTests,
            SkipPlan skip)

Constructor with parameters

Parameters:

amountOfTests - How many tests we have in the plan.

skip - Plan skip with a reason.

Plan

public Plan(Integer initialTestNumber,
            Integer lastTestNumber,
            SkipPlan skip)

Constructor with parameters

Parameters:

initialTestNumber - Initial test number (usually is 1).

lastTestNumber - Last test number (may be 0 if to skip all tests).

skip - Plan skip with a reason.

Method Detail

getInitialTestNumber

public Integer getInitialTestNumber()

Returns:

Initial test number.

getLastTestNumber

public Integer getLastTestNumber()

Returns:

Last test number.

isSkip

public Boolean isSkip()

Returns:

Flag used to indicate whether skip all tests or not.

getSkip

public SkipPlan getSkip()

Returns:

Plan Skip with reason.

setSkip

public void setSkip(SkipPlan skip)

Defines whether we should skip all tests or not.

Parameters:

skip - Plan Skip.

getComment

public Comment getComment()

Returns:

Optional Plan comment.

setComment

public void setComment(Comment comment)

Sets a comment into the Plan.

Parameters:

comment - Plan comment.