org.revapi

Interface DifferenceTransform<T extends Element>

Type Parameters:

T - the type of the element expected in the transform method. Note that you need to be careful about this type because the types of the elements passed to transform depend on the differences that the transform is interested in. Thus you may end up with ClassCastExceptions if you're not careful. This type needs to be cast-able to the type of all possible elements that the handled differences can apply to. If in doubt, just use Element which is guaranteed to work.

All Superinterfaces:

AutoCloseable, Configurable

All Known Implementing Classes:

SimpleDifferenceTransform

public interface DifferenceTransform<T extends Element>
extends AutoCloseable, Configurable

A difference transform may elect to transform certain kinds of differences into other kinds. This comes useful in custom extensions that want to "modify the behavior" of other extensions by consuming and transforming the differences found by the other extensions into something else.

The AutoCloseable.close() is not called if there is no prior call to Configurable.initialize(AnalysisContext). Do all your resource acquisition in initialize, not during the construction of the object.

Since:

0.1

Author:

Lukas Krejci

Method Summary

Modifier and Type	Method and Description
Pattern[]	getDifferenceCodePatterns()
Difference	transform(T oldElement, T newElement, Difference difference) Returns a transformed version of the difference.

Methods inherited from interface java.lang.AutoCloseable

close

Methods inherited from interface org.revapi.configuration.Configurable

getExtensionId, getJSONSchema, initialize

Method Detail

getDifferenceCodePatterns

@Nonnull
Pattern[] getDifferenceCodePatterns()

Returns:

The list of regexes to match the difference codes this transform can handle.

transform

@Nullable
Difference transform(@Nullable
                               T oldElement,
                               @Nullable
                               T newElement,
                               @Nonnull
                               Difference difference)

Returns a transformed version of the difference. If this method returns null, the difference is discarded and not reported. Therefore, if you don't want to transform a difference, just return it.

The code of the supplied difference will match at least one of the regexes returned from the getDifferenceCodePatterns() method.

Parameters:

oldElement - the old differing element

newElement - the new differing element

difference - the difference description

Returns:

the transformed difference or the passed in difference if no transformation necessary or null if the difference should be discarded