io.evitadb.api.requestResponse.data.ContentComparator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of evita_api Show documentation

Module contains external API of the evitaDB.

The newest version!

/*
 *
 *                         _ _        ____  ____
 *               _____   _(_) |_ __ _|  _ \| __ )
 *              / _ \ \ / / | __/ _` | | | |  _ \
 *             |  __/\ V /| | || (_| | |_| | |_) |
 *              \___| \_/ |_|\__\__,_|____/|____/
 *
 *   Copyright (c) 2023
 *
 *   Licensed under the Business Source License, Version 1.1 (the "License");
 *   you may not use this file except in compliance with the License.
 *   You may obtain a copy of the License at
 *
 *   https://github.com/FgForrest/evitaDB/blob/master/LICENSE
 *
 *   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 io.evitadb.api.requestResponse.data;

import javax.annotation.Nullable;

/**
 * This interface allows to unite access to the full internals object comparison. This comparison is usually done in
 * {@link Object#equals(Object)} method but in Evita immutable objects are {@link Object#hashCode()} and {@link Object#equals(Object)}
 * optimized for sped and use only primary key and version. For tests and other purposes we need also full comparison
 * method that check entire contents for equality.
 *
 * @author Jan Novotný ([email protected]), FG Forrest a.s. (c) 2021
 */
public interface ContentComparator {

	/**
	 * Returns true if single item deep wise differs from the item of other object. This and otherObject must be of
	 * equal types.
	 */
	boolean differsFrom(@Nullable T otherObject);

}