Class SpecializationComparator

java.lang.Object

org.microbean.assign.SpecializationComparator

All Implemented Interfaces:

Comparator<TypeMirror>

public final class SpecializationComparator
extends Object
implements Comparator<TypeMirror>

A Comparator of TypeMirrors that establishes a partial order on its arguments, enforcing only that more specialized types precede less specialized ones. Instances of this class are (deliberately) not consistent with equals.

Author:

Laird Nelson

See Also:

• compare(TypeMirror, TypeMirror)

Constructor Summary

Constructors

Constructor	Description
SpecializationComparator(Domain domain)	Creates a new SpecializationComparator.

Method Summary

Modifier and Type	Method	Description
final int	compare(TypeMirror t, TypeMirror s)	Compares two TypeMirrors and returns the result.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Comparator

equals, reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Constructor Details

SpecializationComparator

public SpecializationComparator(Domain domain)

Creates a new SpecializationComparator.

Parameters:

domain - a Domain; must not be null

Throws:

NullPointerException - if domain is null

Method Details

compare

public final int compare(TypeMirror t,
 TypeMirror s)

Compares two TypeMirrors and returns the result.

The following rules are evaluated in order to calculate the returned result:

If t == s, or t and s are the same time, returns 0.

If t is null and s is not, returns a positive value.

If s is null and t is not, returns a negative value.

If t is a subtype of s, returns a negative value.

If s is a subtype of t, returns a positive value.

In all other cases 0 is returned.

.

Specified by:

compare in interface Comparator<TypeMirror>

Parameters:

t - a TypeMirror; may be null

s - a TypeMirror; may be null

Returns:

a comparison result

See Also:

• Domain.sameType(TypeMirror, TypeMirror)
• Domain.subtype(TypeMirror, TypeMirror)