uk.co.jemos.podam.common

Annotation Type PodamByteValue

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

Annotation used to customise min and max values of a byte 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.
byte	maxValue The minimum value for the annotated field.
byte	minValue The minimum value for the annotated field.
String	numValue A precise value for the annotated attribute.

Element Detail

numValue

public abstract String numValue

A precise value for 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 be byte, 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 byte value to assign to the annotated attribute

Default:

""

minValue

public abstract byte minValue

The minimum value for the annotated field.

Returns:

The minimum byte value to assign to the annotated attribute

Default:

0

maxValue

public abstract byte maxValue

The minimum value for the annotated field.

Returns:

The maximum byte value to assign to the annotated attribute

Default:

0

comment

public abstract String comment

It allows clients to make comments.

Returns:

A string representing comments for this annotation

Default:

""