com.feilong.core.Validator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of feilong Show documentation
feilong is a suite of core and expanded libraries that include utility classes, http, excel,cvs, io classes, and much much more.
There is a newer version: 4.3.0
Show newest version
/*
 * Copyright (C) 2008 feilong
 *
 * 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.feilong.core;

import java.lang.reflect.Array;
import java.util.Collection;
import java.util.Enumeration;
import java.util.Iterator;
import java.util.Map;

import com.feilong.core.lang.NumberUtil;
import com.feilong.core.lang.StringUtil;
import com.feilong.lib.collection4.CollectionUtils;
import com.feilong.lib.lang3.StringUtils;

/**
 * 判断给定的对象是否是null或者empty.
 * 
 * 
 * 更多说明,参见 wiki Validator wiki
 * 
 * 
 * 
 * {@link #isNullOrEmpty(Object)} 判断对象是否是null或者empty
 * {@link #isNotNullOrEmpty(Object)} 判断对象是否不是null或者不是empty
 * 
 * 
 * 对于empty的判断,使用以下逻辑:
 * 
 * 
 * 
 * {@link CharSequence},支持子类有 {@link String},{@link StringBuffer},{@link StringBuilder},使用
 * {@link com.feilong.lib.lang3.StringUtils#isBlank(CharSequence)};
 * {@link Collection},使用其 {@link Collection#isEmpty()};
 * {@link Map},使用其 {@link Map#isEmpty()};
 * {@link Enumeration},使用 {@link Enumeration#hasMoreElements()};
 * {@link Iterator},使用 {@link Iterator#hasNext()};
 * 数组{@link java.lang.Class#isArray()},判断 {@link Array#getLength(Object)} ==0
 * 
 * 
 * 
 * @author feilong
 * @see String#trim()
 * @see Map#isEmpty()
 * @see Collection#isEmpty()
 * @see Enumeration#hasMoreElements()
 * @see Iterator#hasNext()
 * @see com.feilong.lib.lang3.Validate
 * @see com.feilong.lib.lang3.StringUtils#isBlank(CharSequence)
 * @see com.feilong.lib.lang3.StringUtils#isEmpty(CharSequence)
 * @see com.feilong.lib.lang3.ArrayUtils#isEmpty(byte[])
 * @see com.feilong.lib.lang3.ArrayUtils#isEmpty(boolean[])
 * @see com.feilong.lib.lang3.ArrayUtils#isEmpty(char[])
 * @see com.feilong.lib.lang3.ArrayUtils#isEmpty(int[])
 * @see com.feilong.lib.lang3.ArrayUtils#isEmpty(long[])
 * @see com.feilong.lib.lang3.ArrayUtils#isEmpty(short[])
 * @see com.feilong.lib.lang3.ArrayUtils#isEmpty(float[])
 * @see com.feilong.lib.lang3.ArrayUtils#isEmpty(double[])
 * @see com.feilong.lib.lang3.ArrayUtils#isEmpty(Object[])
 * @see com.feilong.lib.collection4.CollectionUtils#sizeIsEmpty(Object)
 * @see com.feilong.lib.collection4.CollectionUtils#isEmpty(Collection)
 * @see com.feilong.lib.collection4.CollectionUtils#isNotEmpty(Collection)
 * @see "org.apache.commons.collections4.MapUtils#isEmpty(Map)"
 * @see "org.apache.commons.collections4.MapUtils#isNotEmpty(Map)"
 * @since 1.0.0
 */
public final class Validator{

    /** Don't let anyone instantiate this class. */
    private Validator(){
        //AssertionError不是必须的. 但它可以避免不小心在类的内部调用构造器. 保证该类在任何情况下都不会被实例化.
        //see 《Effective Java》 2nd
        throw new AssertionError("No " + getClass().getName() + " instances for you!");
    }

    //---------------------------------------------------------------

    /**
     * 判断内部任何对象 values 是不是 null或者empty.
     * 
     * 示例:
     * 
     * 
     * 
     *      * Validator.isAnyNullOrEmpty((String) null)    = true
     * Validator.isAnyNullOrEmpty((Object[]) null)  = false
     * 
     * Validator.isAnyNullOrEmpty(null, "foo")      = true
     * Validator.isAnyNullOrEmpty(null, null)       = true
     * 
     * 
     * 
     * 
     * 对于empty的判断,使用以下逻辑:
     * 
     * 
     * 
     * {@link CharSequence},支持子类有 {@link String},{@link StringBuffer},{@link StringBuilder},使用
     * {@link com.feilong.lib.lang3.StringUtils#isBlank(CharSequence)};
     * {@link Collection},使用其 {@link Collection#isEmpty()};
     * {@link Map},使用其 {@link Map#isEmpty()};
     * {@link Enumeration},使用 {@link Enumeration#hasMoreElements()};
     * {@link Iterator},使用 {@link Iterator#hasNext()};
     * 数组{@link java.lang.Class#isArray()},判断 {@link Array#getLength(Object)} ==0
     * 
     * 
     * 
     * @param values
     *            元素可以是{@link Collection},{@link Map},{@link Enumeration},{@link Iterator},{@link Iterable},{@link CharSequence},
     *            以及所有数组类型(包括原始类型数组)
     * @return 如果values是null,返回false

     *         如果values是empty也返回false

     *         逻辑和 StringUtils#isAnyBlank(CharSequence...) 保持一致
     * @see com.feilong.lib.lang3.StringUtils#isAnyBlank(CharSequence...)
     * @since 3.2.0
     */
    public static boolean isAnyNullOrEmpty(Object...values){
        if (isNullOrEmpty(values)){
            return false;
        }
        for (Object value : values){
            //有一个是null或者empty 就返回true
            if (isNullOrEmpty(value)){
                return true;
            }
        }
        //表示所有元素都不是null 或者empty
        return false;
    }

    /**
     * 判断所有元素 values 都是 null或者empty.
     * 
     * 示例:
     * 
     * 
     * 
     *      * Validator.isAllNullOrEmpty((String) null)    = true
     * Validator.isAllNullOrEmpty((Object[]) null)  = true
     * 
     * Validator.isAllNullOrEmpty(null, "foo")      = false
     * Validator.isAllNullOrEmpty(null, null)       = true
     * 
     * 
     * 
     * 
     * 对于empty的判断,使用以下逻辑:
     * 
     * 
     * 
     * {@link CharSequence},支持子类有 {@link String},{@link StringBuffer},{@link StringBuilder},使用
     * {@link com.feilong.lib.lang3.StringUtils#isBlank(CharSequence)};
     * {@link Collection},使用其 {@link Collection#isEmpty()};
     * {@link Map},使用其 {@link Map#isEmpty()};
     * {@link Enumeration},使用 {@link Enumeration#hasMoreElements()};
     * {@link Iterator},使用 {@link Iterator#hasNext()};
     * 数组{@link java.lang.Class#isArray()},判断 {@link Array#getLength(Object)} ==0
     * 
     * 
     * 
     * @param values
     *            元素可以是{@link Collection},{@link Map},{@link Enumeration},{@link Iterator},{@link Iterable},{@link CharSequence},
     *            以及所有数组类型(包括原始类型数组)
     * @return 如果values是null,返回true

     *         如果values是empty也返回true

     *         如果values内有任何元素不是null/empty,返回false

     *         逻辑和 StringUtils#isAllBlank(CharSequence...) 保持一致
     * @see com.feilong.lib.lang3.StringUtils#isAllBlank(CharSequence...)
     * @since 3.5.0
     */
    public static boolean isAllNullOrEmpty(Object...values){
        if (isNullOrEmpty(values)){
            return true;
        }
        for (Object value : values){
            //有一个不是null/empty 就返回false
            if (isNotNullOrEmpty(value)){
                return false;
            }
        }
        //表示所有元素都是null/empty
        return true;
    }

    /**
     * 判断对象 value 是不是 null或者empty.
     * 
     * 示例:
     * 
     * 
     * 
     *      * 
     * // null
     * Validator.isNullOrEmpty(null)                                            = true
     * 
     * //CharSequence
     * Validator.isNullOrEmpty("")                                              = true
     * Validator.isNullOrEmpty("   ")                                           = true
     * 
     * Validator.isNullOrEmpty(new StringBuffer())                              = true
     * Validator.isNullOrEmpty(new StringBuffer(""))                            = true
     * Validator.isNullOrEmpty(new StringBuffer(" "))                           = true
     * 
     * Validator.isNullOrEmpty(new StringBuilder())                             = true
     * Validator.isNullOrEmpty(new StringBuilder(""))                           = true
     * Validator.isNullOrEmpty(new StringBuilder(" "))                          = true
     * 
     * //Collection
     * Validator.isNullOrEmpty(new ArrayList{@code }())                 = true
     * 
     * //Map
     * Validator.isNullOrEmpty(new LinkedHashMap{@code }())     = true
     * 
     * //Iterator
     * Validator.isNullOrEmpty(new ArrayList{@code }().iterator())      = true
     * 
     * //Enumeration
     * Validator.isNullOrEmpty(toEnumeration(new ArrayList{@code }()))  = true
     * 
     * //Array
     * Validator.isNullOrEmpty(new String[] {})                                 = true
     * Validator.isNullOrEmpty(new Integer[][] {})                              = true
     * Validator.isNullOrEmpty(new User[] {})                                   = true
     * 
     * //Primitive Array
     * Validator.isNullOrEmpty(new double[] {})                                 = true
     * Validator.isNullOrEmpty(new float[] {})                                  = true
     * Validator.isNullOrEmpty(new long[] {})                                   = true
     * Validator.isNullOrEmpty(new int[] {})                                    = true
     * Validator.isNullOrEmpty(new short[] {})                                  = true
     * Validator.isNullOrEmpty(new char[] {})                                   = true
     * Validator.isNullOrEmpty(new byte[] {})                                   = true
     * Validator.isNullOrEmpty(new boolean[] {})                                = true
     * 
     * 
     * 
     * 
     * 对于empty的判断,使用以下逻辑:
     * 
     * 
     * 
     * {@link CharSequence},支持子类有 {@link String},{@link StringBuffer},{@link StringBuilder},使用
     * {@link com.feilong.lib.lang3.StringUtils#isBlank(CharSequence)};
     * {@link Collection},使用其 {@link Collection#isEmpty()};
     * {@link Map},使用其 {@link Map#isEmpty()};
     * {@link Enumeration},使用 {@link Enumeration#hasMoreElements()};
     * {@link Iterator},使用 {@link Iterator#hasNext()};
     * 数组{@link java.lang.Class#isArray()},判断 {@link Array#getLength(Object)} ==0
     * 
     * 
     * 
     * @param value
     *            可以是{@link Collection},{@link Map},{@link Enumeration},{@link Iterator},{@link Iterable},{@link CharSequence},
     *            以及所有数组类型(包括原始类型数组)
     * @return 如果是null,返回true

     *         如果是empty也返回true

     *         其他情况返回false

     * @see com.feilong.lib.collection4.CollectionUtils#sizeIsEmpty(Object)
     * @see com.feilong.lib.lang3.StringUtils#isBlank(CharSequence)
     */
    public static boolean isNullOrEmpty(Object value){
        if (null == value){
            return true;
        }
        // 字符串
        if (value instanceof CharSequence){
            CharSequence charSequence = (CharSequence) value;
            boolean blank = StringUtils.isBlank(charSequence);
            if (blank){
                return true;
            }
            return handleSpace(charSequence);
        }

        //---------------------------------------------------------------

        // collections 支持的类型
        if (isCollectionsSupportType(value)){
            return CollectionUtils.sizeIsEmpty(value);
        }
        return false;
    }

    /**
     * 处理空格
     * 
     * @param charSequence
     * @return
     * @since 3.3.8
     */
    private static boolean handleSpace(CharSequence charSequence){
        String removeSpecialSpace = StringUtil.removeSpecialSpace(charSequence);
        return StringUtils.isBlank(removeSpecialSpace);
    }

    //---------------------------------------------------------------

    /**
     * 判断对象 value 是否不是null或者empty,调用 !{@link #isNullOrEmpty(Object)} 方法 .
     * 
     * 
     * 示例参考 {@link #isNullOrEmpty(Object)} 方法
     * 
     * 
     * 对于empty的判断,使用以下逻辑:
     * 
     * 
     * 
     * {@link CharSequence},支持子类有 {@link String},{@link StringBuffer},{@link StringBuilder},使用
     * {@link com.feilong.lib.lang3.StringUtils#isBlank(CharSequence)};
     * {@link Collection},使用其 {@link Collection#isEmpty()};
     * {@link Map},使用其 {@link Map#isEmpty()};
     * {@link Enumeration},使用 {@link Enumeration#hasMoreElements()};
     * {@link Iterator},使用 {@link Iterator#hasNext()};
     * 数组{@link java.lang.Class#isArray()},判断 {@link Array#getLength(Object)} ==0
     * 
     * 
     * 
     * @param value
     *            可以是{@link Collection},{@link Map},{@link Enumeration},{@link Iterator},{@link Iterable},{@link CharSequence}
     *            ,以及所有数组类型(包括原始类型数组)
     * @return 如果是null,返回false

     *         如果是空也返回false

     *         其他情况返回true

     * @see #isNullOrEmpty(Object)
     */
    public static boolean isNotNullOrEmpty(Object value){
        return !isNullOrEmpty(value);
    }

    /**
     * 判断对象 value 是否是null或者是0.
     * 
     * 重构:
     * 
     * 
     * 
     * 常用来做行数或者接口数据总数的判断,
     * 
     * 
     * 对于以下代码:
     * 
     * 
     *      * Long countTrack = bookVo.getCountTrack();//可能是0
     * if (Objects.equals(0L, countTrack)){
     *     return 0;
     * }
     * 
     * 
     * 
     * 可以重构成:
     * 
     *      * if (isNullOrZero(countTrack)){
     *     return 0;
     * }
     * 
     * 
     * 
     *
     * @param value
     *            the value
     * @return 如果是null,返回true

     *         如果是0也返回true

     *         其他情况返回false

     * @see #isNullOrEmpty(Object)
     * @since 3.3.3
     */
    public static boolean isNullOrZero(Number value){
        return null == value || NumberUtil.isEquals(value, 0);
    }

    /**
     * 判断对象 value 是否不是null且不是0.,调用 !{@link #isNullOrZero(Number)} 方法 .
     *
     * @param value
     *            the value
     * @return 如果是null,返回false

     *         如果是0也返回false

     *         其他情况返回true

     * @see #isNullOrEmpty(Object)
     * @since 3.3.3
     */
    public static boolean isNotNullOrZero(Number value){
        return !isNullOrZero(value);
    }

    //---------------------------------------------------------------

    /**
     * Checks if is collections support type.
     *
     * @param value
     *            the value
     * @return true, if checks if is collections support type
     * @since 1.5.2
     */
    private static boolean isCollectionsSupportType(Object value){
        // 集合或者map
        boolean isCollectionOrMap = value instanceof Collection || value instanceof Map;

        // 枚举 或者是 Iterator迭代器
        boolean isEnumerationOrIterator = value instanceof Enumeration || value instanceof Iterator;

        return isCollectionOrMap//集合或者map
                        || isEnumerationOrIterator//枚举 或者是 Iterator迭代器
                        || value.getClass().isArray()//判断数组
        ;
    }
}