de.danielbechler.diff.ObjectDiffer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of java-object-diff Show documentation

Framework to detect and handle differences between Java objects

There is a newer version: 0.95

/*
 * Copyright 2014 Daniel Bechler
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package de.danielbechler.diff;

import de.danielbechler.diff.access.Instances;
import de.danielbechler.diff.access.RootAccessor;
import de.danielbechler.diff.differ.DifferDispatcher;
import de.danielbechler.diff.node.DiffNode;

/**
 * This is the entry point for all comparisons. It determines the type of the given objects and passes them to
 * the appropriate {@link de.danielbechler.diff.differ.Differ}.
 *
 * @author Daniel Bechler
 */
public class ObjectDiffer
{
	private final DifferDispatcher dispatcher;

	public ObjectDiffer(final DifferDispatcher differDispatcher)
	{
		this.dispatcher = differDispatcher;
	}

	/**
	 * Recursively inspects the given objects and returns a node representing their differences. Both objects
	 * have be have the same type.
	 *
	 * @param working This object will be treated as the successor of the `base` object.
	 * @param base    This object will be treated as the predecessor of the working object.
	 * @return A node representing the differences between the given objects.
	 */
	public  DiffNode compare(final T working, final T base)
	{
		return dispatcher.dispatch(DiffNode.ROOT, Instances.of(working, base), RootAccessor.getInstance());
	}
}