org.eclipse.emf.ecore.util

Class EcoreUtil.ContentTreeIterator<E>

java.lang.Object

<any>

org.eclipse.emf.ecore.util.EcoreUtil.ContentTreeIterator<E>

Enclosing class:

EcoreUtil

public static class EcoreUtil.ContentTreeIterator<E>
extends <any>

An iterator over the tree contents of a collection of EObjects, Resources, and ResourceSets. It provides a special iterator for ResourceSet.getResources that is tolerant of growth in the underlying collection which result from demand loaded resources; the iterator will walk these additional resources.

See Also:

EcoreUtil.getAllContents(EObject, boolean), EcoreUtil.getAllContents(Resource, boolean), EcoreUtil.getAllContents(ResourceSet, boolean)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	EcoreUtil.ContentTreeIterator.ResourcesIterator A special iterator that's tolerant of growth in the list of resources which can result from demand loading when traversing the tree of contents.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	isResolveProxies Whether proxies should be resolved.
protected EcoreUtil.ContentTreeIterator.ResourcesIterator	resourceSetIterator The most recently created iterator over a resource set's resources.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ContentTreeIterator(java.util.Collection<?> emfObjects) Creates an instance for the given collection of objects.
protected	ContentTreeIterator(java.lang.Object object, boolean isResolveProxies) Creates an instance for the given collection of objects.

Method Summary

Modifier and Type	Method and Description
java.util.Iterator<E>	getChildren(java.lang.Object object) Returns an iterator over the children of the given parent object.
protected java.util.Iterator<? extends EObject>	getEObjectChildren(EObject eObject) Returns an iterator over the children of the given parent EObject.
protected java.util.Iterator<E>	getObjectChildren(java.lang.Object object) Returns an empty iterator; subclasses may override this method.
protected java.util.Iterator<EObject>	getResourceChildren(Resource resource) Returns an iterator over the children of the given parent resource.
protected java.util.Iterator<Resource>	getResourceSetChildren(ResourceSet resourceSet) Returns an iterator over the children of the given parent resource set.
boolean	hasNext() Returns the next object and advances the iterator.
protected boolean	isResolveProxies() Returns whether proxies should resolve.

Methods inherited from class java.lang.Object

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

Field Detail

isResolveProxies

protected boolean isResolveProxies

Whether proxies should be resolved.

resourceSetIterator

protected EcoreUtil.ContentTreeIterator.ResourcesIterator resourceSetIterator

The most recently created iterator over a resource set's resources. This iterator needs special handling because it returns true for hasNext() even when the list is exhausted. This ensures that any growth in the resources list will not be overlooked.

Constructor Detail

ContentTreeIterator

protected ContentTreeIterator(java.util.Collection<?> emfObjects)

Creates an instance for the given collection of objects.

Parameters:

emfObjects - the collection of objects to iterate over.

ContentTreeIterator

protected ContentTreeIterator(java.lang.Object object,
                              boolean isResolveProxies)

Creates an instance for the given collection of objects.

Parameters:

object - the collection of objects to iterate over.

isResolveProxies - whether proxies should be resolved during the traversal.

Method Detail

getChildren

public java.util.Iterator<E> getChildren(java.lang.Object object)

Returns an iterator over the children of the given parent object.

Parameters:

object - the parent object.

Returns:

the children iterator.

getEObjectChildren

protected java.util.Iterator<? extends EObject> getEObjectChildren(EObject eObject)

Returns an iterator over the children of the given parent EObject.

Parameters:

eObject - the parent object.

Returns:

the children iterator.

isResolveProxies

protected boolean isResolveProxies()

Returns whether proxies should resolve.

Returns:

whether proxies should resolve.

getResourceChildren

protected java.util.Iterator<EObject> getResourceChildren(Resource resource)

Returns an iterator over the children of the given parent resource.

Parameters:

resource - the parent resource.

Returns:

the children iterator.

hasNext

public boolean hasNext()

Returns the next object and advances the iterator. This override handles the resourceSetIterator in a special way, i.e., it skips the null object that iterator yields as the last fake item of the list.

Returns:

the next object.

getResourceSetChildren

protected java.util.Iterator<Resource> getResourceSetChildren(ResourceSet resourceSet)

Returns an iterator over the children of the given parent resource set. It also records the result in resourceSetIterator for special handling in hasNext().

Parameters:

resourceSet - the parent resource set.

Returns:

the children iterator.

getObjectChildren

protected java.util.Iterator<E> getObjectChildren(java.lang.Object object)

Returns an empty iterator; subclasses may override this method.

Parameters:

object - the parent object.

Returns:

the children iterator.