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

Class BasePlaceholder

java.lang.Object

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

Direct Known Subclasses:

CanonicalClassNamePlaceholder, CompleteMethodSignaturePlaceholder, IndexPlaceholder, ParameterPlaceholder, SimpleClassNamePlaceholder, SimpleMethodNamePlaceholder

public abstract class BasePlaceholder
extends java.lang.Object

Base class for all placeholder which are used to format the test method name. One can create his/her own placeholder extending this and overriding getReplacementFor(String). Afterwards add the new placeholder to the other placeholders by using Placeholders.all() (for details see Placeholders).

See Also:

DataProvider.format(), Placeholders

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
BasePlaceholder(java.lang.String placeholderRegex)

Method Summary

Modifier and Type	Method and Description
protected abstract java.lang.String	getReplacementFor(java.lang.String placeholder) Generate and returns the replacement for the found and given 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 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

BasePlaceholder

public BasePlaceholder(java.lang.String placeholderRegex)

Parameters:

placeholderRegex - - regular expression to match the placeholder in the DataProvider.format().

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 abstract java.lang.String getReplacementFor(java.lang.String placeholder)

Generate and returns the replacement for the found and given placeholder.

Parameters:

placeholder - for which the replacement String should be returned

Returns:

the replacement for the given placeholder (not null)