Annotation Type Convert


  • @Target({METHOD,FIELD,TYPE})
    @Retention(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 Description
      java.lang.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.
      java.lang.Class converter
      Specifies the converter to be applied.
      boolean disableConversion
      Used to disable an auto-apply or inherited converter.
    • Element Detail

      • converter

        java.lang.Class converter
        Specifies the converter to be applied. A value for this element must be specified if multiple converters would otherwise apply.
        Default:
        void.class
      • attributeName

        java.lang.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.
        Default:
        ""
      • disableConversion

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