xxl.comparators
Class EmbeddingComparator

java.lang.Object
  |
  +--xxl.comparators.EmbeddingComparator

public class EmbeddingComparator

extends java.lang.Object

implements java.util.Comparator

The EmbeddingComparator adds a bound to a given Comparator.

Field Summary

protected java.lang.Object	bound The bound of the Comparator.
protected java.util.Comparator	comparator The Comparator to be wrapped.
protected boolean	lowerBound Determines whether the bound is the lower bound.
static EmbeddingComparator	PROTOTYPE A prototype-object of this class.

Constructor Summary

EmbeddingComparator()
Creates a new EmbeddingComparator.

EmbeddingComparator(boolean lowerBound)
Creates a new EmbeddingComparator.

EmbeddingComparator(java.util.Comparator comparator)
Creates a new EmbeddingComparator.

EmbeddingComparator(java.util.Comparator comparator, boolean lowerBound)
Creates a new EmbeddingComparator.

EmbeddingComparator(java.util.Comparator comparator, java.lang.Object bound)
Creates a new EmbeddingComparator.

EmbeddingComparator(java.util.Comparator comparator, java.lang.Object bound, boolean lowerBound)
Creates a new EmbeddingComparator.

EmbeddingComparator(java.lang.Object bound)
Creates a new EmbeddingComparator.

EmbeddingComparator(java.lang.Object bound, boolean lowerBound)
Creates a new EmbeddingComparator.

Method Summary

int	compare(java.lang.Object object1, java.lang.Object object2) Compares its two arguments for order.

Methods inherited from class java.lang.Object

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

Field Detail

PROTOTYPE

public static final EmbeddingComparator PROTOTYPE

A prototype-object of this class.

comparator

protected java.util.Comparator comparator

The Comparator to be wrapped.

bound

protected java.lang.Object bound

The bound of the Comparator.

lowerBound

protected boolean lowerBound

Determines whether the bound is the lower bound.

Constructor Detail

EmbeddingComparator

public EmbeddingComparator(java.util.Comparator comparator,
                           java.lang.Object bound,
                           boolean lowerBound)

Creates a new EmbeddingComparator.

Parameters:

comparator - the Comparator to be wrapped

bound - the bound of the comparator

lowerBound - determines whether the bound is the lower bound

EmbeddingComparator

public EmbeddingComparator()

Creates a new EmbeddingComparator.

EmbeddingComparator

public EmbeddingComparator(boolean lowerBound)

Creates a new EmbeddingComparator.

Parameters:

lowerBound - determines whether the bound is the lower bound

EmbeddingComparator

public EmbeddingComparator(java.util.Comparator comparator)

Creates a new EmbeddingComparator.

Parameters:

comparator - the Comparator to be wrapped

EmbeddingComparator

public EmbeddingComparator(java.lang.Object bound)

Creates a new EmbeddingComparator.

Parameters:

bound - the bound of the comparator

EmbeddingComparator

public EmbeddingComparator(java.util.Comparator comparator,
                           boolean lowerBound)

Creates a new EmbeddingComparator.

Parameters:

comparator - the Comparator to be wrapped

lowerBound - determines whether the bound is the lower bound

EmbeddingComparator

public EmbeddingComparator(java.util.Comparator comparator,
                           java.lang.Object bound)

Creates a new EmbeddingComparator.

Parameters:

comparator - the Comparator to be wrapped

bound - the bound of the comparator

EmbeddingComparator

public EmbeddingComparator(java.lang.Object bound,
                           boolean lowerBound)

Creates a new EmbeddingComparator.

Parameters:

bound - the bound of the comparator

lowerBound - determines whether the bound is the lower bound

Method Detail

compare

public int compare(java.lang.Object object1,
                   java.lang.Object object2)

Compares its two arguments for order.

Specified by:

compare in interface java.util.Comparator