io.requery.meta

Interface Type<T>

Type Parameters:

T - entity java type

All Superinterfaces:

Expression<T>

All Known Implementing Classes:

TypeBuilder

public interface Type<T>
extends Expression<T>

Represents type information about an entity class.

Method Summary

Modifier and Type	Method and Description
Set<Attribute<T,?>>	getAttributes()
Class<?>	getBaseType()
<B> Supplier<B>	getBuilderFactory()
<B> Function<B,T>	getBuildFunction()
Class<T>	getClassType()
Supplier<T>	getFactory()
Set<Attribute<T,?>>	getKeyAttributes()
String	getName()
Function<T,EntityProxy<T>>	getProxyProvider()
Attribute<T,?>	getSingleKeyAttribute()
String[]	getTableCreateAttributes()
String[]	getTableUniqueIndexes()
boolean	isBuildable()
boolean	isCacheable()
boolean	isImmutable()
boolean	isReadOnly()
boolean	isStateless()

Methods inherited from interface io.requery.query.Expression

getExpressionType

Method Detail

getName

String getName()

Specified by:

getName in interface Expression<T>

Returns:

the type name, note this can be different from the class name.

getClassType

Class<T> getClassType()

Specified by:

getClassType in interface Expression<T>

Returns:

the Java Class for which this type information is for.

getBaseType

Class<?> getBaseType()

Returns:

the base type this entity is representing if any.

isCacheable

boolean isCacheable()

Returns:

true if instances of this type can be cached for reuse, false otherwise.

isImmutable

boolean isImmutable()

Returns:

true if the type being represented is immutable and its values cannot be modified.

isReadOnly

boolean isReadOnly()

Returns:

true if instances of this type are read only and can't be modified, false otherwise.

isStateless

boolean isStateless()

Returns:

true if the type has all state tracking disabled, false otherwise.

isBuildable

boolean isBuildable()

Returns:

true if a builder class is used to construct instances of the type when reading from a store or query. Generally used for immutable objects.

getBuilderFactory

<B> Supplier<B> getBuilderFactory()

Type Parameters:

B - builder type

Returns:

if isBuildable() returns the factory that instantiates the builder instance, otherwise null.

getBuildFunction

<B> Function<B,T> getBuildFunction()

Type Parameters:

B - builder type

Returns:

if isBuildable() returns the function that builds the final type from a builder instance.

getAttributes

Set<Attribute<T,?>> getAttributes()

Returns:

A readonly collection of Attributes that this type represents. (includes all attributes)

getKeyAttributes

Set<Attribute<T,?>> getKeyAttributes()

Returns:

A readonly collection of Attributes that are the key for this type.

getSingleKeyAttribute

Attribute<T,?> getSingleKeyAttribute()

Returns:

If there is only a single key that key's attribute, otherwise null.

getFactory

Supplier<T> getFactory()

Returns:

Supplier instance used to provide new instances of getClassType().

getProxyProvider

Function<T,EntityProxy<T>> getProxyProvider()

Returns:

Function provider for retrieving the EntityProxy for a given entity instance.

getTableCreateAttributes

String[] getTableCreateAttributes()

Returns:

optional table creation attributes Table.createAttributes()

getTableUniqueIndexes

String[] getTableUniqueIndexes()

Returns:

optional unique index names Table.uniqueIndexes() ()}