org.unidal.maven.plugin.project.rule

Interface IRule<T extends AnnotatedElement>

All Superinterfaces:

Comparator<T>

All Known Implementing Classes:

ClassRule, ConstructorRule, FieldRule, MethodRule

public interface IRule<T extends AnnotatedElement>
extends Comparator<T>

Method Summary

Modifier and Type	Method and Description
int	compare(T source, T target) Compare the two annotated elements(Class, Field, Constructor and Method) to determine the back compatibility.
String	getName()
RuleType	getType()

Methods inherited from interface java.util.Comparator

comparing, comparing, comparingDouble, comparingInt, comparingLong, equals, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Method Detail

getName

String getName()

getType

RuleType getType()

compare

int compare(T source,
            T target)

Compare the two annotated elements(Class, Field, Constructor and Method) to determine the back compatibility.

Specified by:

compare in interface Comparator<T extends AnnotatedElement>

Parameters:

source - current annotated element to compare

target - the baseline annotated element to compare

Returns:

an int < 0 is error code if source is NOT compatible with target, 0 means they are compatible or skipped, and > 0 is reason code when the comparison is stopped