Package org.aoju.bus.core.toolkit

Class IterKit

java.lang.Object
org.aoju.bus.core.toolkit.IterKit
public class IterKit extends Object
Iterable 和 Iterator 相关工具类
Since:
Java 17+
Author:
Kimi Liu

  • Constructor Details

    • IterKit

      public IterKit()

  • Method Details

    • isEmpty

      public static boolean isEmpty(Iterable<?> iterable)
      Iterable是否为空
      Parameters:
      iterable - Iterable对象
      Returns:
      是否为空

    • isEmpty

      public static boolean isEmpty(Iterator<?> iterator)
      Iterator是否为空
      Parameters:
      iterator - Iterator对象
      Returns:
      是否为空

    • isNotEmpty

      public static boolean isNotEmpty(Iterable<?> iterable)
      Iterable是否为空
      Parameters:
      iterable - Iterable对象
      Returns:
      是否为空

    • isNotEmpty

      public static boolean isNotEmpty(Iterator<?> iterator)
      Iterator是否为空
      Parameters:
      iterator - Iterator对象
      Returns:
      是否为空

    • isEqualList

      public static boolean isEqualList(Iterable<?> list1, Iterable<?> list2)
      判断两个Iterable 是否元素和顺序相同，返回true的条件是： 此方法来自Apache-Commons-Collections4。
      Parameters:
      list1 - 列表1
      list2 - 列表2
      Returns:
      是否相同

    • hasNull

      public static boolean hasNull(Iterable<?> iterable)
      是否包含null元素
      Parameters:
      iterable - 被检查的Iterable对象,如果为null 返回true
      Returns:
      是否包含null元素

    • hasNull

      public static boolean hasNull(Iterator<?> iterator)
      是否包含null元素
      Parameters:
      iterator - 被检查的Iterator对象,如果为null 返回true
      Returns:
      是否包含null元素

    • isAllNull

      public static boolean isAllNull(Iterable<?> iterable)
      是否全部元素为null
      Parameters:
      iterable - iter 被检查的Iterable对象,如果为null 返回true
      Returns:
      是否全部元素为null

    • isAllNull

      public static boolean isAllNull(Iterator<?> iterator)
      是否全部元素为null
      Parameters:
      iterator - iter 被检查的Iterator对象,如果为null 返回true
      Returns:
      是否全部元素为null

    • countMap

      public static <T> Map<T,Integer> countMap(Iterable<T> iterable)
      根据集合返回一个元素计数的 Map 所谓元素计数就是假如这个集合中某个元素出现了n次,那将这个元素做为key,n做为value 例如：[a,b,c,c,c] 得到： a: 1 b: 1 c: 3
      Type Parameters:
      T - 集合元素类型
      Parameters:
      iterable - Iterable,如果为null返回一个空的Map
      Returns:
      Map

    • countMap

      public static <T> Map<T,Integer> countMap(Iterator<T> iterator)
      根据集合返回一个元素计数的 Map 所谓元素计数就是假如这个集合中某个元素出现了n次,那将这个元素做为key,n做为value 例如：[a,b,c,c,c] 得到： a: 1 b: 1 c: 3
      Type Parameters:
      T - 集合元素类型
      Parameters:
      iterator - Iterator,如果为null返回一个空的Map
      Returns:
      Map

    • fieldValueMap

      public static <K, V> Map<K,V> fieldValueMap(Iterable<V> iterable, String fieldName)
      字段值与列表值对应的Map,常用于元素对象中有唯一ID时需要按照这个ID查找对象的情况 例如：车牌号 = 车
      Type Parameters:
      K - 字段名对应值得类型,不确定请使用Object
      V - 对象类型
      Parameters:
      iterable - 对象列表
      fieldName - 字段名(会通过反射获取其值)
      Returns:
      某个字段值与对象对应Map

    • fieldValueMap

      public static <K, V> Map<K,V> fieldValueMap(Iterator<V> iterator, String fieldName)
      字段值与列表值对应的Map,常用于元素对象中有唯一ID时需要按照这个ID查找对象的情况 例如：车牌号 = 车
      Type Parameters:
      K - 字段名对应值得类型,不确定请使用Object
      V - 对象类型
      Parameters:
      iterator - 对象列表
      fieldName - 字段名(会通过反射获取其值)
      Returns:
      某个字段值与对象对应Map

    • fieldValueAsMap

      public static <K, V> Map<K,V> fieldValueAsMap(Iterator<?> iterator, String fieldNameForKey, String fieldNameForValue)
      两个字段值组成新的Map
      Type Parameters:
      K - 字段名对应值得类型,不确定请使用Object
      V - 值类型,不确定使用Object
      Parameters:
      iterator - 对象列表
      fieldNameForKey - 做为键的字段名(会通过反射获取其值)
      fieldNameForValue - 做为值的字段名(会通过反射获取其值)
      Returns:
      某个字段值与对象对应Map

    • fieldValueList

      public static <V, R> List<R> fieldValueList(Iterable<V> iterable, String fieldName)
      获取指定Bean列表中某个字段，生成新的列表
      Type Parameters:
      V - 对象类型
      R - 返回元素类型
      Parameters:
      iterable - 对象列表
      fieldName - 字段名（会通过反射获取其值）
      Returns:
      某个字段值与对象对应Map

    • fieldValueList

      public static <V, R> List<R> fieldValueList(Iterator<V> iterator, String fieldName)
      获取指定Bean列表中某个字段,生成新的列表
      Type Parameters:
      V - 对象类型
      R - 返回元素类型
      Parameters:
      iterator - 对象列表
      fieldName - 字段名(会通过反射获取其值)
      Returns:
      某个字段值与对象对应Map

    • join

      public static <T> String join(Iterable<T> iterable, CharSequence conjunction)
      以 conjunction 为分隔符将集合转换为字符串
      Type Parameters:
      T - 集合元素类型
      Parameters:
      iterable - Iterable
      conjunction - 分隔符
      Returns:
      连接后的字符串

    • join

      public static <T> String join(Iterable<T> iterable, CharSequence conjunction, String prefix, String suffix)
      以 conjunction 为分隔符将集合转换为字符串
      Type Parameters:
      T - 集合元素类型
      Parameters:
      iterable - Iterable
      conjunction - 分隔符
      prefix - 每个元素添加的前缀,null表示不添加
      suffix - 每个元素添加的后缀,null表示不添加
      Returns:
      连接后的字符串

    • join

      public static <T> String join(Iterator<T> iterator, CharSequence conjunction)
      以 conjunction 为分隔符将集合转换为字符串 如果集合元素为数组、Iterable或Iterator,则递归组合其为字符串
      Type Parameters:
      T - 集合元素类型
      Parameters:
      iterator - 集合
      conjunction - 分隔符
      Returns:
      连接后的字符串

    • join

      public static <T> String join(Iterator<T> iterator, CharSequence conjunction, String prefix, String suffix)
      以 conjunction 为分隔符将集合转换为字符串 如果集合元素为数组、Iterable或Iterator,则递归组合其为字符串
      Type Parameters:
      T - 集合元素类型
      Parameters:
      iterator - 集合
      conjunction - 分隔符
      prefix - 每个元素添加的前缀,null表示不添加
      suffix - 每个元素添加的后缀,null表示不添加
      Returns:
      连接后的字符串

    • join

      public static <T> String join(Iterator<T> iterator, CharSequence conjunction, Function<T,? extends CharSequence> func)
      以 conjunction 为分隔符将集合转换为字符串 如果集合元素为数组、Iterable或Iterator，则递归组合其为字符串
      Type Parameters:
      T - 集合元素类型
      Parameters:
      iterator - 集合
      conjunction - 分隔符
      func - 集合元素转换器，将元素转换为字符串
      Returns:
      连接后的字符串

    • toMap

      public static <K, V> HashMap<K,V> toMap(Iterable<Map.Entry<K,V>> entryIter)
      将Entry集合转换为HashMap
      Type Parameters:
      K - 键类型
      V - 值类型
      Parameters:
      entryIter - entry集合
      Returns:
      Map

    • toMap

      public static <K, V> Map<K,V> toMap(Iterable<K> keys, Iterable<V> values)
      将键列表和值列表转换为Map 以键为准,值与键位置需对应 如果键元素数多于值元素,多余部分值用null代替 如果值多于键,忽略多余的值
      Type Parameters:
      K - 键类型
      V - 值类型
      Parameters:
      keys - 键列表
      values - 值列表
      Returns:
      标题内容Map

    • toMap

      public static <K, V> Map<K,V> toMap(Iterable<K> keys, Iterable<V> values, boolean isOrder)
      将键列表和值列表转换为Map 以键为准,值与键位置需对应 如果键元素数多于值元素,多余部分值用null代替 如果值多于键,忽略多余的值
      Type Parameters:
      K - 键类型
      V - 值类型
      Parameters:
      keys - 键列表
      values - 值列表
      isOrder - 是否有序
      Returns:
      标题内容Map

    • toMap

      public static <K, V> Map<K,V> toMap(Iterator<K> keys, Iterator<V> values)
      将键列表和值列表转换为Map 以键为准,值与键位置需对应 如果键元素数多于值元素,多余部分值用null代替 如果值多于键,忽略多余的值
      Type Parameters:
      K - 键类型
      V - 值类型
      Parameters:
      keys - 键列表
      values - 值列表
      Returns:
      标题内容Map

    • toMap

      public static <K, V> Map<K,V> toMap(Iterator<K> keys, Iterator<V> values, boolean isOrder)
      将键列表和值列表转换为Map 以键为准,值与键位置需对应 如果键元素数多于值元素,多余部分值用null代替 如果值多于键,忽略多余的值
      Type Parameters:
      K - 键类型
      V - 值类型
      Parameters:
      keys - 键列表
      values - 值列表
      isOrder - 是否有序
      Returns:
      标题内容Map

    • toListMap

      public static <K, V> Map<K,List<V>> toListMap(Iterable<V> iterable, Function<V,K> keyMapper)
      将列表转成值为List的HashMap
      Type Parameters:
      K - 键类型
      V - 值类型
      Parameters:
      iterable - 值列表
      keyMapper - Map的键映射
      Returns:
      HashMap

    • toListMap

      public static <T, K, V> Map<K,List<V>> toListMap(Iterable<T> iterable, Function<T,K> keyMapper, Function<T,V> valueMapper)
      将列表转成值为List的HashMap
      Type Parameters:
      T - 列表值类型
      K - 键类型
      V - 值类型
      Parameters:
      iterable - 值列表
      keyMapper - Map的键映射
      valueMapper - Map中List的值映射
      Returns:
      HashMap

    • toListMap

      public static <T, K, V> Map<K,List<V>> toListMap(Map<K,List<V>> resultMap, Iterable<T> iterable, Function<T,K> keyMapper, Function<T,V> valueMapper)
      将列表转成值为List的HashMap
      Type Parameters:
      T - 列表值类型
      K - 键类型
      V - 值类型
      Parameters:
      resultMap - 结果Map，可自定义结果Map类型
      iterable - 值列表
      keyMapper - Map的键映射
      valueMapper - Map中List的值映射
      Returns:
      HashMap

    • toMap

      public static <K, V> Map<K,V> toMap(Iterable<V> iterable, Function<V,K> keyMapper)
      将列表转成HashMap
      Type Parameters:
      K - 键类型
      V - 值类型
      Parameters:
      iterable - 值列表
      keyMapper - Map的键映射
      Returns:
      HashMap

    • toMap

      public static <T, K, V> Map<K,V> toMap(Iterable<T> iterable, Function<T,K> keyMapper, Function<T,V> valueMapper)
      将列表转成HashMap
      Type Parameters:
      T - 列表值类型
      K - 键类型
      V - 值类型
      Parameters:
      iterable - 值列表
      keyMapper - Map的键映射
      valueMapper - Map的值映射
      Returns:
      HashMap

    • toMap

      public static <T, K, V> Map<K,V> toMap(Map<K,V> resultMap, Iterable<T> iterable, Function<T,K> keyMapper, Function<T,V> valueMapper)
      将列表转成Map
      Type Parameters:
      T - 列表值类型
      K - 键类型
      V - 值类型
      Parameters:
      resultMap - 结果Map，通过传入map对象决定结果的Map类型
      iterable - 值列表
      keyMapper - Map的键映射
      valueMapper - Map的值映射
      Returns:
      HashMap

    • toList

      public static <E> List<E> toList(Iterable<E> iterable)
      Iterator转List 不判断,直接生成新的List
      Type Parameters:
      E - 元素类型
      Parameters:
      iterable - Iterator
      Returns:
      List

    • toList

      public static <E> List<E> toList(Iterator<E> iterator)
      Iterator转List 不判断,直接生成新的List
      Type Parameters:
      E - 元素类型
      Parameters:
      iterator - Iterator
      Returns:
      List

    • asIterator

      public static <E> Iterator<E> asIterator(Enumeration<E> e)
      Enumeration转换为Iterator

      Adapt the specified Enumeration to the Iterator interface

      Type Parameters:
      E - 集合元素类型
      Parameters:
      e - Enumeration
      Returns:
      Iterator

    • asIterable

      public static <E> Iterable<E> asIterable(Iterator<E> iter)
      Iterator 转为 Iterable
      Type Parameters:
      E - 元素类型
      Parameters:
      iter - Iterator
      Returns:
      Iterable

    • getFirst

      public static <T> T getFirst(Iterable<T> iterable)
      获取集合的第一个元素
      Type Parameters:
      T - 集合元素类型
      Parameters:
      iterable - Iterable
      Returns:
      第一个元素

    • getFirst

      public static <T> T getFirst(Iterator<T> iterator)
      获取集合的第一个元素
      Type Parameters:
      T - 集合元素类型
      Parameters:
      iterator - Iterator
      Returns:
      第一个元素

    • getFirstNoneNull

      public static <T> T getFirstNoneNull(Iterable<T> iterable)
      获取集合的第一个非空元素
      Type Parameters:
      T - 集合元素类型
      Parameters:
      iterable - Iterable
      Returns:
      第一个元素

    • getFirstNoneNull

      public static <T> T getFirstNoneNull(Iterator<T> iterator)
      获取集合的第一个非空元素
      Type Parameters:
      T - 集合元素类型
      Parameters:
      iterator - Iterator
      Returns:
      第一个非空元素，null表示未找到

    • getFirstNoneNull

      public static <T> T getFirstNoneNull(Iterator<T> iterator, Matcher<T> matcher)
      返回Iterator中第一个匹配规则的值
      Type Parameters:
      T - 数组元素类型
      Parameters:
      iterator - Iterator
      matcher - 匹配接口，实现此接口自定义匹配规则
      Returns:
      匹配元素，如果不存在匹配元素或Iterator为空，返回 null

    • getElementType

      public static Class<?> getElementType(Iterable<?> iterable)
      获得Iterable对象的元素类型(通过第一个非空元素判断) 注意,此方法至少会调用多次next方法
      Parameters:
      iterable - Iterable
      Returns:
      元素类型, 当列表为空或元素全部为null时, 返回null

    • getElementType

      public static Class<?> getElementType(Iterator<?> iterator)
      获得Iterator对象的元素类型(通过第一个非空元素判断) 注意,此方法至少会调用多次next方法
      Parameters:
      iterator - Iterator，为 null返回null
      Returns:
      元素类型，当列表为空或元素全部为null时，返回null

    • filter

      public static <T extends Iterable<E>, E> T filter(T iterable, Predicate<E> filter)
      过滤集合，此方法在原集合上直接修改 通过实现Filter接口，完成元素的过滤，这个Filter实现可以实现以下功能： 
       过滤出需要的对象，Predicate.test(Object)方法
 返回false的对象将被使用Iterator.remove()方法移除
      Type Parameters:
      T - 集合类型
      E - 集合元素类型
      Parameters:
      iterable - 集合
      filter - 过滤器接口
      Returns:
      编辑后的集合

    • filter

      public static <E> Iterator<E> filter(Iterator<E> iterator, Predicate<E> filter)
      过滤集合，此方法在原集合上直接修改 通过实现Filter接口，完成元素的过滤，这个Filter实现可以实现以下功能： 
       过滤出需要的对象，Predicate.test(Object)方法
 返回false的对象将被使用Iterator.remove()方法移除
      Type Parameters:
      E - 集合元素类型
      Parameters:
      iterator - 集合
      filter - 过滤器接口，删除Predicate.test(Object)为false的元素
      Returns:
      编辑后的集合

    • filterToList

      public static <E> List<E> filterToList(Iterator<E> iter, Predicate<E> filter)
      过滤Iterator并将过滤后满足条件的元素添加到List中
      Type Parameters:
      E - 元素类型
      Parameters:
      iter - Iterator
      filter - 过滤器，保留Predicate.test(Object)为true的元素
      Returns:
      the list

    • filtered

      public static <E> FilterIterator<E> filtered(Iterator<? extends E> iterator, Predicate<? super E> filter)
      获取一个新的 FilterIterator，用于过滤指定元素
      Type Parameters:
      E - 元素类型
      Parameters:
      iterator - 被包装的 Iterator
      filter - 过滤断言，当Predicate.test(Object)为true时保留元素，false抛弃元素
      Returns:
      FilterIterator

    • toMap

      public static <K, V> Map<K,V> toMap(Iterator<V> iterator, Map<K,V> map, XFunction<V,K> keyFunc)
      Iterator转换为Map，转换规则为： 按照keyFunc函数规则根据元素对象生成Key，元素作为值
      Type Parameters:
      K - Map键类型
      V - Map值类型
      Parameters:
      iterator - 数据列表
      map - Map对象，转换后的键值对加入此Map，通过传入此对象自定义Map类型
      keyFunc - 生成key的函数
      Returns:
      生成的map

    • toMap

      public static <K, V, E> Map<K,V> toMap(Iterator<E> iterator, Map<K,V> map, XFunction<E,K> keyFunc, XFunction<E,V> valueFunc)
      集合转换为Map，转换规则为： 按照keyFunc函数规则根据元素对象生成Key，按照valueFunc函数规则根据元素对象生成value组成新的Map
      Type Parameters:
      K - Map键类型
      V - Map值类型
      E - 元素类型
      Parameters:
      iterator - 数据列表
      map - Map对象，转换后的键值对加入此Map，通过传入此对象自定义Map类型
      keyFunc - 生成key的函数
      valueFunc - 生成值的策略函数
      Returns:
      生成的map

    • empty

      public static <T> Iterator<T> empty()
      返回一个空Iterator
      Type Parameters:
      T - 元素类型
      Returns:
      空Iterator
      See Also:

    • size

      public static int size(Iterable<?> iterable)
      返回 Iterable 对象的元素数量
      Parameters:
      iterable - Iterable对象
      Returns:
      Iterable对象的元素数量

    • size

      public static int size(Iterator<?> iterator)
      返回 Iterator 对象的元素数量
      Parameters:
      iterator - Iterator对象
      Returns:
      Iterator对象的元素数量

    • clear

      public static void clear(Iterator<?> iterator)
      清空指定Iterator，此方法遍历后调用Iterator.remove()移除每个元素
      Parameters:
      iterator - Iterator

    • forEach

      public static <E> void forEach(Iterator<E> iterator, Consumer<? super E> consumer)
      遍历Iterator 当consumer为null表示不处理，但是依旧遍历Iterator
      Type Parameters:
      E - 元素类型
      Parameters:
      iterator - Iterator
      consumer - 节点消费，null表示不处理

    • toString

      public static <E> String toString(Iterator<E> iterator)
      拼接 Iterator为字符串
      Type Parameters:
      E - 元素类型
      Parameters:
      iterator - Iterator
      Returns:
      字符串

    • toString

      public static <E> String toString(Iterator<E> iterator, Function<? super E,String> transFunc)
      拼接 Iterator为字符串
      Type Parameters:
      E - 元素类型
      Parameters:
      iterator - Iterator
      transFunc - 元素转字符串函数
      Returns:
      字符串

    • toString

      public static <E> String toString(Iterator<E> iterator, Function<? super E,String> transFunc, String delimiter, String prefix, String suffix)
      拼接 Iterator为字符串
      Type Parameters:
      E - 元素类型
      Parameters:
      iterator - Iterator
      transFunc - 元素转字符串函数
      delimiter - 分隔符
      prefix - 前缀
      suffix - 后缀
      Returns:
      字符串

    • get

      public static <T> Iterator<T> get(Iterable<T> iterable)
      获取Iterator
      Type Parameters:
      T - 元素类型
      Parameters:
      iterable - Iterable
      Returns:
      当iterable为null返回null，否则返回对应的Iterator

    • get

      public static <E> E get(Iterator<E> iterator, int index)
      遍历Iterator，获取指定index位置的元素
      Type Parameters:
      E - 元素类型
      Parameters:
      iterator - Iterator
      index - 位置
      Returns:
      元素，找不到元素返回null

    • get

      public static Iterator<?> get(Object object)
      从给定的对象中获取可能存在的Iterator，规则如下：
      Parameters:
      object - 可以获取Iterator的对象
      Returns:
      Iterator，如果提供对象为null，返回null