org.apache.commons.lang3.builder

## Class Diff<T>

- java.lang.Object
- - org.apache.commons.lang3.tuple.Pair<T,T>
  - - org.apache.commons.lang3.builder.Diff<T>

- Type Parameters:
    `T` - The type of object contained within this `Diff`. Differences between primitive objects are stored as their Object wrapper equivalent.
  All Implemented Interfaces:
    Serializable, Comparable<Pair<T,T>>, Map.Entry<T,T>

      public abstract class Diff<T>
      extends Pair<T,T>

  A `Diff` contains the differences between two `Diffable` class fields.

  Typically, `Diff`s are retrieved by using a `DiffBuilder` to produce a `DiffResult`, containing the differences between two objects.

  Since:
    3.3
  See Also:
    Serialized Form

- - ### Field Summary

    - ### Fields inherited from class org.apache.commons.lang3.tuple.Pair

      `EMPTY_ARRAY`

  - ### Constructor Summary

    Constructors
    Modifier | Constructor and Description
    --- | ---
    `protected` | `Diff(String fieldName)` Constructs a new `Diff` for the given field name.

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `String` | `getFieldName()` Gets the name of the field.
    `Type` | `getType()` Gets the type of the field.
    `T` | `setValue(T value)` Throws `UnsupportedOperationException`.
    `String` | `toString()` Returns a `String` representation of the `Diff`, with the following format:

    - ### Methods inherited from class org.apache.commons.lang3.tuple.Pair

      `accept, apply, compareTo, emptyArray, equals, getKey, getLeft, getRight, getValue, hashCode, of, of, ofNonNull, toString`

    - ### Methods inherited from class java.lang.Object

      `clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

    - ### Methods inherited from interface java.util.Map.Entry

      `comparingByKey, comparingByKey, comparingByValue, comparingByValue`

- - ### Constructor Detail

    - #### Diff

          protected Diff(String fieldName)

      Constructs a new `Diff` for the given field name.
      Parameters:
        `fieldName` - the field name

  - ### Method Detail

    - #### getType

          public final Type getType()

      Gets the type of the field.
      Returns:
        the field type

    - #### getFieldName

          public final String getFieldName()

      Gets the name of the field.
      Returns:
        the field name

    - #### toString

          public final String toString()

      Returns a `String` representation of the `Diff`, with the following format:

           [fieldname: left-value, right-value]

      Overrides:
        `toString` in class `Pair<T,T>`
      Returns:
        the string representation

    - #### setValue

          public final T setValue(T value)

      Throws `UnsupportedOperationException`.
      Parameters:
        `value` - ignored
      Returns:
        nothing

Copyright © 2001–2023 The Apache Software Foundation. All rights reserved.