org.mdiutil.util.partialset

Interface PartiallyOrderedSet<E>

Type Parameters:

E - the element type

All Superinterfaces:

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

All Known Implementing Classes:

PartiallyOrderedHashSet, PartiallyOrderedTreeSet

public interface PartiallyOrderedSet<E>
extends Set<E>

A set of Objects with pairwise orderings between them. The iterator method provides the elements in topologically sorted order. Elements participating in a cycle are not returned. Unlike the SortedSet and SortedMap interfaces, which require their elements to implement the Comparable interface, this class receives ordering information via its setOrdering and unsetOrdering methods.

Since:

1.3.29

Method Summary

Modifier and Type	Method and Description
boolean	hasOrdering(E preferred, E other) Returns true if an ordering exists between two elements.
boolean	setOrdering(E first, E second) Sets an ordering between two elements.
boolean	unsetOrdering(E first, E second) Removes any ordering between two elements.

Methods inherited from interface java.util.Set

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

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Method Detail

setOrdering

boolean setOrdering(E first,
                    E second)

Sets an ordering between two elements. When an iterator is requested, the first element will appear earlier in the sequence than the second element. If a prior ordering existed between the elements in the opposite order, it is removed.

Parameters:

first - the first element

second - the second element

Returns:

true if no prior ordering existed between the elements, false otherwise.

unsetOrdering

boolean unsetOrdering(E first,
                      E second)

Removes any ordering between two elements.

Parameters:

first - the first element

second - the second element

Returns:

true if an ordering existed between the elements.

hasOrdering

boolean hasOrdering(E preferred,
                    E other)

Returns true if an ordering exists between two elements.

Parameters:

preferred - the element to consider

other - the other element

Returns:

true if there is an ordetring between the two elements