Skip navigation links
B C D E I N P S T U V 

B

Backlink - Annotation Type in io.objectbox.annotation
Defines a backlink relation, which is based on another relation reversing the direction.
BaseEntity - Annotation Type in io.objectbox.annotation
Marks a class as an ObjectBox Entity super class.
Beta - Annotation Type in io.objectbox.annotation.apihint
APIs annotated with @Beta may change and may be even removed in a future release (but is somewhat less likely compared to Experimental).

C

Convert - Annotation Type in io.objectbox.annotation
Supplies a converter to store custom Property types as a supported Convert.dbType().
convertToDatabaseValue(P) - Method in interface io.objectbox.converter.PropertyConverter
 
convertToEntityProperty(D) - Method in interface io.objectbox.converter.PropertyConverter
 

D

DefaultValue - Annotation Type in io.objectbox.annotation
Defines the Java code of the default value to use for a property, when getting an existing entity and the database value for the property is null.

E

Entity - Annotation Type in io.objectbox.annotation
Marks a class as an ObjectBox Entity.
Experimental - Annotation Type in io.objectbox.annotation.apihint
APIs annotated with @Experimental are likely to change and may be even removed in a future release.

I

Id - Annotation Type in io.objectbox.annotation
Marks the ID property of an @Entity.
Index - Annotation Type in io.objectbox.annotation
Specifies that the property should be indexed.
IndexType - Enum in io.objectbox.annotation
ObjectBox offers a value and two hash index types, from which it chooses a reasonable default (see IndexType.DEFAULT).
Internal - Annotation Type in io.objectbox.annotation.apihint
APIs annotated with @Internal must NOT be used.
io.objectbox.annotation - package io.objectbox.annotation
Annotations to mark a class as an @Entity, to specify the @Id Property, to create an @Index or a @Transient Property.
io.objectbox.annotation.apihint - package io.objectbox.annotation.apihint
Annotations to mark APIs as for example @Internal or @Experimental.
io.objectbox.converter - package io.objectbox.converter
For use with @Convert: PropertyConverter to convert custom Property types.

N

NameInDb - Annotation Type in io.objectbox.annotation
Allows to specify a simple name mapping for entities and properties.

P

PropertyConverter<P,D> - Interface in io.objectbox.converter
To use custom types in your entity, implement this to convert db values to entity values and back.

S

Sync - Annotation Type in io.objectbox.annotation
Enables sync for an Entity class.

T

TargetIdProperty - Annotation Type in io.objectbox.annotation
Defines the property serving as the target ID of a ToOne.
Transient - Annotation Type in io.objectbox.annotation
Transient fields are not persisted in the database.

U

Uid - Annotation Type in io.objectbox.annotation
UIDs identify entities (and properties) uniquely in the meta object model file (objectbox-model/default.json).
Unique - Annotation Type in io.objectbox.annotation
Enforces that the value of a property is unique among all objects in a box before an object can be put.

V

valueOf(String) - Static method in enum io.objectbox.annotation.IndexType
Returns the enum constant of this type with the specified name.
values() - Static method in enum io.objectbox.annotation.IndexType
Returns an array containing the constants of this enum type, in the order they are declared.
B C D E I N P S T U V 
Skip navigation links