org.revapi.basic

Class IgnoreDifferenceTransform

java.lang.Object

org.revapi.basic.AbstractDifferenceReferringTransform<IgnoreDifferenceTransform.IgnoreRecipe,Void>

org.revapi.basic.IgnoreDifferenceTransform

All Implemented Interfaces:

AutoCloseable, Configurable, DifferenceTransform<Element>

public class IgnoreDifferenceTransform
extends AbstractDifferenceReferringTransform<IgnoreDifferenceTransform.IgnoreRecipe,Void>

A generic difference transform that can ignore differences based on the difference code (Difference.code) and on the old or new elements' full human representations (Element.getFullHumanReadableString()).

The transform is configured using properties in the general form of:

  {
      "revapi" : {
          "ignore" : [
              {
                  "regex" : false,
                  "code" : "PROBLEM_CODE",
                  "old" : "FULL_REPRESENTATION_OF_THE_OLD_ELEMENT",
                  "new" : "FULL_REPRESENTATION_OF_THE_NEW_ELEMENT",
              },
              ...
          ]
      }
  }
 

The code is mandatory (obviously). The old and new properties are optional and the rule will match when all the specified properties of it match. If regex attribute is "true" (defaults to "false"), all the code, old and new are understood as regexes (java regexes, not javascript ones).

Since:

0.1

Author:

Lukas Krejci

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IgnoreDifferenceTransform.IgnoreRecipe

Constructor Summary

Constructors

Constructor and Description
IgnoreDifferenceTransform()

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
String[]	getConfigurationRootPaths()
Reader	getJSONSchema(String configurationRootPath)
protected Void	initConfiguration()
protected IgnoreDifferenceTransform.IgnoreRecipe	newRecipe(Void context, org.jboss.dmr.ModelNode config)

Methods inherited from class org.revapi.basic.AbstractDifferenceReferringTransform

getDifferenceCodePatterns, initialize, transform

Methods inherited from class java.lang.Object

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

Constructor Detail

IgnoreDifferenceTransform

public IgnoreDifferenceTransform()

Method Detail

getConfigurationRootPaths

@Nullable
public String[] getConfigurationRootPaths()

getJSONSchema

@Nullable
public Reader getJSONSchema(@Nonnull
                            String configurationRootPath)

initConfiguration

@Nullable
protected Void initConfiguration()

Specified by:

initConfiguration in class AbstractDifferenceReferringTransform<IgnoreDifferenceTransform.IgnoreRecipe,Void>

newRecipe

@Nonnull
protected IgnoreDifferenceTransform.IgnoreRecipe newRecipe(Void context,
                                                       org.jboss.dmr.ModelNode config)

Specified by:

newRecipe in class AbstractDifferenceReferringTransform<IgnoreDifferenceTransform.IgnoreRecipe,Void>

close

public void close()