Spring Framework 6.1.4 · org.springframework.aop.aspectj.autoproxy.AspectJPrecedenceComparator

Orders AspectJ advice/advisors by precedence (not invocation order).

Given two pieces of advice, A and B:

If A and B are defined in different aspects, then the advice in the aspect with the lowest order value has the highest precedence.
If A and B are defined in the same aspect, if one of A or B is a form of after advice, then the advice declared last in the aspect has the highest precedence. If neither A nor B is a form of after advice, then the advice declared first in the aspect has the highest precedence.

Important Note

This comparator is used with AspectJ's PartialOrder sorting utility. Thus, unlike a normal Comparator, a return value of 0 from this comparator means we don't care about the ordering, not that the two elements must be sorted identically.

Field Summary

Modifier and Type	Field and Description
private final Comparator<? super Advisor>	advisorComparator
private static final int	HIGHER_PRECEDENCE
private static final int	LOWER_PRECEDENCE
private static final int	SAME_PRECEDENCE

Constructor Summary

Access	Constructor and Description
public	AspectJPrecedenceComparator() Create a default `AspectJPrecedenceComparator`.
public	AspectJPrecedenceComparator(Comparator<? super Advisor> the `Comparator` to use for advisors advisorComparator) Create an `AspectJPrecedenceComparator`, using the given `Comparator` for comparing `org.springframework.aop.Advisor` instances.

Method Summary

Modifier and Type	Method and Description
public int	compare(Advisor the first object to be compared. o1, Advisor the second object to be compared. o2) Implements java.util.Comparator.compare. Compares its two arguments for order.
private int	comparePrecedenceWithinAspect(Advisor advisor1, Advisor advisor2)
private boolean	declaredInSameAspect(Advisor advisor1, Advisor advisor2)
private int	getAspectDeclarationOrder(Advisor advisor)
private String	getAspectName(Advisor advisor)
private boolean	hasAspectName(Advisor advisor)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

advisorComparator	back to summary
private final Comparator<? super Advisor> advisorComparator

HIGHER_PRECEDENCE	back to summary
private static final int HIGHER_PRECEDENCE

LOWER_PRECEDENCE	back to summary
private static final int LOWER_PRECEDENCE

SAME_PRECEDENCE	back to summary
private static final int SAME_PRECEDENCE

Constructor Detail

AspectJPrecedenceComparator	back to summary
public AspectJPrecedenceComparator() Create a default `AspectJPrecedenceComparator`.

AspectJPrecedenceComparator back to summary

AspectJPrecedenceComparator	back to summary
public AspectJPrecedenceComparator(Comparator<? super Advisor> advisorComparator) Create an `AspectJPrecedenceComparator`, using the given `Comparator` for comparing `org.springframework.aop.Advisor` instances. Parameters advisorComparator:Comparator<? super Advisor> the `Comparator` to use for advisors

public AspectJPrecedenceComparator(Comparator<? super Advisor> advisorComparator)

Create an AspectJPrecedenceComparator, using the given Comparator for comparing org.springframework.aop.Advisor instances.

Parameters

advisorComparator:Comparator<? super Advisor>: the Comparator to use for advisors

Method Detail

compare back to summary

compare	back to summary
public int compare(Advisor o1, Advisor o2) Implements java.util.Comparator.compare. Doc from java.util.Comparator.compare. Compares its two arguments for order. Returns a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second. The implementor must ensure that `signum(compare(x, y)) == -signum(compare(y, x))` for all `x` and `y`. (This implies that `compare(x, y)` must throw an exception if and only if `compare(y, x)` throws an exception.) The implementor must also ensure that the relation is transitive: `((compare(x, y)>0) && (compare(y, z)>0))` implies `compare(x, z)>0`. Finally, the implementor must ensure that `compare(x, y)==0` implies that `signum(compare(x, z))==signum(compare(y, z))` for all `z`. Parameters o1:Advisor the first object to be compared. o2:Advisor the second object to be compared. Returns:int a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second. Annotations @Override

public int compare(Advisor o1, Advisor o2)

Implements java.util.Comparator.compare.

Doc from java.util.Comparator.compare.

Compares its two arguments for order. Returns a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

The implementor must ensure that signum(compare(x, y)) == -signum(compare(y, x)) for all x and y. (This implies that compare(x, y) must throw an exception if and only if compare(y, x) throws an exception.)

The implementor must also ensure that the relation is transitive: ((compare(x, y)>0) && (compare(y, z)>0)) implies compare(x, z)>0.

Finally, the implementor must ensure that compare(x, y)==0 implies that signum(compare(x, z))==signum(compare(y, z)) for all z.

Parameters

o1:Advisor: the first object to be compared.
o2:Advisor: the second object to be compared.

Returns:int

a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

Annotations

@Override

comparePrecedenceWithinAspect	back to summary
private int comparePrecedenceWithinAspect(Advisor advisor1, Advisor advisor2)

declaredInSameAspect	back to summary
private boolean declaredInSameAspect(Advisor advisor1, Advisor advisor2)

getAspectDeclarationOrder	back to summary
private int getAspectDeclarationOrder(Advisor advisor)

getAspectName	back to summary
private String getAspectName(Advisor advisor)

hasAspectName	back to summary
private boolean hasAspectName(Advisor advisor)