org.revapi.simple

Class SimpleDifferenceTransform<T extends Element>

java.lang.Object

org.revapi.simple.SimpleConfigurable

org.revapi.simple.SimpleDifferenceTransform<T>

All Implemented Interfaces:

AutoCloseable, Configurable, DifferenceTransform<T>

public abstract class SimpleDifferenceTransform<T extends Element>
extends SimpleConfigurable
implements DifferenceTransform<T>

Since:

0.4.0

Author:

Lukas Krejci

Constructor Summary

Constructors

Constructor and Description
SimpleDifferenceTransform()

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 class org.revapi.simple.SimpleConfigurable

close, getJSONSchema, initialize

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.AutoCloseable

close

Methods inherited from interface org.revapi.configuration.Configurable

getExtensionId, getJSONSchema, initialize

Constructor Detail

SimpleDifferenceTransform

public SimpleDifferenceTransform()

Method Detail

getDifferenceCodePatterns

@Nonnull
public Pattern[] getDifferenceCodePatterns()

Specified by:

getDifferenceCodePatterns in interface DifferenceTransform<T extends Element>

Returns:

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

transform

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

Description copied from interface: DifferenceTransform

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 DifferenceTransform.getDifferenceCodePatterns() method.

Specified by:

transform in interface DifferenceTransform<T extends Element>

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