com.tngtech.java.junit.dataprovider.internal.placeholder

Class ParameterPlaceholder

java.lang.Object

com.tngtech.junit.dataprovider.placeholder.BasePlaceholder

com.tngtech.junit.dataprovider.placeholder.ArgumentPlaceholder

com.tngtech.java.junit.dataprovider.internal.placeholder.ParameterPlaceholder

public class ParameterPlaceholder
extends com.tngtech.junit.dataprovider.placeholder.ArgumentPlaceholder

This placeholder format the parameters of a dataprovider test as comma-separated String according to the given index or range subscript (see DataProvider.format(). Furthermore the following parameter values are treated specially:

Parameter value	target String
null	<null>
"" (= empty string)	<empty string>
array (e.g. String[])	"[" + formatPattern(array) + "]"
other	Object.toString()

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	com.tngtech.junit.dataprovider.placeholder.AbstractArgumentPlaceholder.FromAndTo

Field Summary

Fields

Modifier and Type	Field and Description
protected int	idx
protected java.lang.reflect.Method	method
protected java.lang.Object[]	parameters

Constructor Summary

Constructors

Constructor and Description
ParameterPlaceholder()

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	format(java.lang.Object param)
protected java.lang.String	formatAll(java.util.List<java.lang.Object> arguments)
protected java.lang.String	formatAll(java.lang.Object[] parameters) Formats the given parameters by retrieving it's String representation and separate it by comma (= ,).
protected java.lang.String	getReplacementFor(java.lang.String placeholder)
java.lang.String	process(java.lang.String formatPattern) Executes this placeholder for the given String by searching all occurrences of the regular expression supplied in the constructor and replaces them with the retrieved replacement from getReplacementFor(String).
void	setContext(java.lang.reflect.Method method, int idx, java.lang.Object[] parameters) Sets the given arguments as context for processing or replacement generation, respectively.

Methods inherited from class com.tngtech.junit.dataprovider.placeholder.ArgumentPlaceholder

getReplacementFor

Methods inherited from class com.tngtech.junit.dataprovider.placeholder.BasePlaceholder

process

Methods inherited from class java.lang.Object

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

Field Detail

method

protected java.lang.reflect.Method method

idx

protected int idx

parameters

protected java.lang.Object[] parameters

Constructor Detail

ParameterPlaceholder

public ParameterPlaceholder()

Method Detail

setContext

public void setContext(java.lang.reflect.Method method,
                       int idx,
                       java.lang.Object[] parameters)

Sets the given arguments as context for processing or replacement generation, respectively.

Parameters:

method - - test method

idx - - index of the dataprovider row

parameters - of the current dataprovider test to be executed

process

public java.lang.String process(java.lang.String formatPattern)

Executes this placeholder for the given String by searching all occurrences of the regular expression supplied in the constructor and replaces them with the retrieved replacement from getReplacementFor(String). If the regular expression does not match, an exact copy of the given String is returned.

Parameters:

formatPattern - to be processed

Returns:

the given formatPattern containing the generated replacements instead of matching patterns

getReplacementFor

protected java.lang.String getReplacementFor(java.lang.String placeholder)

formatAll

protected java.lang.String formatAll(java.lang.Object[] parameters)

Formats the given parameters by retrieving it's String representation and separate it by comma (= ,).

Note: For new and future-proof implementations, please use formatAll(java.util.List) instead.

Parameters:

parameters - to be formatted

Returns:

the String representation of the given Object[]

See Also:

formatAll(java.util.List)

formatAll

protected java.lang.String formatAll(java.util.List<java.lang.Object> arguments)

Overrides:

formatAll in class com.tngtech.junit.dataprovider.placeholder.ArgumentPlaceholder

format

protected java.lang.String format(java.lang.Object param)