Package io.objectbox

Class Property<ENTITY>

java.lang.Object

io.objectbox.Property<ENTITY>

All Implemented Interfaces:

Serializable

public class Property<ENTITY>
extends Object
implements Serializable

Meta data describing a Property of an ObjectBox Entity. Properties are typically used when defining Query conditions using QueryBuilder. Access properties using the generated underscore class of an entity (e.g. Example_.id).

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
final Class<? extends PropertyConverter>	converterClass
final Class<?>	customType	Type, which is converted to a type supported by the DB.
final String	dbName
final EntityInfo<ENTITY>	entity
final int	id
final boolean	isId
final boolean	isVirtual
final String	name
final int	ordinal
final Class<?>	type	One of the supported types to be mapped to the DB.

Constructor Summary

Constructors

Constructor	Description
Property(EntityInfo<ENTITY> entity, int ordinal, int id, Class<?> type, String name)
Property(EntityInfo<ENTITY> entity, int ordinal, int id, Class<?> type, String name, boolean isVirtual)
Property(EntityInfo<ENTITY> entity, int ordinal, int id, Class<?> type, String name, boolean isId, boolean isVirtual, String dbName, Class<? extends PropertyConverter> converterClass, Class<?> customType)
Property(EntityInfo<ENTITY> entity, int ordinal, int id, Class<?> type, String name, boolean isId, String dbName)
Property(EntityInfo<ENTITY> entity, int ordinal, int id, Class<?> type, String name, boolean isId, String dbName, Class<? extends PropertyConverter> converterClass, Class<?> customType)

Method Summary

Modifier and Type	Method	Description
PropertyQueryCondition<ENTITY>	between(double lowerBoundary, double upperBoundary)	Creates a "BETWEEN ...
PropertyQueryCondition<ENTITY>	between(int lowerBoundary, int upperBoundary)	Creates a "BETWEEN ...
PropertyQueryCondition<ENTITY>	between(long lowerBoundary, long upperBoundary)	Creates a "BETWEEN ...
PropertyQueryCondition<ENTITY>	between(short lowerBoundary, short upperBoundary)	Creates a "BETWEEN ...
PropertyQueryCondition<ENTITY>	between(Date lowerBoundary, Date upperBoundary)	Creates a "BETWEEN ...
PropertyQueryCondition<ENTITY>	contains(String value)	Creates a contains condition for this property using StringOrder#CASE_SENSITIVE.
PropertyQueryCondition<ENTITY>	contains(String value, QueryBuilder.StringOrder order)
PropertyQueryCondition<ENTITY>	containsElement(String value)	For a String array, list or String-key map property, matches if at least one element equals the given value using StringOrder#CASE_SENSITIVE.
PropertyQueryCondition<ENTITY>	containsElement(String value, QueryBuilder.StringOrder order)
PropertyQueryCondition<ENTITY>	containsKeyValue(String key, String value)	Deprecated. Use the equalKeyValue(String, String, StringOrder) condition instead.
PropertyQueryCondition<ENTITY>	containsKeyValue(String key, String value, QueryBuilder.StringOrder order)	Deprecated. Use the equalKeyValue(String, String, StringOrder) condition instead.
PropertyQueryCondition<ENTITY>	endsWith(String value)	Creates an ends with condition using StringOrder#CASE_SENSITIVE.
PropertyQueryCondition<ENTITY>	endsWith(String value, QueryBuilder.StringOrder order)
PropertyQueryCondition<ENTITY>	eq(Object value)	Deprecated. Use equal(boolean) instead.
PropertyQueryCondition<ENTITY>	equal(boolean value)	Creates an "equal ('=')" condition for this property.
PropertyQueryCondition<ENTITY>	equal(byte[] value)	Creates an "equal ('=')" condition for this property.
PropertyQueryCondition<ENTITY>	equal(double value, double tolerance)	Calls between(double, double) with value - tolerance as lower bound and value + tolerance as upper bound.
PropertyQueryCondition<ENTITY>	equal(int value)	Creates an "equal ('=')" condition for this property.
PropertyQueryCondition<ENTITY>	equal(long value)	Creates an "equal ('=')" condition for this property.
PropertyQueryCondition<ENTITY>	equal(short value)	Creates an "equal ('=')" condition for this property.
PropertyQueryCondition<ENTITY>	equal(String value)	Creates an "equal ('=')" condition for this property using StringOrder#CASE_SENSITIVE.
PropertyQueryCondition<ENTITY>	equal(String value, QueryBuilder.StringOrder order)	Creates an "equal ('=')" condition for this property.
PropertyQueryCondition<ENTITY>	equal(Date value)	Creates an "equal ('=')" condition for this property.
PropertyQueryCondition<ENTITY>	equalKeyValue(String key, double value)	For a String-key map property, matches the combination where the key and value of at least one map entry is equal to the given key and value.
PropertyQueryCondition<ENTITY>	equalKeyValue(String key, long value)	For a String-key map property, matches the combination where the key and value of at least one map entry is equal to the given key and value.
PropertyQueryCondition<ENTITY>	equalKeyValue(String key, String value, QueryBuilder.StringOrder order)	For a String-key map property, matches the combination where the key and value of at least one map entry is equal to the given key and value.
int	getEntityId()
int	getId()
PropertyQueryCondition<ENTITY>	greater(byte[] value)	Creates a "greater than ('>')" condition for this property.
PropertyQueryCondition<ENTITY>	greater(double value)	Creates a "greater than ('>')" condition for this property.
PropertyQueryCondition<ENTITY>	greater(int value)	Creates a "greater than ('>')" condition for this property.
PropertyQueryCondition<ENTITY>	greater(long value)	Creates a "greater than ('>')" condition for this property.
PropertyQueryCondition<ENTITY>	greater(short value)	Creates a "greater than ('>')" condition for this property.
PropertyQueryCondition<ENTITY>	greater(String value)	Creates a "greater than ('>')" condition for this property using StringOrder#CASE_SENSITIVE.
PropertyQueryCondition<ENTITY>	greater(String value, QueryBuilder.StringOrder order)	Creates a "greater than ('>')" condition for this property.
PropertyQueryCondition<ENTITY>	greater(Date value)	Creates a "greater than ('>')" condition for this property.
PropertyQueryCondition<ENTITY>	greaterKeyValue(String key, double value)	For a String-key map property, matches the combination where the key and value of at least one map entry is greater than the given key and value.
PropertyQueryCondition<ENTITY>	greaterKeyValue(String key, long value)	For a String-key map property, matches the combination where the key and value of at least one map entry is greater than the given key and value.
PropertyQueryCondition<ENTITY>	greaterKeyValue(String key, String value, QueryBuilder.StringOrder order)	For a String-key map property, matches the combination where the key and value of at least one map entry is greater than the given key and value.
PropertyQueryCondition<ENTITY>	greaterOrEqual(byte[] value)	Creates a "greater or equal ('>=')" condition for this property.
PropertyQueryCondition<ENTITY>	greaterOrEqual(double value)	Creates a "greater or equal ('>=')" condition for this property.
PropertyQueryCondition<ENTITY>	greaterOrEqual(int value)	Creates a "greater or equal ('>=')" condition for this property.
PropertyQueryCondition<ENTITY>	greaterOrEqual(long value)	Creates a "greater or equal ('>=')" condition for this property.
PropertyQueryCondition<ENTITY>	greaterOrEqual(short value)	Creates a "greater or equal ('>=')" condition for this property.
PropertyQueryCondition<ENTITY>	greaterOrEqual(String value, QueryBuilder.StringOrder order)	Creates a "greater or equal ('>=')" condition for this property.
PropertyQueryCondition<ENTITY>	greaterOrEqual(Date value)	Creates a "greater or equal ('>=')" condition for this property.
PropertyQueryCondition<ENTITY>	greaterOrEqualKeyValue(String key, double value)	For a String-key map property, matches the combination where the key and value of at least one map entry is greater than or equal to the given key and value.
PropertyQueryCondition<ENTITY>	greaterOrEqualKeyValue(String key, long value)	For a String-key map property, matches the combination where the key and value of at least one map entry is greater than or equal to the given key and value.
PropertyQueryCondition<ENTITY>	greaterOrEqualKeyValue(String key, String value, QueryBuilder.StringOrder order)	For a String-key map property, matches the combination where the key and value of at least one map entry is greater than or equal to the given key and value.
PropertyQueryCondition<ENTITY>	gt(Object value)	Deprecated. Use greater(short) instead.
PropertyQueryCondition<ENTITY>	in(Object... values)	Deprecated. Use oneOf(int[]) instead.
PropertyQueryCondition<ENTITY>	in(Collection<?> inValues)	Deprecated. Use oneOf(int[]) instead.
PropertyQueryCondition<ENTITY>	isNotNull()	Deprecated. Use notNull() instead.
PropertyQueryCondition<ENTITY>	isNull()	Creates an "IS NULL" condition for this property.
PropertyQueryCondition<ENTITY>	less(byte[] value)	Creates a "less than ('<')" condition for this property.
PropertyQueryCondition<ENTITY>	less(double value)	Creates a "less than ('<')" condition for this property.
PropertyQueryCondition<ENTITY>	less(int value)	Creates a "less than ('<')" condition for this property.
PropertyQueryCondition<ENTITY>	less(long value)	Creates a "less than ('<')" condition for this property.
PropertyQueryCondition<ENTITY>	less(short value)	Creates a "less than ('<')" condition for this property.
PropertyQueryCondition<ENTITY>	less(String value)	Creates a "less than ('<')" condition for this property using StringOrder#CASE_SENSITIVE.
PropertyQueryCondition<ENTITY>	less(String value, QueryBuilder.StringOrder order)	Creates a "less than ('<')" condition for this property.
PropertyQueryCondition<ENTITY>	less(Date value)	Creates a "less than ('<')" condition for this property.
PropertyQueryCondition<ENTITY>	lessKeyValue(String key, double value)	For a String-key map property, matches the combination where the key and value of at least one map entry is less than the given key and value.
PropertyQueryCondition<ENTITY>	lessKeyValue(String key, long value)	For a String-key map property, matches the combination where the key and value of at least one map entry is less than the given key and value.
PropertyQueryCondition<ENTITY>	lessKeyValue(String key, String value, QueryBuilder.StringOrder order)	For a String-key map property, matches the combination where the key and value of at least one map entry is less than the given key and value.
PropertyQueryCondition<ENTITY>	lessOrEqual(byte[] value)	Creates a "less or equal ('<=')" condition for this property.
PropertyQueryCondition<ENTITY>	lessOrEqual(double value)	Creates a "less or equal ('<=')" condition for this property.
PropertyQueryCondition<ENTITY>	lessOrEqual(int value)	Creates a "less or equal ('<=')" condition for this property.
PropertyQueryCondition<ENTITY>	lessOrEqual(long value)	Creates a "less or equal ('<=')" condition for this property.
PropertyQueryCondition<ENTITY>	lessOrEqual(short value)	Creates a "less or equal ('<=')" condition for this property.
PropertyQueryCondition<ENTITY>	lessOrEqual(String value, QueryBuilder.StringOrder order)	Creates a "less or equal ('<=')" condition for this property.
PropertyQueryCondition<ENTITY>	lessOrEqual(Date value)	Creates a "less or equal ('<=')" condition for this property.
PropertyQueryCondition<ENTITY>	lessOrEqualKeyValue(String key, double value)	For a String-key map property, matches the combination where the key and value of at least one map entry is less than or equal to the given key and value.
PropertyQueryCondition<ENTITY>	lessOrEqualKeyValue(String key, long value)	For a String-key map property, matches the combination where the key and value of at least one map entry is less than or equal to the given key and value.
PropertyQueryCondition<ENTITY>	lessOrEqualKeyValue(String key, String value, QueryBuilder.StringOrder order)	For a String-key map property, matches the combination where the key and value of at least one map entry is less than or equal to the given key and value.
PropertyQueryCondition<ENTITY>	lt(Object value)	Deprecated. Use less(short) instead.
PropertyQueryCondition<ENTITY>	nearestNeighbors(float[] queryVector, int maxResultCount)	Performs an approximate nearest neighbor (ANN) search to find objects near to the given queryVector.
PropertyQueryCondition<ENTITY>	notEq(Object value)	Deprecated. Use notEqual(boolean) instead.
PropertyQueryCondition<ENTITY>	notEqual(boolean value)	Creates a "not equal ('<>')" condition for this property.
PropertyQueryCondition<ENTITY>	notEqual(int value)	Creates a "not equal ('<>')" condition for this property.
PropertyQueryCondition<ENTITY>	notEqual(long value)	Creates a "not equal ('<>')" condition for this property.
PropertyQueryCondition<ENTITY>	notEqual(short value)	Creates a "not equal ('<>')" condition for this property.
PropertyQueryCondition<ENTITY>	notEqual(String value)	Creates a "not equal ('<>')" condition for this property using StringOrder#CASE_SENSITIVE.
PropertyQueryCondition<ENTITY>	notEqual(String value, QueryBuilder.StringOrder order)	Creates a "not equal ('<>')" condition for this property.
PropertyQueryCondition<ENTITY>	notEqual(Date value)	Creates a "not equal ('<>')" condition for this property.
PropertyQueryCondition<ENTITY>	notNull()	Creates an "IS NOT NULL" condition for this property.
PropertyQueryCondition<ENTITY>	notOneOf(int[] values)	Creates a "NOT IN (..., ..., ...)" condition for this property.
PropertyQueryCondition<ENTITY>	notOneOf(long[] values)	Creates a "NOT IN (..., ..., ...)" condition for this property.
PropertyQueryCondition<ENTITY>	notOneOf(Date[] value)	Creates a "NOT IN (..., ..., ...)" condition for this property.
PropertyQueryCondition<ENTITY>	oneOf(int[] values)	Creates an "IN (..., ..., ...)" condition for this property.
PropertyQueryCondition<ENTITY>	oneOf(long[] values)	Creates an "IN (..., ..., ...)" condition for this property.
PropertyQueryCondition<ENTITY>	oneOf(String[] values)	Creates an "IN (..., ..., ...)" condition for this property using StringOrder#CASE_SENSITIVE.
PropertyQueryCondition<ENTITY>	oneOf(String[] values, QueryBuilder.StringOrder order)	Creates an "IN (..., ..., ...)" condition for this property.
PropertyQueryCondition<ENTITY>	oneOf(Date[] value)	Creates an "IN (..., ..., ...)" condition for this property.
PropertyQueryCondition<ENTITY>	startsWith(String value)	Creates a starts with condition using StringOrder#CASE_SENSITIVE.
PropertyQueryCondition<ENTITY>	startsWith(String value, QueryBuilder.StringOrder order)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

entity

public final EntityInfo<ENTITY> entity

ordinal

public final int ordinal

id

public final int id

type

public final Class<?> type

One of the supported types to be mapped to the DB.

name

public final String name

isId

public final boolean isId

isVirtual

public final boolean isVirtual

dbName

public final String dbName

converterClass

public final Class<? extends PropertyConverter> converterClass

customType

public final Class<?> customType

Type, which is converted to a type supported by the DB.

Constructor Details

Property

public Property(EntityInfo<ENTITY> entity,
 int ordinal,
 int id,
 Class<?> type,
 String name)

Property

public Property(EntityInfo<ENTITY> entity,
 int ordinal,
 int id,
 Class<?> type,
 String name,
 boolean isVirtual)

Property

public Property(EntityInfo<ENTITY> entity,
 int ordinal,
 int id,
 Class<?> type,
 String name,
 boolean isId,
 @Nullable
 String dbName)

Property

public Property(EntityInfo<ENTITY> entity,
 int ordinal,
 int id,
 Class<?> type,
 String name,
 boolean isId,
 @Nullable
 String dbName,
 @Nullable
 Class<? extends PropertyConverter> converterClass,
 @Nullable
 Class<?> customType)

Property

public Property(EntityInfo<ENTITY> entity,
 int ordinal,
 int id,
 Class<?> type,
 String name,
 boolean isId,
 boolean isVirtual,
 @Nullable
 String dbName,
 @Nullable
 Class<? extends PropertyConverter> converterClass,
 @Nullable
 Class<?> customType)

Method Details

isNull

public PropertyQueryCondition<ENTITY> isNull()

Creates an "IS NULL" condition for this property.

notNull

public PropertyQueryCondition<ENTITY> notNull()

Creates an "IS NOT NULL" condition for this property.

equal

public PropertyQueryCondition<ENTITY> equal(boolean value)

Creates an "equal ('=')" condition for this property.

notEqual

public PropertyQueryCondition<ENTITY> notEqual(boolean value)

Creates a "not equal ('<>')" condition for this property.

equal

public PropertyQueryCondition<ENTITY> equal(short value)

Creates an "equal ('=')" condition for this property.

notEqual

public PropertyQueryCondition<ENTITY> notEqual(short value)

Creates a "not equal ('<>')" condition for this property.

greater

public PropertyQueryCondition<ENTITY> greater(short value)

Creates a "greater than ('>')" condition for this property.

greaterOrEqual

public PropertyQueryCondition<ENTITY> greaterOrEqual(short value)

Creates a "greater or equal ('>=')" condition for this property.

less

public PropertyQueryCondition<ENTITY> less(short value)

Creates a "less than ('<')" condition for this property.

lessOrEqual

public PropertyQueryCondition<ENTITY> lessOrEqual(short value)

Creates a "less or equal ('<=')" condition for this property.

between

public PropertyQueryCondition<ENTITY> between(short lowerBoundary,
 short upperBoundary)

Creates a "BETWEEN ... AND ..." condition for this property. Finds objects with property value between and including the first and second value.

equal

public PropertyQueryCondition<ENTITY> equal(int value)

Creates an "equal ('=')" condition for this property.

notEqual

public PropertyQueryCondition<ENTITY> notEqual(int value)

Creates a "not equal ('<>')" condition for this property.

greater

public PropertyQueryCondition<ENTITY> greater(int value)

Creates a "greater than ('>')" condition for this property.

greaterOrEqual

public PropertyQueryCondition<ENTITY> greaterOrEqual(int value)

Creates a "greater or equal ('>=')" condition for this property.

less

public PropertyQueryCondition<ENTITY> less(int value)

Creates a "less than ('<')" condition for this property.

lessOrEqual

public PropertyQueryCondition<ENTITY> lessOrEqual(int value)

Creates a "less or equal ('<=')" condition for this property.

between

public PropertyQueryCondition<ENTITY> between(int lowerBoundary,
 int upperBoundary)

Creates a "BETWEEN ... AND ..." condition for this property. Finds objects with property value between and including the first and second value.

oneOf

public PropertyQueryCondition<ENTITY> oneOf(int[] values)

Creates an "IN (..., ..., ...)" condition for this property.

notOneOf

public PropertyQueryCondition<ENTITY> notOneOf(int[] values)

Creates a "NOT IN (..., ..., ...)" condition for this property.

equal

public PropertyQueryCondition<ENTITY> equal(long value)

Creates an "equal ('=')" condition for this property.

notEqual

public PropertyQueryCondition<ENTITY> notEqual(long value)

Creates a "not equal ('<>')" condition for this property.

greater

public PropertyQueryCondition<ENTITY> greater(long value)

Creates a "greater than ('>')" condition for this property.

greaterOrEqual

public PropertyQueryCondition<ENTITY> greaterOrEqual(long value)

Creates a "greater or equal ('>=')" condition for this property.

less

public PropertyQueryCondition<ENTITY> less(long value)

Creates a "less than ('<')" condition for this property.

lessOrEqual

public PropertyQueryCondition<ENTITY> lessOrEqual(long value)

Creates a "less or equal ('<=')" condition for this property.

between

public PropertyQueryCondition<ENTITY> between(long lowerBoundary,
 long upperBoundary)

Creates a "BETWEEN ... AND ..." condition for this property. Finds objects with property value between and including the first and second value.

oneOf

public PropertyQueryCondition<ENTITY> oneOf(long[] values)

Creates an "IN (..., ..., ...)" condition for this property.

notOneOf

public PropertyQueryCondition<ENTITY> notOneOf(long[] values)

Creates a "NOT IN (..., ..., ...)" condition for this property.

equal

public PropertyQueryCondition<ENTITY> equal(double value,
 double tolerance)

Calls between(double, double) with value - tolerance as lower bound and value + tolerance as upper bound.

greater

public PropertyQueryCondition<ENTITY> greater(double value)

Creates a "greater than ('>')" condition for this property.

greaterOrEqual

public PropertyQueryCondition<ENTITY> greaterOrEqual(double value)

Creates a "greater or equal ('>=')" condition for this property.

less

public PropertyQueryCondition<ENTITY> less(double value)

Creates a "less than ('<')" condition for this property.

lessOrEqual

public PropertyQueryCondition<ENTITY> lessOrEqual(double value)

Creates a "less or equal ('<=')" condition for this property.

between

public PropertyQueryCondition<ENTITY> between(double lowerBoundary,
 double upperBoundary)

Creates a "BETWEEN ... AND ..." condition for this property. Finds objects with property value between and including the first and second value.

nearestNeighbors

public PropertyQueryCondition<ENTITY> nearestNeighbors(float[] queryVector,
 int maxResultCount)

Performs an approximate nearest neighbor (ANN) search to find objects near to the given queryVector.

This requires the vector property to have an HnswIndex.

The dimensions of the query vector should be at least the dimensions of this vector property.

Use maxResultCount to set the maximum number of objects to return by the ANN condition. Hint: it can also be used as the "ef" HNSW parameter to increase the search quality in combination with a query limit. For example, use maxResultCount of 100 with a Query limit of 10 to have 10 results that are of potentially better quality than just passing in 10 for maxResultCount (quality/performance tradeoff).

To change the given parameters after building the query, use Query.setParameter(Property, float[]) and Query.setParameter(Property, long) or their alias equivalent.

equal

public PropertyQueryCondition<ENTITY> equal(Date value)

Creates an "equal ('=')" condition for this property.

notEqual

public PropertyQueryCondition<ENTITY> notEqual(Date value)

Creates a "not equal ('<>')" condition for this property.

greater

public PropertyQueryCondition<ENTITY> greater(Date value)

Creates a "greater than ('>')" condition for this property.

greaterOrEqual

public PropertyQueryCondition<ENTITY> greaterOrEqual(Date value)

Creates a "greater or equal ('>=')" condition for this property.

less

public PropertyQueryCondition<ENTITY> less(Date value)

Creates a "less than ('<')" condition for this property.

lessOrEqual

public PropertyQueryCondition<ENTITY> lessOrEqual(Date value)

Creates a "less or equal ('<=')" condition for this property.

oneOf

public PropertyQueryCondition<ENTITY> oneOf(Date[] value)

Creates an "IN (..., ..., ...)" condition for this property.

notOneOf

public PropertyQueryCondition<ENTITY> notOneOf(Date[] value)

Creates a "NOT IN (..., ..., ...)" condition for this property.

between

public PropertyQueryCondition<ENTITY> between(Date lowerBoundary,
 Date upperBoundary)

Creates a "BETWEEN ... AND ..." condition for this property. Finds objects with property value between and including the first and second value.

equal

public PropertyQueryCondition<ENTITY> equal(String value)

Creates an "equal ('=')" condition for this property using StringOrder#CASE_SENSITIVE.

See Also:

• equal(String, StringOrder)

equal

public PropertyQueryCondition<ENTITY> equal(String value,
 QueryBuilder.StringOrder order)

Creates an "equal ('=')" condition for this property.

notEqual

public PropertyQueryCondition<ENTITY> notEqual(String value)

Creates a "not equal ('<>')" condition for this property using StringOrder#CASE_SENSITIVE.

See Also:

• notEqual(String, StringOrder)

notEqual

public PropertyQueryCondition<ENTITY> notEqual(String value,
 QueryBuilder.StringOrder order)

Creates a "not equal ('<>')" condition for this property.

greater

public PropertyQueryCondition<ENTITY> greater(String value)

Creates a "greater than ('>')" condition for this property using StringOrder#CASE_SENSITIVE.

See Also:

• greater(String, StringOrder)

greater

public PropertyQueryCondition<ENTITY> greater(String value,
 QueryBuilder.StringOrder order)

Creates a "greater than ('>')" condition for this property.

greaterOrEqual

public PropertyQueryCondition<ENTITY> greaterOrEqual(String value,
 QueryBuilder.StringOrder order)

Creates a "greater or equal ('>=')" condition for this property.

less

public PropertyQueryCondition<ENTITY> less(String value)

Creates a "less than ('<')" condition for this property using StringOrder#CASE_SENSITIVE.

See Also:

• less(String, StringOrder)

less

public PropertyQueryCondition<ENTITY> less(String value,
 QueryBuilder.StringOrder order)

Creates a "less than ('<')" condition for this property.

lessOrEqual

public PropertyQueryCondition<ENTITY> lessOrEqual(String value,
 QueryBuilder.StringOrder order)

Creates a "less or equal ('<=')" condition for this property.

contains

public PropertyQueryCondition<ENTITY> contains(String value)

Creates a contains condition for this property using StringOrder#CASE_SENSITIVE.

Note: for a String array property, use containsElement(java.lang.String) instead.

See Also:

• contains(String, StringOrder)

contains

public PropertyQueryCondition<ENTITY> contains(String value,
 QueryBuilder.StringOrder order)

containsElement

public PropertyQueryCondition<ENTITY> containsElement(String value)

For a String array, list or String-key map property, matches if at least one element equals the given value using StringOrder#CASE_SENSITIVE.

See Also:

• containsElement(String, StringOrder)

containsElement

public PropertyQueryCondition<ENTITY> containsElement(String value,
 QueryBuilder.StringOrder order)

containsKeyValue

@Deprecated
public PropertyQueryCondition<ENTITY> containsKeyValue(String key,
 String value)

Deprecated.

Use the equalKeyValue(String, String, StringOrder) condition instead.

For a String-key map property, matches if at least one key and value combination equals the given values using StringOrder#CASE_SENSITIVE.

See Also:

• containsKeyValue(String, String, StringOrder)

containsKeyValue

@Deprecated
public PropertyQueryCondition<ENTITY> containsKeyValue(String key,
 String value,
 QueryBuilder.StringOrder order)

Deprecated.

Use the equalKeyValue(String, String, StringOrder) condition instead.

See Also:

• containsKeyValue(String, String)

equalKeyValue

public PropertyQueryCondition<ENTITY> equalKeyValue(String key,
 String value,
 QueryBuilder.StringOrder order)

For a String-key map property, matches the combination where the key and value of at least one map entry is equal to the given key and value.

greaterKeyValue

public PropertyQueryCondition<ENTITY> greaterKeyValue(String key,
 String value,
 QueryBuilder.StringOrder order)

For a String-key map property, matches the combination where the key and value of at least one map entry is greater than the given key and value.

greaterOrEqualKeyValue

public PropertyQueryCondition<ENTITY> greaterOrEqualKeyValue(String key,
 String value,
 QueryBuilder.StringOrder order)

For a String-key map property, matches the combination where the key and value of at least one map entry is greater than or equal to the given key and value.

lessKeyValue

public PropertyQueryCondition<ENTITY> lessKeyValue(String key,
 String value,
 QueryBuilder.StringOrder order)

For a String-key map property, matches the combination where the key and value of at least one map entry is less than the given key and value.

lessOrEqualKeyValue

public PropertyQueryCondition<ENTITY> lessOrEqualKeyValue(String key,
 String value,
 QueryBuilder.StringOrder order)

For a String-key map property, matches the combination where the key and value of at least one map entry is less than or equal to the given key and value.

equalKeyValue

public PropertyQueryCondition<ENTITY> equalKeyValue(String key,
 long value)

For a String-key map property, matches the combination where the key and value of at least one map entry is equal to the given key and value.

greaterKeyValue

public PropertyQueryCondition<ENTITY> greaterKeyValue(String key,
 long value)

For a String-key map property, matches the combination where the key and value of at least one map entry is greater than the given key and value.

greaterOrEqualKeyValue

public PropertyQueryCondition<ENTITY> greaterOrEqualKeyValue(String key,
 long value)

For a String-key map property, matches the combination where the key and value of at least one map entry is greater than or equal to the given key and value.

lessKeyValue

public PropertyQueryCondition<ENTITY> lessKeyValue(String key,
 long value)

For a String-key map property, matches the combination where the key and value of at least one map entry is less than the given key and value.

lessOrEqualKeyValue

public PropertyQueryCondition<ENTITY> lessOrEqualKeyValue(String key,
 long value)

For a String-key map property, matches the combination where the key and value of at least one map entry is less than or equal to the given key and value.

equalKeyValue

public PropertyQueryCondition<ENTITY> equalKeyValue(String key,
 double value)

For a String-key map property, matches the combination where the key and value of at least one map entry is equal to the given key and value.

greaterKeyValue

public PropertyQueryCondition<ENTITY> greaterKeyValue(String key,
 double value)

For a String-key map property, matches the combination where the key and value of at least one map entry is greater than the given key and value.

greaterOrEqualKeyValue

public PropertyQueryCondition<ENTITY> greaterOrEqualKeyValue(String key,
 double value)

For a String-key map property, matches the combination where the key and value of at least one map entry is greater than or equal to the given key and value.

lessKeyValue

public PropertyQueryCondition<ENTITY> lessKeyValue(String key,
 double value)

For a String-key map property, matches the combination where the key and value of at least one map entry is less than the given key and value.

lessOrEqualKeyValue

public PropertyQueryCondition<ENTITY> lessOrEqualKeyValue(String key,
 double value)

For a String-key map property, matches the combination where the key and value of at least one map entry is less than or equal to the given key and value.

startsWith

public PropertyQueryCondition<ENTITY> startsWith(String value)

Creates a starts with condition using StringOrder#CASE_SENSITIVE.

See Also:

• startsWith(String, StringOrder)

startsWith

public PropertyQueryCondition<ENTITY> startsWith(String value,
 QueryBuilder.StringOrder order)

endsWith

public PropertyQueryCondition<ENTITY> endsWith(String value)

Creates an ends with condition using StringOrder#CASE_SENSITIVE.

See Also:

• endsWith(String, StringOrder)

endsWith

public PropertyQueryCondition<ENTITY> endsWith(String value,
 QueryBuilder.StringOrder order)

oneOf

public PropertyQueryCondition<ENTITY> oneOf(String[] values)

Creates an "IN (..., ..., ...)" condition for this property using StringOrder#CASE_SENSITIVE.

See Also:

• oneOf(String[], StringOrder)

oneOf

public PropertyQueryCondition<ENTITY> oneOf(String[] values,
 QueryBuilder.StringOrder order)

Creates an "IN (..., ..., ...)" condition for this property.

equal

public PropertyQueryCondition<ENTITY> equal(byte[] value)

Creates an "equal ('=')" condition for this property.

greater

public PropertyQueryCondition<ENTITY> greater(byte[] value)

Creates a "greater than ('>')" condition for this property.

greaterOrEqual

public PropertyQueryCondition<ENTITY> greaterOrEqual(byte[] value)

Creates a "greater or equal ('>=')" condition for this property.

less

public PropertyQueryCondition<ENTITY> less(byte[] value)

Creates a "less than ('<')" condition for this property.

lessOrEqual

public PropertyQueryCondition<ENTITY> lessOrEqual(byte[] value)

Creates a "less or equal ('<=')" condition for this property.

eq

@Deprecated
public PropertyQueryCondition<ENTITY> eq(Object value)

Deprecated.

Use equal(boolean) instead.

Creates an "equal ('=')" condition for this property.

notEq

@Deprecated
public PropertyQueryCondition<ENTITY> notEq(Object value)

Deprecated.

Use notEqual(boolean) instead.

Creates an "not equal ('<>')" condition for this property.

in

@Deprecated
public PropertyQueryCondition<ENTITY> in(Object... values)

Deprecated.

Use oneOf(int[]) instead.

Creates an "IN (..., ..., ...)" condition for this property.

in

@Deprecated
public PropertyQueryCondition<ENTITY> in(Collection<?> inValues)

Deprecated.

Use oneOf(int[]) instead.

Creates an "IN (..., ..., ...)" condition for this property.

gt

@Deprecated
public PropertyQueryCondition<ENTITY> gt(Object value)

Deprecated.

Use greater(short) instead.

Creates an "greater than ('>')" condition for this property.

lt

@Deprecated
public PropertyQueryCondition<ENTITY> lt(Object value)

Deprecated.

Use less(short) instead.

Creates an "less than ('<')" condition for this property.

isNotNull

@Deprecated
public PropertyQueryCondition<ENTITY> isNotNull()

Deprecated.

Use notNull() instead.

Creates an "IS NOT NULL" condition for this property.

getEntityId

@Internal
public int getEntityId()

getId

@Internal
public int getId()

toString

public String toString()

Overrides:

toString in class Object