Module org.jhotdraw8.icollection

Package org.jhotdraw8.icollection.facade

Class SetFacade<E>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractSet<E>

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

Type Parameters:

E - the element type

All Implemented Interfaces:

Iterable<E>, Collection<E>, Set<E>, ReadOnlyCollection<E>, ReadOnlySet<E>

Direct Known Subclasses:

SequencedSetFacade

public class SetFacade<E>
extends AbstractSet<E>
implements ReadOnlySet<E>

Provides a Set facade to a set of Set 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
SetFacade(@NonNull Set<E> backingSet)
SetFacade(@NonNull Supplier<Iterator<E>> iteratorFunction, @NonNull IntSupplier sizeFunction, @NonNull Predicate<Object> containsFunction)
SetFacade(@NonNull Supplier<Iterator<E>> iteratorFunction, @NonNull Supplier<Spliterator<E>> spliteratorFunction, @NonNull IntSupplier sizeFunction, @NonNull Predicate<Object> containsFunction, @Nullable Runnable clearFunction, @Nullable Predicate<E> addFunction, @Nullable Predicate<Object> removeFunction)
SetFacade(@NonNull ReadOnlySet<E> backingSet)

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.
boolean	equals(Object o)	Compares the specified object with this set for equality.
@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.AbstractSet

hashCode, removeAll

Methods inherited from class java.util.AbstractCollection

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

parallelStream, removeIf, toArray

Methods inherited from interface java.lang.Iterable

forEach

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

asCollection, containsAll, isEmpty, toArray, toArray

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

asSet, characteristics, hashCode

Methods inherited from interface java.util.Set

addAll, containsAll, isEmpty, retainAll, 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

addFunction

protected final @NonNull Predicate<E> addFunction

clearFunction

protected final @NonNull Runnable clearFunction

removeFunction

protected final @NonNull Predicate<Object> removeFunction

Constructor Details

SetFacade

public SetFacade(@NonNull ReadOnlySet<E> backingSet)

SetFacade

public SetFacade(@NonNull Set<E> backingSet)

SetFacade

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

SetFacade

public SetFacade(@NonNull Supplier<Iterator<E>> iteratorFunction,
 @NonNull 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>

Specified by:

remove in interface Set<E>

Overrides:

remove in class AbstractCollection<E>

clear

public void clear()

Specified by:

clear in interface Collection<E>

Specified by:

clear in interface Set<E>

Overrides:

clear in class AbstractCollection<E>

spliterator

public Spliterator<E> spliterator()

Specified by:

spliterator in interface Collection<E>

Specified by:

spliterator in interface Iterable<E>

Specified by:

spliterator in interface Set<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

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 interface Set<E>

Specified by:

iterator in class AbstractCollection<E>

Returns:

an iterator

equals

public boolean equals(Object o)

Description copied from interface: ReadOnlySet

Compares the specified object with this set for equality.

Returns true if the given object is also a read-only set and the two sets contain the same elements, ignoring the sequence of the elements.

Implementations of this method should use ReadOnlySet.setEquals(org.jhotdraw8.icollection.readonly.ReadOnlySet<E>, java.lang.Object).

Specified by:

equals in interface Collection<E>

Specified by:

equals in interface ReadOnlySet<E>

Specified by:

equals in interface Set<E>

Overrides:

equals in class AbstractSet<E>

Parameters:

o - an object

Returns:

true if the object is equal to this map

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 interface Set<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>

Specified by:

contains in interface Set<E>

Overrides:

contains in class AbstractCollection<E>

Parameters:

o - an object

Returns:

true if this collection contains the specified object

add

public boolean add(E e)

Specified by:

add in interface Collection<E>

Specified by:

add in interface Set<E>

Overrides:

add in class AbstractCollection<E>