A B C D E F H I N O P R S T U V
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- assignable() - Method in annotation type io.objectbox.annotation.Id
-
Allows IDs of new entities to be assigned manually.
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
- ConflictStrategy - Enum in io.objectbox.annotation
-
Used with
Uniqueto specify the conflict resolution strategy. - Convert - Annotation Type in io.objectbox.annotation
-
Supplies a
converterto store custom Property types as a supportedConvert.dbType(). - converter() - Method in annotation type io.objectbox.annotation.Convert
-
The converter class that ObjectBox should use.
- convertToDatabaseValue(P) - Method in interface io.objectbox.converter.PropertyConverter
- convertToEntityProperty(D) - Method in interface io.objectbox.converter.PropertyConverter
D
- DatabaseType - Enum in io.objectbox.annotation
-
Use with
@Typeto override how a property value is stored and interpreted in the database. - DateNano - io.objectbox.annotation.DatabaseType
-
Use with 64-bit long properties to store them as high precision time representing nanoseconds since 1970-01-01 (unix epoch).
- dbType() - Method in annotation type io.objectbox.annotation.Convert
-
The Property type the Java field value is converted to/from.
- DEFAULT - io.objectbox.annotation.IndexType
-
Use the default index type depending on the property type:
IndexType.VALUEfor scalars andIndexType.HASHfor Strings. - 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.
F
- FAIL - io.objectbox.annotation.ConflictStrategy
-
Throws UniqueViolationException if any property violates a
Uniqueconstraint.
H
- HASH - io.objectbox.annotation.IndexType
-
Use a (fast non-cryptographic) hash of the property value to build the index.
- HASH64 - io.objectbox.annotation.IndexType
-
Use a long (fast non-cryptographic) hash of the property value to build the index.
I
- Id - Annotation Type in io.objectbox.annotation
-
Marks the ID property of an
@Entity. - IdCompanion - Annotation Type in io.objectbox.annotation
-
Marks a property as a companion to an @Id property.
- 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@IdProperty, to create an@Indexor a@TransientProperty. - io.objectbox.annotation.apihint - package io.objectbox.annotation.apihint
-
Annotations to mark APIs as for example
@Internalor@Experimental. - io.objectbox.converter - package io.objectbox.converter
-
For use with
@Convert:PropertyConverterto convert custom Property types.
N
- NameInDb - Annotation Type in io.objectbox.annotation
-
Allows to specify a simple name mapping for entities and properties.
O
- onConflict() - Method in annotation type io.objectbox.annotation.Unique
-
The strategy to use when a conflict is detected when an object is put.
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.
R
- REPLACE - io.objectbox.annotation.ConflictStrategy
-
Any conflicting objects are deleted before the object is inserted.
S
- sharedGlobalIds() - Method in annotation type io.objectbox.annotation.Sync
- Sync - Annotation Type in io.objectbox.annotation
-
Enables sync for an
Entityclass.
T
- TargetIdProperty - Annotation Type in io.objectbox.annotation
-
Defines the property serving as the target ID of a ToOne.
- to() - Method in annotation type io.objectbox.annotation.Backlink
-
Name of the relation the backlink should be based on (e.g.
- Transient - Annotation Type in io.objectbox.annotation
-
Transient fields are not persisted in the database.
- type() - Method in annotation type io.objectbox.annotation.Index
-
Sets the
IndexType, defaults toIndexType.DEFAULT. - Type - Annotation Type in io.objectbox.annotation
-
Use on a property to override how its value is stored and interpreted 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.
- Unsigned - Annotation Type in io.objectbox.annotation
-
Indicates that values of an integer property (e.g.
- useNoArgConstructor() - Method in annotation type io.objectbox.annotation.Entity
-
Use a no-arg constructor instead of an all properties constructor (generated).
V
- value() - Method in annotation type io.objectbox.annotation.DefaultValue
- value() - Method in annotation type io.objectbox.annotation.NameInDb
-
Name used in the database.
- value() - Method in annotation type io.objectbox.annotation.TargetIdProperty
-
Name used in the database.
- value() - Method in annotation type io.objectbox.annotation.Type
- value() - Method in annotation type io.objectbox.annotation.Uid
-
The UID associated with an entity/property.
- VALUE - io.objectbox.annotation.IndexType
-
Use the property value to build the index.
- valueOf(String) - Static method in enum io.objectbox.annotation.ConflictStrategy
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.objectbox.annotation.DatabaseType
-
Returns the enum constant of this type with the specified name.
- 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.ConflictStrategy
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum io.objectbox.annotation.DatabaseType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- 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.
All Classes All Packages