EDIT

/*

 * Hibernate, Relational Persistence for Idiomatic Java

 *

 * License: GNU Lesser General Public License (LGPL), version 2.1 or later.

 * See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.

 */

package org.hibernate.collection.internal;

import java.io.Serializable;

import java.lang.reflect.Field;

import java.util.ArrayList;

import java.util.Collection;

import java.util.Collections;

import java.util.HashSet;

import java.util.Iterator;

import java.util.List;

import java.util.ListIterator;

import java.util.Map;

import org.hibernate.AssertionFailure;

import org.hibernate.FlushMode;

import org.hibernate.HibernateException;

import org.hibernate.LazyInitializationException;

import org.hibernate.Session;

import org.hibernate.collection.spi.PersistentCollection;

import org.hibernate.engine.internal.ForeignKeys;

import org.hibernate.engine.spi.CollectionEntry;

import org.hibernate.engine.spi.EntityEntry;

import org.hibernate.engine.spi.PersistenceContext;

import org.hibernate.engine.spi.SessionFactoryImplementor;

import org.hibernate.engine.spi.SessionImplementor;

import org.hibernate.engine.spi.SharedSessionContractImplementor;

import org.hibernate.engine.spi.Status;

import org.hibernate.engine.spi.TypedValue;

import org.hibernate.internal.CoreLogging;

import org.hibernate.internal.CoreMessageLogger;

import org.hibernate.internal.SessionFactoryRegistry;

import org.hibernate.internal.util.MarkerObject;

import org.hibernate.internal.util.collections.IdentitySet;

import org.hibernate.persister.collection.CollectionPersister;

import org.hibernate.persister.entity.EntityPersister;

import org.hibernate.pretty.MessageHelper;

import org.hibernate.resource.transaction.spi.TransactionStatus;

import org.hibernate.type.CompositeType;

import org.hibernate.type.IntegerType;

import org.hibernate.type.LongType;

import org.hibernate.type.PostgresUUIDType;

import org.hibernate.type.StringType;

import org.hibernate.type.Type;

import org.hibernate.type.UUIDBinaryType;

import org.hibernate.type.UUIDCharType;

import eu.etaxonomy.cdm.api.application.CdmApplicationRemoteConfiguration;

import eu.etaxonomy.cdm.cache.ProxyUtils;

import eu.etaxonomy.cdm.model.common.CdmBase;

import eu.etaxonomy.taxeditor.remoting.CdmEagerLoadingException;

import eu.etaxonomy.taxeditor.service.ICachedCommonService;

/**

 * Base class implementing {@link org.hibernate.collection.spi.PersistentCollection}

 *

 * This is an extended copy of the original class from hibernate. It has been extended to

 * allow making remote service calls to spring httpinvoker services (see section at the bottom

 * of this class).

 *

 * NOTE: For updating this class to the latest hibernate version, update the serialVersionUID as

 *       described above, copy the new class to the old class BUT keep those 5 places marked with

 *       ##REMOTING-KEEP##

 *

 * @author Gavin King

 * @author Cherian Mathew

 */

public abstract class AbstractPersistentCollection implements Serializable, PersistentCollection {

	private static final CoreMessageLogger LOG = CoreLogging.messageLogger( AbstractPersistentCollection.class );

	/**

	 * <b>IMPORTANT:</b><br>

	 * This serialVersionUID must be kept in sync with the serialVersionUID which is generated

	 * on the fly for serialized AbstractPersistentCollection objects coming from the httpInvoker

	 * service.

	 * This is most probably necessary after updating hibernate to a newer version. In any case

	 * it the need for updating this <code>serialVersionUID</code> becomes obvious when the attempt

	 * to connect to the server side fails with an  <code>InvalidClassException</code>:

	 *

	 * <pre>

	 * java.io.InvalidClassException: org.hibernate.collection.internal.AbstractPersistentCollection;

	 * local class incompatible:

	 * stream classdesc serialVersionUID = 2742261122392386159,

	 * local class serialVersionUID = -7238232378593030571

	 * </pre>

	 * The correct <code>serialVersionUID</code> is the <code>stream classdesc serialVersionUID</code>

	 * from the error message.

	 */

	private static final long serialVersionUID = 6275967693128102740L;

	private transient SharedSessionContractImplementor session;

	private boolean isTempSession = false;

	private boolean initialized;

	private transient List<DelayedOperation> operationQueue;

	private transient boolean directlyAccessible;

	private transient boolean initializing;

	private Object owner;

	private int cachedSize = -1;

	private String role;

	private Serializable key;

	// collections detect changes made via their public interface and mark

	// themselves as dirty as a performance optimization

	private boolean dirty;

	protected boolean elementRemoved;

	private Serializable storedSnapshot;

	private String sessionFactoryUuid;

	private boolean allowLoadOutsideTransaction;

	/**

	 * Not called by Hibernate, but used by non-JDK serialization,

	 * eg. SOAP libraries.

	 */

	public AbstractPersistentCollection() {

	}

	protected AbstractPersistentCollection(SharedSessionContractImplementor session) {

		this.session = session;

	}

	/**

	 * @deprecated {@link #AbstractPersistentCollection(SharedSessionContractImplementor)} should be used instead.

	 */

	@Deprecated

	protected AbstractPersistentCollection(SessionImplementor session) {

		this( (SharedSessionContractImplementor) session );

	}

	@Override

	public final String getRole() {

		return role;

	}

	@Override

	public final Serializable getKey() {

		return key;

	}

	@Override

	public final boolean isUnreferenced() {

		return role == null;

	}

	@Override

	public final boolean isDirty() {

		return dirty;

	}

	@Override

	public boolean isElementRemoved() {

		return elementRemoved;

	}

	@Override

	public final void clearDirty() {

		dirty = false;

		elementRemoved = false;

	}

	@Override

	public final void dirty() {

		dirty = true;

	}

	@Override

	public final Serializable getStoredSnapshot() {

		return storedSnapshot;

	}

	//Careful: these methods do not initialize the collection.

	@Override

	public abstract boolean empty();

	/**

	 * Called by any read-only method of the collection interface

	 */

	protected final void read() {

		initialize( false );

	}

	/**

	 * Called by the {@link Collection#size} method

	 */

	@SuppressWarnings({"JavaDoc"})

	protected boolean readSize() {

		if ( !initialized ) {

			if ( cachedSize != -1 && !hasQueuedOperations() ) {

				return true;

			}

			else {

				//##REMOTING-KEEP##

				// In remoting we are sure that session is null

				// both when using property paths and switching off conversations

				if(session == null && remoting) {

					LOG.info("--> readSize, of " + getRole() + " with key " + getKey());

					read();

				} else {

			    //keep formatting below to ease update to newer hibernate version

				//##REMOTING-KEEP END##

				final boolean isExtraLazy = withTemporarySessionIfNeeded(

						new LazyInitializationWork<Boolean>() {

							@Override

							public Boolean doWork() {

								final CollectionEntry entry = session.getPersistenceContextInternal().getCollectionEntry( AbstractPersistentCollection.this );

								if ( entry != null ) {

									final CollectionPersister persister = entry.getLoadedPersister();

									if ( persister.isExtraLazy() ) {

										if ( hasQueuedOperations() ) {

											session.flush();

										}

										cachedSize = persister.getSize( entry.getLoadedKey(), session );

										return true;

									}

									else {

										read();

									}

								}

								else{

									throwLazyInitializationExceptionIfNotConnected();

								}

								return false;

							}

						}

				);

				if ( isExtraLazy ) {

					return true;

				}

				}

			}

		}

		return false;

	}

	/**

	 * TBH not sure why this is public

	 *

	 * @param <T> The java type of the return for this LazyInitializationWork

	 */

	public static interface LazyInitializationWork<T> {

		/**

		 * Do the represented work and return the result.

		 *

		 * @return The result

		 */

		public T doWork();

	}

	private <T> T withTemporarySessionIfNeeded(LazyInitializationWork<T> lazyInitializationWork) {

		SharedSessionContractImplementor tempSession = null;

		if ( session == null ) {

			if ( allowLoadOutsideTransaction ) {

				tempSession = openTemporarySessionForLoading();

			}

			else {

				throwLazyInitializationException( "could not initialize proxy - no Session" );

			}

		}

		else if ( !session.isOpenOrWaitingForAutoClose() ) {

			if ( allowLoadOutsideTransaction ) {

				tempSession = openTemporarySessionForLoading();

			}

			else {

				throwLazyInitializationException( "could not initialize proxy - the owning Session was closed" );

			}

		}

		else if ( !session.isConnected() ) {

			if ( allowLoadOutsideTransaction ) {

				tempSession = openTemporarySessionForLoading();

			}

			else {

				throwLazyInitializationException( "could not initialize proxy - the owning Session is disconnected" );

			}

		}

		SharedSessionContractImplementor originalSession = null;

		boolean isJTA = false;

		if ( tempSession != null ) {

			isTempSession = true;

			originalSession = session;

			session = tempSession;

			isJTA = session.getTransactionCoordinator().getTransactionCoordinatorBuilder().isJta();

			if ( !isJTA ) {

				// Explicitly handle the transactions only if we're not in

				// a JTA environment.  A lazy loading temporary session can

				// be created even if a current session and transaction are

				// open (ex: session.clear() was used).  We must prevent

				// multiple transactions.

				( (Session) session ).beginTransaction();

			}

			session.getPersistenceContextInternal().addUninitializedDetachedCollection(

					session.getFactory().getCollectionPersister( getRole() ),

					this

			);

		}

		try {

			return lazyInitializationWork.doWork();

		}

		finally {

			if ( tempSession != null ) {

				// make sure the just opened temp session gets closed!

				isTempSession = false;

				session = originalSession;

				try {

					if ( !isJTA ) {

						( (Session) tempSession ).getTransaction().commit();

					}

					( (Session) tempSession ).close();

				}

				catch (Exception e) {

					LOG.warn( "Unable to close temporary session used to load lazy collection associated to no session" );

				}

			}

		}

	}

	private SharedSessionContractImplementor openTemporarySessionForLoading() {

		if ( sessionFactoryUuid == null ) {

			throwLazyInitializationException( "SessionFactory UUID not known to create temporary Session for loading" );

		}

		final SessionFactoryImplementor sf = (SessionFactoryImplementor)

				SessionFactoryRegistry.INSTANCE.getSessionFactory( sessionFactoryUuid );

		final SharedSessionContractImplementor session = (SharedSessionContractImplementor) sf.openSession();

		session.getPersistenceContextInternal().setDefaultReadOnly( true );

		session.setFlushMode( FlushMode.MANUAL );

		return session;

	}

	protected Boolean readIndexExistence(final Object index) {

		if ( !initialized ) {

			//##REMOTING-KEEP##

			// In remoting we are sure that session is null

			// both when using property paths and switching off conversations

			if(session == null && remoting) {

				LOG.info("--> readIndexExistence, of " + getRole() + " with key " + getKey());

				read();

			} else {

		    //keep formatting below to ease update to newer hibernate version

			//##REMOTING-KEEP END##

			final Boolean extraLazyExistenceCheck = withTemporarySessionIfNeeded(

					new LazyInitializationWork<Boolean>() {

						@Override

						public Boolean doWork() {

							final CollectionEntry entry = session.getPersistenceContextInternal().getCollectionEntry( AbstractPersistentCollection.this );

							final CollectionPersister persister = entry.getLoadedPersister();

							if ( persister.isExtraLazy() ) {

								if ( hasQueuedOperations() ) {

									session.flush();

								}

								return persister.indexExists( entry.getLoadedKey(), index, session );

							}

							else {

								read();

							}

							return null;

						}

					}

			);

			if ( extraLazyExistenceCheck != null ) {

				return extraLazyExistenceCheck;

			}

			}

		}

		return null;

	}

	protected Boolean readElementExistence(final Object element) {

		if ( !initialized ) {

			//##REMOTING-KEEP##

			// In remoting we are sure that session is null

			// both when using property paths and switching off conversations

			if(session == null && remoting) {

				LOG.info("--> readElementExistence, of " + getRole() + " with key " + getKey());

				read();

			} else {

		    //keep formatting below to ease update to newer hibernate version

			//##REMOTING-KEEP END##

			final Boolean extraLazyExistenceCheck = withTemporarySessionIfNeeded(

					new LazyInitializationWork<Boolean>() {

						@Override

						public Boolean doWork() {

							final CollectionEntry entry = session.getPersistenceContextInternal().getCollectionEntry( AbstractPersistentCollection.this );

							final CollectionPersister persister = entry.getLoadedPersister();

							if ( persister.isExtraLazy() ) {

								if ( hasQueuedOperations() ) {

									session.flush();

								}

								return persister.elementExists( entry.getLoadedKey(), element, session );

							}

							else {

								read();

							}

							return null;

						}

					}

			);

			if ( extraLazyExistenceCheck != null ) {

				return extraLazyExistenceCheck;

			}

			}

		}

		return null;

	}

	protected static final Object UNKNOWN = new MarkerObject( "UNKNOWN" );

	protected Object readElementByIndex(final Object index) {

		if ( !initialized ) {

			//##REMOTING-KEEP##

			// In remoting we are sure that session is null

			// both when using property paths and switching off conversations

			if(session == null && remoting) {

				LOG.info("--> readElementByIndex, of " + getRole() + " with key " + getKey());

				read();

			} else {

		    //keep formatting below to ease update to newer hibernate version

			//##REMOTING-KEEP END##

			class ExtraLazyElementByIndexReader implements LazyInitializationWork {

				private boolean isExtraLazy;

				private Object element;

				@Override

				public Object doWork() {

					final CollectionEntry entry = session.getPersistenceContextInternal().getCollectionEntry( AbstractPersistentCollection.this );

					final CollectionPersister persister = entry.getLoadedPersister();

					isExtraLazy = persister.isExtraLazy();

					if ( isExtraLazy ) {

						if ( hasQueuedOperations() ) {

							session.flush();

						}

						element = persister.getElementByIndex( entry.getLoadedKey(), index, session, owner );

					}

					else {

						read();

					}

					return null;

				}

			}

			final ExtraLazyElementByIndexReader reader = new ExtraLazyElementByIndexReader();

			//noinspection unchecked

			withTemporarySessionIfNeeded( reader );

			if ( reader.isExtraLazy ) {

				return reader.element;

			}

			}

		}

		return UNKNOWN;

	}

	protected int getCachedSize() {

		return cachedSize;

	}

	protected boolean isConnectedToSession() {

		return session != null

				&& session.isOpen()

				&& session.getPersistenceContextInternal().containsCollection( this );

	}

	protected boolean isInitialized() {

		return initialized;

	}

	/**

	 * Called by any writer method of the collection interface

	 */

	protected final void write() {

		initialize( true );

		dirty();

	}

	/**

	 * Is this collection in a state that would allow us to

	 * "queue" operations?

	 */

	@SuppressWarnings({"JavaDoc"})

	protected boolean isOperationQueueEnabled() {

		return !initialized

				&& isConnectedToSession()

				&& isInverseCollection();

	}

	/**

	 * Is this collection in a state that would allow us to

	 * "queue" puts? This is a special case, because of orphan

	 * delete.

	 */

	@SuppressWarnings({"JavaDoc"})

	protected boolean isPutQueueEnabled() {

		return !initialized

				&& isConnectedToSession()

				&& isInverseOneToManyOrNoOrphanDelete();

	}

	/**

	 * Is this collection in a state that would allow us to

	 * "queue" clear? This is a special case, because of orphan

	 * delete.

	 */

	@SuppressWarnings({"JavaDoc"})

	protected boolean isClearQueueEnabled() {

		return !initialized

				&& isConnectedToSession()

				&& isInverseCollectionNoOrphanDelete();

	}

	/**

	 * Is this the "inverse" end of a bidirectional association?

	 */

	@SuppressWarnings({"JavaDoc"})

	protected boolean isInverseCollection() {

		final CollectionEntry ce = session.getPersistenceContextInternal().getCollectionEntry( this );

		return ce != null && ce.getLoadedPersister().isInverse();

	}

	/**

	 * Is this the "inverse" end of a bidirectional association with

	 * no orphan delete enabled?

	 */

	@SuppressWarnings({"JavaDoc"})

	protected boolean isInverseCollectionNoOrphanDelete() {

		final CollectionEntry ce = session.getPersistenceContextInternal().getCollectionEntry( this );

		if ( ce == null ) {

			return false;

		}

		final CollectionPersister loadedPersister = ce.getLoadedPersister();

		return loadedPersister.isInverse() && !loadedPersister.hasOrphanDelete();

	}

	/**

	 * Is this the "inverse" end of a bidirectional one-to-many, or

	 * of a collection with no orphan delete?

	 */

	@SuppressWarnings({"JavaDoc"})

	protected boolean isInverseOneToManyOrNoOrphanDelete() {

		final CollectionEntry ce = session.getPersistenceContextInternal().getCollectionEntry( this );

		if ( ce == null ) {

			return false;

		}

		final CollectionPersister loadedPersister = ce.getLoadedPersister();

		return loadedPersister.isInverse() && ( loadedPersister.isOneToMany() || !loadedPersister.hasOrphanDelete() );

	}

	/**

	 * Queue an addition

	 */

	@SuppressWarnings({"JavaDoc"})

	protected final void queueOperation(DelayedOperation operation) {

		if ( operationQueue == null ) {

			operationQueue = new ArrayList<DelayedOperation>( 10 );

		}

		operationQueue.add( operation );

		//needed so that we remove this collection from the second-level cache

		dirty = true;

	}

	/**

	 * Replace entity instances with copy in {@code copyCache}/.

	 *

	 * @param copyCache - mapping from entity in the process of being

	 *                    merged to managed copy.

	 */

	public final void replaceQueuedOperationValues(CollectionPersister persister, Map copyCache) {

		for ( DelayedOperation operation : operationQueue ) {

			if ( ValueDelayedOperation.class.isInstance( operation ) ) {

				( (ValueDelayedOperation) operation ).replace( persister, copyCache );

			}

		}

	}

	/**

	 * After reading all existing elements from the database,

	 * add the queued elements to the underlying collection.

	 */

	protected final void performQueuedOperations() {

		for ( DelayedOperation operation : operationQueue ) {

			operation.operate();

		}

		clearOperationQueue();

	}

	@Override

	public void setSnapshot(Serializable key, String role, Serializable snapshot) {

		this.key = key;

		this.role = role;

		this.storedSnapshot = snapshot;

	}

	@Override

	public void postAction() {

		clearOperationQueue();

		cachedSize = -1;

		clearDirty();

	}

	public final void clearOperationQueue() {

		operationQueue = null;

	}

	@Override

	public Object getValue() {

		return this;

	}

	@Override

	public void beginRead() {

		// override on some subclasses

		initializing = true;

	}

	@Override

	public boolean endRead() {

		//override on some subclasses

		return afterInitialize();

	}

	@Override

	public boolean afterInitialize() {

		setInitialized();

		//do this bit after setting initialized to true or it will recurse

		if ( hasQueuedOperations() ) {

			performQueuedOperations();

			cachedSize = -1;

			return false;

		}

		else {

			return true;

		}

	}

	/**

	 * Initialize the collection, if possible, wrapping any exceptions

	 * in a runtime exception

	 *

	 * @param writing currently obsolete

	 *

	 * @throws LazyInitializationException if we cannot initialize

	 */

	protected final void initialize(final boolean writing) {

		if ( initialized ) {

			return;

		}

		//##REMOTING-KEEP##

	    // In remoting we are sure that session is null

	    // both when using property paths and switching off conversations

	    if(session == null && remoting) {

	        remoteInitialize();

	    } else {

	    //keep formatting below to ease update to newer hibernate version

		//##REMOTING-KEEP END##

	    withTemporarySessionIfNeeded(

				new LazyInitializationWork<Object>() {

					@Override

					public Object doWork() {

						session.initializeCollection( AbstractPersistentCollection.this, writing );

						return null;

					}

				}

		);

	    }

	}

	private void throwLazyInitializationExceptionIfNotConnected() {

		if ( !isConnectedToSession() ) {

			throwLazyInitializationException( "no session or session was closed" );

		}

		if ( !session.isConnected() ) {

			throwLazyInitializationException( "session is disconnected" );

		}

	}

	private void throwLazyInitializationException(String message) {

		throw new LazyInitializationException(

				"failed to lazily initialize a collection" +

						(role == null ? "" : " of role: " + role) +

						", " + message

		);

	}

	protected final void setInitialized() {

		this.initializing = false;

		this.initialized = true;

	}

	protected final void setDirectlyAccessible(boolean directlyAccessible) {

		this.directlyAccessible = directlyAccessible;

	}

	@Override

	public boolean isDirectlyAccessible() {

		return directlyAccessible;

	}

	@Override

	public final boolean unsetSession(SharedSessionContractImplementor currentSession) {

		prepareForPossibleLoadingOutsideTransaction();

		if ( currentSession == this.session ) {

			if ( !isTempSession ) {

				if ( hasQueuedOperations() ) {

					final String collectionInfoString = MessageHelper.collectionInfoString( getRole(), getKey() );

					try {

						final TransactionStatus transactionStatus =

								session.getTransactionCoordinator().getTransactionDriverControl().getStatus();

						if ( transactionStatus.isOneOf(

								TransactionStatus.ROLLED_BACK,

								TransactionStatus.MARKED_ROLLBACK,

								TransactionStatus.FAILED_COMMIT,

								TransactionStatus.FAILED_ROLLBACK,

								TransactionStatus.ROLLING_BACK

						) ) {

							// It was due to a rollback.

							LOG.queuedOperationWhenDetachFromSessionOnRollback( collectionInfoString );

						}

						else {

							// We don't know why the collection is being detached.

							// Just log the info.

							LOG.queuedOperationWhenDetachFromSession( collectionInfoString );

						}

					}

					catch (Exception e) {

						// We don't know why the collection is being detached.

						// Just log the info.

						LOG.queuedOperationWhenDetachFromSession( collectionInfoString );

					}

				}

				if ( allowLoadOutsideTransaction && !initialized && session.getLoadQueryInfluencers().hasEnabledFilters() ) {

					final String collectionInfoString = MessageHelper.collectionInfoString( getRole(), getKey() );

					LOG.enabledFiltersWhenDetachFromSession( collectionInfoString );

				}

				this.session = null;

			}

			return true;

		}

		else {

			if ( this.session != null ) {

				LOG.logCannotUnsetUnexpectedSessionInCollection( generateUnexpectedSessionStateMessage( currentSession ) );

			}

			return false;

		}

	}

	protected void prepareForPossibleLoadingOutsideTransaction() {

		if ( session != null ) {

			allowLoadOutsideTransaction = session.getFactory().getSessionFactoryOptions().isInitializeLazyStateOutsideTransactionsEnabled();

			if ( allowLoadOutsideTransaction && sessionFactoryUuid == null ) {

				sessionFactoryUuid = session.getFactory().getUuid();

			}

		}

	}

	@Override

	public final boolean setCurrentSession(SharedSessionContractImplementor session) throws HibernateException {

		if ( session == this.session ) {

			return false;

		}

		else if ( this.session != null ) {

			final String msg = generateUnexpectedSessionStateMessage( session );

			if ( isConnectedToSession() ) {

				throw new HibernateException(

						"Illegal attempt to associate a collection with two open sessions. " + msg

				);

			}

			else {

				LOG.logUnexpectedSessionInCollectionNotConnected( msg );

			}

		}

		if ( hasQueuedOperations() ) {

			LOG.queuedOperationWhenAttachToSession( MessageHelper.collectionInfoString( getRole(), getKey() ) );

		}

		this.session = session;

		return true;

	}

	private String generateUnexpectedSessionStateMessage(SharedSessionContractImplementor session) {

		// NOTE: If this.session != null, this.session may be operating on this collection

		// (e.g., by changing this.role, this.key, or even this.session) in a different thread.

		// Grab the current role and key (it can still get changed by this.session...)

		// If this collection is connected to this.session, then this.role and this.key should

		// be consistent with the CollectionEntry in this.session (as long as this.session doesn't

		// change it). Don't access the CollectionEntry in this.session because that could result

		// in multi-threaded access to this.session.

		final String roleCurrent = role;

		final Serializable keyCurrent = key;

		final StringBuilder sb = new StringBuilder( "Collection : " );

		if ( roleCurrent != null ) {

			sb.append( MessageHelper.collectionInfoString( roleCurrent, keyCurrent ) );

		}

		else {

			final CollectionEntry ce = session.getPersistenceContextInternal().getCollectionEntry( this );

			if ( ce != null ) {

				sb.append(

						MessageHelper.collectionInfoString(

								ce.getLoadedPersister(),

								this,

								ce.getLoadedKey(),

								session

						)

				);

			}

			else {

				sb.append( "<unknown>" );

			}

		}

		// only include the collection contents if debug logging

		if ( LOG.isDebugEnabled() ) {

			final String collectionContents = wasInitialized() ? toString() : "<uninitialized>";

			sb.append( "\nCollection contents: [" ).append( collectionContents ).append( "]" );

		}

		return sb.toString();

	}

	@Override

	public boolean needsRecreate(CollectionPersister persister) {

		// Workaround for situations like HHH-7072.  If the collection element is a component that consists entirely

		// of nullable properties, we currently have to forcefully recreate the entire collection.  See the use

		// of hasNotNullableColumns in the AbstractCollectionPersister constructor for more info.  In order to delete

		// row-by-row, that would require SQL like "WHERE ( COL = ? OR ( COL is null AND ? is null ) )", rather than

		// the current "WHERE COL = ?" (fails for null for most DBs).  Note that

		// the param would have to be bound twice.  Until we eventually add "parameter bind points" concepts to the

		// AST in ORM 5+, handling this type of condition is either extremely difficult or impossible.  Forcing

		// recreation isn't ideal, but not really any other option in ORM 4.

		// Selecting a type used in where part of update statement

		// (must match condition in org.hibernate.persister.collection.BasicCollectionPersister#doUpdateRows).

		// See HHH-9474

		Type whereType;

		if ( persister.hasIndex() ) {

			whereType = persister.getIndexType();

		}

		else {

			whereType = persister.getElementType();

		}

		if ( whereType instanceof CompositeType ) {

			CompositeType componentIndexType = (CompositeType) whereType;

			return !componentIndexType.hasNotNullProperty();

		}

		return false;

	}

	@Override

	public final void forceInitialization() throws HibernateException {

		if ( !initialized ) {

			if ( initializing ) {

				throw new AssertionFailure( "force initialize loading collection" );

			}

			initialize( false );

		}

	}

	/**

	 * Get the current snapshot from the session

	 */

	@SuppressWarnings({"JavaDoc"})

	protected final Serializable getSnapshot() {

		return session.getPersistenceContext().getSnapshot( this );

	}

	@Override

	public final boolean wasInitialized() {

		return initialized;

	}

	@Override

	public boolean isRowUpdatePossible() {

		return true;

	}

	@Override

	public final boolean hasQueuedOperations() {

		return operationQueue != null;

	}

	@Override

	public final Iterator queuedAdditionIterator() {

		if ( hasQueuedOperations() ) {

			return new Iterator() {

				private int index;

				@Override

				public Object next() {

					return operationQueue.get( index++ ).getAddedInstance();

				}

				@Override

				public boolean hasNext() {

					return index < operationQueue.size();

				}

				@Override

				public void remove() {

					throw new UnsupportedOperationException();

				}

			};

		}

		else {

			return Collections.emptyIterator();

		}

	}

	@Override

	@SuppressWarnings({"unchecked"})

	public final Collection getQueuedOrphans(String entityName) {

		if ( hasQueuedOperations() ) {

			final Collection additions = new ArrayList( operationQueue.size() );

			final Collection removals = new ArrayList( operationQueue.size() );

			for ( DelayedOperation operation : operationQueue ) {

				additions.add( operation.getAddedInstance() );

				removals.add( operation.getOrphan() );

			}

			return getOrphans( removals, additions, entityName, session );

		}

		else {

			return Collections.EMPTY_LIST;

		}

	}

	@Override