javolution.util.internal.collection.MappedCollectionImpl< E, R > Class Template Reference

Inheritance diagram for javolution.util.internal.collection.MappedCollectionImpl< E, R >:

Collaboration diagram for javolution.util.internal.collection.MappedCollectionImpl< E, R >:

Classes
class	IteratorImpl

Public Member Functions
	MappedCollectionImpl (CollectionService< E > target, Function<? super E, ? extends R > function)
boolean	add (R element)
void	clear ()
Equality<? super R >	comparator ()
boolean	isEmpty ()
Iterator< R >	iterator ()
int	size ()
abstract boolean	add (E element)
boolean	addAll (Collection<? extends E > c)
CollectionView< E >	clone ()
boolean	contains (Object obj)
boolean	containsAll (Collection<?> c)
boolean	equals (Object o)
int	hashCode ()
void	perform (Consumer< CollectionService< E >> action, CollectionService< E > view)
boolean	remove (Object obj)
boolean	removeAll (Collection<?> c)
boolean	retainAll (Collection<?> c)
CollectionService< E >[]	split (int n)
CollectionService< E >	threadSafe ()
Object[]	toArray ()
void	update (Consumer< CollectionService< E >> action, CollectionService< E > view)

Protected Member Functions
CollectionService< E >	target ()
CollectionService< E >	service ()

Protected Attributes
final Function<? super E, ? extends R >	function

Package Functions
public< T > T[]	toArray (T[] a)

Private Attributes
CollectionService< E >	target

Static Private Attributes
static final long	serialVersionUID = 0x600L

Detailed Description

A mapped view over a collection.

Definition at line 21 of file MappedCollectionImpl.java.

Constructor & Destructor Documentation

MappedCollectionImpl()

javolution.util.internal.collection.MappedCollectionImpl< E, R >.MappedCollectionImpl	(	CollectionService< E >	target,
		Function<? super E, ? extends R >	function
	)

Definition at line 53 of file MappedCollectionImpl.java.

                                                       {
        super((CollectionService<R>) target); // Beware target is of type <E>
        this.function = function;
    }

Member Function Documentation

add() [1/2]

abstract boolean javolution.util.internal.collection.CollectionView< E >.add ( E  element )

abstractinherited

Adds the specified element to this collection

add() [2/2]

boolean javolution.util.internal.collection.MappedCollectionImpl< E, R >.add

(

R

element

)

Reimplemented in javolution.util.internal.set.MappedSetImpl< E, R >.

Definition at line 60 of file MappedCollectionImpl.java.

                                  {
        throw new UnsupportedOperationException(
                "New elements cannot be added to mapped views");
    }

addAll()

boolean javolution.util.internal.collection.CollectionView< E >.addAll ( Collection<? extends E >  c )

inherited

Adds all the specified elements to this collection.

Definition at line 46 of file CollectionView.java.

                                                     {
        boolean changed = false;
        Iterator<? extends E> it = c.iterator();
        while (it.hasNext()) {
            if (add(it.next())) changed = true;
        }
        return changed;
    }

clear()

void javolution.util.internal.collection.MappedCollectionImpl< E, R >.clear

(

)

Definition at line 66 of file MappedCollectionImpl.java.

                        {
        target().clear();
    }

clone()

CollectionView<E> javolution.util.internal.collection.CollectionView< E >.clone

inherited

Returns a copy of this collection; updates of the copy should not impact the original.

Definition at line 66 of file CollectionView.java.

                                     {
        try {
            CollectionView<E> copy = (CollectionView<E>) super.clone();
            if (target != null) { // Not a root class.
                copy.target = target.clone();
            }
            return copy;
        } catch (CloneNotSupportedException e) {
            throw new Error("Should not happen since target is cloneable");
        }
    }

comparator()

Equality<? super R> javolution.util.internal.collection.MappedCollectionImpl< E, R >.comparator

(

)

Reimplemented in javolution.util.internal.map.MapView< K, V >.Values, and javolution.util.internal.map.MapView< K, V >.KeySet.

Definition at line 71 of file MappedCollectionImpl.java.

                                            {
        return Equalities.STANDARD;
    }

contains()

boolean javolution.util.internal.collection.CollectionView< E >.contains ( Object  obj )

inherited

Indicates if this collection contains the specified element.

Definition at line 83 of file CollectionView.java.

                                        {
        Iterator<? extends E> it = iterator();
        Equality<Object> cmp = (Equality<Object>) comparator();
        while (it.hasNext()) {
            if (cmp.areEqual(obj, it.next())) return true;
        }
        return false;
    }

containsAll()

boolean javolution.util.internal.collection.CollectionView< E >.containsAll ( Collection<?>  c )

inherited

Indicates if this collection contains all the specified elements.

Definition at line 93 of file CollectionView.java.

                                                {
        for (Object e : c) {
            if (!contains(e)) return false;
        }
        return true;
    }

equals()

boolean javolution.util.internal.collection.CollectionView< E >.equals ( Object  o )

inherited

Compares the specified object with this collection for equality. This method follows the Collection#equals(Object) specification if this collection comparator is Equalities#STANDARD (default). Otherwise, only collections using the same comparator can be considered equals.

Parameters

obj	the object to be compared for equality with this collection

Returns

true if both collections are considered equals; false otherwise.

Definition at line 102 of file CollectionView.java.

                                    {
        // Follow Collection.equals specification if this comparator is standard.        
        if (this == o) return true;
        // Check comparators consistency.
        if (o instanceof CollectionService) {
            if (!comparator().equals(((CollectionService<E>) o).comparator())) return false; // Different comparators.
        } else {
            if (!comparator().equals(Equalities.STANDARD)) return false;
        }
        // Collection.equals contract.
        if (this instanceof Set) {
            if (!(o instanceof Set)) return false;
            Set<E> set = (Set<E>) o;
            return (size() == set.size()) && containsAll(set);
        } else if (this instanceof List) {
            if (!(o instanceof List)) return false;
            List<E> list = (List<E>) o;
            if (size() != list.size()) return false; // Short-cut.
            Equality<? super E> cmp = comparator();
            Iterator<E> it1 = this.iterator();
            Iterator<E> it2 = list.iterator();
            while (it1.hasNext()) {
                if (!it2.hasNext()) return false;
                if (!cmp.areEqual(it1.next(), it2.next())) return false;
            }
            if (it2.hasNext()) return false;
            return true;
        } else {
            return false;
        }
    }

hashCode()

int javolution.util.internal.collection.CollectionView< E >.hashCode

inherited

Returns the hash code of this collection. This method follows the Collection#hashCode() specification if this collection comparator is Equalities#STANDARD.

Returns

this collection hash code.

Definition at line 135 of file CollectionView.java.

                          {
        // Follow Collection.equals specification if this comparator is standard.        
        Equality<? super E> cmp = comparator();
        Iterator<E> it = this.iterator();
        int hash = 0;
        if (this instanceof Set) {
            while (it.hasNext()) {
                hash += cmp.hashCodeOf(it.next());
            }
        } else if (this instanceof List) {
            while (it.hasNext()) {
                hash += 31 * hash + cmp.hashCodeOf(it.next());
            }
        } else {
            hash = super.hashCode();
        }
        return hash;
    }

isEmpty()

boolean javolution.util.internal.collection.MappedCollectionImpl< E, R >.isEmpty

(

)

Definition at line 76 of file MappedCollectionImpl.java.

                             {
        return target().isEmpty();
    }

iterator()

Iterator<R> javolution.util.internal.collection.MappedCollectionImpl< E, R >.iterator

(

)

Definition at line 81 of file MappedCollectionImpl.java.

                                  {
        return new IteratorImpl();
    }

perform()

void javolution.util.internal.collection.CollectionView< E >.perform ( Consumer< CollectionService< E >>  action, CollectionService< E >  view  )

inherited

Definition at line 163 of file CollectionView.java.

                                                                                          {
        if (target == null) {
            action.accept(view);
        } else {
            target.perform(action, view);
        }
    }

remove()

boolean javolution.util.internal.collection.CollectionView< E >.remove ( Object  obj )

inherited

Removes the specified element from this collection.

Definition at line 173 of file CollectionView.java.

                                      {
        Iterator<? extends E> it = iterator();
        Equality<Object> cmp = (Equality<Object>) comparator();
        while (it.hasNext()) {
            if (cmp.areEqual(obj, it.next())) {
                it.remove();
                return true;
            }
        }
        return false;
    }

removeAll()

boolean javolution.util.internal.collection.CollectionView< E >.removeAll ( Collection<?>  c )

inherited

Removes all the specified element from this collection.

Definition at line 186 of file CollectionView.java.

                                              {
        boolean changed = false;
        Iterator<? extends E> it = iterator();
        while (it.hasNext()) {
            if (c.contains(it.next())) {
                it.remove();
                changed = true;
            }
        }
        return changed;
    }

retainAll()

boolean javolution.util.internal.collection.CollectionView< E >.retainAll ( Collection<?>  c )

inherited

Removes all the elements except those in the specified collection.

Definition at line 199 of file CollectionView.java.

                                              {
        boolean changed = false;
        Iterator<? extends E> it = iterator();
        while (it.hasNext()) {
            if (!c.contains(it.next())) {
                it.remove();
                changed = true;
            }
        }
        return changed;
    }

service()

CollectionService<E> javolution.util.internal.collection.CollectionView< E >.service

protectedinherited

Returns the service implementation of this collection (for sub-classes).

Definition at line 274 of file CollectionView.java.

                                             {
        return this;
    }

size()

int javolution.util.internal.collection.MappedCollectionImpl< E, R >.size

(

)

Definition at line 86 of file MappedCollectionImpl.java.

                      {
        return target().size();
    }

split()

CollectionService<E> [] javolution.util.internal.collection.CollectionView< E >.split ( int  n )

inherited

Returns

n 

distinct parts of this object. This method may return an array of size less than

n 

(e.g. an array of size one if this object cannot split).

Parameters

n	the number of parts.

Returns

the distinct parts (or views) for this object.

Exceptions

IllegalArgumentException

if n <= 1

Definition at line 224 of file CollectionView.java.

                                               {
        if (target == null) return new CollectionService[] { this }; // No split.
        CollectionService<E>[] subTargets = target.split(n);
        CollectionService<E>[] result = new CollectionService[subTargets.length];
        for (int i = 0; i < subTargets.length; i++) {
            CollectionView<E> copy = this.clone();
            copy.target = subTargets[i];
            result[i] = copy;
        }
        return result;
    }

target()

CollectionService<E> javolution.util.internal.collection.CollectionView< E >.target

protectedinherited

Returns the actual target

Definition at line 279 of file CollectionView.java.

                                            {
        return target;
    }

threadSafe()

CollectionService<E> javolution.util.internal.collection.CollectionView< E >.threadSafe

inherited

Returns a thread-safe version of this service (used during parallel updates).

Definition at line 237 of file CollectionView.java.

                                             {
        // We use shared collection as default (they can split).
        return new SharedCollectionImpl<E>(this); 
    }

toArray() [1/2]

Object [] javolution.util.internal.collection.CollectionView< E >.toArray

inherited

Returns an array holding this collection elements.

Definition at line 243 of file CollectionView.java.

                              {
        return toArray(new Object[size()]);
    }

toArray() [2/2]

public<T> T [] javolution.util.internal.collection.CollectionView< E >.toArray ( T[]  a )

packageinherited

Returns the specified array holding this collection elements if enough capacity.

Definition at line 249 of file CollectionView.java.

                                  {
        final int size = size();
        final T[] result = (size <= a.length) ? a
                : (T[]) java.lang.reflect.Array.newInstance(a.getClass()
                        .getComponentType(), size);
        int i = 0;
        Iterator<E> it = iterator();
        while (it.hasNext()) {
            result[i++] = (T) it.next();
        }
        if (result.length > size) {
            result[size] = null; // As per Collection contract.
        }
        return result;
    }

update()

void javolution.util.internal.collection.CollectionView< E >.update ( Consumer< CollectionService< E >>  action, CollectionService< E >  view  )

inherited

Definition at line 266 of file CollectionView.java.

                                                                                         {
        if (target == null) {
            action.accept(view);
        } else {
            target.perform(action, view);
        }
    }

Member Data Documentation

function

final Function<? super E, ? extends R> javolution.util.internal.collection.MappedCollectionImpl< E, R >.function

protected

Definition at line 50 of file MappedCollectionImpl.java.

serialVersionUID

final long javolution.util.internal.collection.MappedCollectionImpl< E, R >.serialVersionUID = 0x600L

staticprivate

Definition at line 49 of file MappedCollectionImpl.java.

target

CollectionService<E> javolution.util.internal.collection.CollectionView< E >.target

privateinherited

Definition at line 33 of file CollectionView.java.

---

The documentation for this class was generated from the following file:

• MappedCollectionImpl.java