org.jbehave.core.model
Class ExamplesTable
java.lang.Object
org.jbehave.core.model.ExamplesTable
public class ExamplesTable
- extends java.lang.Object
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 "|--".
By default all column values are trimmed. To avoid trimming the values:
{trim=false}
| header 1 | header 2 | .... | header n |
| value 11 | value 12 | .... | value 1n |
The table also 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.
|
Constructor Summary |
ExamplesTable(java.lang.String tableAsString)
|
ExamplesTable(java.lang.String tableAsString,
java.lang.String headerSeparator,
java.lang.String valueSeparator)
|
ExamplesTable(java.lang.String tableAsString,
java.lang.String headerSeparator,
java.lang.String valueSeparator,
java.lang.String ignorableSeparator,
ParameterConverters parameterConverters)
|
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
EMPTY
public static final ExamplesTable EMPTY
ExamplesTable
public ExamplesTable(java.lang.String tableAsString)
ExamplesTable
public ExamplesTable(java.lang.String tableAsString,
java.lang.String headerSeparator,
java.lang.String valueSeparator)
ExamplesTable
public ExamplesTable(java.lang.String tableAsString,
java.lang.String headerSeparator,
java.lang.String valueSeparator,
java.lang.String ignorableSeparator,
ParameterConverters parameterConverters)
createRowMap
protected java.util.Map<java.lang.String,java.lang.String> createRowMap()
withDefaults
public ExamplesTable withDefaults(Parameters defaults)
withNamedParameters
public ExamplesTable withNamedParameters(java.util.Map<java.lang.String,java.lang.String> namedParameters)
getProperties
public java.util.Properties getProperties()
getHeaders
public java.util.List<java.lang.String> getHeaders()
getRow
public java.util.Map<java.lang.String,java.lang.String> getRow(int row)
getRowAsParameters
public Parameters getRowAsParameters(int row)
getRowAsParameters
public Parameters getRowAsParameters(int row,
boolean replaceNamedParameters)
getRowCount
public int getRowCount()
getRows
public java.util.List<java.util.Map<java.lang.String,java.lang.String>> getRows()
getRowsAsParameters
public java.util.List<Parameters> getRowsAsParameters()
getRowsAsParameters
public java.util.List<Parameters> getRowsAsParameters(boolean replaceNamedParameters)
getHeaderSeparator
public java.lang.String getHeaderSeparator()
getValueSeparator
public java.lang.String getValueSeparator()
asString
public java.lang.String asString()
toString
public java.lang.String toString()
- Overrides:
toString in class java.lang.Object
Copyright © 2003-2011. All Rights Reserved.