org.seedstack.business.domain

Class SortOption

java.lang.Object

org.seedstack.business.domain.SortOption

All Implemented Interfaces:

Repository.Option

public class SortOption
extends Object
implements Repository.Option

Repository option for sorting aggregates.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SortOption.Direction Sort direction associated to a sorted attribute.
static class	SortOption.SortedAttribute Represents a specific sorted attribute in a SortOption.

Constructor Summary

Constructors

Constructor and Description
SortOption() Creates an empty sort option with SortOption.Direction.ASCENDING as default sort direction.
SortOption(SortOption.Direction defaultDirection) Creates an empty sort option with the specified argument as default sort direction.

Method Summary

Modifier and Type	Method and Description
SortOption	add(String attribute) Adds the specified attribute to the list of sorted attributes with the default direction.
SortOption	add(String attribute, SortOption.Direction direction) Adds the specified attribute to the list of sorted attributes with the specified direction.
<T> Comparator<T>	buildComparator() Builds a comparator allowing the sorting of objects according to the sort criteria.
List<SortOption.SortedAttribute>	getSortedAttributes() Returns the sorted attributes.

Methods inherited from class java.lang.Object

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

Constructor Detail

SortOption

public SortOption()

Creates an empty sort option with SortOption.Direction.ASCENDING as default sort direction.

SortOption

public SortOption(SortOption.Direction defaultDirection)

Creates an empty sort option with the specified argument as default sort direction.

Parameters:

defaultDirection - the default sort direction.

Method Detail

add

public SortOption add(String attribute)

Adds the specified attribute to the list of sorted attributes with the default direction.

Parameters:

attribute - the attribute to sort.

Returns:

the sort option itself.

add

public SortOption add(String attribute,
                      SortOption.Direction direction)

Adds the specified attribute to the list of sorted attributes with the specified direction.

Parameters:

attribute - the attribute to sort.

direction - the direction this attribute will be sorted with.

Returns:

the sort option itself.

getSortedAttributes

public List<SortOption.SortedAttribute> getSortedAttributes()

Returns the sorted attributes.

Returns:

the list of currently registered sorted attributes.

buildComparator

public <T> Comparator<T> buildComparator()

Builds a comparator allowing the sorting of objects according to the sort criteria.

Type Parameters:

T - the type of the object to compare.

Returns:

the comparator.