Module com.aoapps.collections

Package com.aoapps.collections

Class UnionSet<E>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractSet<E>

com.aoapps.collections.UnionSet<E>

All Implemented Interfaces:

Iterable<E>, Collection<E>, Set<E>

public class UnionSet<E>
extends AbstractSet<E>

In order to efficiently provide a union of fewer, larger sets, this provides a set view on top of other sets. Any set that is added to this union set via addAll(Set) must not be modified after being added. For performance purposes, defensive copying is not performed.

Author:

AO Industries, Inc.

Constructor Summary

Constructors

Constructor	Description
UnionSet()
UnionSet(Collection<? extends E> c)
UnionSet(Set<? extends E> set)

Method Summary

Modifier and Type	Method	Description
boolean	add(E e)
boolean	addAll(Collection<? extends E> c)	Triggers combining.
void	addAll(Set<? extends E> set)	If the set has size > MAXIMUM_COMBINE_SIZE, the set will be added to the added list, which may then be later combined only when needed.
void	clear()
boolean	contains(Object o)
boolean	containsAll(Collection<?> c)
boolean	isEmpty()
Iterator<E>	iterator()	Triggers combining.
boolean	remove(Object o)	Triggers combining.
boolean	removeAll(Collection<?> c)	Triggers combining.
boolean	retainAll(Collection<?> c)	Triggers combining.
int	size()	Triggers combining.
Object[]	toArray()	Triggers combining.
<T> T[]	toArray(T[] a)	Triggers combining.

Methods inherited from class java.util.AbstractSet

equals, hashCode

Methods inherited from class java.util.AbstractCollection

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, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.Set

spliterator

Constructor Details

UnionSet

public UnionSet()

UnionSet

public UnionSet(Collection<? extends E> c)

UnionSet

public UnionSet(Set<? extends E> set)

Method Details

size

public int size()

Triggers combining.

Specified by:

size in interface Collection<E>

Specified by:

size in interface Set<E>

Specified by:

size in class AbstractCollection<E>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<E>

Specified by:

isEmpty in interface Set<E>

Overrides:

isEmpty in class AbstractCollection<E>

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection<E>

Specified by:

contains in interface Set<E>

Overrides:

contains in class AbstractCollection<E>

iterator

public Iterator<E> iterator()

Triggers combining.

TODO: Iterate without combining - benchmark speed versus complexity

Specified by:

iterator in interface Collection<E>

Specified by:

iterator in interface Iterable<E>

Specified by:

iterator in interface Set<E>

Specified by:

iterator in class AbstractCollection<E>

toArray

public Object[] toArray()

Triggers combining.

Specified by:

toArray in interface Collection<E>

Specified by:

toArray in interface Set<E>

Overrides:

toArray in class AbstractCollection<E>

toArray

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

Triggers combining.

Specified by:

toArray in interface Collection<E>

Specified by:

toArray in interface Set<E>

Overrides:

toArray in class AbstractCollection<E>

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>

remove

public boolean remove(Object o)

Triggers combining.

Specified by:

remove in interface Collection<E>

Specified by:

remove in interface Set<E>

Overrides:

remove in class AbstractCollection<E>

containsAll

public boolean containsAll(Collection<?> c)

Specified by:

containsAll in interface Collection<E>

Specified by:

containsAll in interface Set<E>

Overrides:

containsAll in class AbstractCollection<E>

addAll

public boolean addAll(Collection<? extends E> c)

Triggers combining.

Specified by:

addAll in interface Collection<E>

Specified by:

addAll in interface Set<E>

Overrides:

addAll in class AbstractCollection<E>

See Also:

• addAll(java.util.Set)

addAll

public void addAll(Set<? extends E> set)

If the set has size > MAXIMUM_COMBINE_SIZE, the set will be added to the added list, which may then be later combined only when needed. Because of this potentially delayed combining, any set added should not be subsequently altered.

retainAll

public boolean retainAll(Collection<?> c)

Triggers combining.

Specified by:

retainAll in interface Collection<E>

Specified by:

retainAll in interface Set<E>

Overrides:

retainAll in class AbstractCollection<E>

removeAll

public boolean removeAll(Collection<?> c)

Triggers combining.

Specified by:

removeAll in interface Collection<E>

Specified by:

removeAll in interface Set<E>

Overrides:

removeAll in class AbstractSet<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>