ma.glasnost.orika.util

Class SortedCollection<V>

java.lang.Object

ma.glasnost.orika.util.SortedCollection<V>

Type Parameters:

V - the element type contained in this list

All Implemented Interfaces:

Iterable<V>, Collection<V>

Direct Known Subclasses:

SortedSet

public class SortedCollection<V>
extends Object
implements Collection<V>

A simple sorted collection implementation that allows for duplicates; new items are inserted based on their comparison to existing items; if a new item is found to be less than any item in the list, it is inserted before that item, else it is inserted at the end.

The collection is backed by a ConcurrentSkipListMap, with the keys defined as Double, allowing for inserts of items at a specific location with respect to the other items in the map.

This class is thread-safe, with the same caveats for ConcurrentSkipListMap.

Author:

matt.deboer@gmail.com

Field Summary

Fields

Modifier and Type	Field and Description
protected Ordering<V>	ordering

Constructor Summary

Constructors

Constructor and Description
SortedCollection(Collection<? extends V> c, Ordering<V> ordering)
SortedCollection(Ordering<V> ordering)

Method Summary

Modifier and Type	Method and Description
boolean	add(V value)
boolean	addAll(Collection<? extends V> c)
void	clear()
boolean	contains(Object o)
boolean	containsAll(Collection<?> c)
V	first()
boolean	isEmpty()
Iterator<V>	iterator()
protected boolean	mustAdd(V item)
boolean	remove(Object o)
boolean	removeAll(Collection<?> c)
boolean	retainAll(Collection<?> c)
int	size()
Object[]	toArray()
<T> T[]	toArray(T[] a)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

equals, hashCode, parallelStream, removeIf, spliterator, stream

Methods inherited from interface java.lang.Iterable

forEach

Field Detail

ordering

protected final Ordering<V> ordering

Constructor Detail

SortedCollection

public SortedCollection(Ordering<V> ordering)

Parameters:

ordering -

SortedCollection

public SortedCollection(Collection<? extends V> c,
                        Ordering<V> ordering)

Parameters:

c - the collection from which to initialize this SortedCollection

ordering - the ordering used for sorting the elements

Method Detail

add

public boolean add(V value)

Specified by:

add in interface Collection<V>

mustAdd

protected boolean mustAdd(V item)

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<V>

clear

public void clear()

Specified by:

clear in interface Collection<V>

size

public int size()

Specified by:

size in interface Collection<V>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<V>

iterator

public Iterator<V> iterator()

Specified by:

iterator in interface Iterable<V>

Specified by:

iterator in interface Collection<V>

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection<V>

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<V>

toArray

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

Specified by:

toArray in interface Collection<V>

containsAll

public boolean containsAll(Collection<?> c)

Specified by:

containsAll in interface Collection<V>

addAll

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

Specified by:

addAll in interface Collection<V>

removeAll

public boolean removeAll(Collection<?> c)

Specified by:

removeAll in interface Collection<V>

retainAll

public boolean retainAll(Collection<?> c)

Specified by:

retainAll in interface Collection<V>

first

public V first()

Returns:

the first item in this collection