org.revapi.basic

Class IgnoreDifferenceTransform

java.lang.Object

org.revapi.basic.AbstractDifferenceReferringTransform

org.revapi.basic.DifferencesTransform

org.revapi.basic.IgnoreDifferenceTransform

All Implemented Interfaces:

AutoCloseable, org.revapi.configuration.Configurable, org.revapi.DifferenceTransform<org.revapi.Element>

Deprecated.

This is superseded by DifferencesTransform

@Deprecated
public class IgnoreDifferenceTransform
extends DifferencesTransform

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",
                  "justification": "blah"
              },
              ...
          ]
      }
  }
 

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/interfaces inherited from class org.revapi.basic.DifferencesTransform

DifferencesTransform.DifferenceRecipe

Field Summary

Fields inherited from class org.revapi.basic.AbstractDifferenceReferringTransform

analysisContext

Constructor Summary

Constructors

Constructor and Description
IgnoreDifferenceTransform() Deprecated.

Method Summary

Modifier and Type	Method and Description
void	close() Deprecated.
Reader	getJSONSchema() Deprecated.
protected org.jboss.dmr.ModelNode	getRecipesConfigurationAndInitialize() Deprecated.
protected DifferencesTransform.DifferenceRecipe	newRecipe(org.jboss.dmr.ModelNode config) Deprecated.

Methods inherited from class org.revapi.basic.AbstractDifferenceReferringTransform

getDifferenceCodePatterns, getExtensionId, 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()

Deprecated.

Method Detail

getRecipesConfigurationAndInitialize

protected org.jboss.dmr.ModelNode getRecipesConfigurationAndInitialize()

Deprecated.

Overrides:

getRecipesConfigurationAndInitialize in class DifferencesTransform

Returns:

a list node where the difference recipes are stored

getJSONSchema

@Nullable
public Reader getJSONSchema()

Deprecated.

Specified by:

getJSONSchema in interface org.revapi.configuration.Configurable

Overrides:

getJSONSchema in class DifferencesTransform

newRecipe

@Nonnull
protected DifferencesTransform.DifferenceRecipe newRecipe(org.jboss.dmr.ModelNode config)

Deprecated.

Overrides:

newRecipe in class DifferencesTransform

close

public void close()

Deprecated.

Specified by:

close in interface AutoCloseable

Overrides:

close in class DifferencesTransform