Package org.revapi.basic

Class ClassificationTransform

  • All Implemented Interfaces:
    AutoCloseable, org.revapi.configuration.Configurable, org.revapi.DifferenceTransform
    @Deprecated
public class ClassificationTransform
extends DifferencesTransform
    Deprecated.
    This is superseded by DifferencesTransform
    A generic difference transform that can change the classification of a difference. This can be used in situations where one wants to consider certain differences differently than the defining extension declared them.

    The transform can be configured like so: 

     
 {
  "revapi" : {
      "reclassify" : [
          {
              "regex" : false,
              "code" : "PROBLEM_CODE",
              "old" : "FULL_REPRESENTATION_OF_THE_OLD_ELEMENT",
              "new" : "FULL_REPRESENTATION_OF_THE_NEW_ELEMENT",
              classify : {
                  "NEW_COMPATIBILITY_TYPE": "NEW_SEVERITY",
                  "NEW_COMPATIBILITY_TYPE_2": "NEW_SEVERITY_2",
              }
          },
          ...
      ]
  }
 }

    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).

    The NEW_COMPATIBILITY_TYPE corresponds to one of the names of the CompatibilityType enum and the NEW_SEVERITY corresponds to one of the names of the DifferenceSeverity enum. The reclassified difference inherits its classification (i.e. the compatibility type + severity pairs) and only redefines the ones explicitly defined in the configuration.

    Since:
    0.1
    Author:
    Lukas Krejci