io.objectbox.generator.model

Class Property.PropertyBuilder

java.lang.Object

io.objectbox.generator.model.Property.PropertyBuilder

Enclosing class:

Property

public static class Property.PropertyBuilder
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
PropertyBuilder(Schema schema, Entity entity, PropertyType propertyType, java.lang.String propertyName)

Method Summary

Modifier and Type	Method and Description
Property.PropertyBuilder	customType(java.lang.String customType, java.lang.String converter)
Property.PropertyBuilder	dbName(java.lang.String dbName)
Property.PropertyBuilder	dbType(java.lang.String dbType)
Property.PropertyBuilder	fieldAccessible()
Property	getProperty()
Property.PropertyBuilder	getterMethodName(java.lang.String getterMethodName)
Property.PropertyBuilder	hnswParams(io.objectbox.annotation.HnswIndex annotation) Sets HNSW index parameters, implicitly creates an index().
Property.PropertyBuilder	idAssignable()
Property.PropertyBuilder	idCompanion()
Property.PropertyBuilder	index()
Property.PropertyBuilder	index(int indexFlags, int maxValueLength)
Property.PropertyBuilder	isList() See Property.isList().
Property.PropertyBuilder	modelId(io.objectbox.generator.IdUid modelId)
Property.PropertyBuilder	modelIndexId(io.objectbox.generator.IdUid indexId)
Property.PropertyBuilder	nonPrimitiveFlag() See Property.isNonPrimitiveFlag().
Property.PropertyBuilder	notNullFlag()
Property.PropertyBuilder	primaryKey()
Property.PropertyBuilder	typeNotNull()
Property.PropertyBuilder	unsigned()
Property.PropertyBuilder	virtualTargetName(java.lang.String virtualTargetName)
Property.PropertyBuilder	virtualTargetValueExpression(java.lang.String virtualTargetValueExpression)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PropertyBuilder

public PropertyBuilder(Schema schema,
                       Entity entity,
                       PropertyType propertyType,
                       java.lang.String propertyName)

Method Detail

dbName

public Property.PropertyBuilder dbName(java.lang.String dbName)

dbType

public Property.PropertyBuilder dbType(java.lang.String dbType)

modelId

public Property.PropertyBuilder modelId(io.objectbox.generator.IdUid modelId)

modelIndexId

public Property.PropertyBuilder modelIndexId(io.objectbox.generator.IdUid indexId)

primaryKey

public Property.PropertyBuilder primaryKey()

idCompanion

public Property.PropertyBuilder idCompanion()

typeNotNull

public Property.PropertyBuilder typeNotNull()

See Also:

Property.isTypeNotNull()

notNullFlag

public Property.PropertyBuilder notNullFlag()

See Also:

Property.isNotNullFlag()

idAssignable

public Property.PropertyBuilder idAssignable()

fieldAccessible

public Property.PropertyBuilder fieldAccessible()

nonPrimitiveFlag

public Property.PropertyBuilder nonPrimitiveFlag()

See Property.isNonPrimitiveFlag().

isList

public Property.PropertyBuilder isList()

See Property.isList().

unsigned

public Property.PropertyBuilder unsigned()

index

public Property.PropertyBuilder index()

index

public Property.PropertyBuilder index(int indexFlags,
                                      int maxValueLength)

Parameters:

indexFlags - One or more of the INDEX or UNIQUE PropertyFlags.

hnswParams

public Property.PropertyBuilder hnswParams(io.objectbox.annotation.HnswIndex annotation)
                                    throws ModelException

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

Parameters:

annotation - to extract parameters from.

Returns:

this builder.

Throws:

ModelException - if invalid parameters are set.

customType

public Property.PropertyBuilder customType(java.lang.String customType,
                                           java.lang.String converter)

virtualTargetName

public Property.PropertyBuilder virtualTargetName(java.lang.String virtualTargetName)

virtualTargetValueExpression

public Property.PropertyBuilder virtualTargetValueExpression(java.lang.String virtualTargetValueExpression)

getterMethodName

public Property.PropertyBuilder getterMethodName(java.lang.String getterMethodName)

getProperty

public Property getProperty()