uk.co.jemos.podam.common

Annotation Type PodamShortValue

@Documented
@Target(value={FIELD,PARAMETER})
@Retention(value=RUNTIME)
public @interface PodamShortValue

Annotation used to customise min and max values of a short type attribute or constructor parameter.

Author:

mtedone

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	comment It allows clients to make comments on the annotated attribute.
short	maxValue The maximum value for the annotated field.
short	minValue The minimum value to assign to the annotated attribute.
String	numValue It returns the precise value to be assigned to the annotated attribute.

Element Detail

minValue

public abstract short minValue

The minimum value to assign to the annotated attribute.

Returns:

The minimum value to assign to the annotated attribute.

Default:

0

maxValue

public abstract short maxValue

The maximum value for the annotated field.

Returns:

The maximum value for the annotated field.

Default:

0

comment

public abstract String comment

It allows clients to make comments on the annotated attribute.

This attribute defaults to an empty string.

Returns:

A string representing comments on the annotated attribute.

Default:

""

numValue

public abstract String numValue

It returns the precise value to be assigned to the annotated attribute.

This attribute defaults to an empty string.

Please note that the format should be String to allow for null values for this annotation attribute. If we set the type to the primitive for this annotation, then to allow for null values we should have set something arbitrary as default 0. If set, the value must be convertible to the type of this annotation or a NumberFormatException will be thrown.

If set, it will take precedence over all other annotation attributes (e.g. min/max)

Returns:

The precise value to assign to the annotated attribute, in String format

Default:

""