Module org.jhotdraw8.icollection

Package org.jhotdraw8.icollection.facade

Class CollectionFacade<E>

java.lang.Object

java.util.AbstractCollection<E>

org.jhotdraw8.icollection.facade.CollectionFacade<E>

Type Parameters:

E - the element type

All Implemented Interfaces:

Iterable<E>, Collection<E>, ReadOnlyCollection<E>

Direct Known Subclasses:

SequencedCollectionFacade

public class CollectionFacade<E>
extends AbstractCollection<E>
implements ReadOnlyCollection<E>

Provides a Collection facade to a set of Collection functions.

Author:

Werner Randelshofer

Field Summary

Fields

Modifier and Type	Field	Description
protected final @NonNull Predicate<E>	addFunction
protected final @NonNull Runnable	clearFunction
protected final @NonNull Predicate<Object>	containsFunction
protected final @NonNull Supplier<Iterator<E>>	iteratorFunction
protected final @NonNull Predicate<Object>	removeFunction
protected final @NonNull IntSupplier	sizeFunction
protected final @NonNull Supplier<Spliterator<E>>	spliteratorFunction

Constructor Summary

Constructors

Constructor	Description
CollectionFacade(@NonNull Collection<E> backingCollection)
CollectionFacade(@NonNull Supplier<Iterator<E>> iteratorFunction, @NonNull IntSupplier sizeFunction, @NonNull Predicate<Object> containsFunction)
CollectionFacade(@NonNull Supplier<Iterator<E>> iteratorFunction, @Nullable Supplier<Spliterator<E>> spliteratorFunction, @NonNull IntSupplier sizeFunction, @NonNull Predicate<Object> containsFunction, @Nullable Runnable clearFunction, @Nullable Predicate<E> addFunction, @Nullable Predicate<Object> removeFunction)
CollectionFacade(@NonNull ReadOnlyCollection<E> backingCollection)

Method Summary

Modifier and Type	Method	Description
boolean	add(E e)
void	clear()
boolean	contains(Object o)	Returns true if this collection contains the specified object.
@NonNull Iterator<E>	iterator()	Returns an iterator over the elements in this collection.
boolean	remove(Object o)
int	size()	Returns the size of the collection.
Spliterator<E>	spliterator()
Stream<E>	stream()	Returns a stream.

Methods inherited from class java.util.AbstractCollection

addAll, containsAll, isEmpty, removeAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

equals, hashCode, parallelStream, removeIf, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface org.jhotdraw8.icollection.readonly.ReadOnlyCollection

asCollection, characteristics, containsAll, isEmpty, toArray, toArray

Field Details

iteratorFunction

protected final @NonNull Supplier<Iterator<E>> iteratorFunction

spliteratorFunction

protected final @NonNull Supplier<Spliterator<E>> spliteratorFunction

sizeFunction

protected final @NonNull IntSupplier sizeFunction

containsFunction

protected final @NonNull Predicate<Object> containsFunction

clearFunction

protected final @NonNull Runnable clearFunction

removeFunction

protected final @NonNull Predicate<Object> removeFunction

addFunction

protected final @NonNull Predicate<E> addFunction

Constructor Details

CollectionFacade

public CollectionFacade(@NonNull ReadOnlyCollection<E> backingCollection)

CollectionFacade

public CollectionFacade(@NonNull Collection<E> backingCollection)

CollectionFacade

public CollectionFacade(@NonNull Supplier<Iterator<E>> iteratorFunction,
 @NonNull IntSupplier sizeFunction,
 @NonNull Predicate<Object> containsFunction)

CollectionFacade

public CollectionFacade(@NonNull Supplier<Iterator<E>> iteratorFunction,
 @Nullable Supplier<Spliterator<E>> spliteratorFunction,
 @NonNull IntSupplier sizeFunction,
 @NonNull Predicate<Object> containsFunction,
 @Nullable Runnable clearFunction,
 @Nullable Predicate<E> addFunction,
 @Nullable Predicate<Object> removeFunction)

Method Details

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<E>

Overrides:

remove in class AbstractCollection<E>

add

public boolean add(E e)

Specified by:

add in interface Collection<E>

Overrides:

add in class AbstractCollection<E>

clear

public void clear()

Specified by:

clear in interface Collection<E>

Overrides:

clear in class AbstractCollection<E>

stream

public Stream<E> stream()

Description copied from interface: ReadOnlyCollection

Returns a stream.

Specified by:

stream in interface Collection<E>

Specified by:

stream in interface ReadOnlyCollection<E>

Returns:

a stream

spliterator

public Spliterator<E> spliterator()

Specified by:

spliterator in interface Collection<E>

Specified by:

spliterator in interface Iterable<E>

iterator

public @NonNull Iterator<E> iterator()

Description copied from interface: ReadOnlyCollection

Returns an iterator over the elements in this collection.

Specified by:

iterator in interface Collection<E>

Specified by:

iterator in interface Iterable<E>

Specified by:

iterator in interface ReadOnlyCollection<E>

Specified by:

iterator in class AbstractCollection<E>

Returns:

an iterator

size

public int size()

Description copied from interface: ReadOnlyCollection

Returns the size of the collection.

Specified by:

size in interface Collection<E>

Specified by:

size in interface ReadOnlyCollection<E>

Specified by:

size in class AbstractCollection<E>

Returns:

the size

contains

public boolean contains(Object o)

Description copied from interface: ReadOnlyCollection

Returns true if this collection contains the specified object.

Specified by:

contains in interface Collection<E>

Specified by:

contains in interface ReadOnlyCollection<E>

Overrides:

contains in class AbstractCollection<E>

Parameters:

o - an object

Returns:

true if this collection contains the specified object