Package org.jbehave.core.steps

Class ConvertedParameters

java.lang.Object

org.jbehave.core.steps.ConvertedParameters

All Implemented Interfaces:

Parameters, Row

public class ConvertedParameters
extends Object
implements Parameters

Implementation of Parameters that uses ParameterConverters to convert values.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ConvertedParameters.ParametersNotMappableToType
static class	ConvertedParameters.ValueNotFound

Constructor Summary

Constructors

Constructor	Description
ConvertedParameters(Map<String,String> values, ParameterConverters parameterConverters)	Creates an instance of ConvertedParameters with given values
ConvertedParameters(Row row, ParameterConverters parameterConverters)	Creates an instance of ConvertedParameters from a Row which provides the values

Method Summary

Modifier and Type	Method	Description
<T> T	mapTo(Class<T> type)	Maps parameters to the specified type
<T> T	mapTo(Class<T> type, Map<String,String> fieldNameMapping)	Maps parameters to the specified type
<T> T	valueAs(String name, Type type)	Returns the value of a named parameter as a given type
<T> T	valueAs(String name, Type type, T defaultValue)	Returns the value of a named parameter as a given type while providing a default value if the name is not found
Map<String,String>	values()	Returns the values as a Map, where the key is the column name and the value is the row value.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConvertedParameters

public ConvertedParameters(Row row,
                           ParameterConverters parameterConverters)

Creates an instance of ConvertedParameters from a Row which provides the values

Parameters:

row - the Row to get the values from

parameterConverters - the ParameterConverters used for conversion

ConvertedParameters

public ConvertedParameters(Map<String,String> values,
                           ParameterConverters parameterConverters)

Creates an instance of ConvertedParameters with given values

Parameters:

values - the Map<String,String> of values

parameterConverters - the ParameterConverters used for conversion

Method Detail

valueAs

public <T> T valueAs(String name,
                     Type type)

Description copied from interface: Parameters

Returns the value of a named parameter as a given type

Specified by:

valueAs in interface Parameters

Parameters:

name - the name of the parameter

type - the Type or Class of type <T> to convert to

Returns:

The value of type <T>

valueAs

public <T> T valueAs(String name,
                     Type type,
                     T defaultValue)

Description copied from interface: Parameters

Returns the value of a named parameter as a given type while providing a default value if the name is not found

Specified by:

valueAs in interface Parameters

Parameters:

name - the name of the parameter

type - Type or Class of type <T> to convert to

defaultValue - the default value if the name is not found

Returns:

The value of type <T>

mapTo

public <T> T mapTo(Class<T> type)

Description copied from interface: Parameters

Maps parameters to the specified type

Specified by:

mapTo in interface Parameters

Parameters:

type - The target type

Returns:

The object of type <T>

mapTo

public <T> T mapTo(Class<T> type,
                   Map<String,String> fieldNameMapping)

Description copied from interface: Parameters

Maps parameters to the specified type

Specified by:

mapTo in interface Parameters

Parameters:

type - The target type

fieldNameMapping - The field mapping between parameters and target type fields

Returns:

The object of type <T>

values

public Map<String,String> values()

Description copied from interface: Row

Returns the values as a Map, where the key is the column name and the value is the row value.

Specified by:

values in interface Row

Returns:

The Map of values