org.pfsw.tools.cda.base.util

Class PrioritySorter<T>

java.lang.Object

org.pfsw.tools.cda.base.util.PrioritySorter<T>

public class PrioritySorter<T>
extends java.lang.Object

This class is supposed to support sorting of objects (of type T) by an external priority. That is, the objects themselves do not contain the sort criteria.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	PrioritySorter.PrioritizedObject<T>
protected class	PrioritySorter.PrioritizingComparator

Constructor Summary

Constructors

Constructor and Description
PrioritySorter() Creates a new instance of this class.

Method Summary

Modifier and Type	Method and Description
PrioritySorter<T>	add(T object, int priority) Adds an object with its associated priority.
static <E> PrioritySorter<E>	create() Creates a new instance of this class.
protected java.util.Comparator<? super T>	createComparator()
int	getDefaultPriority() Returns the default priority for objects not registered with this sorter.
protected java.util.function.BiFunction<T,T,java.lang.Boolean>	getMatchFunction()
protected PrioritySorter.PrioritizedObject<T>	getPrioritizedObject(T object)
protected java.util.List<PrioritySorter.PrioritizedObject<T>>	getPrioritizedObjects()
protected boolean	matches(PrioritySorter.PrioritizedObject<T> prioritizedObject, T object)
PrioritySorter<T>	setDefaultPriority(int defaultPriority) Sets the default priority for objects not registered with this sorter to the given value.
PrioritySorter<T>	setMatchFunction(java.util.function.BiFunction<T,T,java.lang.Boolean> matchFunction) Sets a function that will be used to match registered prioritized objects against objects from the collection to be sorted.
java.util.List<T>	sortAscending(java.util.Collection<T> collection) Sorts the given list of objects according to their associated priorities.
java.util.List<T>	sortDescending(java.util.Collection<T> collection) Sorts the given list of objects according to their associated priorities in a descending order.

Methods inherited from class java.lang.Object

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

Constructor Detail

PrioritySorter

public PrioritySorter()

Creates a new instance of this class.

Method Detail

create

public static <E> PrioritySorter<E> create()

Creates a new instance of this class.

sortAscending

public java.util.List<T> sortAscending(java.util.Collection<T> collection)

Sorts the given list of objects according to their associated priorities. in an ascending order. That is, each object that has previously been registered with a priority by calling the add(Object, int) method will be detected by its equals() method and then compared for sorting by its associated priority.
All those objects of the list that have not been registered or are not detected will be handled with the getDefaultPriority() value.

The order of the input list will not be changed!

Parameters:

collection - The collection of objects to be sorted (must not be null).

Returns:

The sorted list.

sortDescending

public java.util.List<T> sortDescending(java.util.Collection<T> collection)

Sorts the given list of objects according to their associated priorities in a descending order. That is, each object that has previously been registered with a priority by calling the add(Object, int) method will be detected by its equals() method and then compared for sorting by its associated priority.
All those objects of the list that have not been registered or are not detected will be handled with the getDefaultPriority() value.

The order of the input list will not be changed!

Parameters:

collection - The collection of objects to be sorted (must not be null).

Returns:

The sorted list.

add

public PrioritySorter<T> add(T object,
                             int priority)

Adds an object with its associated priority. The default priority for objects that have not been added is provided bay getDefaultPriority() and is initialized to 100.

Parameters:

object - The object to register along with the given priority (must not be null).

priority - The priority value to associate to the given object.

Returns:

This instance, to support fluent API.

getDefaultPriority

public int getDefaultPriority()

Returns the default priority for objects not registered with this sorter. If not explicitly changed the value is 100.

Returns:

The current default priority.

setDefaultPriority

public PrioritySorter<T> setDefaultPriority(int defaultPriority)

Sets the default priority for objects not registered with this sorter to the given value.

Parameters:

defaultPriority - The new default priority.

Returns:

This instance, to support fluent API.

setMatchFunction

public PrioritySorter<T> setMatchFunction(java.util.function.BiFunction<T,T,java.lang.Boolean> matchFunction)

Sets a function that will be used to match registered prioritized objects against objects from the collection to be sorted.
If no match function is defined, the equals() will be used.

The first argument to the function's apply() method is the registered object and the second argument an element from the collection to be sorted.

Parameters:

matchFunction - The function to match objects against registered prioritized objects.

Returns:

This instance, to support fluent API.

getPrioritizedObject

protected PrioritySorter.PrioritizedObject<T> getPrioritizedObject(T object)

matches

protected boolean matches(PrioritySorter.PrioritizedObject<T> prioritizedObject,
                          T object)

createComparator

protected java.util.Comparator<? super T> createComparator()

getPrioritizedObjects

protected java.util.List<PrioritySorter.PrioritizedObject<T>> getPrioritizedObjects()

getMatchFunction

protected java.util.function.BiFunction<T,T,java.lang.Boolean> getMatchFunction()