EntityType (doma-core 2.60.1 API)

Type Parameters:

ENTITY - the entity type

All Known Implementing Classes:

AbstractEntityType, EntityTypeProxy
```
public interface EntityType<ENTITY>
```
A description for an entity class.
The implementation instance must be thread safe.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`java.lang.String`	`getCatalogName()` Returns the catalog name.
`java.lang.Class<ENTITY>`	`getEntityClass()` Returns the entity class.
`EntityPropertyType<ENTITY,?>`	`getEntityPropertyType(java.lang.String __name)` Returns the property description with the name.
`java.util.List<EntityPropertyType<ENTITY,?>>`	`getEntityPropertyTypes()` Returns the property descriptions.
`GeneratedIdPropertyType<ENTITY,?,?>`	`getGeneratedIdPropertyType()` Returns the identity property description whose value is generated.
`java.util.List<EntityPropertyType<ENTITY,?>>`	`getIdPropertyTypes()` Returns the identity property descriptions
`java.lang.String`	`getName()` Returns the entity name
`NamingType`	`getNamingType()` Returns the naming convention.
`ENTITY`	`getOriginalStates(ENTITY entity)` Returns the original states.
`java.lang.String`	`getQualifiedTableName()` Deprecated. Use `getQualifiedTableName(BiFunction, Function)`
`java.lang.String`	`getQualifiedTableName(java.util.function.BiFunction<NamingType,java.lang.String,java.lang.String> namingFunction, java.util.function.Function<java.lang.String,java.lang.String> quoteFunction)` Returns the qualified table name.
`java.lang.String`	`getQualifiedTableName(java.util.function.Function<java.lang.String,java.lang.String> quoteFunction)` Deprecated. Use `getQualifiedTableName(BiFunction, Function)`
`java.lang.String`	`getSchemaName()` Returns the schema name.
`java.lang.String`	`getTableName()` Deprecated. Use `getTableName(BiFunction)`
`java.lang.String`	`getTableName(java.util.function.BiFunction<NamingType,java.lang.String,java.lang.String> namingFunction)` Returns the table name.
`TenantIdPropertyType<ENTITY,?,?>`	`getTenantIdPropertyType()` Returns the tenant id property description
`VersionPropertyType<ENTITY,?,?>`	`getVersionPropertyType()` Returns the version property description
`boolean`	`isImmutable()` Whether the entity is immutable.
`boolean`	`isQuoteRequired()` Returns quotation marks are required for catalog, schema and table.
`ENTITY`	`newEntity(java.util.Map<java.lang.String,Property<ENTITY,?>> __args)` Instantiate a new entity.
`void`	`postDelete(ENTITY entity, PostDeleteContext<ENTITY> context)` Handles the entity after a delete.
`void`	`postInsert(ENTITY entity, PostInsertContext<ENTITY> context)` Handles the entity after an insert.
`void`	`postUpdate(ENTITY entity, PostUpdateContext<ENTITY> context)` Handles the entity after an update.
`void`	`preDelete(ENTITY entity, PreDeleteContext<ENTITY> context)` Handles the entity before a delete.
`void`	`preInsert(ENTITY entity, PreInsertContext<ENTITY> context)` Handles the entity before an insert.
`void`	`preUpdate(ENTITY entity, PreUpdateContext<ENTITY> context)` Handles the entity before an update.
`void`	`saveCurrentStates(ENTITY entity)` Saves the current states.

- Method Detail
  - isImmutable
```
boolean isImmutable()
```
    Whether the entity is immutable.
    
    Returns:
    
    true if the entity is immutable
  - getName
```
java.lang.String getName()
```
    Returns the entity name
    
    Returns:
    
    the entity name
  - getCatalogName
```
java.lang.String getCatalogName()
```
    Returns the catalog name.
    
    Returns:
    
    the catalog name
  - getSchemaName
```
java.lang.String getSchemaName()
```
    Returns the schema name.
    
    Returns:
    
    the schema name
  - getTableName
```
@Deprecated
java.lang.String getTableName()
```
    Deprecated. Use getTableName(BiFunction)
    
    Returns the table name.
    
    Returns:
    
    the table name
  - getTableName
```
java.lang.String getTableName(java.util.function.BiFunction<NamingType,java.lang.String,java.lang.String> namingFunction)
```
    Returns the table name.
    
    Parameters:
    
    namingFunction - the function that applies naming convention
    
    Returns:
    
    the table name
  - getQualifiedTableName
```
@Deprecated
java.lang.String getQualifiedTableName()
```
    Deprecated. Use getQualifiedTableName(BiFunction, Function)
    
    Returns the qualified table name.
    
    Returns:
    
    the qualified table name
  - getQualifiedTableName
```
@Deprecated
java.lang.String getQualifiedTableName(java.util.function.Function<java.lang.String,java.lang.String> quoteFunction)
```
    Deprecated. Use getQualifiedTableName(BiFunction, Function)
    
    Returns the qualified table name.
    
    Parameters:
    
    quoteFunction - the function that applies quotation marks
    
    Returns:
    
    the qualified table name
  - getQualifiedTableName
```
java.lang.String getQualifiedTableName(java.util.function.BiFunction<NamingType,java.lang.String,java.lang.String> namingFunction,
                                       java.util.function.Function<java.lang.String,java.lang.String> quoteFunction)
```
    Returns the qualified table name.
    
    Parameters:
    
    namingFunction - the function that applies naming convention
    
    quoteFunction - the function that applies quotation marks
    
    Returns:
    
    the qualified table name
  - isQuoteRequired
```
boolean isQuoteRequired()
```
    Returns quotation marks are required for catalog, schema and table.
    
    Returns:
    
    true if quotation marks are required
  - getNamingType
```
NamingType getNamingType()
```
    Returns the naming convention.
    
    Returns:
    
    the naming convention or null
    
    See Also:
    
    Entity.naming()
  - getGeneratedIdPropertyType
```
GeneratedIdPropertyType<ENTITY,?,?> getGeneratedIdPropertyType()
```
    Returns the identity property description whose value is generated.
    
    Returns:
    
    the identity property description
  - getVersionPropertyType
```
VersionPropertyType<ENTITY,?,?> getVersionPropertyType()
```
    Returns the version property description
    
    Returns:
    
    the version property description
  - getTenantIdPropertyType
```
TenantIdPropertyType<ENTITY,?,?> getTenantIdPropertyType()
```
    Returns the tenant id property description
    
    Returns:
    
    the tenant id property description
  - getIdPropertyTypes
```
java.util.List<EntityPropertyType<ENTITY,?>> getIdPropertyTypes()
```
    Returns the identity property descriptions
    
    Returns:
    
    the identity property descriptions
  - getEntityPropertyType
```
EntityPropertyType<ENTITY,?> getEntityPropertyType(java.lang.String __name)
```
    Returns the property description with the name.
    
    Parameters:
    
    __name - the name of the property
    
    Returns:
    
    the name of the property or null if the property is not found
  - getEntityPropertyTypes
```
java.util.List<EntityPropertyType<ENTITY,?>> getEntityPropertyTypes()
```
    Returns the property descriptions.
    
    Returns:
    
    the property descriptions
  - newEntity
```
ENTITY newEntity(java.util.Map<java.lang.String,Property<ENTITY,?>> __args)
```
    Instantiate a new entity.
    
    Parameters:
    
    __args - the arguments
    
    Returns:
    
    an entity
  - getEntityClass
```
java.lang.Class<ENTITY> getEntityClass()
```
    Returns the entity class.
    
    Returns:
    
    the entity class
  - saveCurrentStates
```
void saveCurrentStates(ENTITY entity)
```
    Saves the current states.
    
    Parameters:
    
    entity - the current states
  - getOriginalStates
```
ENTITY getOriginalStates(ENTITY entity)
```
    Returns the original states.
    
    Parameters:
    
    entity - the original states
    
    Returns:
    
    the original states or null if it does not exist
  - preInsert
```
void preInsert(ENTITY entity,
               PreInsertContext<ENTITY> context)
```
    Handles the entity before an insert.
    
    Parameters:
    
    entity - the entity
    
    context - the context
  - preUpdate
```
void preUpdate(ENTITY entity,
               PreUpdateContext<ENTITY> context)
```
    Handles the entity before an update.
    
    Parameters:
    
    entity - the entity
    
    context - the context
  - preDelete
```
void preDelete(ENTITY entity,
               PreDeleteContext<ENTITY> context)
```
    Handles the entity before a delete.
    
    Parameters:
    
    entity - the entity
    
    context - the context
  - postInsert
```
void postInsert(ENTITY entity,
                PostInsertContext<ENTITY> context)
```
    Handles the entity after an insert.
    
    Parameters:
    
    entity - the entity
    
    context - the context
  - postUpdate
```
void postUpdate(ENTITY entity,
                PostUpdateContext<ENTITY> context)
```
    Handles the entity after an update.
    
    Parameters:
    
    entity - the entity
    
    context - the context
  - postDelete
```
void postDelete(ENTITY entity,
                PostDeleteContext<ENTITY> context)
```
    Handles the entity after a delete.
    
    Parameters:
    
    entity - the entity
    
    context - the context

Interface EntityType<ENTITY>

Method Summary

Method Detail

isImmutable

getName

getCatalogName

getSchemaName

getTableName

getTableName

getQualifiedTableName

getQualifiedTableName

getQualifiedTableName

isQuoteRequired

getNamingType

getGeneratedIdPropertyType

getVersionPropertyType

getTenantIdPropertyType

getIdPropertyTypes

getEntityPropertyType

getEntityPropertyTypes

newEntity

getEntityClass

saveCurrentStates

getOriginalStates

preInsert

preUpdate

preDelete

postInsert

postUpdate

postDelete