Class IterUtil

java.lang.Object
com.sure.tool.collection.IterUtil

public final class IterUtil extends Object
迭代器工具类,参考 Hutool 的 IterUtil 设计。

所有方法对 null 迭代器/可迭代对象保持空安全;消耗迭代器的方法 (toList/size/getFirst/clear 等)会推进迭代器, 调用方不应在之后继续使用同一迭代器。

示例:

List<String> list = List.of("a", "bb", "ccc");
List<String> filtered = IterUtil.filterToList(list, s -> s.length() > 1); // [bb, ccc]
List<Integer> lengths = IterUtil.trans(list, String::length);            // [1, 2, 3]
String joined = IterUtil.join(list, ",");                                // "a,bb,ccc"

null 语义:迭代器/可迭代对象为 null 时视为空(空安全), getFirst 返回 null,其余集合类方法返回空集合/空串。

English: Iterator and stream convenience methods, including null-safe traversal and joining.

Since:
1.19.1
Author:
suretool
  • Method Details

    • getIter

      public static <T> Iterator<T> getIter(Iterable<T> iterable)
      获取可迭代对象的迭代器。
      Type Parameters:
      T - 元素类型
      Parameters:
      iterable - 可迭代对象,可为 null
      Returns:
      迭代器;null 返回空迭代器
    • empty

      public static <T> Iterator<T> empty()
      返回空迭代器。
      Type Parameters:
      T - 元素类型
      Returns:
      空迭代器
    • isEmpty

      public static boolean isEmpty(Iterable<?> iterable)
      判断可迭代对象是否为空。
      Parameters:
      iterable - 可迭代对象,可为 null
      Returns:
      无元素返回 true
    • isEmpty

      public static boolean isEmpty(Iterator<?> iterator)
      判断迭代器是否为空(不消耗元素)。
      Parameters:
      iterator - 迭代器,可为 null
      Returns:
      无元素返回 true
    • isNotEmpty

      public static boolean isNotEmpty(Iterable<?> iterable)
      判断可迭代对象是否非空。
      Parameters:
      iterable - 可迭代对象,可为 null
      Returns:
      有元素返回 true
    • isNotEmpty

      public static boolean isNotEmpty(Iterator<?> iterator)
      判断迭代器是否非空(不消耗元素)。
      Parameters:
      iterator - 迭代器,可为 null
      Returns:
      有元素返回 true
    • hasNull

      public static boolean hasNull(Iterable<?> iterable)
      判断可迭代对象是否包含 null 元素。
      Parameters:
      iterable - 可迭代对象,可为 null
      Returns:
      含 null 返回 true
    • hasNull

      public static boolean hasNull(Iterator<?> iterator)
      判断迭代器是否包含 null 元素(消耗迭代器)。
      Parameters:
      iterator - 迭代器,可为 null
      Returns:
      含 null 返回 true
    • isAllNull

      public static boolean isAllNull(Iterable<?> iterable)
      判断可迭代对象是否全部为 null(空集合返回 false)。
      Parameters:
      iterable - 可迭代对象,可为 null
      Returns:
      非空且全部为 null 返回 true
    • isAllNull

      public static boolean isAllNull(Iterator<?> iterator)
      判断迭代器是否全部为 null(空迭代器返回 false)。
      Parameters:
      iterator - 迭代器,可为 null
      Returns:
      非空且全部为 null 返回 true
    • size

      public static int size(Iterable<?> iterable)
      统计可迭代对象元素个数。
      Parameters:
      iterable - 可迭代对象,可为 null
      Returns:
      元素个数
    • size

      public static int size(Iterator<?> iterator)
      统计迭代器元素个数(消耗迭代器)。
      Parameters:
      iterator - 迭代器,可为 null
      Returns:
      元素个数
    • toList

      public static <T> List<T> toList(Iterable<T> iterable)
      将可迭代对象转为 List。
      Type Parameters:
      T - 元素类型
      Parameters:
      iterable - 可迭代对象,可为 null
      Returns:
      List;null 返回空列表
    • toList

      public static <T> List<T> toList(Iterator<T> iterator)
      将迭代器转为 List(消耗迭代器)。
      Type Parameters:
      T - 元素类型
      Parameters:
      iterator - 迭代器,可为 null
      Returns:
      List;null 返回空列表
    • asIterator

      public static <E> Iterator<E> asIterator(Enumeration<E> enumeration)
      将 Enumeration 转为迭代器。
      Type Parameters:
      E - 元素类型
      Parameters:
      enumeration - 枚举对象,可为 null
      Returns:
      迭代器;null 返回空迭代器
    • getFirst

      public static <T> T getFirst(Iterable<T> iterable)
      获取可迭代对象首元素。
      Type Parameters:
      T - 元素类型
      Parameters:
      iterable - 可迭代对象,可为 null
      Returns:
      首元素;无元素返回 null
    • getFirst

      public static <T> T getFirst(Iterator<T> iterator)
      获取迭代器首元素(消耗一个元素)。
      Type Parameters:
      T - 元素类型
      Parameters:
      iterator - 迭代器,可为 null
      Returns:
      首元素;无元素返回 null
    • getFirstNoneNull

      public static <T> T getFirstNoneNull(Iterable<T> iterable)
      获取可迭代对象首个非 null 元素。
      Type Parameters:
      T - 元素类型
      Parameters:
      iterable - 可迭代对象,可为 null
      Returns:
      首个非 null 元素;无则返回 null
    • getFirstNoneNull

      public static <T> T getFirstNoneNull(Iterator<T> iterator)
      获取迭代器首个非 null 元素(消耗迭代器直至命中或结束)。
      Type Parameters:
      T - 元素类型
      Parameters:
      iterator - 迭代器,可为 null
      Returns:
      首个非 null 元素;无则返回 null
    • filter

      public static <T> List<T> filter(Iterable<T> iterable, Predicate<T> predicate)
      过滤可迭代对象,返回新 List。
      Type Parameters:
      T - 元素类型
      Parameters:
      iterable - 可迭代对象,可为 null
      predicate - 过滤条件,不可为 null
      Returns:
      过滤结果列表
    • filterToList

      public static <T> List<T> filterToList(Iterator<T> iterator, Predicate<T> predicate)
      过滤迭代器,返回新 List(消耗迭代器)。
      Type Parameters:
      T - 元素类型
      Parameters:
      iterator - 迭代器,可为 null
      predicate - 过滤条件,不可为 null
      Returns:
      过滤结果列表
    • trans

      public static <F,T> Iterator<T> trans(Iterator<F> iterator, Function<? super F, ? extends T> function)
      转换迭代器元素类型(惰性求值)。
      Type Parameters:
      F - 源元素类型
      T - 目标元素类型
      Parameters:
      iterator - 源迭代器,可为 null
      function - 转换函数,不可为 null
      Returns:
      转换后的迭代器;源为 null 时返回空迭代器
    • join

      public static <T> String join(Iterator<T> iterator, CharSequence separator)
      使用分隔符拼接迭代器元素(null 元素输出 "null")。
      Type Parameters:
      T - 元素类型
      Parameters:
      iterator - 迭代器,可为 null
      separator - 分隔符,null 视为空串
      Returns:
      拼接结果;无元素返回空串
    • forEach

      public static <T> void forEach(Iterator<T> iterator, Consumer<? super T> consumer)
      遍历迭代器并执行消费操作(消耗迭代器)。
      Type Parameters:
      T - 元素类型
      Parameters:
      iterator - 迭代器,可为 null
      consumer - 消费操作,不可为 null
    • clear

      public static void clear(Iterator<?> iterator)
      清空迭代器(消耗全部元素)。
      Parameters:
      iterator - 迭代器,可为 null