TenantIdGeneration (Hibernate Javadocs)

java.lang.Object
- org.hibernate.generator.internal.TenantIdGeneration

All Implemented Interfaces:

Serializable, BeforeExecutionGenerator, Generator
```
public class TenantIdGeneration
extends Object
implements BeforeExecutionGenerator
```
A generator that produces the current tenant identifier to be assigned to the TenantId property.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

TenantIdGeneration(TenantId annotation, Member member, GeneratorCreationContext context)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Object`	`generate(SharedSessionContractImplementor session, Object owner, Object currentValue, EventType eventType)`	Generate a value.
`EnumSet<EventType>`	`getEventTypes()`	The event types for which this generator should be called to produce a new value.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hibernate.generator.BeforeExecutionGenerator
generatedOnExecution

Methods inherited from interface org.hibernate.generator.Generator
allowAssignedIdentifiers, generatedOnExecution, generatesOnInsert, generatesOnUpdate, generatesSometimes

- Constructor Detail
  - TenantIdGeneration
```
public TenantIdGeneration(TenantId annotation,
                          Member member,
                          GeneratorCreationContext context)
```
- Method Detail
  - getEventTypes
```
public EnumSet<EventType> getEventTypes()
```
    Description copied from interface: Generator
    
    The event types for which this generator should be called to produce a new value.
    Identifier generators must return EventTypeSets.INSERT_ONLY.
    
    Specified by:
    
    getEventTypes in interface Generator
    
    Returns:
    
    EventTypeSets.INSERT_ONLY
  - generate
```
public Object generate(SharedSessionContractImplementor session,
                       Object owner,
                       Object currentValue,
                       EventType eventType)
```
    Description copied from interface: BeforeExecutionGenerator
    
    Generate a value.
    
    Specified by:
    
    generate in interface BeforeExecutionGenerator
    
    Parameters:
    
    session - The session from which the request originates.
    
    owner - The instance of the object owning the attribute for which we are generating a value.
    
    currentValue - The current value assigned to the property, or null
    
    eventType - The type of event that has triggered generation of a new value
    
    Returns:
    
    The generated value