Package org.jbehave.core.model

Class OutcomesTable

java.lang.Object

org.jbehave.core.model.OutcomesTable

public class OutcomesTable
extends Object

Represents a tabular structure that holds OutcomesTable.Outcomes to be verified by invoking method verify(). If verification fails an OutcomesTable.OutcomesFailed exception is thrown.

The Outcomes Tables allows the specification of Keywords for the outcome fields, as well as rendering formats for different types. The default formats include:

• Date: "EEE MMM dd hh:mm:ss zzz yyyy"
• Number: "0.###"
• Boolean: "yes,no"

These formats can be overridden as well as new ones added. The formats can be retrieved via methods getFormat(Type) and getFormat(String).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OutcomesTable.FormatTypeInvalid
static class	OutcomesTable.Outcome<T>
static class	OutcomesTable.OutcomesFailed

Constructor Summary

Constructors

Constructor	Description
OutcomesTable()
OutcomesTable(Map<Type,String> formats)
OutcomesTable(Keywords keywords)
OutcomesTable(Keywords keywords, String dateFormat)	Deprecated. Use OutcomesTable(Keywords, Map)
OutcomesTable(Keywords keywords, Map<Type,String> formats)

Method Summary

Modifier and Type	Method	Description
<T> void	addOutcome(String description, T value, org.hamcrest.Matcher<T> matcher)
String	asString()
UUIDExceptionWrapper	failureCause()
String	getDateFormat()	Deprecated. Use getFormat(Type)
List<OutcomesTable.Outcome<?>>	getFailedOutcomes()
String	getFormat(Type type)
String	getFormat(String typeName)
Map<Type,String>	getFormats()
List<String>	getOutcomeFields()
List<OutcomesTable.Outcome<?>>	getOutcomes()
String	toString()
void	verify()

Methods inherited from class java.lang.Object

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

Constructor Detail

OutcomesTable

public OutcomesTable()

OutcomesTable

public OutcomesTable(Keywords keywords)

OutcomesTable

public OutcomesTable(Map<Type,String> formats)

OutcomesTable

public OutcomesTable(Keywords keywords,
                     Map<Type,String> formats)

OutcomesTable

@Deprecated
public OutcomesTable(Keywords keywords,
                     String dateFormat)

Deprecated.

Use OutcomesTable(Keywords, Map)

Creates outcomes table using the specified keywords and date format

Method Detail

addOutcome

public <T> void addOutcome(String description,
                           T value,
                           org.hamcrest.Matcher<T> matcher)

verify

public void verify()

failureCause

public UUIDExceptionWrapper failureCause()

getOutcomes

public List<OutcomesTable.Outcome<?>> getOutcomes()

getFailedOutcomes

public List<OutcomesTable.Outcome<?>> getFailedOutcomes()

getOutcomeFields

public List<String> getOutcomeFields()

getFormats

public Map<Type,String> getFormats()

getFormat

public String getFormat(Type type)

getFormat

public String getFormat(String typeName)

getDateFormat

@Deprecated
public String getDateFormat()

Deprecated.

Use getFormat(Type)

Provides used date format

asString

public String asString()

toString

public String toString()

Overrides:

toString in class Object