Package io.ebeaninternal.server.deploy.generatedproperty

Interface GeneratedProperty

All Known Implementing Classes:

GeneratedCounter, GeneratedCounterInteger, GeneratedCounterLong, GeneratedInsertDate, GeneratedInsertJavaTime.Base, GeneratedInsertJavaTime.InstantDT, GeneratedInsertJavaTime.LocalDT, GeneratedInsertJavaTime.OffsetDT, GeneratedInsertJavaTime.ZonedDT, GeneratedInsertJodaTime.Base, GeneratedInsertJodaTime.DateTimeDT, GeneratedInsertJodaTime.LocalDT, GeneratedInsertLong, GeneratedInsertTimestamp, GeneratedUpdateDate, GeneratedUpdateJavaTime.Base, GeneratedUpdateJavaTime.InstantDT, GeneratedUpdateJavaTime.LocalDT, GeneratedUpdateJavaTime.OffsetDT, GeneratedUpdateJavaTime.ZonedDT, GeneratedUpdateJodaTime.Base, GeneratedUpdateJodaTime.DateTimeDT, GeneratedUpdateJodaTime.LocalDT, GeneratedUpdateLong, GeneratedUpdateTimestamp, GeneratedWhoCreated, GeneratedWhoModified, UuidGeneratedProperty

public interface GeneratedProperty

Used to generate values for a property rather than have then set by the user. For example generate the update timestamp when a bean is updated.

Method Summary

Modifier and Type	Method	Description
Object	getInsertValue(BeanProperty prop, EntityBean bean, long now)	Get the generated insert value for a specific property of a bean.
Object	getUpdateValue(BeanProperty prop, EntityBean bean, long now)	Get the generated update value for a specific property of a bean.
boolean	includeInAllUpdates()	Return true if the property should be included in an update even if it is not loaded (ie.
boolean	includeInInsert()	Return true if this should be included in insert statements.
boolean	includeInUpdate()	Return true if this should always be includes in an update statement.
boolean	isDDLNotNullable()	Return true if the GeneratedProperty implies the DDL to create the DB column should have a not null constraint.

Method Detail

getInsertValue

Object getInsertValue(BeanProperty prop,
                      EntityBean bean,
                      long now)

Get the generated insert value for a specific property of a bean.

getUpdateValue

Object getUpdateValue(BeanProperty prop,
                      EntityBean bean,
                      long now)

Get the generated update value for a specific property of a bean.

includeInUpdate

boolean includeInUpdate()

Return true if this should always be includes in an update statement.

Used to include GeneratedUpdateTimestamp in dynamic table updates.

includeInAllUpdates

boolean includeInAllUpdates()

Return true if the property should be included in an update even if it is not loaded (ie. Last Updated Timestamp).

includeInInsert

boolean includeInInsert()

Return true if this should be included in insert statements.

isDDLNotNullable

boolean isDDLNotNullable()

Return true if the GeneratedProperty implies the DDL to create the DB column should have a not null constraint.