de.alpharogroup.evaluate.object.evaluators.ToStringEvaluator Maven / Gradle / Ivy

Go to download
/**
 * The MIT License
 *
 * Copyright (C) 2015 Asterios Raptis
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
 * associated documentation files (the "Software"), to deal in the Software without restriction,
 * including without limitation the rights to use, copy, modify, merge, publish, distribute,
 * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all copies or
 * substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
 * NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */
package de.alpharogroup.evaluate.object.evaluators;

import de.alpharogroup.evaluate.object.checkers.ToStringCheck;
import lombok.experimental.UtilityClass;

/**
 * The class {@link ToStringEvaluator} provides algorithms for evaluate the
 * {@link Object#toString()} method.
 */
@UtilityClass
public final class ToStringEvaluator
{

	/**
	 * Evaluate if the given class implements the toString method.
	 *
	 * @param clazz
	 *            the class
	 * @return true, if successful
	 */
	public static boolean evaluate(Class clazz)
	{
		return !ToStringCheck.evaluate(clazz).isPresent();
	}

	/**
	 * Evaluate consistency of method {@link Object#toString()} for the given objects 

	 * This method calls the same name method with default iterations of 7

	 * 

	 *
	 * @param 
	 *            the generic type
	 * @param object
	 *            the object
	 * @return true, if consistency of method {@link Object#toString()} for the given objects is
	 *         given otherwise false
	 */
	public static  boolean evaluateConsistency(T object)
	{
		return !ToStringCheck.consistency(object).isPresent();
	}

	/**
	 * Evaluate consistency of method {@link Object#toString()} for the given objects 

	 *
	 * @param 
	 *            the generic type
	 * @param object
	 *            the object
	 * @param iterations
	 *            the iterations of call of equals method.
	 * @return true, if consistency of method {@link Object#toString()} is given otherwise false
	 */
	public static  boolean evaluateConsistency(T object, int iterations)
	{
		return !ToStringCheck.consistency(object, iterations).isPresent();
	}

}