Custom Types
Which types are supported by default in ObjectBox, how to store types that are not, recommendations for storing enums.
With ObjectBox you can store pretty much any type (class), given that it can be converted to any of the built-in types.
ObjectBox can store the following built-in types without a converter:
Java
Kotlin
Dart
boolean, Boolean
int, Integer
short, Short
long, Long
float, Float
double, Double
byte, Byte
char, Character
String
// Strings
String[]
List<String>
Map<String, String>
// integer arrays
byte[]
char[]
short[]
int[]
long[]
// floating point arrays
float[]
double[]
// Stored as time (long) with millisecond precision.
java.util.Date
// Stored as time (long) with nanosecond precision.
@Type(DatabaseType.DateNano) long, Long
// The nullable variants are supported as well.
Boolean
Int
Short
Long
Float
Double
Byte
Char
String
// Strings
Array<String>
MutableList<String>
MutableMap<String, String>
// integer arrays
ByteArray
CharArray
ShortArray
IntArray
LongArray
// floating point arrays
FloatArray
DoubleArray
// Stored as time (Long) with millisecond precision.
java.util.Date
// Stored as time (Long) with nanosecond precision.
@Type(DatabaseType.DateNano) Long?
// all fields are supported as both nullable and non-nullable
bool
int // 64-bit, see below to store as smaller integer
double // 64-bit, see below to store as smaller floating-point
String
List<String>
// Time with millisecond precision.
// Note: always restored in default time zone.
@Property(type: PropertyType.date)
DateTime date;
// Time with millisecond precision restored in UTC time zone.
@Transient()
DateTime utcDate;
int get dbUtcDate => utcDate.millisecondsSinceEpoch;
set dbUtcDate(int value) {
utcDate = DateTime.fromMillisecondsSinceEpoch(value, isUtc: true);
}
// Time with nanosecond precision.
@Property(type: PropertyType.dateNano)
DateTime nanoDate;
@Property(type: PropertyType.byte)
int byte; // 1 byte
@Property(type: PropertyType.short)
int short; // 2 bytes
@Property(type: PropertyType.char)
int char; // 1 bytes
@Property(type: PropertyType.int)
int int32; // 4 bytes
int int64; // 8 bytes
@Property(type: PropertyType.float)
double float; // 4 bytes
double float64; // 8 bytes
// And three supported types for a byte vector (binary data):
@Property(type: PropertyType.byteVector)
List<int> byteList;
Int8List int8List;
Uint8List uint8List;
ObjectBox supports properties where the type is not known at compile time using
Object in Java or Any? in Kotlin. These "flex properties" can store types like integers, floating point values, strings and byte arrays. Or lists and maps (using string keys) of those. Some limitations apply, see the FlexObjectConverter class documentation for details.@Entity
data class Customer(
@Id var id: Long = 0,
// Stores any supported type at runtime
var tag: Any? = null,
// Or explicitly use a String map
var stringMap: MutableMap<String, Any>? = null
// Or a list
var flexList: MutableList<Any>? = null
)
val customerStrTag = Customer(tag = "string-tag")
val customerIntTag = Customer(tag = 1234)
box.put(customerStrTag, customerIntTag)
To store any other type or to override the default behavior, configure a converter like shown below.
To add support for a custom type, you need to provide a conversion to one of the ObjectBox built-in types. For example, you could define a color in your entity using a custom
Color class and map it to an Integer. Or you can map the popular org.joda.time.DateTime from Joda Time to a Long.Here is an example mapping an
enum to an integer:Java
Kotlin
Dart
@Entity
public class User {
@Id
public long id;
@Convert(converter = RoleConverter.class, dbType = Integer.class)
public Role role;
public enum Role {
DEFAULT(0), AUTHOR(1), ADMIN(2);
final int id;
Role(int id) {
this.id = id;
}
}
public static class RoleConverter implements PropertyConverter<Role, Integer> {
@Override
public Role convertToEntityProperty(Integer databaseValue) {
if (databaseValue == null) {
return null;
}
for (Role role : Role.values()) {
if (role.id == databaseValue) {
return role;
}
}
return Role.DEFAULT;
}
@Override
public Integer convertToDatabaseValue(Role entityProperty) {
return entityProperty == null ? null : entityProperty.id;
}
}
}
@Entity
data class User(
@Id
var id: Long = 0,
@Convert(converter = RoleConverter::class, dbType = Int::class)
var role: Role? = null
)
enum class Role(val id: Int) {
DEFAULT(0), AUTHOR(1), ADMIN(2);
}
class RoleConverter : PropertyConverter<Role?, Int?> {
override fun convertToEntityProperty(databaseValue: Int?): Role? {
if (databaseValue == null) {
return null
}
for (role in Role.values()) {
if (role.id == databaseValue) {
return role
}
}
return Role.DEFAULT
}
override fun convertToDatabaseValue(entityProperty: Role?): Int? {
return entityProperty?.id
}
}
enum Role {
unknown,
author,
admin
}
@Entity()
class User {
int id;
// The Role type is not supported by ObjectBox.
// So ignore this field...
@Transient()
Role? role;
// ...and define a field with a supported type,
// that is backed by the role field.
int? get dbRole {
_ensureStableEnumValues();
return role?.index;
}
set dbRole(int? value) {
_ensureStableEnumValues();
if (value == null) {
role = null;
} else {
role = Role.values[value]; // throws a RangeError if not found
// or if you want to handle unknown values gracefully:
role = value >= 0 && value < Role.values.length
? Role.values[value]
: Role.unknown;
}
}
User(this.id);
void _ensureStableEnumValues() {
assert(Role.unknown.index == 0);
assert(Role.author.index == 1);
assert(Role.admin.index == 2);
}
}
If you define your custom type or converter inside a Java or Kotlin entity class, it must be static or respectively not an inner class.
Don’t forget to handle null values correctly – usually, you should return null if the input is null.
Database types in the sense of the converter are the primitive (built-in) types offered by ObjectBox, as mentioned in the beginning. It is recommended to use a primitive type that is easily convertible (int, long, byte array, String, …).
You must not interact with the database (such as using
Box or BoxStore) inside the converter. The converter methods are called within a transaction, so for example, getting or putting entities to a box will fail.Note: For optimal performance, ObjectBox will use a single converter instance for all conversions. Make sure the converter does not have any other constructor besides the parameter-less default constructor. Also, make it thread-safe, because it might be called concurrently on multiple entities.
You can use a converter with List types. For example, you could convert a List of Strings to a JSON array resulting in a single string for the database. At the moment it is not possible to use an array with converters (you can track this feature request).
ObjectBox (Java, Dart) has built-in support for String lists. ObjectBox for Java also has built-in support for String arrays.
Enums are popular with data objects like entities. When persisting enums, there are a couple of best practices:
- Do not persist the enum’s ordinal or name: Both are unstable, and can easily change the next time you edit your enum definitions.
- Use stable ids: Define a custom property (integer or string) in your enum that is guaranteed to be stable. Use this for your persistence mapping.
- Prepare for the unknown: Define an UNKNOWN enum value. It can serve to handle null or unknown values. This will allow you to handle cases like an old enum value getting removed without crashing your app.
QueryBuilder is unaware of custom types. You have to use the primitive DB type for queries.So for the Role example above you would get users with the role of admin with the query condition
.equal(UserProperties.Role, 2).Last modified 19d ago