io.requery

Interface Converter<A,B>

Type Parameters:

A - the mapped type

B - the stored persisted type

All Known Implementing Classes:

EnumOrdinalConverter, EnumStringConverter, LocalDateConverter, LocalDateTimeConverter, LocalTimeConverter, OffsetDateTimeConverter, URIConverter, URLConverter, UUIDConverter, ZonedDateTimeConverter

public interface Converter<A,B>

Interface for converting between a java custom type to a basic java persisted type. Example a conversion to store a java URI as a string. Would define a class like:

 
     public class URIConverter implements Converter<URI, String> {
     ...
     }
 
 

and implement the corresponding methods for converting the URI to and from a string. Then it can be registered via mapping or in the entity class like so:

     @Entity
     public class AbstractUser {
         @Convert(URIConverter.class)
         URI homepage
     }
 }
 

When used with the Convert annotation the converter must have a no argument constructor or compilation will fail.

See Also:

Convert

Method Summary

Modifier and Type	Method and Description
A	convertToMapped(Class<? extends A> type, B value) Convert the persisted type B to the mapped type A.
B	convertToPersisted(A value) Convert the mapped type A to the persisted type B.
Class<A>	getMappedType()
Integer	getPersistedSize()
Class<B>	getPersistedType()

Method Detail

getMappedType

Class<A> getMappedType()

Returns:

the type to be converted.

getPersistedType

Class<B> getPersistedType()

Returns:

the persisted type.

getPersistedSize

@Nullable
Integer getPersistedSize()

Returns:

size or length of the persisted type (optional) in bytes otherwise return null.

convertToPersisted

B convertToPersisted(A value)

Convert the mapped type A to the persisted type B.

Parameters:

value - to convert

Returns:

converted value

convertToMapped

A convertToMapped(Class<? extends A> type,
                  @Nullable
                  B value)

Convert the persisted type B to the mapped type A.

Parameters:

type - the type to convert

value - value to convert

Returns:

converted value