javax.persistence

Annotation Type Convert

@Target(value={METHOD,FIELD,TYPE})
@Retention(value=RUNTIME)
public @interface Convert

The Convert annotation is used to specify the conversion of a Basic field or property. It is not necessary to use the Basic annotation or corresponding XML element to specify the basic type.

Since:

Java Persistence 2.1

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	attributeName The attributeName must be specified unless the Convert annotation is on an attribute of basic type or on an element collection of basic type.
Class	converter Specifies the converter to be applied.
boolean	disableConversion Used to disable an auto-apply or inherited converter.

Element Detail

converter

public abstract Class converter

Specifies the converter to be applied. A value for this element must be specified if multiple converters would otherwise apply.

Returns:

converter

Default:

void.class

attributeName

public abstract String attributeName

The attributeName must be specified unless the Convert annotation is on an attribute of basic type or on an element collection of basic type. In these cases, attributeName must not be specified.

Returns:

attribute name

Default:

""

disableConversion

public abstract boolean disableConversion

Used to disable an auto-apply or inherited converter. If disableConversion is true, the converter element should not be specified.

Returns:

disable

Default:

false