Package org.testng.internal

Class Parameters

java.lang.Object

org.testng.internal.Parameters

public class Parameters
extends Object

Methods that bind parameters declared in testng.xml to actual values used to invoke methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static final class	Parameters.FilterOutInjectedTypesResult	Store the result of parameterTypes and optionalValues after filter out injected types
static class	Parameters.MethodParameters	A parameter passing helper class.

Field Summary

Fields

Modifier and Type	Field	Description
private static final List<Class<? extends Annotation>>	annotationList
private static final List<Class<?>>	INJECTED_TYPES
private static final Map<String,List<Class<?>>>	mapping
static final String	NULL_VALUE	Deprecated.

Constructor Summary

Constructors

Constructor	Description
Parameters()

Method Summary

Modifier and Type	Method	Description
private static boolean	areAllOptionalValuesNull(String[] optionalValues)
private static boolean	canInject(String annotation)
private static void	checkParameterTypes(String methodName, Class<?>[] parameterTypes, String methodAnnotation, String[] parameterNames)
static Object[]	createConfigurationParameters(Method m, Map<String,String> params, Object[] parameterValues, ITestNGMethod currentTestMethod, IAnnotationFinder finder, XmlSuite xmlSuite, ITestContext ctx, ITestResult testResult)	Creates the parameters needed for the specified @Configuration Method .
static Object[]	createInstantiationParameters(Constructor<?> ctor, String methodAnnotation, IAnnotationFinder finder, String[] parameterNames, Map<String,String> params, XmlSuite xmlSuite)	Creates the parameters needed for constructing a test class instance.
private static Object[]	createParameters(ConstructorOrMethod m, Parameters.MethodParameters params, IAnnotationFinder finder, XmlSuite xmlSuite, String atName)
private static Object[]	createParametersForConstructor(Constructor<?> constructor, Class<?>[] parameterTypes, String[] optionalValues, String methodAnnotation, String[] parameterNames, Parameters.MethodParameters params, XmlSuite xmlSuite)
private static Object[]	createParametersForMethod(ConstructorOrMethod method, Class<?>[] parameterTypes, String[] optionalValues, String methodAnnotation, String[] parameterNames, Parameters.MethodParameters params, XmlSuite xmlSuite)
private static List<Object>	createParams(String name, String prefix, String methodAnnotation, Class<?>[] parameterTypes, String[] optionalValues, String[] parameterNames, Parameters.MethodParameters params, XmlSuite xmlSuite)
private static String[]	extractOptionalValues(IAnnotationFinder finder, ConstructorOrMethod consMethod)
private static Parameter[]	extractParameters(ConstructorOrMethod method)
(package private) static Parameters.FilterOutInjectedTypesResult	filterOutInjectedTypesFromOptionalValues(Class<?>[] parameterTypes, String[] optionalValues)	Remove injected types from parameterTypes and optionalValues
private static IDataProviderMethod	findDataProvider(ITestObjectFactory objectFactory, Object instance, ITestClass clazz, IAnnotationFinder finder, String name, Class<?> dataProviderClass, boolean isDynamicDataProvider, ITestContext context)	Find a method that has a @DataProvider(name=name)
private static IDataProviderMethod	findDataProvider(ITestObjectFactory objectFactory, Object instance, ITestClass clazz, ConstructorOrMethod m, IAnnotationFinder finder, ITestContext context)
private static IDataProvidable	findDataProviderInfo(ITestClass clazz, ConstructorOrMethod m, IAnnotationFinder finder)	Find the data provider info (data provider name and class) on either @Test(dataProvider), @Factory(dataProvider) on a method or @Factory(dataProvider) on a constructor.
private static String	getDataProviderName(IDataProviderAnnotation dp, Method m)
static ParameterHolder	handleParameters(ITestObjectFactory objectFactory, ITestNGMethod testMethod, Map<String,String> allParameterNames, Object instance, Parameters.MethodParameters methodParams, XmlSuite xmlSuite, IAnnotationFinder annotationFinder, Object fedInstance, DataProviderHolder holder)	If the method has parameters, fill them in.
static ParameterHolder	handleParameters(ITestObjectFactory objectFactory, ITestNGMethod testMethod, Map<String,String> allParameterNames, Object instance, Parameters.MethodParameters methodParams, XmlSuite xmlSuite, IAnnotationFinder annotationFinder, Object fedInstance, DataProviderHolder holder, String annotationName)	If the method has parameters, fill them in.
static Object[]	injectParameters(Object[] parameterValues, Method method, ITestContext context)	Gets an array of parameter values returned by data provider or the ones that are injected based on parameter type.
private static boolean	isDataProviderClassEmpty(ITestAnnotation annotation)
private static boolean	isDataProviderNameEmpty(ITestAnnotation annotation)
private static boolean	isDynamicDataProviderClassEmpty(ITestAnnotation annotation)
private static IDataProvidable	merge(ITestAnnotation methodLevel, ITestAnnotation classLevel)
private static String	prettyFormat(List<Class<?>> classes)
private static Class<? extends Annotation>	retrieveConfigAnnotation(Method m)
private static boolean	validParameters(String methodAnnotation, Class<?>[] parameterTypes)

Methods inherited from class java.lang.Object

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

Field Details

NULL_VALUE

@Deprecated
public static final String NULL_VALUE

Deprecated.

See Also:

• Constant Field Values

annotationList

private static final List<Class<? extends Annotation>> annotationList

mapping

private static final Map<String,List<Class<?>>> mapping

INJECTED_TYPES

private static final List<Class<?>> INJECTED_TYPES

Constructor Details

Parameters

public Parameters()

Method Details

createInstantiationParameters

public static Object[] createInstantiationParameters(Constructor<?> ctor,
 String methodAnnotation,
 IAnnotationFinder finder,
 String[] parameterNames,
 Map<String,String> params,
 XmlSuite xmlSuite)

Creates the parameters needed for constructing a test class instance.

createConfigurationParameters

public static Object[] createConfigurationParameters(Method m,
 Map<String,String> params,
 Object[] parameterValues,
 ITestNGMethod currentTestMethod,
 IAnnotationFinder finder,
 XmlSuite xmlSuite,
 ITestContext ctx,
 ITestResult testResult)

Creates the parameters needed for the specified @Configuration Method .

Parameters:

m - the configuraton method

currentTestMethod - the current @Test method or null if no @Test is available (this is not only in case the configuration method is a @Before/@AfterMethod

finder - the annotation finder

retrieveConfigAnnotation

private static Class<? extends Annotation> retrieveConfigAnnotation(Method m)

createParametersForConstructor

private static Object[] createParametersForConstructor(Constructor<?> constructor,
 Class<?>[] parameterTypes,
 String[] optionalValues,
 String methodAnnotation,
 String[] parameterNames,
 Parameters.MethodParameters params,
 XmlSuite xmlSuite)

createParams

private static List<Object> createParams(String name,
 String prefix,
 String methodAnnotation,
 Class<?>[] parameterTypes,
 String[] optionalValues,
 String[] parameterNames,
 Parameters.MethodParameters params,
 XmlSuite xmlSuite)

filterOutInjectedTypesFromOptionalValues

static Parameters.FilterOutInjectedTypesResult filterOutInjectedTypesFromOptionalValues(Class<?>[] parameterTypes,
 String[] optionalValues)

Remove injected types from parameterTypes and optionalValues

Parameters:

parameterTypes - - The parameter types to be used

optionalValues - - The optional values to be considered.

Returns:

FilterOutInjectedTypesResult

areAllOptionalValuesNull

private static boolean areAllOptionalValuesNull(String[] optionalValues)

createParametersForMethod

private static Object[] createParametersForMethod(ConstructorOrMethod method,
 Class<?>[] parameterTypes,
 String[] optionalValues,
 String methodAnnotation,
 String[] parameterNames,
 Parameters.MethodParameters params,
 XmlSuite xmlSuite)

Returns:

An array of parameters suitable to invoke this method, possibly picked from the property file

extractParameters

private static Parameter[] extractParameters(ConstructorOrMethod method)

canInject

private static boolean canInject(String annotation)

checkParameterTypes

private static void checkParameterTypes(String methodName,
 Class<?>[] parameterTypes,
 String methodAnnotation,
 String[] parameterNames)

validParameters

private static boolean validParameters(String methodAnnotation,
 Class<?>[] parameterTypes)

prettyFormat

private static String prettyFormat(List<Class<?>> classes)

findDataProvider

private static IDataProviderMethod findDataProvider(ITestObjectFactory objectFactory,
 Object instance,
 ITestClass clazz,
 ConstructorOrMethod m,
 IAnnotationFinder finder,
 ITestContext context)

findDataProviderInfo

private static IDataProvidable findDataProviderInfo(ITestClass clazz,
 ConstructorOrMethod m,
 IAnnotationFinder finder)

Find the data provider info (data provider name and class) on either @Test(dataProvider), @Factory(dataProvider) on a method or @Factory(dataProvider) on a constructor.

merge

private static IDataProvidable merge(ITestAnnotation methodLevel,
 ITestAnnotation classLevel)

isDataProviderClassEmpty

private static boolean isDataProviderClassEmpty(ITestAnnotation annotation)

isDynamicDataProviderClassEmpty

private static boolean isDynamicDataProviderClassEmpty(ITestAnnotation annotation)

isDataProviderNameEmpty

private static boolean isDataProviderNameEmpty(ITestAnnotation annotation)

findDataProvider

private static IDataProviderMethod findDataProvider(ITestObjectFactory objectFactory,
 Object instance,
 ITestClass clazz,
 IAnnotationFinder finder,
 String name,
 Class<?> dataProviderClass,
 boolean isDynamicDataProvider,
 ITestContext context)

Find a method that has a @DataProvider(name=name)

getDataProviderName

private static String getDataProviderName(IDataProviderAnnotation dp,
 Method m)

extractOptionalValues

private static String[] extractOptionalValues(IAnnotationFinder finder,
 ConstructorOrMethod consMethod)

createParameters

private static Object[] createParameters(ConstructorOrMethod m,
 Parameters.MethodParameters params,
 IAnnotationFinder finder,
 XmlSuite xmlSuite,
 String atName)

handleParameters

public static ParameterHolder handleParameters(ITestObjectFactory objectFactory,
 ITestNGMethod testMethod,
 Map<String,String> allParameterNames,
 Object instance,
 Parameters.MethodParameters methodParams,
 XmlSuite xmlSuite,
 IAnnotationFinder annotationFinder,
 Object fedInstance,
 DataProviderHolder holder)

If the method has parameters, fill them in. Either by using a @DataProvider if any was provided, or by looking up <parameters> in testng.xml

Returns:

An Iterator over the values for each parameter of this method.

handleParameters

public static ParameterHolder handleParameters(ITestObjectFactory objectFactory,
 ITestNGMethod testMethod,
 Map<String,String> allParameterNames,
 Object instance,
 Parameters.MethodParameters methodParams,
 XmlSuite xmlSuite,
 IAnnotationFinder annotationFinder,
 Object fedInstance,
 DataProviderHolder holder,
 String annotationName)

If the method has parameters, fill them in. Either by using a @DataProvider if any was provided, or by looking up <parameters> in testng.xml

Returns:

An Iterator over the values for each parameter of this method.

injectParameters

public static Object[] injectParameters(Object[] parameterValues,
 Method method,
 ITestContext context)
                                 throws TestNGException

Gets an array of parameter values returned by data provider or the ones that are injected based on parameter type. The method also checks for NoInjection annotation

Parameters:

parameterValues - parameter values from a data provider

method - method to be invoked

context - test context

Throws:

TestNGException