A B C D E F G H I M N P S T U V

A

addEntity(String) - Method in class io.objectbox.generator.model.Schema

Adds a new entity to the schema.

addIdProperty() - Method in class io.objectbox.generator.model.Entity

Adds a standard id property.

addIndex(Index) - Method in class io.objectbox.generator.model.Entity

Adds a new index to the entity.

addProperty(PropertyType, String) - Method in class io.objectbox.generator.model.Entity

addToMany(ToManyStandalone, Entity) - Method in class io.objectbox.generator.model.Entity

Adds a (stand-alone) to-many relation (ToManyStandalone) to another entity.

addToManyByToManyBacklink(ToManyByBacklink, Entity, ToManyStandalone) - Method in class io.objectbox.generator.model.Entity

Adds a to-many relation based on a (stand-alone) to-many relation (Entity.addToMany(io.objectbox.generator.model.ToManyStandalone, io.objectbox.generator.model.Entity)) from another entity to this entity.

addToManyByToOneBacklink(ToManyByBacklink, Entity, ToOne) - Method in class io.objectbox.generator.model.Entity

Adds a to-many relation based on a to-one relation (Entity.addToOne(io.objectbox.generator.model.ToOne, io.objectbox.generator.model.Entity)) from another entity to this entity.

addToOne(ToOne, Entity) - Method in class io.objectbox.generator.model.Entity

Adds a to-one relationship to the given target entity.

B

BASE_PACKAGE_PATH - Static variable in class io.objectbox.generator.BoxGenerator

BoxGenerator - Class in io.objectbox.generator

Once you have your model created, use this class to generate box cursors as required by ObjectBox.

BoxGenerator() - Constructor for class io.objectbox.generator.BoxGenerator

C

capFirst(String) - Static method in class io.objectbox.generator.TextUtil

computeEntityFlags() - Method in class io.objectbox.generator.model.Entity

Based on this entities attributes computes required EntityFlags.

computePropertyFlags() - Method in class io.objectbox.generator.model.Property

Based on this properties attributes computes required PropertyFlags.

create(String) - Static method in class io.objectbox.generator.GeneratorOutput

create(File) - Static method in class io.objectbox.generator.GeneratorOutput

create(Filer) - Static method in class io.objectbox.generator.GeneratorOutput

createWriter(String, String, String) - Method in class io.objectbox.generator.GeneratorOutput

customType(String, String) - Method in class io.objectbox.generator.model.Property.PropertyBuilder

D

dbName(String) - Method in class io.objectbox.generator.model.Property.PropertyBuilder

dbName(String) - Static method in class io.objectbox.generator.TextUtil

dbType(String) - Method in class io.objectbox.generator.model.Property.PropertyBuilder

DEFAULT_NAME - Static variable in class io.objectbox.generator.model.Schema

E

Entity - Class in io.objectbox.generator.model

Model class for an entity: a Java data object mapped to a data base representation.

F

fieldAccessible() - Method in class io.objectbox.generator.model.Property.PropertyBuilder

findPropertyByName(String) - Method in class io.objectbox.generator.model.Entity

finish() - Method in class io.objectbox.generator.model.Schema

Sets DAO names for ObjectBox (Cursor), runs 2nd and 3rd pass on schema.

G

generateAll(GeneratorJob) - Method in class io.objectbox.generator.BoxGenerator

Generates all classes and other artifacts for the given job.

GeneratorJob - Class in io.objectbox.generator

State for a job done by BoxGenerator.

GeneratorJob(Schema, GeneratorOutput) - Constructor for class io.objectbox.generator.GeneratorJob

GeneratorOutput - Class in io.objectbox.generator

Abstraction for output used by BoxGenerator.

getAdditionalImportsDao() - Method in class io.objectbox.generator.model.Entity

getClassName() - Method in class io.objectbox.generator.model.Entity

getClassNameDao() - Method in class io.objectbox.generator.model.Entity

getClassnameFromFullyQualified(String) - Static method in class io.objectbox.generator.TextUtil

getConverter() - Method in class io.objectbox.generator.model.Property

getConverterClassName() - Method in class io.objectbox.generator.model.Property

getCustomType() - Method in class io.objectbox.generator.model.Property

getCustomTypeClassName() - Method in class io.objectbox.generator.model.Property

getDatabaseValueExpression() - Method in class io.objectbox.generator.model.Property

getDatabaseValueExpression(String) - Method in class io.objectbox.generator.model.Property

getDbName() - Method in class io.objectbox.generator.model.Entity

getDbName() - Method in class io.objectbox.generator.model.Property

getDbType() - Method in class io.objectbox.generator.model.Property

String representation of a PropertyType enum.

getDbTypeId() - Method in class io.objectbox.generator.model.Property

ID of the PropertyType.

getDefaultJavaPackage() - Method in class io.objectbox.generator.model.Schema

getDefaultJavaPackageDao() - Method in class io.objectbox.generator.model.Schema

getEntities() - Method in class io.objectbox.generator.model.Schema

getEntity() - Method in class io.objectbox.generator.model.Property

getEntityFlags() - Method in class io.objectbox.generator.model.Entity

Returns combined EntityFlags value.

getEntityFlagsForModelFile() - Method in class io.objectbox.generator.model.Entity

Returns combined EntityFlags value of only those flags that should be stored in the model file.

getEntityFlagsNames() - Method in class io.objectbox.generator.model.Entity

Returns names of EntityFlags.

getFileOrNull(String, String, String) - Method in class io.objectbox.generator.GeneratorOutput

getGetterMethodName() - Method in class io.objectbox.generator.model.Property

getHasBoxStoreField() - Method in class io.objectbox.generator.model.Entity

getHnswParams() - Method in class io.objectbox.generator.model.Property

getHnswParamsExpression() - Method in class io.objectbox.generator.model.Property

getIncomingToManyRelations() - Method in class io.objectbox.generator.model.Entity

getIndex() - Method in class io.objectbox.generator.model.Property

Note: index is not set until after finishing schema.

getIndexes() - Method in class io.objectbox.generator.model.Entity

getJavaPackage() - Method in class io.objectbox.generator.model.Entity

getJavaPackageDao() - Method in class io.objectbox.generator.model.Entity

getJavaRawType() - Method in class io.objectbox.generator.model.Property

If the Java type is generic, returns the raw type.

getJavaType() - Method in class io.objectbox.generator.model.Property

Returns the type including type parameters, e.g.

getJavaTypeInEntity() - Method in class io.objectbox.generator.model.Property

getLastEntityId() - Method in class io.objectbox.generator.model.Schema

getLastIndexId() - Method in class io.objectbox.generator.model.Schema

getLastPropertyId() - Method in class io.objectbox.generator.model.Entity

getLastRelationId() - Method in class io.objectbox.generator.model.Schema

getModelId() - Method in class io.objectbox.generator.model.Entity

getModelId() - Method in class io.objectbox.generator.model.Property

getModelIndexId() - Method in class io.objectbox.generator.model.Property

getModelUid() - Method in class io.objectbox.generator.model.Entity

getMultiIndexes() - Method in class io.objectbox.generator.model.Entity

getName() - Method in class io.objectbox.generator.model.Schema

getName() - Method in class io.objectbox.generator.model.ToManyBase

getOrdinal() - Method in class io.objectbox.generator.model.Property

getOutput() - Method in class io.objectbox.generator.GeneratorJob

getOutputFlatbuffersSchema() - Method in class io.objectbox.generator.GeneratorJob

getPackageFromFullyQualified(String) - Static method in class io.objectbox.generator.TextUtil

getParsedElement() - Method in class io.objectbox.generator.model.Entity

getParsedElement() - Method in interface io.objectbox.generator.model.HasParsedElement

getParsedElement() - Method in class io.objectbox.generator.model.Property

getParsedElement() - Method in class io.objectbox.generator.model.ToManyBase

getPkProperty() - Method in class io.objectbox.generator.model.Entity

Internal property used by templates, don't use during entity definition.

getPkType() - Method in class io.objectbox.generator.model.Entity

Internal property used by templates, don't use during entity definition.

getPrefix() - Method in class io.objectbox.generator.model.Schema

getProperties() - Method in class io.objectbox.generator.model.Entity

getPropertiesColumns() - Method in class io.objectbox.generator.model.Entity

getPropertiesPk() - Method in class io.objectbox.generator.model.Entity

Internal property used by templates, don't use during entity definition.

getProperty() - Method in class io.objectbox.generator.model.Property.PropertyBuilder

getPropertyFlagsForGeneratedCode() - Method in class io.objectbox.generator.model.Property

Returns names of PropertyFlags to be used in generated model builder code.

getPropertyFlagsForModelFile() - Method in class io.objectbox.generator.model.Property

Returns combined PropertyFlags value of only those flags that should be stored in the model file.

getPropertyName() - Method in class io.objectbox.generator.model.Property

getPropertyType() - Method in class io.objectbox.generator.model.Property

getSchema() - Method in class io.objectbox.generator.GeneratorJob

getSchema() - Method in class io.objectbox.generator.model.Entity

getSetValueExpression(String) - Method in class io.objectbox.generator.model.Property

getSourceEntity() - Method in class io.objectbox.generator.model.ToManyBase

getTargetEntity() - Method in class io.objectbox.generator.model.Property

getTargetEntity() - Method in class io.objectbox.generator.model.ToManyBase

getTargetEntityName() - Method in class io.objectbox.generator.model.ToManyBase

getterMethodName(String) - Method in class io.objectbox.generator.model.Property.PropertyBuilder

getToManyRelations() - Method in class io.objectbox.generator.model.Entity

getToOneRelations() - Method in class io.objectbox.generator.model.Entity

getValueExpression() - Method in class io.objectbox.generator.model.Property

getValueExpression() - Method in class io.objectbox.generator.model.ToManyBase

getVersion() - Method in class io.objectbox.generator.model.Schema

getVirtualTargetName() - Method in class io.objectbox.generator.model.Property

getVirtualTargetValueExpression() - Method in class io.objectbox.generator.model.Property

H

hasAllArgsConstructor() - Method in class io.objectbox.generator.model.Entity

hasHnswParams() - Method in class io.objectbox.generator.model.Property

HasParsedElement - Interface in io.objectbox.generator.model

A model parser can set any object for future reference; e.g.

hasRelations() - Method in class io.objectbox.generator.model.Entity

hnswParams(HnswIndex) - Method in class io.objectbox.generator.model.Property.PropertyBuilder

Sets HNSW index parameters, implicitly creates an Property.PropertyBuilder.index().

I

idAssignable() - Method in class io.objectbox.generator.model.Property.PropertyBuilder

idCompanion() - Method in class io.objectbox.generator.model.Property.PropertyBuilder

index() - Method in class io.objectbox.generator.model.Property.PropertyBuilder

index(int, int) - Method in class io.objectbox.generator.model.Property.PropertyBuilder

init2ndPassNamesWithDefaults() - Method in class io.objectbox.generator.model.Entity

io.objectbox.generator - package io.objectbox.generator

io.objectbox.generator.model - package io.objectbox.generator.model

isDaoCompat() - Method in class io.objectbox.generator.GeneratorJob

isFinished() - Method in class io.objectbox.generator.model.Schema

isIdAssignable() - Method in class io.objectbox.generator.model.Property

If PropertyFlags.ID_SELF_ASSIGNABLE should be set on this property.

isIdCompanion() - Method in class io.objectbox.generator.model.Property

If PropertyFlags.ID_COMPANION should be set on this property.

isList() - Method in class io.objectbox.generator.model.Property

For a vector property, if it is a List or an array.

isList() - Method in class io.objectbox.generator.model.Property.PropertyBuilder

See Property.isList().

isNonPrimitiveFlag() - Method in class io.objectbox.generator.model.Property

If PropertyFlags.NON_PRIMITIVE_TYPE should be set on this property.

isNotNullFlag() - Method in class io.objectbox.generator.model.Property

If PropertyFlags.NOT_NULL should be set on this property.

isPrimaryKey() - Method in class io.objectbox.generator.model.Property

If this property is a primary key and PropertyFlags.ID should be set.

isScalar() - Method in enum io.objectbox.generator.model.PropertyType

True if the type can be represented using a scalar (primitive type).

isSyncEnabled() - Method in class io.objectbox.generator.model.Entity

isSyncSharedGlobalIds() - Method in class io.objectbox.generator.model.Entity

isTypeNotNull() - Method in class io.objectbox.generator.model.Property

If a property value may never be null, so e.g.

isUnsigned() - Method in class io.objectbox.generator.model.Property

If PropertyFlags.UNSIGNED should be set on this property.

isVirtual() - Method in class io.objectbox.generator.model.Property

If this property does not actually exist in the entity class, but only in the model and PropertyFlags.VIRTUAL should be set.

M

mapToDbType(PropertyType) - Method in class io.objectbox.generator.model.Schema

mapToDbTypeId(PropertyType) - Method in class io.objectbox.generator.model.Schema

mapToJavaTypeNotNull(PropertyType) - Method in class io.objectbox.generator.model.Schema

mapToJavaTypeNullable(PropertyType) - Method in class io.objectbox.generator.model.Schema

ModelException - Exception in io.objectbox.generator.model

Thrown when there is a configuration issue with the model that can be resolved by the user.

ModelException(String) - Constructor for exception io.objectbox.generator.model.ModelException

modelId(IdUid) - Method in class io.objectbox.generator.model.Property.PropertyBuilder

modelIndexId(IdUid) - Method in class io.objectbox.generator.model.Property.PropertyBuilder

ModelRuntimeException - Exception in io.objectbox.generator.model

Thrown when the model was configured incorrectly.

ModelRuntimeException(String) - Constructor for exception io.objectbox.generator.model.ModelRuntimeException

MYOBJECTBOX_FTL - Static variable in class io.objectbox.generator.BoxGenerator

N

nonPrimitiveFlag() - Method in class io.objectbox.generator.model.Property.PropertyBuilder

See Property.isNonPrimitiveFlag().

notNullFlag() - Method in class io.objectbox.generator.model.Property.PropertyBuilder

P

primaryKey() - Method in class io.objectbox.generator.model.Property.PropertyBuilder

Property - Class in io.objectbox.generator.model

Model class for an entity's property: a Java property mapped to a data base representation.

Property(Schema, Entity, PropertyType, String) - Constructor for class io.objectbox.generator.model.Property

Property.PropertyBuilder - Class in io.objectbox.generator.model

PropertyBuilder(Schema, Entity, PropertyType, String) - Constructor for class io.objectbox.generator.model.Property.PropertyBuilder

PropertyType - Enum in io.objectbox.generator.model

Currently available types for properties in the Java generator.

S

Schema - Class in io.objectbox.generator.model

The "root" model class to which you can add entities to.

Schema(String, int, String) - Constructor for class io.objectbox.generator.model.Schema

Schema(int, String) - Constructor for class io.objectbox.generator.model.Schema

setClassNameDao(String) - Method in class io.objectbox.generator.model.Entity

setDaoCompat(boolean) - Method in class io.objectbox.generator.GeneratorJob

setDbName(String) - Method in class io.objectbox.generator.model.Entity

setHasAllArgsConstructor(boolean) - Method in class io.objectbox.generator.model.Entity

Set to indicate the associated class has a constructor with an argument for every property available.

setHasBoxStoreField(boolean) - Method in class io.objectbox.generator.model.Entity

setIndex(Index) - Method in class io.objectbox.generator.model.Property

setJavaPackage(String) - Method in class io.objectbox.generator.model.Entity

setJavaPackageDao(String) - Method in class io.objectbox.generator.model.Entity

setLastEntityId(IdUid) - Method in class io.objectbox.generator.model.Schema

setLastIndexId(IdUid) - Method in class io.objectbox.generator.model.Schema

setLastPropertyId(IdUid) - Method in class io.objectbox.generator.model.Entity

setLastRelationId(IdUid) - Method in class io.objectbox.generator.model.Schema

setModelId(Integer) - Method in class io.objectbox.generator.model.Entity

setModelId(IdUid) - Method in class io.objectbox.generator.model.Property

setModelIndexId(IdUid) - Method in class io.objectbox.generator.model.Property

setModelUid(Long) - Method in class io.objectbox.generator.model.Entity

setOutputFlatbuffersSchema(GeneratorOutput) - Method in class io.objectbox.generator.GeneratorJob

setParsedElement(Object) - Method in class io.objectbox.generator.model.Entity

setParsedElement(Object) - Method in interface io.objectbox.generator.model.HasParsedElement

setParsedElement(Object) - Method in class io.objectbox.generator.model.Property

setParsedElement(Object) - Method in class io.objectbox.generator.model.ToManyBase

setSyncEnabled(boolean) - Method in class io.objectbox.generator.model.Entity

setSyncSharedGlobalIds(boolean) - Method in class io.objectbox.generator.model.Entity

T

TextUtil - Class in io.objectbox.generator

Internal API

TextUtil() - Constructor for class io.objectbox.generator.TextUtil

ToManyBase - Class in io.objectbox.generator.model

Base class for to-many relationship from source entities to target entities.

toString() - Method in class io.objectbox.generator.model.Entity

toString() - Method in class io.objectbox.generator.model.Property

toString() - Method in class io.objectbox.generator.model.ToManyBase

typeNotNull() - Method in class io.objectbox.generator.model.Property.PropertyBuilder

U

unsigned() - Method in class io.objectbox.generator.model.Property.PropertyBuilder

V

valueOf(String) - Static method in enum io.objectbox.generator.model.PropertyType

Returns the enum constant of this type with the specified name.

values() - Static method in enum io.objectbox.generator.model.PropertyType

Returns an array containing the constants of this enum type, in the order they are declared.

virtualTargetName(String) - Method in class io.objectbox.generator.model.Property.PropertyBuilder

virtualTargetValueExpression(String) - Method in class io.objectbox.generator.model.Property.PropertyBuilder

A B C D E F G H I M N P S T U V