Package de.danielbechler.diff.introspection

Annotation Interface ObjectDiffProperty

@Retention(RUNTIME) @Target(METHOD) @Inherited public @interface ObjectDiffProperty
Annotation to be used on property getters in order to configure if and how they should be treated during object comparison.

  • Element Details

    • excluded

      @Deprecated boolean excluded
      Deprecated.
      Please use inclusion() instead. When used in conjunction with inclusion(), the latter one will win over excluded().
      Causes the Differs to skip the marked property and all its children.
      Returns:
      true if the property should be ignored.
      Default:
      false

    • inclusion

      Inclusion inclusion
      Default:
      DEFAULT

    • equalsOnly

      boolean equalsOnly
      Causes the Differs to compare the object by using the Object.equals(Object) method instead of introspection.
      Returns:
      true if the property should be compared via Object.equals(Object).
      Default:
      false

    • categories

      String[] categories
      Categories will be passed along with the object node and can be used for advanced filtering of specific property groups.
      Returns:
      The categories for this property.
      Default:
      {}

    • equalsOnlyValueProviderMethod

      String equalsOnlyValueProviderMethod
      Can be used in conjunction with equalsOnly() to name a method on the object that provides the value to compare via equals.
      Returns:
      The method returning the object to use for the equals check.
      Default:
      ""