|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jbehave.core.model.ExamplesTable
public class ExamplesTable
Represents a tabular structure that holds rows of example data for parameters named via the column headers:
|header 1|header 2| .... |header n| |value 11|value 12| .... |value 1n| ... |value m1|value m2| .... |value mn|
Different header and value column separators can be specified to replace the default separator "|":
!!header 1!!header 2!! .... !!header n!! !value 11!value 12! .... !value 1n! ... !value m1!value m2| .... !value mn!
Rows starting with an ignorable separator are allowed and ignored:
|header 1|header 2| .... |header n| |-- A commented row --| |value 11|value 12| .... |value 1n| ... |-- Another commented row --| |value m1|value m2| .... |value mn|
Ignorable separator is configurable and defaults to "|--".
The separators are also configurable via inlined properties:
{ignorableSeparator=!--,headerSeparator=!,valueSeparator=!} !header 1!header 2! .... !header n! !-- A commented row --! !value 11!value 12! .... !value 1n! ... !-- Another commented row --! !value m1!value m2! .... !value mn!
By default all column values are trimmed. To avoid trimming the values, use the "trim" inlined property:
{trim=false} | header 1 | header 2 | .... | header n | | value 11 | value 12 | .... | value 1n |
The table allows the retrieval of row values as converted parameters. Use
getRowAsParameters(int)
and invoke
Parameters.valueAs(String, Class)
specifying the header and the class
type of the parameter.
The table allows the transformation of its string representation via the "transformer" inlined property:
{transformer=myTransformerName} |header 1|header 2| .... |header n| |value 11|value 12| .... |value 1n| ... |value m1|value m2| .... |value mn|The transformer needs to be registered by name via the
TableTransformers.useTransformer(String, TableTransformer)
. A few
transformers are already registered by default in TableTransformers
.
Once created, the table row can be modified, via the
withRowValues(int, Map)
method, by specifying the map of row values
to be changed.
A table can also be created by providing the entire data content, via the
#withRows(List
method.
Nested Class Summary | |
---|---|
static class |
ExamplesTable.RowNotFound
|
Field Summary | |
---|---|
static ExamplesTable |
EMPTY
|
Constructor Summary | |
---|---|
ExamplesTable(String tableAsString)
|
|
ExamplesTable(String tableAsString,
String headerSeparator,
String valueSeparator)
|
|
ExamplesTable(String tableAsString,
String headerSeparator,
String valueSeparator,
String ignorableSeparator,
ParameterConverters parameterConverters)
|
|
ExamplesTable(String tableAsString,
String headerSeparator,
String valueSeparator,
String ignorableSeparator,
ParameterConverters parameterConverters,
TableTransformers tableTransformers)
|
Method Summary | |
---|---|
String |
asString()
|
List<String> |
getHeaders()
|
String |
getHeaderSeparator()
|
Properties |
getProperties()
|
Map<String,String> |
getRow(int row)
|
Parameters |
getRowAsParameters(int row)
|
Parameters |
getRowAsParameters(int row,
boolean replaceNamedParameters)
|
int |
getRowCount()
|
List<Map<String,String>> |
getRows()
|
List<Parameters> |
getRowsAsParameters()
|
List<Parameters> |
getRowsAsParameters(boolean replaceNamedParameters)
|
String |
getValueSeparator()
|
void |
outputTo(PrintStream output)
|
String |
toString()
|
ExamplesTable |
withDefaults(Parameters defaults)
|
ExamplesTable |
withNamedParameters(Map<String,String> namedParameters)
|
ExamplesTable |
withRows(List<Map<String,String>> values)
|
ExamplesTable |
withRowValues(int row,
Map<String,String> values)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final ExamplesTable EMPTY
Constructor Detail |
---|
public ExamplesTable(String tableAsString)
public ExamplesTable(String tableAsString, String headerSeparator, String valueSeparator)
public ExamplesTable(String tableAsString, String headerSeparator, String valueSeparator, String ignorableSeparator, ParameterConverters parameterConverters)
public ExamplesTable(String tableAsString, String headerSeparator, String valueSeparator, String ignorableSeparator, ParameterConverters parameterConverters, TableTransformers tableTransformers)
Method Detail |
---|
public ExamplesTable withDefaults(Parameters defaults)
public ExamplesTable withNamedParameters(Map<String,String> namedParameters)
public ExamplesTable withRowValues(int row, Map<String,String> values)
public ExamplesTable withRows(List<Map<String,String>> values)
public Properties getProperties()
public List<String> getHeaders()
public Map<String,String> getRow(int row)
public Parameters getRowAsParameters(int row)
public Parameters getRowAsParameters(int row, boolean replaceNamedParameters)
public int getRowCount()
public List<Map<String,String>> getRows()
public List<Parameters> getRowsAsParameters()
public List<Parameters> getRowsAsParameters(boolean replaceNamedParameters)
public String getHeaderSeparator()
public String getValueSeparator()
public String asString()
public void outputTo(PrintStream output)
public String toString()
toString
in class Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |