io.requery

Annotation Type Entity

@Documented
 @Target(value=TYPE)
 @Retention(value=RUNTIME)
public @interface Entity

Marks a type as persistable. When used with the annotation processor the processor will inspect the given class and generate a corresponding Entity class that can be used by the persistence store to perform query/create/update/delete operations. Note that only the fields in the class annotated with Entity will be persisted fields in super or sub classes will not be considered.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Class<?>	builder
boolean	cacheable
boolean	copyable
boolean	extendable
boolean	immutable
String	model
String	name
PropertyNameStyle	propertyNameStyle Defines the name style of properties in the target entity e.g.
boolean	stateless

Element Detail

name

public abstract String name

Returns:

the desired Entity name for the type. This class will be generated by the processor in the same package as the type the annotation is placed on. This name is also used as the table name unless a Table attribute is specified with a different name. Defaults to empty, the processor will remove "Abstract" prefix from the class name if it exists.

Default:

""

model

public abstract String model

Returns:

the model group this entity belongs to. Can be used to separate entities belonging to different models (databases/persistence stores) by the processor.

Default:

""

builder

public abstract Class<?> builder

Returns:

the builder class used to construct this entity if it is immutable(). Note the builder class must have a zero-argument constructor that is either package visible or public.

Default:

void.class

cacheable

public abstract boolean cacheable

Returns:

true if the given object should be cached by the entity store, false otherwise.

Default:

true

copyable

public abstract boolean copyable

Returns:

true if the entity should be trivially copyable. In which case the annotation processor will generate a copy() method returning a shallow copy of the given object.

Default:

false

extendable

public abstract boolean extendable

Returns:

false if they class being annotated as entity is not extendable and the annotation processor should not generate a type extending or implementing it but instead generate only the attribute meta information. Defaults to true unless this annotation is placed on a class that is final then defaults to false.

Default:

true

immutable

public abstract boolean immutable

Returns:

true if the entity object is immutable. If true the entity cannot have changeable relations and will not have any state, this implies stateless() is true. Defaults to false however if this annotation is placed in conjunction with immutable type annotations e.g. @AutoValue from Google on an object then defaults to true.

Default:

false

stateless

public abstract boolean stateless

Returns:

true if the entity object should have state tracking disabled, which allows partial updates of changed values only and automatic retrieval of not loaded properties. Defaults to false, unless the entity is immutable() in which case the value is true.

Default:

false

propertyNameStyle

public abstract PropertyNameStyle propertyNameStyle

Defines the name style of properties in the target entity e.g. for a property 'name' and style set to PropertyNameStyle.BEAN would map to:

  getName() {...}
  setName(String name) {...}
 

vs for PropertyNameStyle.NONE:

  name() {...}
  name(String name) {...}
 

Returns:

the name style of properties in the target entity.

Default:

io.requery.PropertyNameStyle.BEAN