Home » JPA » Miscellaneous » FlushModeType
324 words

javax.persistence.FlushModeType - JPA enum

javax.persistence
Enum FlushModeType

java.lang.Object
    java.lang.Enum<javax.persistence.FlushModeType>
        javax.persistence.FlushModeType
Implemented Interfaces:
Serializable, Comparable<FlushModeType>
Flush mode setting.

When queries are executed within a transaction, if FlushModeType.AUTO is set on the Query or TypedQuery object, or if the flush mode setting for the persistence context is AUTO (the default) and a flush mode setting has not been specified for the Query or TypedQuery object, the persistence provider is responsible for ensuring that all updates to the state of all entities in the persistence context which could potentially affect the result of the query are visible to the processing of the query. The persistence provider implementation may achieve this by flushing those entities to the database or by some other means.

If FlushModeType.COMMIT is set, the effect of updates made to entities in the persistence context upon queries is unspecified.

If there is no transaction active, the persistence provider must not flush to the database.

Since:
JPA 1.0
FlushModeType AUTO
(Default) Flushing to occur at query execution.
(Default) Flushing to occur at query execution.
Since:
JPA 1.0
FlushModeType COMMIT
Flushing to occur at transaction commit.
Flushing to occur at transaction commit. The provider may flush at other times, but is not required to.
Since:
JPA 1.0
FlushModeType valueOf(String name)

Returns the enum constant of this type with the specified name.

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type.

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null

FlushModeType[] values()

Returns an array containing the constants of this enum type.

Returns an array containing the constants of this enum type.

This method may be used to iterate over the constants as follows:

for (FlushModeType c : FlushModeType.values())
    System.out.println(c)
Returns:
an array containing the constants of this enum type, in the order they are declared

This documentation page is derived (with some adjustments) from the open source JPA 2 RI (EclipseLink)
and is available under the terms of the Eclipse Public License, v. 1.0 and Eclipse Distribution License, v. 1.0.
Object Relational Mapping (ORM) JPA 2 providers include Hibernate, EclipseLink, TopLink, OpenJPA and DataNucleus.
Object DB is not an ORM JPA implementation but an Object Database for Java with built in JPA 2 support.