oracle.javatools.db.diff

Class DiffEngine

java.lang.Object

oracle.javatools.db.diff.DiffEngine

public final class DiffEngine
extends java.lang.Object

Engine that can diff two objects and return the results.

Since:

10.1.3

Constructor Summary

Constructors

Constructor and Description
DiffEngine()
DiffEngine(boolean allowMultipleDiffers)
DiffEngine(DiffEngine existing) Create a new diff engine with the same differs as an existing one

Method Summary

Methods

Modifier and Type	Method and Description
void	cancelDiff()
void	checkProgress()
DiffEngine	copy() Creates a copy of this diff engine with all the same comparators and differs registered.
DiffContext	diff(java.util.List a, java.util.List b, ResultSet r, DiffContext dc) Diff the given object lists with the prepared context.
DiffContext	diff(java.lang.Object[] a, java.lang.Object[] b) Diff the given objects.
DiffContext	diff(java.lang.Object[] a, java.lang.Object[] b, ResultSet r) Diff the given object arrays.
DiffContext	diff(java.lang.Object[] a, java.lang.Object[] b, ResultSet r, DiffContext dc) Diff the given object arrays with the prepared context.
DiffContext	diff(java.lang.Object a, java.lang.Object b) Diff the given objects.
DiffContext	diff(java.lang.Object a, java.lang.Object b, ResultSet r, DiffContext dc) Diff the given objects with the prepared context.
Difference	difference(java.lang.Object a, java.lang.Object b) Diffs the given objects and returns a Difference object that represents the differences between them.
<T> java.util.Comparator<? super T>	getComparator(java.lang.Class<T> type) Gets the Comparator implementation that this engine will use to compare objects of the given class when they are in an array.
<T> void	registerComparator(java.util.Comparator<? super T> cmp, java.lang.Class<T> c) Registers a Comparator for a given object type.
void	registerDiffer(Differ d, java.lang.Class c) Registers a given Differ implementation with an object type (to be used by only this DiffEngine instance)
void	registerListDiffer(Differ d, java.lang.Class c) Registers a given Differ implementation with a List of object type (to be used by only this DiffEngine instances)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DiffEngine

public DiffEngine()

DiffEngine

public DiffEngine(boolean allowMultipleDiffers)

DiffEngine

public DiffEngine(DiffEngine existing)

Create a new diff engine with the same differs as an existing one

Method Detail

difference

public Difference difference(java.lang.Object a,
                    java.lang.Object b)

Diffs the given objects and returns a Difference object that represents the differences between them.

diff

public DiffContext diff(java.lang.Object a,
               java.lang.Object b)

Diff the given objects. Only use if you specifically need a DiffContext.

See Also:

difference(Object,Object)

diff

public DiffContext diff(java.lang.Object[] a,
               java.lang.Object[] b)

Diff the given objects. Only use if you specifically need a DiffContext.

See Also:

difference(Object,Object)

diff

public DiffContext diff(java.lang.Object a,
               java.lang.Object b,
               ResultSet r,
               DiffContext dc)

Diff the given objects with the prepared context. Used internally by Differs to recurse a diff to child objects.

diff

public DiffContext diff(java.lang.Object[] a,
               java.lang.Object[] b,
               ResultSet r)

Diff the given object arrays. Used to compare ordered lists of children. Used internally.

diff

public DiffContext diff(java.lang.Object[] a,
               java.lang.Object[] b,
               ResultSet r,
               DiffContext dc)

Diff the given object arrays with the prepared context. Used to compare ordered lists of children. Used internally.

diff

public DiffContext diff(java.util.List a,
               java.util.List b,
               ResultSet r,
               DiffContext dc)

Diff the given object lists with the prepared context. Used to compare ordered lists of children. Used internally.

registerDiffer

public void registerDiffer(Differ d,
                  java.lang.Class c)

Registers a given Differ implementation with an object type (to be used by only this DiffEngine instance)

registerListDiffer

public void registerListDiffer(Differ d,
                      java.lang.Class c)

Registers a given Differ implementation with a List of object type (to be used by only this DiffEngine instances)

registerComparator

public <T> void registerComparator(java.util.Comparator<? super T> cmp,
                          java.lang.Class<T> c)

Registers a Comparator for a given object type. Comparators are used to compare the contents and ordering of a child list to decide whether children have been added, removed or reordered. The registered Comparator will only be used by this DiffEngine instance.

getComparator

public <T> java.util.Comparator<? super T> getComparator(java.lang.Class<T> type)

Gets the Comparator implementation that this engine will use to compare objects of the given class when they are in an array.

Parameters:

type - the class to look up

Returns:

the Comparator for comparing objects of class type.

checkProgress

public void checkProgress()

cancelDiff

public void cancelDiff()

copy

public DiffEngine copy()

Creates a copy of this diff engine with all the same comparators and differs registered.