Module org.pcollections

Package org.pcollections

Class OrderedPSet<E>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractSet<E>

org.pcollections.AbstractUnmodifiableSet<E>

org.pcollections.OrderedPSet<E>

Type Parameters:

E -

All Implemented Interfaces:

Serializable, Iterable<E>, Collection<E>, Set<E>, PCollection<E>, PSet<E>

public class OrderedPSet<E>
extends AbstractUnmodifiableSet<E>
implements PSet<E>, Serializable

Like PSet but preserves insertion order. Persistent equivalent of LinkedHashSet.

(Note: this is different from PSortedSet, which keeps elements in the order specified by Comparable.compareTo(Object) or Comparator.compare(Object, Object).)

See Also:

• Serialized Form

Method Summary

Modifier and Type	Method	Description
boolean	contains(Object o)
static <E> OrderedPSet<E>	empty()
static <E> OrderedPSet<E>	from(Collection<? extends E> list)
OrderedPSet<E>	intersect(Collection<? extends E> list)
Iterator<E>	iterator()
OrderedPSet<E>	minus(Object e)
OrderedPSet<E>	minusAll(Collection<?> list)
OrderedPSet<E>	plus(E e)
OrderedPSet<E>	plusAll(Collection<? extends E> list)
static <E> OrderedPSet<E>	singleton(E e)
int	size()

Methods inherited from class org.pcollections.AbstractUnmodifiableSet

add, addAll, clear, remove, removeAll, removeIf, retainAll

Methods inherited from class java.util.AbstractSet

equals, hashCode

Methods inherited from class java.util.AbstractCollection

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

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface org.pcollections.PCollection

add, addAll, clear, remove, removeAll, retainAll

Methods inherited from interface java.util.Set

add, addAll, clear, containsAll, equals, hashCode, isEmpty, remove, removeAll, retainAll, spliterator, toArray, toArray

Method Details

empty

public static <E> OrderedPSet<E> empty()

from

public static <E> OrderedPSet<E> from(Collection<? extends E> list)

singleton

public static <E> OrderedPSet<E> singleton(E 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>

plus

public OrderedPSet<E> plus(E e)

Specified by:

plus in interface PCollection<E>

Specified by:

plus in interface PSet<E>

Parameters:

e -

Returns:

a collection which contains e and all of the elements of this

plusAll

public OrderedPSet<E> plusAll(Collection<? extends E> list)

Specified by:

plusAll in interface PCollection<E>

Specified by:

plusAll in interface PSet<E>

Parameters:

list -

Returns:

a collection which contains all of the elements of list and this

minus

public OrderedPSet<E> minus(Object e)

Specified by:

minus in interface PCollection<E>

Specified by:

minus in interface PSet<E>

Parameters:

e -

Returns:

this with a single instance of e removed, if e is in this

minusAll

public OrderedPSet<E> minusAll(Collection<?> list)

Specified by:

minusAll in interface PCollection<E>

Specified by:

minusAll in interface PSet<E>

Parameters:

list -

Returns:

this with all elements of list completely removed

intersect

public OrderedPSet<E> intersect(Collection<? extends E> list)

Specified by:

intersect in interface PSet<E>

Returns:

the equivalent of this.minusAll(this.minusAll(list)).

iterator

public Iterator<E> iterator()

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>

size

public int size()

Specified by:

size in interface Collection<E>

Specified by:

size in interface Set<E>

Specified by:

size in class AbstractCollection<E>