org.hibernate.engine.spi

Class ExecutableList<E extends Executable & Comparable & Serializable>

java.lang.Object

org.hibernate.engine.spi.ExecutableList<E>

Type Parameters:

E - Intersection type describing Executable implementations

All Implemented Interfaces:

Externalizable, Serializable, Iterable<E>

public class ExecutableList<E extends Executable & Comparable & Serializable>
extends Object
implements Serializable, Iterable<E>, Externalizable

Specialized encapsulating of the state pertaining to each Executable list.

Manages sorting the executables (lazily)

Manages the querySpaces affected by the executables in the list, and caches this too.

Author:

Steve Ebersole, Anton Marsden

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ExecutableList.Sorter<E extends Executable> Provides a sorting interface for ExecutableList.

Field Summary

Fields

Modifier and Type	Field and Description
static int	INIT_QUEUE_LIST_SIZE

Constructor Summary

Constructors

Constructor and Description
ExecutableList() Creates a new ExecutableList with the default settings.
ExecutableList(boolean requiresSorting)
ExecutableList(ExecutableList.Sorter<E> sorter) Creates a new ExecutableList using the specified Sorter.
ExecutableList(int initialCapacity) Creates a new ExecutableList with the specified initialCapacity.
ExecutableList(int initialCapacity, boolean requiresSorting)
ExecutableList(int initialCapacity, ExecutableList.Sorter<E> sorter) Creates a new ExecutableList with the specified initialCapacity and Sorter.

Method Summary

Modifier and Type	Method and Description
boolean	add(E executable) Add an Executable to this list.
void	afterDeserialize(SessionImplementor session) Allow the Executables to re-associate themselves with the Session after deserialization.
void	clear() Clears the list of executions.
E	get(int index)
Set<Serializable>	getQuerySpaces() Lazily constructs the querySpaces affected by the actions in the list.
boolean	isEmpty()
Iterator<E>	iterator() Returns an iterator for the list.
void	readExternal(ObjectInput in) Read this object state back in from the given stream as part of de-serialization
E	remove(int index) Removes the entry at position index in the list.
void	removeLastN(int n) Removes the last n entries from the list.
int	size()
void	sort() Sorts the list using the natural ordering or using the Sorter if it's not null.
String	toString()
void	writeExternal(ObjectOutput oos) Write this list out to the given stream as part of serialization

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

INIT_QUEUE_LIST_SIZE

public static final int INIT_QUEUE_LIST_SIZE

See Also:

Constant Field Values

Constructor Detail

ExecutableList

public ExecutableList()

Creates a new ExecutableList with the default settings.

ExecutableList

public ExecutableList(int initialCapacity)

Creates a new ExecutableList with the specified initialCapacity.

Parameters:

initialCapacity - The initial capacity for instantiating the internal List

ExecutableList

public ExecutableList(boolean requiresSorting)

ExecutableList

public ExecutableList(int initialCapacity,
                      boolean requiresSorting)

ExecutableList

public ExecutableList(ExecutableList.Sorter<E> sorter)

Creates a new ExecutableList using the specified Sorter.

Parameters:

sorter - The Sorter to use; may be null

ExecutableList

public ExecutableList(int initialCapacity,
                      ExecutableList.Sorter<E> sorter)

Creates a new ExecutableList with the specified initialCapacity and Sorter.

Parameters:

initialCapacity - The initial capacity for instantiating the internal List

sorter - The Sorter to use; may be null

Method Detail

getQuerySpaces

public Set<Serializable> getQuerySpaces()

Lazily constructs the querySpaces affected by the actions in the list.

Returns:

the querySpaces affected by the actions in this list

isEmpty

public boolean isEmpty()

Returns:

true if the list is empty.

remove

public E remove(int index)

Removes the entry at position index in the list.

Parameters:

index - The index of the element to remove

Returns:

the entry that was removed

clear

public void clear()

Clears the list of executions.

removeLastN

public void removeLastN(int n)

Removes the last n entries from the list.

Parameters:

n - The number of elements to remove.

add

public boolean add(E executable)

Add an Executable to this list.

Parameters:

executable - the executable to add to the list

Returns:

true if the object was added to the list

sort

public void sort()

Sorts the list using the natural ordering or using the Sorter if it's not null.

size

public int size()

Returns:

the current size of the list

get

public E get(int index)

Parameters:

index - The index of the element to retrieve

Returns:

The element at specified index

iterator

public Iterator<E> iterator()

Returns an iterator for the list. Wraps the list just in case something tries to modify it.

Specified by:

iterator in interface Iterable<E extends Executable & Comparable & Serializable>

Returns:

an unmodifiable iterator

writeExternal

public void writeExternal(ObjectOutput oos)
                   throws IOException

Write this list out to the given stream as part of serialization

Specified by:

writeExternal in interface Externalizable

Parameters:

oos - The stream to which to serialize our state

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Read this object state back in from the given stream as part of de-serialization

Specified by:

readExternal in interface Externalizable

Parameters:

in - The stream from which to read our serial state

Throws:

IOException

ClassNotFoundException

afterDeserialize

public void afterDeserialize(SessionImplementor session)

Allow the Executables to re-associate themselves with the Session after deserialization.

Parameters:

session - The session to which to associate the Executables

toString

public String toString()

Overrides:

toString in class Object