All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.dahuatech.hutool.core.collection.IterUtil Maven / Gradle / Ivy

Go to download

Dahua ICC Open API SDK for Java

There is a newer version: 1.0.13.7
Show newest version
package com.dahuatech.hutool.core.collection;

import com.dahuatech.hutool.core.lang.Filter;
import com.dahuatech.hutool.core.map.MapUtil;
import com.dahuatech.hutool.core.util.ArrayUtil;
import com.dahuatech.hutool.core.util.ReflectUtil;
import com.dahuatech.hutool.core.util.StrUtil;

import java.util.*;
import java.util.Map.Entry;

/**
 * {@link Iterable} 和 {@link Iterator} 相关工具类
 *
 * @author Looly
 * @since 3.1.0
 */
public class IterUtil {

  /**
   * Iterable是否为空
   *
   * @param iterable Iterable对象
   * @return 是否为空
   */
  public static boolean isEmpty(Iterable iterable) {
    return null == iterable || isEmpty(iterable.iterator());
  }

  /**
   * Iterator是否为空
   *
   * @param Iterator Iterator对象
   * @return 是否为空
   */
  public static boolean isEmpty(Iterator Iterator) {
    return null == Iterator || false == Iterator.hasNext();
  }

  /**
   * Iterable是否为空
   *
   * @param iterable Iterable对象
   * @return 是否为空
   */
  public static boolean isNotEmpty(Iterable iterable) {
    return null != iterable && isNotEmpty(iterable.iterator());
  }

  /**
   * Iterator是否为空
   *
   * @param Iterator Iterator对象
   * @return 是否为空
   */
  public static boolean isNotEmpty(Iterator Iterator) {
    return null != Iterator && Iterator.hasNext();
  }

  /**
   * 是否包含{@code null}元素
   *
   * @param iter 被检查的{@link Iterable}对象，如果为{@code null} 返回false
   * @return 是否包含{@code null}元素
   */
  public static boolean hasNull(Iterable iter) {
    return hasNull(null == iter ? null : iter.iterator());
  }

  /**
   * 是否包含{@code null}元素
   *
   * @param iter 被检查的{@link Iterator}对象，如果为{@code null} 返回false
   * @return 是否包含{@code null}元素
   */
  public static boolean hasNull(Iterator iter) {
    if (null == iter) {
      return true;
    }
    while (iter.hasNext()) {
      if (null == iter.next()) {
        return true;
      }
    }

    return false;
  }

  /**
   * 是否全部元素为null
   *
   * @param iter iter 被检查的{@link Iterable}对象，如果为{@code null} 返回true
   * @return 是否全部元素为null
   * @since 3.3.0
   */
  public static boolean isAllNull(Iterable iter) {
    return isAllNull(null == iter ? null : iter.iterator());
  }

  /**
   * 是否全部元素为null
   *
   * @param iter iter 被检查的{@link Iterator}对象，如果为{@code null} 返回true
   * @return 是否全部元素为null
   * @since 3.3.0
   */
  public static boolean isAllNull(Iterator iter) {
    if (null == iter) {
      return true;
    }

    while (iter.hasNext()) {
      if (null != iter.next()) {
        return false;
      }
    }
    return true;
  }

  /**
   * 根据集合返回一个元素计数的 {@link Map}

   * 所谓元素计数就是假如这个集合中某个元素出现了n次，那将这个元素做为key，n做为value

   * 例如：[a,b,c,c,c] 得到：

   * a: 1

   * b: 1

   * c: 3

   *
   * @param  集合元素类型
   * @param iter {@link Iterable}，如果为null返回一个空的Map
   * @return {@link Map}
   */
  public static  Map countMap(Iterable iter) {
    return countMap(null == iter ? null : iter.iterator());
  }

  /**
   * 根据集合返回一个元素计数的 {@link Map}

   * 所谓元素计数就是假如这个集合中某个元素出现了n次，那将这个元素做为key，n做为value

   * 例如：[a,b,c,c,c] 得到：

   * a: 1

   * b: 1

   * c: 3

   *
   * @param  集合元素类型
   * @param iter {@link Iterator}，如果为null返回一个空的Map
   * @return {@link Map}
   */
  public static  Map countMap(Iterator iter) {
    final HashMap countMap = new HashMap<>();
    if (null != iter) {
      Integer count;
      T t;
      while (iter.hasNext()) {
        t = iter.next();
        count = countMap.get(t);
        if (null == count) {
          countMap.put(t, 1);
        } else {
          countMap.put(t, count + 1);
        }
      }
    }
    return countMap;
  }

  /**
   * 字段值与列表值对应的Map，常用于元素对象中有唯一ID时需要按照这个ID查找对象的情况

   * 例如：车牌号 =》车
   *
   * @param  字段名对应值得类型，不确定请使用Object
   * @param  对象类型
   * @param iter 对象列表
   * @param fieldName 字段名（会通过反射获取其值）
   * @return 某个字段值与对象对应Map
   * @since 4.0.4
   */
  public static  Map fieldValueMap(Iterable iter, String fieldName) {
    return fieldValueMap(null == iter ? null : iter.iterator(), fieldName);
  }

  /**
   * 字段值与列表值对应的Map，常用于元素对象中有唯一ID时需要按照这个ID查找对象的情况

   * 例如：车牌号 =》车
   *
   * @param  字段名对应值得类型，不确定请使用Object
   * @param  对象类型
   * @param iter 对象列表
   * @param fieldName 字段名（会通过反射获取其值）
   * @return 某个字段值与对象对应Map
   * @since 4.0.4
   */
  @SuppressWarnings("unchecked")
  public static  Map fieldValueMap(Iterator iter, String fieldName) {
    final Map result = new HashMap<>();
    if (null != iter) {
      V value;
      while (iter.hasNext()) {
        value = iter.next();
        result.put((K) ReflectUtil.getFieldValue(value, fieldName), value);
      }
    }
    return result;
  }

  /**
   * 两个字段值组成新的Map
   *
   * @param  字段名对应值得类型，不确定请使用Object
   * @param  值类型，不确定使用Object
   * @param iterable 对象列表
   * @param fieldNameForKey 做为键的字段名（会通过反射获取其值）
   * @param fieldNameForValue 做为值的字段名（会通过反射获取其值）
   * @return 某个字段值与对象对应Map
   * @since 4.6.2
   */
  public static  Map fieldValueAsMap(
      Iterable iterable, String fieldNameForKey, String fieldNameForValue) {
    return fieldValueAsMap(
        null == iterable ? null : iterable.iterator(), fieldNameForKey, fieldNameForValue);
  }

  /**
   * 两个字段值组成新的Map
   *
   * @param  字段名对应值得类型，不确定请使用Object
   * @param  值类型，不确定使用Object
   * @param iter 对象列表
   * @param fieldNameForKey 做为键的字段名（会通过反射获取其值）
   * @param fieldNameForValue 做为值的字段名（会通过反射获取其值）
   * @return 某个字段值与对象对应Map
   * @since 4.0.10
   */
  @SuppressWarnings("unchecked")
  public static  Map fieldValueAsMap(
      Iterator iter, String fieldNameForKey, String fieldNameForValue) {
    final Map result = new HashMap<>();
    if (null != iter) {
      Object value;
      while (iter.hasNext()) {
        value = iter.next();
        result.put(
            (K) ReflectUtil.getFieldValue(value, fieldNameForKey),
            (V) ReflectUtil.getFieldValue(value, fieldNameForValue));
      }
    }
    return result;
  }

  /**
   * 获取指定Bean列表中某个字段，生成新的列表
   *
   * @param  对象类型
   * @param iterable 对象列表
   * @param fieldName 字段名（会通过反射获取其值）
   * @return 某个字段值与对象对应Map
   * @since 4.6.2
   */
  public static  List fieldValueList(Iterable iterable, String fieldName) {
    return fieldValueList(null == iterable ? null : iterable.iterator(), fieldName);
  }

  /**
   * 获取指定Bean列表中某个字段，生成新的列表
   *
   * @param  对象类型
   * @param iter 对象列表
   * @param fieldName 字段名（会通过反射获取其值）
   * @return 某个字段值与对象对应Map
   * @since 4.0.10
   */
  public static  List fieldValueList(Iterator iter, String fieldName) {
    final List result = new ArrayList<>();
    if (null != iter) {
      V value;
      while (iter.hasNext()) {
        value = iter.next();
        result.add(ReflectUtil.getFieldValue(value, fieldName));
      }
    }
    return result;
  }

  /**
   * 以 conjunction 为分隔符将集合转换为字符串
   *
   * @param  集合元素类型
   * @param iterable {@link Iterable}
   * @param conjunction 分隔符
   * @return 连接后的字符串
   */
  public static  String join(Iterable iterable, CharSequence conjunction) {
    if (null == iterable) {
      return null;
    }
    return join(iterable.iterator(), conjunction);
  }

  /**
   * 以 conjunction 为分隔符将集合转换为字符串
   *
   * @param  集合元素类型
   * @param iterable {@link Iterable}
   * @param conjunction 分隔符
   * @param prefix 每个元素添加的前缀，null表示不添加
   * @param suffix 每个元素添加的后缀，null表示不添加
   * @return 连接后的字符串
   * @since 4.0.10
   */
  public static  String join(
      Iterable iterable, CharSequence conjunction, String prefix, String suffix) {
    if (null == iterable) {
      return null;
    }
    return join(iterable.iterator(), conjunction, prefix, suffix);
  }

  /**
   * 以 conjunction 为分隔符将集合转换为字符串

   * 如果集合元素为数组、{@link Iterable}或{@link Iterator}，则递归组合其为字符串
   *
   * @param  集合元素类型
   * @param iterator 集合
   * @param conjunction 分隔符
   * @return 连接后的字符串
   */
  public static  String join(Iterator iterator, CharSequence conjunction) {
    return join(iterator, conjunction, null, null);
  }

  /**
   * 以 conjunction 为分隔符将集合转换为字符串

   * 如果集合元素为数组、{@link Iterable}或{@link Iterator}，则递归组合其为字符串
   *
   * @param  集合元素类型
   * @param iterator 集合
   * @param conjunction 分隔符
   * @param prefix 每个元素添加的前缀，null表示不添加
   * @param suffix 每个元素添加的后缀，null表示不添加
   * @return 连接后的字符串
   * @since 4.0.10
   */
  public static  String join(
      Iterator iterator, CharSequence conjunction, String prefix, String suffix) {
    if (null == iterator) {
      return null;
    }

    final StringBuilder sb = new StringBuilder();
    boolean isFirst = true;
    T item;
    while (iterator.hasNext()) {
      if (isFirst) {
        isFirst = false;
      } else {
        sb.append(conjunction);
      }

      item = iterator.next();
      if (ArrayUtil.isArray(item)) {
        sb.append(ArrayUtil.join(ArrayUtil.wrap(item), conjunction, prefix, suffix));
      } else if (item instanceof Iterable) {
        sb.append(join((Iterable) item, conjunction, prefix, suffix));
      } else if (item instanceof Iterator) {
        sb.append(join((Iterator) item, conjunction, prefix, suffix));
      } else {
        sb.append(StrUtil.wrap(String.valueOf(item), prefix, suffix));
      }
    }
    return sb.toString();
  }

  /**
   * 将Entry集合转换为HashMap
   *
   * @param  键类型
   * @param  值类型
   * @param entryIter entry集合
   * @return Map
   */
  public static  HashMap toMap(Iterable> entryIter) {
    final HashMap map = new HashMap<>();
    if (isNotEmpty(entryIter)) {
      for (Entry entry : entryIter) {
        map.put(entry.getKey(), entry.getValue());
      }
    }
    return map;
  }

  /**
   * 将键列表和值列表转换为Map

   * 以键为准，值与键位置需对应。如果键元素数多于值元素，多余部分值用null代替。

   * 如果值多于键，忽略多余的值。
   *
   * @param  键类型
   * @param  值类型
   * @param keys 键列表
   * @param values 值列表
   * @return 标题内容Map
   * @since 3.1.0
   */
  public static  Map toMap(Iterable keys, Iterable values) {
    return toMap(keys, values, false);
  }

  /**
   * 将键列表和值列表转换为Map

   * 以键为准，值与键位置需对应。如果键元素数多于值元素，多余部分值用null代替。

   * 如果值多于键，忽略多余的值。
   *
   * @param  键类型
   * @param  值类型
   * @param keys 键列表
   * @param values 值列表
   * @param isOrder 是否有序
   * @return 标题内容Map
   * @since 4.1.12
   */
  public static  Map toMap(Iterable keys, Iterable values, boolean isOrder) {
    return toMap(
        null == keys ? null : keys.iterator(), null == values ? null : values.iterator(), isOrder);
  }

  /**
   * 将键列表和值列表转换为Map

   * 以键为准，值与键位置需对应。如果键元素数多于值元素，多余部分值用null代替。

   * 如果值多于键，忽略多余的值。
   *
   * @param  键类型
   * @param  值类型
   * @param keys 键列表
   * @param values 值列表
   * @return 标题内容Map
   * @since 3.1.0
   */
  public static  Map toMap(Iterator keys, Iterator values) {
    return toMap(keys, values, false);
  }

  /**
   * 将键列表和值列表转换为Map

   * 以键为准，值与键位置需对应。如果键元素数多于值元素，多余部分值用null代替。

   * 如果值多于键，忽略多余的值。
   *
   * @param  键类型
   * @param  值类型
   * @param keys 键列表
   * @param values 值列表
   * @param isOrder 是否有序
   * @return 标题内容Map
   * @since 4.1.12
   */
  public static  Map toMap(Iterator keys, Iterator values, boolean isOrder) {
    final Map resultMap = MapUtil.newHashMap(isOrder);
    if (isNotEmpty(keys)) {
      while (keys.hasNext()) {
        resultMap.put(keys.next(), (null != values && values.hasNext()) ? values.next() : null);
      }
    }
    return resultMap;
  }

  /**
   * Iterator转List

   * 不判断，直接生成新的List
   *
   * @param  元素类型
   * @param iter {@link Iterator}
   * @return List
   * @since 4.0.6
   */
  public static  List toList(Iterable iter) {
    if (null == iter) {
      return null;
    }
    return toList(iter.iterator());
  }

  /**
   * Iterator转List

   * 不判断，直接生成新的List
   *
   * @param  元素类型
   * @param iter {@link Iterator}
   * @return List
   * @since 4.0.6
   */
  public static  List toList(Iterator iter) {
    final List list = new ArrayList<>();
    while (iter.hasNext()) {
      list.add(iter.next());
    }
    return list;
  }

  /**
   * Enumeration转换为Iterator
   *
   * 
Adapt the specified Enumeration to the Iterator interface
   *
   * @param  集合元素类型
   * @param e {@link Enumeration}
   * @return {@link Iterator}
   */
  public static  Iterator asIterator(Enumeration e) {
    return new EnumerationIter<>(e);
  }

  /**
   * {@link Iterator} 转为 {@link Iterable}
   *
   * @param  元素类型
   * @param iter {@link Iterator}
   * @return {@link Iterable}
   */
  public static  Iterable asIterable(final Iterator iter) {
    return new Iterable() {
      @Override
      public Iterator iterator() {
        return iter;
      }
    };
  }

  /**
   * 获取集合的第一个元素
   *
   * @param  集合元素类型
   * @param iterable {@link Iterable}
   * @return 第一个元素
   */
  public static  T getFirst(Iterable iterable) {
    if (null == iterable) {
      return null;
    }
    return getFirst(iterable.iterator());
  }

  /**
   * 获取集合的第一个元素
   *
   * @param  集合元素类型
   * @param iterator {@link Iterator}
   * @return 第一个元素
   */
  public static  T getFirst(Iterator iterator) {
    if (null != iterator && iterator.hasNext()) {
      return iterator.next();
    }
    return null;
  }

  /**
   * 获得{@link Iterable}对象的元素类型（通过第一个非空元素判断）

   * 注意，此方法至少会调用多次next方法
   *
   * @param iterable {@link Iterable}
   * @return 元素类型，当列表为空或元素全部为null时，返回null
   */
  public static Class getElementType(Iterable iterable) {
    if (null != iterable) {
      final Iterator iterator = iterable.iterator();
      return getElementType(iterator);
    }
    return null;
  }

  /**
   * 获得{@link Iterator}对象的元素类型（通过第一个非空元素判断）

   * 注意，此方法至少会调用多次next方法
   *
   * @param iterator {@link Iterator}
   * @return 元素类型，当列表为空或元素全部为null时，返回null
   */
  public static Class getElementType(Iterator iterator) {
    final Iterator iter2 = new CopiedIter<>(iterator);
    if (iter2.hasNext()) {
      final Object t = iter2.next();
      if (null != t) {
        return t.getClass();
      }
    }
    return null;
  }

  /**
   * 过滤集合，此方法在原集合上直接修改

   * 通过实现Filter接口，完成元素的过滤，这个Filter实现可以实现以下功能：
   *
   * 
   * 1、过滤出需要的对象，{@link Filter#accept(Object)}方法返回false的对象将被使用{@link Iterator#remove()}方法移除
   * 

   *
   * @param  集合类型
   * @param  集合元素类型
   * @param iter 集合
   * @param filter 过滤器接口
   * @return 编辑后的集合
   * @since 4.6.5
   */
  public static , E> T filter(T iter, Filter filter) {
    if (null == iter) {
      return null;
    }

    filter(iter.iterator(), filter);

    return iter;
  }

  /**
   * 过滤集合，此方法在原集合上直接修改

   * 通过实现Filter接口，完成元素的过滤，这个Filter实现可以实现以下功能：
   *
   * 
   * 1、过滤出需要的对象，{@link Filter#accept(Object)}方法返回false的对象将被使用{@link Iterator#remove()}方法移除
   * 

   *
   * @param  集合元素类型
   * @param iter 集合
   * @param filter 过滤器接口
   * @return 编辑后的集合
   * @since 4.6.5
   */
  public static  Iterator filter(Iterator iter, Filter filter) {
    if (null == iter || null == filter) {
      return iter;
    }

    while (iter.hasNext()) {
      if (false == filter.accept(iter.next())) {
        iter.remove();
      }
    }
    return iter;
  }
}
    

    

    
            
    
            







    
© 2015 - 2024 Weber Informatics LLC | Privacy Policy