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

Fields inherited from class Pair

EMPTY_ARRAY

Modifier and Type	Field	Description
static final Pair<?,?>[]	EMPTY_ARRAY	An empty array.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Diff(String fieldName)	Constructs a new Diff for the given field name.

Method Summary

Modifier and Type	Method	Description
final String	getFieldName()	Gets the name of the field.
final Type	getType()	Deprecated. Unused, will be removed in 4.0.0.
final T	setValue(T value)	Sets no value and always throws UnsupportedOperationException.
final String	toString()	Returns a String representation of the Diff, with the following format:

Methods inherited from class Pair

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

Modifier and Type	Method	Description
<E extends Throwable> void	accept(FailableBiConsumer<T,T,E> consumer)	Accepts this key and value as arguments to the given consumer.
<V, E extends Throwable> V	apply(FailableBiFunction<T,T,V,E> function)	Applies this key and value as arguments to the given function.
int	compareTo(Pair<T,T> other)	Compares the pair based on the left element followed by the right element.
static <L,R> Pair<L,R>[]	emptyArray()	Returns the empty array singleton that can be assigned without compiler warning.
boolean	equals(Object obj)	Compares this pair to another based on the two elements.
final T	getKey()	Gets the key from this pair.
abstract T	getLeft()	Gets the left element from this pair.
abstract T	getRight()	Gets the right element from this pair.
T	getValue()	Gets the value from this pair.
int	hashCode()	Returns a suitable hash code.
static <L,R> Pair<L,R>	of(Map.Entry<L,R> pair)	Creates an immutable pair from a map entry.
static <L,R> Pair<L,R>	of(L left, R right)	Creates an immutable pair of two objects inferring the generic types.
static <L,R> Pair<L,R>	ofNonNull(L left, R right)	Creates an immutable pair of two non-null objects inferring the generic types.
String	toString(String format)	Formats the receiver using the given format.

Methods inherited from class Object

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

Constructor Details

Diff

protected Diff(String fieldName)

Constructs a new Diff for the given field name.

Parameters:

fieldName - the field name.

Method Details

getFieldName

public final String getFieldName()

Gets the name of the field.

Returns:

The field name.

getType

@Deprecated
public final Type getType()

Deprecated.

Unused, will be removed in 4.0.0.

Gets the type of the field.

Returns:

The field type.

setValue

public final T setValue(T value)

Sets no value and always throws UnsupportedOperationException.

Parameters:

value - ignored.

Returns:

Throws UnsupportedOperationException.

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.