com.openpojo.business.utils.BusinessIdentityUtils Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of openpojo Show documentation
This project was born out of a need to validate all POJOs (Plain Old Java Object) are behaving correctly. This project has two main aspects to it: * Make Testing as easy as possible. * Simplifying identity management (hashCode / equals) using annotation.
There is a newer version: 0.7.3
Show newest version
/*
 * Copyright (c) 2010-2012 Osman Shoukry
 *
 *   This program is free software: you can redistribute it and/or modify
 *   it under the terms of the GNU Lesser General Public License as published by
 *   the Free Software Foundation, either version 3 of the License or any
 *   later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU Lesser General Public License for more details.
 *
 *   You should have received a copy of the GNU Lesser General Public License
 *   along with this program.  If not, see .
 */

package com.openpojo.business.utils;

import com.openpojo.business.exception.BusinessException;
import com.openpojo.reflection.PojoField;

/**
 * This class is just a utility class that holds a few utilities needed by various classes in the business package.
 *
 * @author oshoukry
 */
public class BusinessIdentityUtils {
    /**
     * @param objects
     *          List of objects to check if any are null.
     * @return
     *          True if any of the objects passed is null, false otherwise.
     */
    public static boolean anyNull(final Object... objects) {
        if (objects == null) {
            throw BusinessException.getInstance("objects parameter cannot be null");
        }
        for (Object o : objects) {
            if (o == null) {
                return true;
            }
        }
        return false;
    }

    /**
     * This method checks if two objects are of the same class.
     * @param first
     *          First object to check.
     * @param second
     *          Second object to check.
     * @return
     *          True if both have the same class, false otherwise.
     */
    public static boolean sameClass(final Object first, final Object second) {
        return first.getClass() == second.getClass();
    }

    /**
     * This method checks if two object point to the same instance.
     * @param first
     *          First object to check.
     * @param second
     *          Second object to check.
     * @return
     *          True if both first and second point to the same instance, false otherwise.
     */
    public static boolean sameInstance(final Object first, final Object second) {
        return first == second;
    }

    /**
     * Perform Equality between two PojoFields' instances.
     * This is different from regular equals implementation that it will return true
     * if both fields are null, as well as it takes into account case based equality for character sequences.
     *
     * @param first
     *            The first instance that contains this PojoField.
     * @param second
     *            The second instance that contains this PojoField.
     * @param caseSensitive
     *            Whether or not to compare ignoring case.
     * @return
     *         True if they are equal or if they are both null.
     */
     public static boolean areEqual(final PojoField pojoField, final Object first, final Object second, final boolean caseSensitive) {
        Object firstField = pojoField.get(first);
        Object secondField = pojoField.get(second);
        if (firstField == null) {
            return secondField == null;
        }

        if (secondField == null) {
            return false;
        }

        if (!caseSensitive && isCharacterBased(firstField)) {
            return firstField.toString().equalsIgnoreCase(secondField.toString());
        }

        return firstField.equals(secondField);
    }

    /**
     * Generate HashCode on field value.
     * @param instance
     *          The instance to pull the field value out of.
     * @param caseSensitive
     *          Whether or not to ignore case while generating hash code.
     * @return
     *          The generated HashCode.
     */
    public static int getHashCode(final PojoField pojoField, final Object instance, final boolean caseSensitive) {
        Object data = pojoField.get(instance);
        if (data == null) {
            return 0;
        }
        if (!caseSensitive && isCharacterBased(data)) {
            return data.toString().toLowerCase().hashCode();
        }

        return data.hashCode();
    }

    /**
     * This method holds the logic needed to determine that a type is of character
     * (i.e. its contents can be pulled out using toString)
     * @param data
     *          The data to be checked.
     * @return
     *          True if data is of type Character or CharSequence, false otherwise.
     */
    private static boolean isCharacterBased(final Object data) {
        return (data instanceof Character || data instanceof CharSequence);
    }
}