Class 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:
    java.io.Serializable, java.lang.Comparable<Pair<T,​T>>, java.util.Map.Entry<T,​T>

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

    A Diff contains the differences between two Diffable class fields.

    Typically, Diffs 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

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected Diff​(java.lang.String fieldName)
      Constructs a new Diff for the given field name.
    • Constructor Detail

      • Diff

        protected Diff​(java.lang.String fieldName)

        Constructs a new Diff for the given field name.

        Parameters:
        fieldName - the name of the field
    • Method Detail

      • getType

        public final java.lang.reflect.Type getType()

        Returns the type of the field.

        Returns:
        the field type
      • getFieldName

        public final java.lang.String getFieldName()

        Returns the name of the field.

        Returns:
        the field name
      • toString

        public final java.lang.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