com.viiyue.plugins.mybatis.utils.ObjectUtil Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mybatis-mapper Show documentation
Mybatis generic mapper plugin for solving most basic operations, simplifying sql syntax and improving dynamic execution efficiency
There is a newer version: 1.3.7
Show newest version
/**
 * Copyright (C) 2017 the original author or authors.
 *
 * 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 com.viiyue.plugins.mybatis.utils;

import java.lang.reflect.Array;
import java.util.Collection;
import java.util.Map;
import java.util.Objects;

import org.apache.commons.lang3.ObjectUtils;

/**
 * Operations on {@code Object}
 *
 * @author tangxbai
 * @since 1.1.0
 */
public class ObjectUtil extends ObjectUtils {
	
	private ObjectUtil () {}
	
	/**
	 * Determine whether an object is an empty object, if it is a string, then
	 * determine whether it is blank text.
	 * 
	 * @param object the target input object
	 * @return {@code true} if the input object is null, or the input object is an blank text.
	 * @see StringUtil#isBlank(CharSequence)
	 */
	public static boolean isBlank( final Object object ) {
		return object == null || StringUtil.isBlank( object.toString() );
	}
	
	/**
	 * Determine whether an object is a non-empty object, 
	 * if it is a string, determine whether it is non-blank text.
	 * 
	 * @param object the target input object
	 * @return {@code true} if the input object is non-null, or the input object is a non-blank text.
	 * @see StringUtil#isNotBlank(CharSequence)
	 */
	public static boolean isNotBlank( final Object object ) {
		return object != null && StringUtil.isNotBlank( object.toString() );
	}

	/**
	 * Determine if two objects are different
	 * 
	 * @param target the input object
	 * @param another the annother input object
	 * @return {@code true} if both objects are the same, {@code false} otherwise.
	 * @see java.util.Objects#equals(Object, Object)
	 */
	public static boolean isDifferent( final Object target, final Object another ) {
		return !Objects.equals( target, another );
	}
	
	/**
     * Checks if an Object is empty or null.
     *
     * The following types are supported:
     * 
     * {@link CharSequence}: Considered empty if its length is zero.
     * {@code Array}: Considered empty if its length is zero.
     * {@link Collection}: Considered empty if it has zero elements.
     * {@link Map}: Considered empty if it has zero key-value mappings.
     * 
     *
     *      * ObjectUtils.isEmpty(null)             = true
     * ObjectUtils.isEmpty("")               = true
     * ObjectUtils.isEmpty("ab")             = false
     * ObjectUtils.isEmpty(new int[]{})      = true
     * ObjectUtils.isEmpty(new int[]{1,2,3}) = false
     * ObjectUtils.isEmpty(1234)             = false
     * 
     *
     * @param object  the {@code Object} to test, may be {@code null}
     * @return {@code true} if the object has a supported type and is empty or null, {@code false} otherwise.
     * @since common-lang 3.9
     * @since mybatis-mapper 1.2.0
     */
	public static boolean isEmpty( final Object object ) {
		if ( object == null ) {
			return true;
		}
		if ( object instanceof CharSequence ) {
			return ( ( CharSequence ) object ).length() == 0;
		}
		if ( object.getClass().isArray() ) {
			return Array.getLength( object ) == 0;
		}
		if ( object instanceof Collection ) {
			return ( ( Collection ) object ).isEmpty();
		}
		if ( object instanceof Map ) {
			return ( ( Map ) object ).isEmpty();
		}
		return false;
	}

    /**
     * Checks if an Object is not empty and not null.
     *
     * The following types are supported:
     * 
     * {@link CharSequence}: Considered empty if its length is zero.
     * {@code Array}: Considered empty if its length is zero.
     * {@link Collection}: Considered empty if it has zero elements.
     * {@link Map}: Considered empty if it has zero key-value mappings.
     * 
     *
     *      * ObjectUtils.isNotEmpty(null)             = false
     * ObjectUtils.isNotEmpty("")               = false
     * ObjectUtils.isNotEmpty("ab")             = true
     * ObjectUtils.isNotEmpty(new int[]{})      = false
     * ObjectUtils.isNotEmpty(new int[]{1,2,3}) = true
     * ObjectUtils.isNotEmpty(1234)             = true
     * 
     *
     * @param object  the {@code Object} to test, may be {@code null}
     * @return {@code true} if the object has an unsupported type or is not empty
     * and not null, {@code false} otherwise
     * @since common-lang 3.9
     * @since mybatis-mapper 1.2.0
     */
	public static boolean isNotEmpty( final Object object ) {
		return !isEmpty( object );
	}

	/**
	 * Compares given target to a Objects vararg of {@code elements}, or
	 * returning {@code true} if the target is equal to any of the elements.
	 * 
     *      * ObjectUtil.equalsAny(null, (Object[]) null) = false
     * ObjectUtil.equalsAny(null, null, null)    = true
     * ObjectUtil.equalsAny(null, "abc", "def")  = false
     * ObjectUtil.equalsAny("abc", null, "def")  = false
     * ObjectUtil.equalsAny("abc", "abc", "def") = true
     * ObjectUtil.equalsAny("abc", "ABC", "DEF") = false
     * 
     * 
	 * @param target to compare, may be {@code null}.
	 * @param elements a vararg of objects, may be {@code null}.
	 * @return {@code true} if the target is equal to any other element of elements;
     * {@code false} if elements is null or contains no matches.
	 */
	public static boolean equalsAny( Object target, Object ... elements ) {
		if ( isNotEmpty( elements ) ) {
			for ( Object element : elements ) {
				if ( Objects.equals( target, element ) ) {
					return true;
				}
			}
		}
		return false;
	}

}