org.eclipse.sphinx.emf.util

Class AbstractWrappingEList<W,T>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

org.eclipse.emf.common.util.AbstractEList<W>

org.eclipse.sphinx.emf.util.AbstractWrappingEList<W,T>

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<W>, java.util.Collection<W>, java.util.List<W>, org.eclipse.emf.common.util.EList<W>

Direct Known Subclasses:

BasicWrappingEList

public abstract class AbstractWrappingEList<W,T>
extends org.eclipse.emf.common.util.AbstractEList<W>
implements java.lang.Cloneable, java.io.Serializable

An extensible abstract wrapping delegating list implementation with a wrapping and unwrapping object support.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.emf.common.util.AbstractEList

org.eclipse.emf.common.util.AbstractEList.BasicIndexOutOfBoundsException, org.eclipse.emf.common.util.AbstractEList.EIterator<E1>, org.eclipse.emf.common.util.AbstractEList.EListIterator<E1>, org.eclipse.emf.common.util.AbstractEList.NonResolvingEIterator<E1>, org.eclipse.emf.common.util.AbstractEList.NonResolvingEListIterator<E1>

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Class<T>	targetType
protected java.lang.Class<W>	wrapperType

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
AbstractWrappingEList(java.util.List<T> delegateList, java.lang.Class<W> wrapperType, java.lang.Class<T> targetType) Creates an instance of the AbstractWrappingEList delegating list.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addAllUnique(java.util.Collection<? extends W> collection) Adds each object of the collection to the end of the list; it does no uniqueness checking.
boolean	addAllUnique(int index, java.util.Collection<? extends W> collection) Adds each object of the collection at each successive index in the list and returns whether any objects were added; it does no ranging checking or uniqueness checking.
boolean	addAllUnique(int index, java.lang.Object[] objects, int start, int end) Adds each object from start to end of the array at each successive index in the list and returns whether any objects were added; it does no ranging checking or uniqueness checking.
boolean	addAllUnique(java.lang.Object[] objects, int start, int end) Adds each object from start to end of the array at the index of list and returns whether any objects were added; it does no ranging checking or uniqueness checking.
void	addUnique(int index, W object) Adds the object at the given index in the list; it does no ranging checking or uniqueness checking.
void	addUnique(W object) Adds the object at the end of the list; it does no uniqueness checking.
protected W	basicGet(int index) Returns the object at the index without resolving it.
protected java.util.List<W>	basicList() Returns an unsafe list that provides a non-resolving view of the underlying data storage.
void	clear() Clears the list of all objects.
boolean	contains(java.lang.Object object) Returns whether the list contains the object.
boolean	containsAll(java.util.Collection<?> collection) Returns whether the list contains each object in the collection.
protected void	delegateAdd(int index, W object) Adds the unwrapped object at the given index in the backing store list.
protected void	delegateAdd(W object) Adds the unwrapped object at the end of the backing store list.
protected void	delegateClear() Clears the backing store list of all objects.
protected boolean	delegateContains(java.lang.Object object) Returns whether the backing store list contains the object.
protected boolean	delegateContainsAll(java.util.Collection<?> collection) Returns whether the backing store list contains each object in the collection.
protected boolean	delegateEquals(java.lang.Object object) Returns whether the object is a list with corresponding equal objects to those in the backing store list.
protected W	delegateGet(int index) Returns the wrapped object at the index in the backing store list.
protected int	delegateHashCode() Returns the hash code of the backing store list.
protected int	delegateIndexOf(java.lang.Object object) Returns the position of the first occurrence of the object in the backing store list.
protected boolean	delegateIsEmpty() Returns whether the backing store list has zero size.
protected int	delegateLastIndexOf(java.lang.Object object) Returns the position of the last occurrence of the object in the backing store list.
protected java.util.List<T>	delegateList() Returns the list that acts as the backing store.
protected W	delegateMove(int targetIndex, int sourceIndex) Moves the object at the source index in the backing store list by removing it and adding it at the new target index.
protected W	delegateRemove(int index) Removes the object at the index from the backing store list and returns the wrapped object.
protected W	delegateSet(int index, W object) Sets the unwrapped object at the index in the backing store list and returns the wrapped object at the index.
protected int	delegateSize() Returns the number of objects in the backing store list.
protected java.lang.Object[]	delegateToArray() Returns an array containing all the objects in the backing store list in sequence.
protected <E1> E1[]	delegateToArray(E1[] array) Returns an array containing all the objects in the backing store list in sequence.
protected java.lang.String	delegateToString() Returns a the string form of the backing store list.
protected void	doClear(int oldSize, java.lang.Object[] oldData) Does the actual job of clearing all the objects.
boolean	equals(java.lang.Object object) Returns whether the object is a list with corresponding equal objects.
W	get(int index) Returns the object at the index.
int	hashCode() Returns a hash code computed from each object's hash code.
int	indexOf(java.lang.Object object) Returns the position of the first occurrence of the object in the list.
boolean	isEmpty() Returns whether the list has zero size.
int	lastIndexOf(java.lang.Object object) Returns the position of the last occurrence of the object in the list.
W	move(int targetIndex, int sourceIndex) Moves the object at the source index of the list to the target index of the list and returns the moved object.
protected W	primitiveGet(int index)
W	remove(int index) Removes the object at the index from the list and returns it.
boolean	remove(java.lang.Object object) Removes the object from the list and returns whether the object was actually contained by the list.
boolean	removeAll(java.util.Collection<?> collection) Removes each object of the collection from the list and returns whether any object was actually contained by the list.
boolean	retainAll(java.util.Collection<?> collection) Removes from the list each object not contained by the collection and returns whether any object was actually removed.
W	setUnique(int index, W object) Sets the object at the index and returns the old object at the index; it does no ranging checking or uniqueness checking.
int	size() Returns the number of objects in the list.
java.lang.Object[]	toArray() Returns an array containing all the objects in sequence.
<T1> T1[]	toArray(T1[] array) Returns an array containing all the objects in sequence.
java.lang.String	toString() Returns a string of the form "[object1, object2]".
protected abstract T	unwrap(W object) Unwraps the given object.
protected abstract W	wrap(T object) Wraps the given object.

Methods inherited from class org.eclipse.emf.common.util.AbstractEList

add, add, addAll, addAll, basicIterator, basicListIterator, basicListIterator, canContainNull, didAdd, didChange, didClear, didMove, didRemove, didSet, equalObjects, getDuplicates, getNonDuplicates, isUnique, iterator, listIterator, listIterator, move, resolve, set, useEquals, validate

Methods inherited from class java.util.AbstractList

removeRange, subList

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

subList

Field Detail

targetType

protected java.lang.Class<T> targetType

wrapperType

protected java.lang.Class<W> wrapperType

Constructor Detail

AbstractWrappingEList

public AbstractWrappingEList(java.util.List<T> delegateList,
                     java.lang.Class<W> wrapperType,
                     java.lang.Class<T> targetType)

Creates an instance of the AbstractWrappingEList delegating list.

Parameters:

wrapperType - the wrapper type

targetType - the target object type

Method Detail

wrap

protected abstract W wrap(T object)
                   throws org.eclipse.core.runtime.CoreException

Wraps the given object.

Parameters:

object - object to be wrapped.

Returns:

the wrapped object.

Throws:

org.eclipse.core.runtime.CoreException

unwrap

protected abstract T unwrap(W object)

Unwraps the given object.

Parameters:

object - object to be unwrapped.

Returns:

the unwrapped object.

delegateList

protected java.util.List<T> delegateList()

Returns the list that acts as the backing store.

Returns:

the list that acts as the backing store.

size

public int size()

Returns the number of objects in the list.

Specified by:

size in interface java.util.Collection<W>

Specified by:

size in interface java.util.List<W>

Specified by:

size in class java.util.AbstractCollection<W>

Returns:

the number of objects in the list.

delegateSize

protected int delegateSize()

Returns the number of objects in the backing store list.

Returns:

the number of objects in the backing store list.

isEmpty

public boolean isEmpty()

Returns whether the list has zero size.

Specified by:

isEmpty in interface java.util.Collection<W>

Specified by:

isEmpty in interface java.util.List<W>

Overrides:

isEmpty in class java.util.AbstractCollection<W>

Returns:

whether the list has zero size.

delegateIsEmpty

protected boolean delegateIsEmpty()

Returns whether the backing store list has zero size.

Returns:

whether the backing store list has zero size.

contains

public boolean contains(java.lang.Object object)

Returns whether the list contains the object.

Specified by:

contains in interface java.util.Collection<W>

Specified by:

contains in interface java.util.List<W>

Overrides:

contains in class java.util.AbstractCollection<W>

Parameters:

object - the object in question.

Returns:

whether the list contains the object.

delegateContains

protected boolean delegateContains(java.lang.Object object)

Returns whether the backing store list contains the object.

Parameters:

object - the object in question.

Returns:

whether the backing store list contains the object.

containsAll

public boolean containsAll(java.util.Collection<?> collection)

Returns whether the list contains each object in the collection.

Specified by:

containsAll in interface java.util.Collection<W>

Specified by:

containsAll in interface java.util.List<W>

Overrides:

containsAll in class java.util.AbstractCollection<W>

Returns:

whether the list contains each object in the collection.

See Also:

contains(java.lang.Object), AbstractEList.useEquals()

delegateContainsAll

protected boolean delegateContainsAll(java.util.Collection<?> collection)

Returns whether the backing store list contains each object in the collection.

Returns:

whether the backing store list contains each object in the collection.

See Also:

contains(java.lang.Object), AbstractEList.useEquals()

indexOf

public int indexOf(java.lang.Object object)

Returns the position of the first occurrence of the object in the list.

Specified by:

indexOf in interface java.util.List<W>

Overrides:

indexOf in class java.util.AbstractList<W>

Parameters:

object - the object in question.

Returns:

the position of the first occurrence of the object in the list.

delegateIndexOf

protected int delegateIndexOf(java.lang.Object object)

Returns the position of the first occurrence of the object in the backing store list.

Parameters:

object - the object in question.

Returns:

the position of the first occurrence of the object in the backing store list.

lastIndexOf

public int lastIndexOf(java.lang.Object object)

Returns the position of the last occurrence of the object in the list.

Specified by:

lastIndexOf in interface java.util.List<W>

Overrides:

lastIndexOf in class java.util.AbstractList<W>

Parameters:

object - the object in question.

Returns:

the position of the last occurrence of the object in the list.

delegateLastIndexOf

protected int delegateLastIndexOf(java.lang.Object object)

Returns the position of the last occurrence of the object in the backing store list.

Parameters:

object - the object in question.

Returns:

the position of the last occurrence of the object in the backing store list.

toArray

public java.lang.Object[] toArray()

Returns an array containing all the objects in sequence.

Specified by:

toArray in interface java.util.Collection<W>

Specified by:

toArray in interface java.util.List<W>

Overrides:

toArray in class java.util.AbstractCollection<W>

Returns:

an array containing all the objects in sequence.

delegateToArray

protected java.lang.Object[] delegateToArray()

Returns an array containing all the objects in the backing store list in sequence.

Returns:

an array containing all the objects in the backing store list in sequence.

toArray

public <T1> T1[] toArray(T1[] array)

Returns an array containing all the objects in sequence.

Specified by:

toArray in interface java.util.Collection<W>

Specified by:

toArray in interface java.util.List<W>

Overrides:

toArray in class java.util.AbstractCollection<W>

Parameters:

array - the array that will be filled and returned, if it's big enough; otherwise, a suitably large array of the same type will be allocated and used instead.

Returns:

an array containing all the objects in sequence.

delegateToArray

protected <E1> E1[] delegateToArray(E1[] array)

Returns an array containing all the objects in the backing store list in sequence.

Parameters:

array - the array that will be filled and returned, if it's big enough; otherwise, a suitably large array of the same type will be allocated and used instead.

Returns:

an array containing all the objects in sequence.

get

public W get(int index)

Returns the object at the index. This implementation delegates to resolve so that clients may transform the fetched object.

Specified by:

get in interface java.util.List<W>

Specified by:

get in class java.util.AbstractList<W>

Parameters:

index - the position in question.

Returns:

the object at the index.

Throws:

java.lang.IndexOutOfBoundsException - if the index isn't within the size range.

See Also:

AbstractEList.resolve(int, E), basicGet(int)

delegateGet

protected W delegateGet(int index)

Returns the wrapped object at the index in the backing store list.

Parameters:

index - the position in question.

Returns:

the object at the index.

Throws:

java.lang.IndexOutOfBoundsException - if the index isn't within the size range.

basicGet

protected W basicGet(int index)

Returns the object at the index without resolving it.

Overrides:

basicGet in class org.eclipse.emf.common.util.AbstractEList<W>

Parameters:

index - the position in question.

Returns:

the object at the index.

Throws:

java.lang.IndexOutOfBoundsException - if the index isn't within the size range.

See Also:

AbstractEList.resolve(int, E), get(int)

primitiveGet

protected W primitiveGet(int index)

Specified by:

primitiveGet in class org.eclipse.emf.common.util.AbstractEList<W>

setUnique

public W setUnique(int index,
          W object)

Sets the object at the index and returns the old object at the index; it does no ranging checking or uniqueness checking. This implementation delegates to didSet and didChange.

Specified by:

setUnique in class org.eclipse.emf.common.util.AbstractEList<W>

Parameters:

index - the position in question.

object - the object to set.

Returns:

the old object at the index.

See Also:

AbstractEList.set(int, E)

delegateSet

protected W delegateSet(int index,
            W object)

Sets the unwrapped object at the index in the backing store list and returns the wrapped object at the index.

Parameters:

object - the object to set.

Returns:

the old object at the index.

addUnique

public void addUnique(W object)

Adds the object at the end of the list; it does no uniqueness checking. This implementation delegates to didAdd and didChange. after uniqueness checking.

Specified by:

addUnique in class org.eclipse.emf.common.util.AbstractEList<W>

Parameters:

object - the object to be added.

See Also:

AbstractEList.add(Object)

delegateAdd

protected void delegateAdd(W object)

Adds the unwrapped object at the end of the backing store list.

Parameters:

object - the object to be added.

addUnique

public void addUnique(int index,
             W object)

Adds the object at the given index in the list; it does no ranging checking or uniqueness checking. This implementation delegates to didAdd and didChange.

Specified by:

addUnique in class org.eclipse.emf.common.util.AbstractEList<W>

Parameters:

object - the object to be added.

See Also:

AbstractEList.add(int, Object)

delegateAdd

protected void delegateAdd(int index,
               W object)

Adds the unwrapped object at the given index in the backing store list.

Parameters:

object - the object to be added.

addAllUnique

public boolean addAllUnique(java.util.Collection<? extends W> collection)

Adds each object of the collection to the end of the list; it does no uniqueness checking. This implementation delegates to didAdd and didChange.

Specified by:

addAllUnique in class org.eclipse.emf.common.util.AbstractEList<W>

Parameters:

collection - the collection of objects to be added.

See Also:

AbstractEList.addAll(Collection)

addAllUnique

public boolean addAllUnique(int index,
                   java.util.Collection<? extends W> collection)

Adds each object of the collection at each successive index in the list and returns whether any objects were added; it does no ranging checking or uniqueness checking. This implementation delegates to didAdd and didChange.

Specified by:

addAllUnique in class org.eclipse.emf.common.util.AbstractEList<W>

Parameters:

index - the index at which to add.

collection - the collection of objects to be added.

Returns:

whether any objects were added.

See Also:

AbstractEList.addAll(int, Collection)

addAllUnique

public boolean addAllUnique(java.lang.Object[] objects,
                   int start,
                   int end)

Adds each object from start to end of the array at the index of list and returns whether any objects were added; it does no ranging checking or uniqueness checking. This implementation delegates to delegatedAdd, didAdd, and didChange.

Specified by:

addAllUnique in class org.eclipse.emf.common.util.AbstractEList<W>

Parameters:

objects - the objects to be added.

start - the index of first object to be added.

end - the index past the last object to be added.

Returns:

whether any objects were added.

See Also:

addAllUnique(int, Object[], int, int)

addAllUnique

public boolean addAllUnique(int index,
                   java.lang.Object[] objects,
                   int start,
                   int end)

Adds each object from start to end of the array at each successive index in the list and returns whether any objects were added; it does no ranging checking or uniqueness checking. This implementation delegates to delegatedAdd, didAdd, and didChange.

Specified by:

addAllUnique in class org.eclipse.emf.common.util.AbstractEList<W>

Parameters:

index - the index at which to add.

objects - the objects to be added.

start - the index of first object to be added.

end - the index past the last object to be added.

Returns:

whether any objects were added.

See Also:

addAllUnique(Object[], int, int)

remove

public boolean remove(java.lang.Object object)

Removes the object from the list and returns whether the object was actually contained by the list. This implementation uses indexOf to find the object and delegates to remove(int) in the case that it finds the object.

Specified by:

remove in interface java.util.Collection<W>

Specified by:

remove in interface java.util.List<W>

Overrides:

remove in class org.eclipse.emf.common.util.AbstractEList<W>

Parameters:

object - the object to be removed.

Returns:

whether the object was actually contained by the list.

removeAll

public boolean removeAll(java.util.Collection<?> collection)

Removes each object of the collection from the list and returns whether any object was actually contained by the list.

Specified by:

removeAll in interface java.util.Collection<W>

Specified by:

removeAll in interface java.util.List<W>

Overrides:

removeAll in class org.eclipse.emf.common.util.AbstractEList<W>

Parameters:

collection - the collection of objects to be removed.

Returns:

whether any object was actually contained by the list.

remove

public W remove(int index)

Removes the object at the index from the list and returns it. This implementation delegates to didRemove and didChange.

Specified by:

remove in interface java.util.List<W>

Specified by:

remove in class org.eclipse.emf.common.util.AbstractEList<W>

Parameters:

index - the position of the object to remove.

Returns:

the removed object.

Throws:

java.lang.IndexOutOfBoundsException - if the index isn't within the size range.

delegateRemove

protected W delegateRemove(int index)

Removes the object at the index from the backing store list and returns the wrapped object.

Returns:

the removed object.

Throws:

java.lang.IndexOutOfBoundsException - if the index isn't within the size range.

retainAll

public boolean retainAll(java.util.Collection<?> collection)

Removes from the list each object not contained by the collection and returns whether any object was actually removed. This delegates to remove(int) in the case that it finds an object that isn't retained.

Specified by:

retainAll in interface java.util.Collection<W>

Specified by:

retainAll in interface java.util.List<W>

Overrides:

retainAll in class org.eclipse.emf.common.util.AbstractEList<W>

Parameters:

collection - the collection of objects to be retained.

Returns:

whether any object was actually removed.

clear

public void clear()

Clears the list of all objects.

Specified by:

clear in interface java.util.Collection<W>

Specified by:

clear in interface java.util.List<W>

Overrides:

clear in class java.util.AbstractList<W>

doClear

protected void doClear(int oldSize,
           java.lang.Object[] oldData)

Does the actual job of clearing all the objects.

Parameters:

oldSize - the size of the list before it is cleared.

oldData - old values of the list before it is cleared.

delegateClear

protected void delegateClear()

Clears the backing store list of all objects.

move

public W move(int targetIndex,
     int sourceIndex)

Moves the object at the source index of the list to the target index of the list and returns the moved object. This implementation delegates to didMove and didChange.

Specified by:

move in interface org.eclipse.emf.common.util.EList<W>

Specified by:

move in class org.eclipse.emf.common.util.AbstractEList<W>

Parameters:

targetIndex - the new position for the object in the list.

sourceIndex - the old position of the object in the list.

Returns:

the moved object.

Throws:

java.lang.IndexOutOfBoundsException - if either index isn't within the size range.

delegateMove

protected W delegateMove(int targetIndex,
             int sourceIndex)

Moves the object at the source index in the backing store list by removing it and adding it at the new target index.

Parameters:

targetIndex - the new position for the object in the list.

sourceIndex - the old position of the object in the list.

Returns:

the moved object.

Throws:

java.lang.IndexOutOfBoundsException - if either index isn't within the size range.

Since:

2.3

equals

public boolean equals(java.lang.Object object)

Returns whether the object is a list with corresponding equal objects. This implementation uses either equals or "==" depending on useEquals.

Specified by:

equals in interface java.util.Collection<W>

Specified by:

equals in interface java.util.List<W>

Overrides:

equals in class org.eclipse.emf.common.util.AbstractEList<W>

Returns:

whether the object is a list with corresponding equal objects.

See Also:

AbstractEList.useEquals()

delegateEquals

protected boolean delegateEquals(java.lang.Object object)

Returns whether the object is a list with corresponding equal objects to those in the backing store list.

Returns:

whether the object is a list with corresponding equal objects.

hashCode

public int hashCode()

Returns a hash code computed from each object's hash code.

Specified by:

hashCode in interface java.util.Collection<W>

Specified by:

hashCode in interface java.util.List<W>

Overrides:

hashCode in class org.eclipse.emf.common.util.AbstractEList<W>

Returns:

a hash code.

delegateHashCode

protected int delegateHashCode()

Returns the hash code of the backing store list.

Returns:

a hash code.

toString

public java.lang.String toString()

Returns a string of the form "[object1, object2]".

Overrides:

toString in class org.eclipse.emf.common.util.AbstractEList<W>

Returns:

a string of the form "[object1, object2]".

delegateToString

protected java.lang.String delegateToString()

Returns a the string form of the backing store list.

Returns:

a the string form of the backing store list.

basicList

protected java.util.List<W> basicList()

Returns an unsafe list that provides a non-resolving view of the underlying data storage.

Specified by:

basicList in class org.eclipse.emf.common.util.AbstractEList<W>

Returns:

an unsafe list that provides a non-resolving view of the underlying data storage.