cucumber.api

Class DataTable

java.lang.Object

cucumber.api.DataTable

public class DataTable
extends Object

Represents the data from a Gherkin DataTable. Cucumber will convert the table in Gherkin to a DataTable instance and pass it to a step definition.

Constructor Summary

Constructors

Constructor and Description
DataTable(List<gherkin.formatter.model.DataTableRow> gherkinRows, cucumber.runtime.table.TableConverter tableConverter) Creates a new DataTable.

Method Summary

Modifier and Type	Method and Description
<T> List<T>	asList(Class<T> itemType) Converts the table to a List.
<T> List<List<T>>	asLists(Class<T> itemType) Converts the table to a List of List of scalar.
<K,V> Map<K,V>	asMap(Class<K> keyType, Class<V> valueType) Converts the table to a single Map.
<K,V> List<Map<K,V>>	asMaps(Class<K> keyType, Class<V> valueType) Converts the table to a List of Map.
List<List<String>>	cells(int firstRow)
static DataTable	create(List<?> raw)
static DataTable	create(List<?> raw, Locale locale, String... columnNames)
static DataTable	create(List<?> raw, String format, String... columnNames)
void	diff(DataTable other) Diffs this table with other.
void	diff(List<?> other) Diffs this table with other, which can be a List&lt;List&lt;String&gt;&gt; or a List&lt;YourType&gt;.
List<cucumber.runtime.table.DiffableRow>	diffableRows()
boolean	equals(Object o)
List<gherkin.formatter.model.DataTableRow>	getGherkinRows() Internal method.
cucumber.runtime.table.TableConverter	getTableConverter()
int	hashCode()
List<List<String>>	raw()
List<String>	topCells()
String	toString()
DataTable	toTable(List<?> raw, String... columnNames) Creates another table using the same Locale and Format that was used to create this table.
DataTable	transpose()
void	unorderedDiff(DataTable other) Diffs this table with other.
void	unorderedDiff(List<?> other) Diffs this table with other, which can be a List&lt;List&lt;String&gt;&gt; or a List&lt;YourType&gt;.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DataTable

public DataTable(List<gherkin.formatter.model.DataTableRow> gherkinRows,
                 cucumber.runtime.table.TableConverter tableConverter)

Creates a new DataTable. This constructor should not be called by Cucumber users - it's used internally only.

Parameters:

gherkinRows - the underlying rows.

tableConverter - how to convert the rows.

Method Detail

create

public static DataTable create(List<?> raw)

create

public static DataTable create(List<?> raw,
                               String format,
                               String... columnNames)

create

public static DataTable create(List<?> raw,
                               Locale locale,
                               String... columnNames)

raw

public List<List<String>> raw()

Returns:

a List of List of String.

asMaps

public <K,V> List<Map<K,V>> asMaps(Class<K> keyType,
                                   Class<V> valueType)

Converts the table to a List of Map. The top row is used as keys in the maps, and the rows below are used as values.

Type Parameters:

K - key type

V - value type

Parameters:

keyType - key type

valueType - value type

Returns:

a List of Map.

asMap

public <K,V> Map<K,V> asMap(Class<K> keyType,
                            Class<V> valueType)

Converts the table to a single Map. The left column is used as keys, the right column as values.

Type Parameters:

K - key type

V - value type

Parameters:

keyType - key type

valueType - value type

Returns:

a Map.

Throws:

cucumber.runtime.CucumberException - if the table doesn't have 2 columns.

asList

public <T> List<T> asList(Class<T> itemType)

Converts the table to a List. If itemType is a scalar type the table is flattened. Otherwise, the top row is used to name the fields/properties and the remaining rows are turned into list items.

Type Parameters:

T - the type of the list items

Parameters:

itemType - the type of the list items

Returns:

a List of objects

asLists

public <T> List<List<T>> asLists(Class<T> itemType)

Converts the table to a List of List of scalar.

Type Parameters:

T - the type of the list items

Parameters:

itemType - the type of the list items

Returns:

a List of List of objects

topCells

public List<String> topCells()

cells

public List<List<String>> cells(int firstRow)

toTable

public DataTable toTable(List<?> raw,
                         String... columnNames)

Creates another table using the same Locale and Format that was used to create this table.

Parameters:

raw - a list of objects

columnNames - optional explicit header columns

Returns:

a new table

diff

public void diff(List<?> other)
          throws cucumber.runtime.table.TableDiffException

Diffs this table with other, which can be a List<List<String>> or a List<YourType>.

Parameters:

other - the other table to diff with.

Throws:

cucumber.runtime.table.TableDiffException - if the tables are different.

diff

public void diff(DataTable other)
          throws cucumber.runtime.table.TableDiffException

Diffs this table with other.

Parameters:

other - the other table to diff with.

Throws:

cucumber.runtime.table.TableDiffException - if the tables are different.

unorderedDiff

public void unorderedDiff(DataTable other)
                   throws cucumber.runtime.table.TableDiffException

Diffs this table with other. The order is not important. A set-difference is applied.

Parameters:

other - the other table to diff with.

Throws:

cucumber.runtime.table.TableDiffException - if the tables are different.

unorderedDiff

public void unorderedDiff(List<?> other)
                   throws cucumber.runtime.table.TableDiffException

Diffs this table with other, which can be a List<List<String>> or a List<YourType>.

Parameters:

other - the other table to diff with.

Throws:

cucumber.runtime.table.TableDiffException - if the tables are different.

getGherkinRows

public List<gherkin.formatter.model.DataTableRow> getGherkinRows()

Internal method. Do not use.

Returns:

a list of raw rows.

toString

public String toString()

Overrides:

toString in class Object

diffableRows

public List<cucumber.runtime.table.DiffableRow> diffableRows()

getTableConverter

public cucumber.runtime.table.TableConverter getTableConverter()

transpose

public DataTable transpose()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object