net.sf.jiapi.reflect.util

Class Rule

java.lang.Object

net.sf.jiapi.reflect.util.Rule

All Implemented Interfaces:

Comparable<Object>

public class Rule
extends Object
implements Comparable<Object>

Implements a Rule in an InstrumentationDescriptor. Rules determine if a given class matches a certain InstrumentationDescriptor.

Rules can have wildcards.

Rules are ordered according to their precedence.

Author:

Mika Riekkinen, Joni Suominen

Constructor Summary

Constructors

Constructor and Description
Rule(String rule) Creates a rule used used by InstrumentationDescriptor to determine whether a particular class needs to be instrumented.

Method Summary

Modifier and Type	Method and Description
int	compareTo(Object o) The precedence determines the order of Rules.
boolean	equals(Object o) Two rules are equal if the strings which represent them equals.
double	getPrecedence() Get a precedence of this Rule.
int	hashCode()
boolean	isMoreSignificant(Rule other) Checks whether this Rule is more significant than the given Rule.
boolean	match(String s) Check if a given String matches this Rule.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Rule

public Rule(String rule)
     throws JiapiException

Creates a rule used used by InstrumentationDescriptor to determine whether a particular class needs to be instrumented.

Parameters:

rule - a rule can be a classname and it can contain wildcards

Throws:

JiapiException - on error

Method Detail

match

public boolean match(String s)

Check if a given String matches this Rule.

Parameters:

s - String to match

Returns:

true on match, false on mismatch

getPrecedence

public double getPrecedence()

Get a precedence of this Rule. Precedence determines the accuracy of a rule. The more significant rule wins over the less one. E.g. com.opensource.*.Foo is more significant than com.*.Foo since it more accurately describes the class.

Returns:

precedence

isMoreSignificant

public boolean isMoreSignificant(Rule other)

Checks whether this Rule is more significant than the given Rule.

Parameters:

other - other Rule

Returns:

true if this Rule is more significant.

compareTo

public int compareTo(Object o)

The precedence determines the order of Rules.

Specified by:

compareTo in interface Comparable<Object>

Parameters:

o - other Rule

equals

public boolean equals(Object o)

Two rules are equal if the strings which represent them equals. (e.g. "com.* == com.*", "com.foo.* != com.*")

Overrides:

equals in class Object

Parameters:

o - other Rule

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object