ReactiveActionQueue (Hibernate Reactive API documentation)

java.lang.Object
- org.hibernate.reactive.engine.ReactiveActionQueue

```
public class ReactiveActionQueue
extends Object
```
A reactive counterpart to ActionQueue, where DML operations are queued before execution during a flush.

Constructor Summary

Constructors
Constructor and Description

ReactiveActionQueue(ReactiveSession session)
Constructs an action queue bound to the given session.

Constructors
Constructor and Description
`ReactiveActionQueue(ReactiveSession session)` Constructs an action queue bound to the given session.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAction(org.hibernate.action.internal.BulkOperationCleanupAction action)` Adds an action defining a cleanup relating to a bulk operation (HQL/JPQL or Criteria based update/delete)
`void`	`addAction(org.hibernate.action.internal.QueuedOperationCollectionAction action)` Adds an action relating to a collection queued operation (extra lazy).
`void`	`addAction(org.hibernate.reactive.engine.impl.ReactiveCollectionRecreateAction action)` Adds a collection (re)create action
`void`	`addAction(org.hibernate.reactive.engine.impl.ReactiveCollectionRemoveAction action)` Adds a collection remove action
`void`	`addAction(org.hibernate.reactive.engine.impl.ReactiveCollectionUpdateAction action)` Adds a collection update action
`void`	`addAction(org.hibernate.reactive.engine.impl.ReactiveEntityDeleteAction action)` Adds an entity delete action
`CompletionStage<Void>`	`addAction(org.hibernate.reactive.engine.impl.ReactiveEntityIdentityInsertAction action)` Adds an entity (IDENTITY) insert action
`CompletionStage<Void>`	`addAction(org.hibernate.reactive.engine.impl.ReactiveEntityRegularInsertAction action)`
`void`	`addAction(org.hibernate.reactive.engine.impl.ReactiveEntityUpdateAction action)` Adds an entity update action
`void`	`addAction(org.hibernate.reactive.engine.impl.ReactiveOrphanRemovalAction action)` Adds an orphan removal action
`CompletionStage<Void>`	`afterTransactionCompletion(boolean success)` Performs cleanup of any held cache softlocks.
`boolean`	`areInsertionsOrDeletionsQueued()` Check whether any insertion or deletion actions are currently queued.
`boolean`	`areTablesToBeUpdated(Set tables)` Check whether the given tables/query-spaces are to be executed against given the currently queued actions.
`CompletionStage<Void>`	`beforeTransactionCompletion()` Execute any registered `BeforeTransactionCompletionProcess`
`void`	`checkNoUnresolvedActionsAfterOperation()` Throws `PropertyValueException` if there are any unresolved entity insert actions that depend on non-nullable associations with a transient entity.
`void`	`clear()`
`void`	`clearFromFlushNeededCheck(int previousCollectionRemovalSize)`
`<E extends ReactiveExecutable> CompletionStage<Void>`	`execute(E executable)`
`CompletionStage<Void>`	`executeActions()` Perform all currently queued actions.
`CompletionStage<Void>`	`executeInserts()` Perform all currently queued entity-insertion actions.
`boolean`	`hasAfterTransactionActions()`
`boolean`	`hasAnyQueuedActions()`
`boolean`	`hasBeforeTransactionActions()`
`boolean`	`hasUnresolvedEntityInsertActions()` Are there unresolved entity insert actions that depend on non-nullable associations with a transient entity?
`int`	`numberOfCollectionCreations()`
`int`	`numberOfCollectionRemovals()`
`int`	`numberOfCollectionUpdates()`
`int`	`numberOfDeletions()`
`int`	`numberOfInsertions()`
`int`	`numberOfUpdates()`
`void`	`prepareActions()` Prepares the internal action queues for execution.
`void`	`registerProcess(org.hibernate.action.spi.AfterTransactionCompletionProcess process)`
`void`	`registerProcess(org.hibernate.action.spi.BeforeTransactionCompletionProcess process)`
`void`	`registerProcess(ReactiveAfterTransactionCompletionProcess process)`
`void`	`registerProcess(ReactiveBeforeTransactionCompletionProcess process)`
`void`	`sortActions()`
`void`	`sortCollectionActions()`
`String`	`toString()` Returns a string representation of the object.
`void`	`unScheduleDeletion(org.hibernate.engine.spi.EntityEntry entry, Object rescuedEntity)`

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

- Constructor Detail
  - ReactiveActionQueue
```
public ReactiveActionQueue(ReactiveSession session)
```
    Constructs an action queue bound to the given session.
    
    Parameters:
    
    session - The session "owning" this queue.
- Method Detail
  - clear
```
public void clear()
```
  - addAction
```
public CompletionStage<Void> addAction(org.hibernate.reactive.engine.impl.ReactiveEntityRegularInsertAction action)
```
  - addAction
```
public CompletionStage<Void> addAction(org.hibernate.reactive.engine.impl.ReactiveEntityIdentityInsertAction action)
```
    Adds an entity (IDENTITY) insert action
    
    Parameters:
    
    action - The action representing the entity insertion
  - addAction
```
public void addAction(org.hibernate.reactive.engine.impl.ReactiveEntityDeleteAction action)
```
    Adds an entity delete action
    
    Parameters:
    
    action - The action representing the entity deletion
  - addAction
```
public void addAction(org.hibernate.reactive.engine.impl.ReactiveOrphanRemovalAction action)
```
    Adds an orphan removal action
    
    Parameters:
    
    action - The action representing the orphan removal
  - addAction
```
public void addAction(org.hibernate.reactive.engine.impl.ReactiveEntityUpdateAction action)
```
    Adds an entity update action
    
    Parameters:
    
    action - The action representing the entity update
  - addAction
```
public void addAction(org.hibernate.reactive.engine.impl.ReactiveCollectionRecreateAction action)
```
    Adds a collection (re)create action
    
    Parameters:
    
    action - The action representing the (re)creation of a collection
  - addAction
```
public void addAction(org.hibernate.reactive.engine.impl.ReactiveCollectionRemoveAction action)
```
    Adds a collection remove action
    
    Parameters:
    
    action - The action representing the removal of a collection
  - addAction
```
public void addAction(org.hibernate.reactive.engine.impl.ReactiveCollectionUpdateAction action)
```
    Adds a collection update action
    
    Parameters:
    
    action - The action representing the update of a collection
  - addAction
```
public void addAction(org.hibernate.action.internal.QueuedOperationCollectionAction action)
```
    Adds an action relating to a collection queued operation (extra lazy).
    
    Parameters:
    
    action - The action representing the queued operation
  - addAction
```
public void addAction(org.hibernate.action.internal.BulkOperationCleanupAction action)
```
    Adds an action defining a cleanup relating to a bulk operation (HQL/JPQL or Criteria based update/delete)
    
    Parameters:
    
    action - The action representing the queued operation
  - hasUnresolvedEntityInsertActions
```
public boolean hasUnresolvedEntityInsertActions()
```
    Are there unresolved entity insert actions that depend on non-nullable associations with a transient entity?
    
    Returns:
    
    true, if there are unresolved entity insert actions that depend on non-nullable associations with a transient entity; false, otherwise
  - checkNoUnresolvedActionsAfterOperation
```
public void checkNoUnresolvedActionsAfterOperation()
                                            throws org.hibernate.PropertyValueException
```
    Throws PropertyValueException if there are any unresolved entity insert actions that depend on non-nullable associations with a transient entity. This method should be called on completion of an operation (after all cascades are completed) that saves an entity.
    
    Throws:
    
    org.hibernate.PropertyValueException - if there are any unresolved entity insert actions; PropertyValueException.getEntityName() and PropertyValueException.getPropertyName() will return the entity name and property value for the first unresolved entity insert action.
  - registerProcess
```
public void registerProcess(org.hibernate.action.spi.AfterTransactionCompletionProcess process)
```
  - registerProcess
```
public void registerProcess(org.hibernate.action.spi.BeforeTransactionCompletionProcess process)
```
  - registerProcess
```
public void registerProcess(ReactiveAfterTransactionCompletionProcess process)
```
  - registerProcess
```
public void registerProcess(ReactiveBeforeTransactionCompletionProcess process)
```
  - executeInserts
```
public CompletionStage<Void> executeInserts()
```
    Perform all currently queued entity-insertion actions.
    
    Throws:
    
    org.hibernate.HibernateException - error executing queued insertion actions.
  - executeActions
```
public CompletionStage<Void> executeActions()
```
    Perform all currently queued actions.
    
    Throws:
    
    org.hibernate.HibernateException - error executing queued actions.
  - prepareActions
```
public void prepareActions()
                    throws org.hibernate.HibernateException
```
    Prepares the internal action queues for execution.
    
    Throws:
    
    org.hibernate.HibernateException - error preparing actions.
  - afterTransactionCompletion
```
public CompletionStage<Void> afterTransactionCompletion(boolean success)
```
    Performs cleanup of any held cache softlocks.
    
    Parameters:
    
    success - Was the transaction successful.
  - beforeTransactionCompletion
```
public CompletionStage<Void> beforeTransactionCompletion()
```
    Execute any registered BeforeTransactionCompletionProcess
  - areInsertionsOrDeletionsQueued
```
public boolean areInsertionsOrDeletionsQueued()
```
    Check whether any insertion or deletion actions are currently queued.
    
    Returns:
    
    true if insertions or deletions are currently queued; false otherwise.
  - areTablesToBeUpdated
```
public boolean areTablesToBeUpdated(Set tables)
```
    Check whether the given tables/query-spaces are to be executed against given the currently queued actions.
    
    Parameters:
    
    tables - The table/query-spaces to check.
    
    Returns:
    
    true if we contain pending actions against any of the given tables; false otherwise.
  - execute
```
public <E extends ReactiveExecutable> CompletionStage<Void> execute(E executable)
```
    Parameters:
    
    executable - The action to execute
  - toString
```
public String toString()
```
    Returns a string representation of the object.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a string representation of the object.
  - numberOfCollectionRemovals
```
public int numberOfCollectionRemovals()
```
  - numberOfCollectionUpdates
```
public int numberOfCollectionUpdates()
```
  - numberOfCollectionCreations
```
public int numberOfCollectionCreations()
```
  - numberOfDeletions
```
public int numberOfDeletions()
```
  - numberOfUpdates
```
public int numberOfUpdates()
```
  - numberOfInsertions
```
public int numberOfInsertions()
```
  - sortCollectionActions
```
public void sortCollectionActions()
```
  - sortActions
```
public void sortActions()
```
  - clearFromFlushNeededCheck
```
public void clearFromFlushNeededCheck(int previousCollectionRemovalSize)
```
  - hasAfterTransactionActions
```
public boolean hasAfterTransactionActions()
```
  - hasBeforeTransactionActions
```
public boolean hasBeforeTransactionActions()
```
  - hasAnyQueuedActions
```
public boolean hasAnyQueuedActions()
```
  - unScheduleDeletion
```
public void unScheduleDeletion(org.hibernate.engine.spi.EntityEntry entry,
                               Object rescuedEntity)
```

Class ReactiveActionQueue

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ReactiveActionQueue

Method Detail

clear

addAction

addAction

addAction

addAction

addAction

addAction

addAction

addAction

addAction

addAction

hasUnresolvedEntityInsertActions

checkNoUnresolvedActionsAfterOperation

registerProcess

registerProcess

registerProcess

registerProcess

executeInserts

executeActions

prepareActions

afterTransactionCompletion

beforeTransactionCompletion

areInsertionsOrDeletionsQueued

areTablesToBeUpdated

execute

toString

numberOfCollectionRemovals

numberOfCollectionUpdates

numberOfCollectionCreations

numberOfDeletions

numberOfUpdates

numberOfInsertions

sortCollectionActions

sortActions

clearFromFlushNeededCheck

hasAfterTransactionActions

hasBeforeTransactionActions

hasAnyQueuedActions

unScheduleDeletion