com.goldencode.p2j.uast

Class MatchMetrics

java.lang.Object

com.goldencode.p2j.uast.MatchMetrics

All Implemented Interfaces:

java.lang.Comparable<MatchMetrics>

public class MatchMetrics
extends java.lang.Object
implements java.lang.Comparable<MatchMetrics>

Stores metrics state related to the usage of a given class member. This state cannot be stored in the member data itself, since it is different at every usage location of the given member.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) int	cvt Number of matches due to widening or narrowing conversion.
(package private) MethodData	data The member to which the metrics refer.
(package private) int	exact Number of exact matches.
(package private) int	extCvt Number of matches due to fixed extent to indeterminate conversion.
(package private) int	extExact Number of exact extent matches (none to none, fixed to fixed, indeterminate to indeterminate).
(package private) int[]	ooLvl Number of OO inheritance levels the caller type is from the callee type.
(package private) java.lang.String[]	overrides Type overrides needed due to fuzzy matching.
(package private) int	wildcard Number of wildcard matches.

Constructor Summary

Constructors

Constructor and Description
MatchMetrics(MethodData data) Construct an instance which references the given member.

Method Summary

Modifier and Type	Method and Description
private int	compareInheritanceLevels(MatchMetrics other) Compares this object with the given other object to calculate if one of them matched based on OO inheritance and is "closer" in its relationship.
int	compareTo(MatchMetrics other) Compares this object with the given other object to calculate a relative ordering between the two instances.
boolean	equals(java.lang.Object other) Report if the two instances have equivalent state.
java.lang.String	toString() Render the state of the instance in a text form.

Methods inherited from class java.lang.Object

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

Field Detail

data

MethodData data

The member to which the metrics refer.

exact

int exact

Number of exact matches.

cvt

int cvt

Number of matches due to widening or narrowing conversion.

extExact

int extExact

Number of exact extent matches (none to none, fixed to fixed, indeterminate to indeterminate).

extCvt

int extCvt

Number of matches due to fixed extent to indeterminate conversion.

wildcard

int wildcard

Number of wildcard matches.

ooLvl

int[] ooLvl

Number of OO inheritance levels the caller type is from the callee type.

overrides

java.lang.String[] overrides

Type overrides needed due to fuzzy matching.

Constructor Detail

MatchMetrics

public MatchMetrics(MethodData data)

Construct an instance which references the given member.

Parameters:

data - The member being referenced.

Method Detail

compareTo

public int compareTo(MatchMetrics other)

Compares this object with the given other object to calculate a relative ordering between the two instances.

Specified by:

compareTo in interface java.lang.Comparable<MatchMetrics>

Parameters:

other - The other instance. Must NOT be null.

Returns:

-1, 0 or 1 if this instance is less than, equal to, or greater than the other object.

Throws:

java.lang.NullPointerException - If the parameter is null.

equals

public boolean equals(java.lang.Object other)

Report if the two instances have equivalent state.

Overrides:

equals in class java.lang.Object

Parameters:

other - The other instance to check against.

Returns:

true if the other instance is non-null, is the same class and the state is equivalent as reported by compareTo(com.goldencode.p2j.uast.MatchMetrics). false otherwise.

toString

public java.lang.String toString()

Render the state of the instance in a text form.

Overrides:

toString in class java.lang.Object

Returns:

The rendered instance.

compareInheritanceLevels

private int compareInheritanceLevels(MatchMetrics other)

Compares this object with the given other object to calculate if one of them matched based on OO inheritance and is "closer" in its relationship. The first OO level that is different will determine the outcome unless no OO levels are different in which case the instances are equivalent.

Parameters:

other - The other instance. Must NOT be null.

Returns:

-1, 0 or 1 if this instance is less than (farther than), equal to, or greater than (closer than) the other object.

Throws:

java.lang.NullPointerException - If the parameter is null.