Module org.eclipse.persistence.core

Package org.eclipse.persistence.internal.core.queries

Interface CoreContainerPolicy<ABSTRACT_SESSION extends CoreAbstractSession>

All Known Subinterfaces:

CoreMappedKeyMapContainerPolicy<ABSTRACT_SESSION>

All Known Implementing Classes:

ArrayListContainerPolicy, CollectionContainerPolicy, ContainerPolicy, CursoredStreamPolicy, CursorPolicy, IndirectListContainerPolicy, InterfaceContainerPolicy, ListContainerPolicy, MapContainerPolicy, MappedKeyMapContainerPolicy, OrderedListContainerPolicy, ScrollableCursorPolicy, SortedCollectionContainerPolicy, VectorContainerPolicy

public interface CoreContainerPolicy<ABSTRACT_SESSION extends CoreAbstractSession>

Method Summary

Modifier and Type	Method	Description
boolean	addInto(Object element, Object container, ABSTRACT_SESSION session)	INTERNAL: Add element to container.
boolean	addInto(Object key, Object element, Object container, ABSTRACT_SESSION session)	INTERNAL: Add element to container.
void	clear(Object container)	INTERNAL: Remove all the elements from the specified container.
Object	containerInstance()	INTERNAL: Return an instance of the container class.
Object	containerInstance(int initialCapacity)	INTERNAL: Return an instance of the container class with the specified initial capacity.
boolean	contains(Object element, Object container, ABSTRACT_SESSION session)	INTERNAL: Check if the object is contained in the collection.
boolean	hasNext(Object iterator)	INTERNAL: Return whether the iterator has more objects.
boolean	isEmpty(Object container)	INTERNAL: Return whether the container is empty.
boolean	isListPolicy()
Object	iteratorFor(Object container)	INTERNAL: Return an iterator for the given container.
Object	next(Object iterator, ABSTRACT_SESSION session)	INTERNAL: Return the next object from the iterator.
Object	nextEntry(Object iterator)	INTERNAL: Return the next object on the queue.
Object	nextEntry(Object iterator, ABSTRACT_SESSION session)	INTERNAL: Return the next object on the queue.
boolean	removeFrom(Object element, Object container, ABSTRACT_SESSION session)	INTERNAL: Remove the object from the collection.
void	setContainerClass(Class<?> containerClass)	INTERNAL: Set the class used for the container.
int	sizeFor(Object container)	INTERNAL: Return the size of container.
Vector	vectorFor(Object container, ABSTRACT_SESSION session)	INTERNAL: Return a Vector populated with the contents of container.

Method Details

addInto

boolean addInto(Object element,
 Object container,
 ABSTRACT_SESSION session)

INTERNAL: Add element to container. This is used to add to a collection independent of JDK 1.1 and 1.2. The session may be required to wrap for the wrapper policy. Return whether the container changed

addInto

boolean addInto(Object key,
 Object element,
 Object container,
 ABSTRACT_SESSION session)

INTERNAL: Add element to container. This is used to add to a collection independent of type. The session may be required to wrap for the wrapper policy. Return whether the container changed.

clear

void clear(Object container)

INTERNAL: Remove all the elements from the specified container. Valid only for certain subclasses.

containerInstance

Object containerInstance()

INTERNAL: Return an instance of the container class. Null should never be returned. A ValidationException is thrown on error.

contains

boolean contains(Object element,
 Object container,
 ABSTRACT_SESSION session)

INTERNAL: Check if the object is contained in the collection. This is used to check contains in a collection independent of JDK 1.1 and 1.2. The session may be required to unwrap for the wrapper policy.

hasNext

boolean hasNext(Object iterator)

INTERNAL: Return whether the iterator has more objects. The iterator is the one returned from #iteratorFor(). Valid for some subclasses only.

See Also:

• ContainerPolicy.iteratorFor(Object)

isEmpty

boolean isEmpty(Object container)

INTERNAL: Return whether the container is empty.

isListPolicy

boolean isListPolicy()

iteratorFor

Object iteratorFor(Object container)

INTERNAL: Return an iterator for the given container. This iterator can then be used as a parameter to #hasNext() and #next().

See Also:

• ContainerPolicy.hasNext(Object)
• ContainerPolicy.next(Object, org.eclipse.persistence.internal.sessions.AbstractSession)

next

Object next(Object iterator,
 ABSTRACT_SESSION session)

INTERNAL: Return the next object from the iterator. This is used to stream over a collection independent of JDK 1.1 and 1.2. The session may be required to unwrap for the wrapper policy.

nextEntry

Object nextEntry(Object iterator)

INTERNAL: Return the next object on the queue. The iterator is the one returned from #iteratorFor(). In the case of a Map, this will return a MapEntry to allow use of the key

See Also:

• ContainerPolicy.iteratorFor(Object)
• MapContainerPolicy.unwrapIteratorResult(Object)

nextEntry

Object nextEntry(Object iterator,
 ABSTRACT_SESSION session)

INTERNAL: Return the next object on the queue. The iterator is the one returned from #iteratorFor(). In the case of a Map, this will return a MapEntry to allow use of the key

See Also:

• ContainerPolicy.iteratorFor(Object)
• MapContainerPolicy.unwrapIteratorResult(Object)

removeFrom

boolean removeFrom(Object element,
 Object container,
 ABSTRACT_SESSION session)

INTERNAL: Remove the object from the collection. This is used to remove from a collection independent of JDK 1.1 and 1.2. The session may be required to unwrap for the wrapper policy.

setContainerClass

void setContainerClass(Class<?> containerClass)

INTERNAL: Set the class used for the container.

sizeFor

int sizeFor(Object container)

INTERNAL: Return the size of container.

vectorFor

Vector vectorFor(Object container,
 ABSTRACT_SESSION session)

INTERNAL: Return a Vector populated with the contents of container. Added for bug 2766379, must implement a version of vectorFor that handles wrapped objects.

containerInstance

Object containerInstance(int initialCapacity)

INTERNAL: Return an instance of the container class with the specified initial capacity. Null should never be returned. A ValidationException is thrown on error.