Package org.hibernate

Enum FlushMode

java.lang.Object

java.lang.Enum<FlushMode>

org.hibernate.FlushMode

All Implemented Interfaces:

Serializable, Comparable<FlushMode>

public enum FlushMode
extends Enum<FlushMode>

Represents a flushing strategy. The flush process synchronizes database state with session state by detecting state changes and executing SQL statements. A value of this enumeration specifies when the flush process occurs.

For example, COMMIT specifies that the session flushes automatically when the transaction is about to commit.

See Also:

Session.setHibernateFlushMode(org.hibernate.FlushMode), CommonQueryContract.setHibernateFlushMode(org.hibernate.FlushMode)

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALWAYS	The Session is flushed when EntityTransaction.commit() is called and before every query.
AUTO	The Session is flushed when EntityTransaction.commit() is called, and is sometimes flushed before query execution in order to ensure that queries never return stale state.
COMMIT	The Session is flushed when EntityTransaction.commit() is called.
MANUAL	The Session is only flushed when Session.flush() is called explicitly.

Method Summary

Modifier and Type	Method	Description
static FlushMode	fromJpaFlushMode(FlushModeType flushModeType)
static FlushMode	interpretExternalSetting(String externalName)	Interprets an external representation of a flush mode.
boolean	lessThan(FlushMode other)	Compare this flush mode to the given flush mode.
FlushModeType	toJpaFlushMode()
static FlushModeType	toJpaFlushMode(FlushMode flushMode)
static FlushMode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static FlushMode[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

MANUAL

public static final FlushMode MANUAL

The Session is only flushed when Session.flush() is called explicitly. This mode is very efficient for read-only transactions.

COMMIT

public static final FlushMode COMMIT

The Session is flushed when EntityTransaction.commit() is called. It is never automatically flushed before query execution.

See Also:

FlushModeType.COMMIT

AUTO

public static final FlushMode AUTO

The Session is flushed when EntityTransaction.commit() is called, and is sometimes flushed before query execution in order to ensure that queries never return stale state. This is the default flush mode.

See Also:

FlushModeType.AUTO

ALWAYS

public static final FlushMode ALWAYS

The Session is flushed when EntityTransaction.commit() is called and before every query. This is usually unnecessary and inefficient.

Method Detail

values

public static FlushMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (FlushMode c : FlushMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static FlushMode valueOf(String 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. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

lessThan

public boolean lessThan(FlushMode other)

Compare this flush mode to the given flush mode.

Returns:

true if this flush mode flushes less often than the given flush mode

interpretExternalSetting

public static FlushMode interpretExternalSetting(String externalName)

Interprets an external representation of a flush mode.

Parameters:

externalName - the name of a FlushMode, or of a FlushModeType

Returns:

a FlushMode, or null if the argument was null

Throws:

MappingException - for an unrecognized external representation

fromJpaFlushMode

public static FlushMode fromJpaFlushMode(FlushModeType flushModeType)

toJpaFlushMode

public static FlushModeType toJpaFlushMode(FlushMode flushMode)

toJpaFlushMode

public FlushModeType toJpaFlushMode()