senselogic.sitevision.api.node.builder

Interface CompoundComparatorBuilder

All Superinterfaces:

Builder<Comparator<Node>>

@Requireable(value="CompoundComparatorBuilder")
public interface CompoundComparatorBuilder
extends Builder<Comparator<Node>>

Builds a compound comparator that allows comparison based on multiple comparators.

How the compareTo method of a compound comparator works: If comparator A and comparator B is added to this builder, then the compareTo method of A will be invoked first, and if equal (i.e. zero), the compareTo of B will be invoked.

See Builder for a comprehensive example of how to work with builders.

An instance of the Sitevision class implementing this interface can be obtained via NodeComparatorUtil.getCompoundComparatorBuilder(). See NodeComparatorUtil for how to obtain an instance of the NodeComparatorUtil interface.

Since:

Sitevision 3.6.3

Author:

Magnus Lövgren

Method Summary

Modifier and Type	Method and Description
CompoundComparatorBuilder	addComparator(Comparator<Node> aComparator) Adds a node comparator to this builder.
Comparator<Node>	build() Creates a node comparator instance that will calculate its compareTo return value based on currently specified comparators.
CompoundComparatorBuilder	clearComparators() Removes all previously added comparators.

Method Detail

addComparator

CompoundComparatorBuilder addComparator(Comparator<Node> aComparator)

Adds a node comparator to this builder.

Note! Order is important. The compareTo method of a node comparator constructed from this builder will invoke the comparators in the order they were added.

Parameters:

aComparator - the node comparator to add, null will be ignored

Returns:

this builder

clearComparators

CompoundComparatorBuilder clearComparators()

Removes all previously added comparators.

Returns:

this builder

build

Comparator<Node> build()
                throws IllegalStateException

Creates a node comparator instance that will calculate its compareTo return value based on currently specified comparators.

Note! The returned Comparator imposes orderings that are inconsistent with equals.

Specified by:

build in interface Builder<Comparator<Node>>

Returns:

a node comparator

Throws:

IllegalStateException - if this builder contains no comparators.