EmptyInterceptor

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> org >> [ hibernate overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JavaDoc of org.hibernate.EmptyInterceptor

Sourc code of org.hibernate.EmptyInterceptor

Download org.hibernate.EmptyInterceptor

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.hibernate
Class EmptyInterceptor

java.lang.Object
  org.hibernate.EmptyInterceptor

All Implemented Interfaces:: Interceptor, java.io.Serializable

public class EmptyInterceptor
extends java.lang.Object
implements Interceptor, java.io.Serializable

An interceptor that does nothing. May be used as a base class for application-defined custom interceptors.

Field Summary

static Interceptor INSTANCE


Constructor Summary

protected EmptyInterceptor()


Method Summary

void afterTransactionBegin(Transaction tx)
          Called when a Hibernate transaction is begun via the Hibernate Transaction API.

void afterTransactionCompletion(Transaction tx)
          Called after a transaction is committed or rolled back.

void beforeTransactionCompletion(Transaction tx)
          Called before a transaction is committed (but not before rollback).

int[] findDirty(java.lang.Object entity, java.io.Serializable id, java.lang.Object[] currentState, java.lang.Object[] previousState, java.lang.String[] propertyNames, org.hibernate.type.Type[] types)
          Called from flush().

java.lang.Object getEntity(java.lang.String entityName, java.io.Serializable id)
          Get a fully loaded entity instance that is cached externally

java.lang.String getEntityName(java.lang.Object object)
          Get the entity name for a persistent or transient instance

java.lang.Object instantiate(java.lang.String entityName, EntityMode entityMode, java.io.Serializable id)
          Instantiate the entity class.

java.lang.Boolean isTransient(java.lang.Object entity)
          Called to distinguish between transient and detached entities.

void onCollectionRecreate(java.lang.Object collection, java.io.Serializable key)
          Called before a collection is (re)created.

void onCollectionRemove(java.lang.Object collection, java.io.Serializable key)
          Called before a collection is deleted.

void onCollectionUpdate(java.lang.Object collection, java.io.Serializable key)
          Called before a collection is updated.

void onDelete(java.lang.Object entity, java.io.Serializable id, java.lang.Object[] state, java.lang.String[] propertyNames, org.hibernate.type.Type[] types)
          Called before an object is deleted.

boolean onFlushDirty(java.lang.Object entity, java.io.Serializable id, java.lang.Object[] currentState, java.lang.Object[] previousState, java.lang.String[] propertyNames, org.hibernate.type.Type[] types)
          Called when an object is detected to be dirty, during a flush.

boolean onLoad(java.lang.Object entity, java.io.Serializable id, java.lang.Object[] state, java.lang.String[] propertyNames, org.hibernate.type.Type[] types)
          Called just before an object is initialized.

java.lang.String onPrepareStatement(java.lang.String sql)
          Called when sql string is being prepared.

boolean onSave(java.lang.Object entity, java.io.Serializable id, java.lang.Object[] state, java.lang.String[] propertyNames, org.hibernate.type.Type[] types)
          Called before an object is saved.

void postFlush(java.util.Iterator entities)
          Called after a flush that actually ends in execution of the SQL statements required to synchronize in-memory state with the database.

void preFlush(java.util.Iterator entities)
          Called before a flush

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

INSTANCE

public static final Interceptor INSTANCE

Constructor Detail

EmptyInterceptor

protected EmptyInterceptor()

Method Detail

onDelete

public void onDelete(java.lang.Object entity,
                     java.io.Serializable id,
                     java.lang.Object[] state,
                     java.lang.String[] propertyNames,
                     org.hibernate.type.Type[] types)

Description copied from interface: Interceptor

Called before an object is deleted. It is not recommended that the interceptor modify the state.

Specified by:: onDelete in interface Interceptor

onFlushDirty

public boolean onFlushDirty(java.lang.Object entity,
                            java.io.Serializable id,
                            java.lang.Object[] currentState,
                            java.lang.Object[] previousState,
                            java.lang.String[] propertyNames,
                            org.hibernate.type.Type[] types)

Description copied from interface: Interceptor

Called when an object is detected to be dirty, during a flush. The interceptor may modify the detected currentState, which will be propagated to both the database and the persistent object. Note that not all flushes end in actual synchronization with the database, in which case the new currentState will be propagated to the object, but not necessarily (immediately) to the database. It is strongly recommended that the interceptor not modify the previousState.

Specified by:: onFlushDirty in interface Interceptor

onLoad

public boolean onLoad(java.lang.Object entity,
                      java.io.Serializable id,
                      java.lang.Object[] state,
                      java.lang.String[] propertyNames,
                      org.hibernate.type.Type[] types)

Description copied from interface: Interceptor

Called just before an object is initialized. The interceptor may change the state, which will be propagated to the persistent object. Note that when this method is called, entity will be an empty uninitialized instance of the class.

Specified by:: onLoad in interface Interceptor

onSave

public boolean onSave(java.lang.Object entity,
                      java.io.Serializable id,
                      java.lang.Object[] state,
                      java.lang.String[] propertyNames,
                      org.hibernate.type.Type[] types)

Description copied from interface: Interceptor

Called before an object is saved. The interceptor may modify the state, which will be used for the SQL INSERT and propagated to the persistent object.

Specified by:: onSave in interface Interceptor

postFlush

public void postFlush(java.util.Iterator entities)

Description copied from interface: Interceptor

Called after a flush that actually ends in execution of the SQL statements required to synchronize in-memory state with the database.

Specified by:: postFlush in interface Interceptor

preFlush

public void preFlush(java.util.Iterator entities)

Description copied from interface: Interceptor

Called before a flush

Specified by:: preFlush in interface Interceptor

isTransient

public java.lang.Boolean isTransient(java.lang.Object entity)

Description copied from interface: Interceptor

Called to distinguish between transient and detached entities. The return value determines the state of the entity with respect to the current session.

Boolean.TRUE - the entity is transient
Boolean.FALSE - the entity is detached
null - Hibernate uses the unsaved-value mapping and other heuristics to determine if the object is unsaved

Specified by:: isTransient in interface Interceptor

instantiate

public java.lang.Object instantiate(java.lang.String entityName,
                                    EntityMode entityMode,
                                    java.io.Serializable id)

Description copied from interface: Interceptor

Instantiate the entity class. Return null to indicate that Hibernate should use the default constructor of the class. The identifier property of the returned instance should be initialized with the given identifier.

Specified by:: instantiate in interface Interceptor

findDirty

public int[] findDirty(java.lang.Object entity,
                       java.io.Serializable id,
                       java.lang.Object[] currentState,
                       java.lang.Object[] previousState,
                       java.lang.String[] propertyNames,
                       org.hibernate.type.Type[] types)

Description copied from interface: Interceptor

Called from flush(). The return value determines whether the entity is updated

an array of property indices - the entity is dirty
an empty array - the entity is not dirty
null - use Hibernate's default dirty-checking algorithm

Specified by:: findDirty in interface Interceptor

getEntityName

public java.lang.String getEntityName(java.lang.Object object)

Description copied from interface: Interceptor

Get the entity name for a persistent or transient instance

Specified by:: getEntityName in interface Interceptor

getEntity

public java.lang.Object getEntity(java.lang.String entityName,
                                  java.io.Serializable id)

Description copied from interface: Interceptor

Get a fully loaded entity instance that is cached externally

Specified by:: getEntity in interface Interceptor

afterTransactionBegin

public void afterTransactionBegin(Transaction tx)

Description copied from interface: Interceptor

Called when a Hibernate transaction is begun via the Hibernate Transaction API. Will not be called if transactions are being controlled via some other mechanism (CMT, for example).

Specified by:: afterTransactionBegin in interface Interceptor

afterTransactionCompletion

public void afterTransactionCompletion(Transaction tx)

Description copied from interface: Interceptor

Called after a transaction is committed or rolled back.

Specified by:: afterTransactionCompletion in interface Interceptor

beforeTransactionCompletion

public void beforeTransactionCompletion(Transaction tx)

Description copied from interface: Interceptor

Called before a transaction is committed (but not before rollback).

Specified by:: beforeTransactionCompletion in interface Interceptor

onPrepareStatement

public java.lang.String onPrepareStatement(java.lang.String sql)

Description copied from interface: Interceptor

Called when sql string is being prepared.

Specified by:: onPrepareStatement in interface Interceptor

onCollectionRemove

public void onCollectionRemove(java.lang.Object collection,
                               java.io.Serializable key)
                        throws CallbackException

Description copied from interface: Interceptor

Called before a collection is deleted.

Specified by:: onCollectionRemove in interface Interceptor

onCollectionRecreate

public void onCollectionRecreate(java.lang.Object collection,
                                 java.io.Serializable key)
                          throws CallbackException

Description copied from interface: Interceptor

Called before a collection is (re)created.

Specified by:: onCollectionRecreate in interface Interceptor

onCollectionUpdate

public void onCollectionUpdate(java.lang.Object collection,
                               java.io.Serializable key)
                        throws CallbackException

Description copied from interface: Interceptor

Called before a collection is updated.

Specified by:: onCollectionUpdate in interface Interceptor

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> org >> [ hibernate overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JavaDoc of org.hibernate.EmptyInterceptor

Sourc code of org.hibernate.EmptyInterceptor

Download org.hibernate.EmptyInterceptor

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD