Package uk.co.jemos.podam.common

Annotation Type PodamCollection

@Documented
@PodamAnnotation
@Target({FIELD,PARAMETER})
@Retention(RUNTIME)
public @interface PodamCollection

Annotation used to customise collection-type elements

Please note that this annotation can be used with all types of container elements, including arrays.

The minimum number of elements is PodamConstants.DEFAULT_NBR_COLLECTION_ELEMENTS

Author:

mtedone

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
Class<? extends AttributeStrategy<?>>	collectionElementStrategy	The strategy that will populate the annotated attribute.
String	comment	It allows clients to specify a comment on this annotation
Class<? extends AttributeStrategy<?>>	mapElementStrategy	The strategy that will populate a map element on an attribute of type Map.
Class<? extends AttributeStrategy<?>>	mapKeyStrategy	The strategy that will populate a map key on an attribute of type Map.
int	nbrElements	The number of elements to create for the collection

Element Detail

nbrElements

int nbrElements

The number of elements to create for the collection

Returns:

number of elements to place into collection

Default:

5

collectionElementStrategy

Class<? extends AttributeStrategy<?>> collectionElementStrategy

The strategy that will populate the annotated attribute.

The default, in order to make the strategy actually optional is type Object. At runtime, only if both the value of this annotation and the collection element type are Objects, then the collection will be set with type Object, otherwise the collection element type will win.

Returns:

The strategy that will populate the annotated attribute

Default:

uk.co.jemos.podam.api.ObjectStrategy.class

mapKeyStrategy

Class<? extends AttributeStrategy<?>> mapKeyStrategy

The strategy that will populate a map key on an attribute of type Map.

The default, in order to make the strategy actually optional is type Object. At runtime, only if both the value of this annotation and the collection element type are Objects, then the collection will be set with type Object, otherwise the collection element type will win.

Returns:

The strategy that will populate a map key on an attribute of type Map.

Default:

uk.co.jemos.podam.api.ObjectStrategy.class

mapElementStrategy

Class<? extends AttributeStrategy<?>> mapElementStrategy

The strategy that will populate a map element on an attribute of type Map.

The default, in order to make the strategy actually optional is type Object. At runtime, only if both the value of this annotation and the collection element type are Objects, then the collection will be set with type Object, otherwise the collection element type will win.

Returns:

The strategy that will populate a map element on an attribute of type Map.

Default:

uk.co.jemos.podam.api.ObjectStrategy.class

comment

String comment

It allows clients to specify a comment on this annotation

Returns:

comment value

Default:

""