Package com.helger.commons.mock

Class CommonsMock.Param

java.lang.Object

com.helger.commons.mock.CommonsMock.Param

Enclosing class:

CommonsMock

@Immutable
public static final class CommonsMock.Param
extends Object

This class represents a parameter description for a single mockable type. It consists of a parameter name (purely informational), parameter class (required) and a generic supplier.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor	Description
Param(String sParamName, Class<T> aParamClass, Supplier<T> aDefaultValueSupplier)	Constructor for a mock parameter

Method Summary

Modifier and Type	Method	Description
static CommonsMock.Param	createConstant(String sParamName, boolean bDefault)
static <T> CommonsMock.Param	createConstant(String sParamName, Class<T> aParamClass, T aDefault)	Create a CommonsMock.Param with a constant default value.
IGetterDirectTrait	getDefaultValue()
Class<?>	getParamClass()
String	getParamName()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

Param

public Param(@Nonnull @Nonempty
 String sParamName,
 @Nonnull
 Class<T> aParamClass,
 @Nonnull
 Supplier<T> aDefaultValueSupplier)

Constructor for a mock parameter

Type Parameters:

T - data type of the parameter

Parameters:

sParamName - Name of the parameter - informational only. May neither be null nor empty.

aParamClass - The class of the parameter. May neither be null nor empty.

aDefaultValueSupplier - The default value supplier in case the caller did not provide an argument. May not be null.

Method Details

getParamName

@Nonnull
@Nonempty
public String getParamName()

getParamClass

@Nonnull
public Class<?> getParamClass()

getDefaultValue

@Nonnull
public IGetterDirectTrait getDefaultValue()

toString

public String toString()

Overrides:

toString in class Object

createConstant

@Nonnull
public static CommonsMock.Param createConstant(@Nonnull @Nonempty
 String sParamName,
 boolean bDefault)

createConstant

@Nonnull
public static <T> CommonsMock.Param createConstant(@Nonnull @Nonempty
 String sParamName,
 @Nonnull
 Class<T> aParamClass,
 @Nullable
 T aDefault)

Create a CommonsMock.Param with a constant default value.

Type Parameters:

T - data type create the constant of

Parameters:

sParamName - Parameter name. May neither be null nor empty.

aParamClass - The parameter class. May not be null.

aDefault - The constant default value to be used. May be null.

Returns:

The CommonsMock.Param object and never null.