ListUtil (hutool 5.8.33 API)

java.lang.Object
- cn.hutool.core.collection.ListUtil

```
public class ListUtil
extends Object
```
List相关工具类

Author:

looly

Constructor Summary

Constructors
Constructor and Description

ListUtil()

Constructors
Constructor and Description
`ListUtil()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static <T> List<T>`	`empty()` 获取一个空List，这个空List不可变
`static <T> int[]`	`indexOfAll(List<T> list, Matcher<T> matcher)` 获取匹配规则定义中匹配到元素的所有位置
`static <T> int`	`lastIndexOf(List<T> list, Matcher<T> matcher)` 获取匹配规则定义中匹配到元素的最后位置此方法对于某些无序集合的位置信息，以转换为数组后的位置为准。
`static <T> List<T>`	`list(boolean isLinked)` 新建一个空List
`static <T> List<T>`	`list(boolean isLinked, Collection<T> collection)` 新建一个List
`static <T> List<T>`	`list(boolean isLinked, Enumeration<T> enumration)` 新建一个List 提供的参数为null时返回空`ArrayList`
`static <T> List<T>`	`list(boolean isLinked, Iterable<T> iterable)` 新建一个List 提供的参数为null时返回空`ArrayList`
`static <T> List<T>`	`list(boolean isLinked, Iterator<T> iter)` 新建一个List 提供的参数为null时返回空`ArrayList`
`static <T> List<T>`	`list(boolean isLinked, T... values)` 新建一个List
`static <T> List<T>`	`move(List<T> list, T element, int newPosition)` 将元素移动到指定列表的新位置。
`static <T> List<T>`	`of(T... ts)` 数组转为一个不可变List 类似于Java9中的List.of
`static <T> List<T>`	`page(int pageNo, int pageSize, List<T> list)` 对指定List分页取值
`static <T> void`	`page(List<T> list, int pageSize, Consumer<List<T>> pageListConsumer)` 对指定List进行分页，逐页返回数据
`static <T> List<List<T>>`	`partition(List<T> list, int size)` 通过传入分区长度，将指定列表分区为不同的块，每块区域的长度相同（最后一块可能小于长度）分区是在原List的基础上进行的，返回的分区是不可变的抽象列表，原列表元素变更，分区中元素也会变更。
`static <T> List<T>`	`reverse(List<T> list)` 反序给定List，会在原List基础上直接修改
`static <T> List<T>`	`reverseNew(List<T> list)` 反序给定List，会创建一个新的List，原List数据不变
`static <T> List<T>`	`setOrAppend(List<T> list, int index, T element)` 设置或增加元素。
`static <T> List<T>`	`setOrPadding(List<T> list, int index, T element)` 在指定位置设置元素。
`static <T> List<T>`	`setOrPadding(List<T> list, int index, T element, T paddingElement)` 在指定位置设置元素。
`static <T> List<T>`	`setOrPadding(List<T> list, int index, T element, T paddingElement, int indexLimit)` 在指定位置设置元素。
`static <T> List<T>`	`sort(List<T> list, Comparator<? super T> c)` 针对List排序，排序会修改原List
`static List<String>`	`sortByPinyin(List<String> list)` 根据汉字的拼音顺序排序
`static <T> List<T>`	`sortByProperty(List<T> list, String property)` 根据Bean的属性排序
`static <T> List<List<T>>`	`split(List<T> list, int size)` 对集合按照指定长度分段，每一个段为单独的集合，返回这个集合的列表需要特别注意的是，此方法调用`List.subList(int, int)`切分List，此方法返回的是原List的视图，也就是说原List有变更，切分后的结果也会变更。
`static <T> List<List<T>>`	`splitAvg(List<T> list, int limit)` 将集合平均分成多个list，返回这个集合的列表例： ListUtil.splitAvg(null, 3); // [] ListUtil.splitAvg(Arrays.asList(1, 2, 3, 4), 2); // [[1, 2], [3, 4]] ListUtil.splitAvg(Arrays.asList(1, 2, 3), 5); // [[1], [2], [3], [], []] ListUtil.splitAvg(Arrays.asList(1, 2, 3), 2); // [[1, 2], [3]]
`static <T> List<T>`	`sub(List<T> list, int start, int end)` 截取集合的部分
`static <T> List<T>`	`sub(List<T> list, int start, int end, int step)` 截取集合的部分此方法与`List.subList(int, int)` 不同在于子列表是新的副本，操作子列表不会影响原列表。
`static <T> void`	`swapElement(List<T> list, T element, T targetElement)` 将指定元素交换到指定元素位置,其他元素的索引值不变交换会修改原List 如果集合中有多个相同元素，只交换第一个找到的元素
`static <T> void`	`swapTo(List<T> list, T element, Integer targetIndex)` 将指定元素交换到指定索引位置,其他元素的索引值不变交换会修改原List 如果集合中有多个相同元素，只交换第一个找到的元素
`static <T> CopyOnWriteArrayList<T>`	`toCopyOnWriteArrayList(Collection<T> collection)` 新建一个CopyOnWriteArrayList
`static <T> LinkedList<T>`	`toLinkedList(T... values)` 新建LinkedList
`static <T> ArrayList<T>`	`toList(Collection<T> collection)` 新建一个ArrayList
`static <T> ArrayList<T>`	`toList(Enumeration<T> enumeration)` 新建一个ArrayList 提供的参数为null时返回空`ArrayList`
`static <T> ArrayList<T>`	`toList(Iterable<T> iterable)` 新建一个ArrayList 提供的参数为null时返回空`ArrayList`
`static <T> ArrayList<T>`	`toList(Iterator<T> iterator)` 新建一个ArrayList 提供的参数为null时返回空`ArrayList`
`static <T> ArrayList<T>`	`toList(T... values)` 新建一个ArrayList
`static <T> List<T>`	`unmodifiable(List<T> list)` 将对应List转换为不可修改的List

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ListUtil
```
public ListUtil()
```
- Method Detail
  - list
```
public static <T> List<T> list(boolean isLinked)
```
    新建一个空List
    
    Type Parameters:
    
    T - 集合元素类型
    
    Parameters:
    
    isLinked - 是否新建LinkedList
    
    Returns:
    
    List对象
    
    Since:
    
    4.1.2
  - list
```
@SafeVarargs
public static <T> List<T> list(boolean isLinked,
                                             T... values)
```
    新建一个List
    
    Type Parameters:
    
    T - 集合元素类型
    
    Parameters:
    
    isLinked - 是否新建LinkedList
    
    values - 数组
    
    Returns:
    
    List对象
    
    Since:
    
    4.1.2
  - list
```
public static <T> List<T> list(boolean isLinked,
                               Collection<T> collection)
```
    新建一个List
    
    Type Parameters:
    
    T - 集合元素类型
    
    Parameters:
    
    isLinked - 是否新建LinkedList
    
    collection - 集合
    
    Returns:
    
    List对象
    
    Since:
    
    4.1.2
  - list
```
public static <T> List<T> list(boolean isLinked,
                               Iterable<T> iterable)
```
    新建一个List
    提供的参数为null时返回空ArrayList
    
    Type Parameters:
    
    T - 集合元素类型
    
    Parameters:
    
    isLinked - 是否新建LinkedList
    
    iterable - Iterable
    
    Returns:
    
    List对象
    
    Since:
    
    4.1.2
  - list
```
public static <T> List<T> list(boolean isLinked,
                               Iterator<T> iter)
```
    新建一个List
    提供的参数为null时返回空ArrayList
    
    Type Parameters:
    
    T - 集合元素类型
    
    Parameters:
    
    isLinked - 是否新建LinkedList
    
    iter - Iterator
    
    Returns:
    
    ArrayList对象
    
    Since:
    
    4.1.2
  - list
```
public static <T> List<T> list(boolean isLinked,
                               Enumeration<T> enumration)
```
    新建一个List
    提供的参数为null时返回空ArrayList
    
    Type Parameters:
    
    T - 集合元素类型
    
    Parameters:
    
    isLinked - 是否新建LinkedList
    
    enumration - Enumeration
    
    Returns:
    
    ArrayList对象
    
    Since:
    
    3.0.8
  - toList
```
@SafeVarargs
public static <T> ArrayList<T> toList(T... values)
```
    新建一个ArrayList
    
    Type Parameters:
    
    T - 集合元素类型
    
    Parameters:
    
    values - 数组
    
    Returns:
    
    ArrayList对象
  - toLinkedList
```
@SafeVarargs
public static <T> LinkedList<T> toLinkedList(T... values)
```
    新建LinkedList
    
    Type Parameters:
    
    T - 类型
    
    Parameters:
    
    values - 数组
    
    Returns:
    
    LinkedList
    
    Since:
    
    4.1.2
  - of
```
@SafeVarargs
public static <T> List<T> of(T... ts)
```
    数组转为一个不可变List
    类似于Java9中的List.of
    
    Type Parameters:
    
    T - 对象类型
    
    Parameters:
    
    ts - 对象
    
    Returns:
    
    不可修改List
    
    Since:
    
    5.4.3
  - toCopyOnWriteArrayList
```
public static <T> CopyOnWriteArrayList<T> toCopyOnWriteArrayList(Collection<T> collection)
```
    新建一个CopyOnWriteArrayList
    
    Type Parameters:
    
    T - 集合元素类型
    
    Parameters:
    
    collection - 集合
    
    Returns:
    
    CopyOnWriteArrayList
  - toList
```
public static <T> ArrayList<T> toList(Collection<T> collection)
```
    新建一个ArrayList
    
    Type Parameters:
    
    T - 集合元素类型
    
    Parameters:
    
    collection - 集合
    
    Returns:
    
    ArrayList对象
  - toList
```
public static <T> ArrayList<T> toList(Iterable<T> iterable)
```
    新建一个ArrayList
    提供的参数为null时返回空ArrayList
    
    Type Parameters:
    
    T - 集合元素类型
    
    Parameters:
    
    iterable - Iterable
    
    Returns:
    
    ArrayList对象
    
    Since:
    
    3.1.0
  - toList
```
public static <T> ArrayList<T> toList(Iterator<T> iterator)
```
    新建一个ArrayList
    提供的参数为null时返回空ArrayList
    
    Type Parameters:
    
    T - 集合元素类型
    
    Parameters:
    
    iterator - Iterator
    
    Returns:
    
    ArrayList对象
    
    Since:
    
    3.0.8
  - toList
```
public static <T> ArrayList<T> toList(Enumeration<T> enumeration)
```
    新建一个ArrayList
    提供的参数为null时返回空ArrayList
    
    Type Parameters:
    
    T - 集合元素类型
    
    Parameters:
    
    enumeration - Enumeration
    
    Returns:
    
    ArrayList对象
    
    Since:
    
    3.0.8
  - page
```
public static <T> List<T> page(int pageNo,
                               int pageSize,
                               List<T> list)
```
    对指定List分页取值
    
    Type Parameters:
    
    T - 集合元素类型
    
    Parameters:
    
    pageNo - 页码，第一页的页码取决于PageUtil.getFirstPageNo()，默认0
    
    pageSize - 每页的条目数
    
    list - 列表
    
    Returns:
    
    分页后的段落内容
    
    Since:
    
    4.1.20
  - page
```
public static <T> void page(List<T> list,
                            int pageSize,
                            Consumer<List<T>> pageListConsumer)
```
    对指定List进行分页，逐页返回数据
    
    Type Parameters:
    
    T - 集合元素类型
    
    Parameters:
    
    list - 源数据列表
    
    pageSize - 每页的条目数
    
    pageListConsumer - 单页数据函数式返回
    
    Since:
    
    5.7.10
  - sort
```
public static <T> List<T> sort(List<T> list,
                               Comparator<? super T> c)
```
    针对List排序，排序会修改原List
    
    Type Parameters:
    
    T - 元素类型
    
    Parameters:
    
    list - 被排序的List
    
    c - Comparator
    
    Returns:
    
    原list
    
    See Also:
    
    Collections.sort(List, Comparator)
  - sortByProperty
```
public static <T> List<T> sortByProperty(List<T> list,
                                         String property)
```
    根据Bean的属性排序
    
    Type Parameters:
    
    T - 元素类型
    
    Parameters:
    
    list - List
    
    property - 属性名
    
    Returns:
    
    排序后的List
    
    Since:
    
    4.0.6
  - sortByPinyin
```
public static List<String> sortByPinyin(List<String> list)
```
    根据汉字的拼音顺序排序
    
    Parameters:
    
    list - List
    
    Returns:
    
    排序后的List
    
    Since:
    
    4.0.8
  - reverse
```
public static <T> List<T> reverse(List<T> list)
```
    反序给定List，会在原List基础上直接修改
    
    Type Parameters:
    
    T - 元素类型
    
    Parameters:
    
    list - 被反转的List
    
    Returns:
    
    反转后的List
    
    Since:
    
    4.0.6
  - reverseNew
```
public static <T> List<T> reverseNew(List<T> list)
```
    反序给定List，会创建一个新的List，原List数据不变
    
    Type Parameters:
    
    T - 元素类型
    
    Parameters:
    
    list - 被反转的List
    
    Returns:
    
    反转后的List
    
    Since:
    
    4.0.6
  - setOrAppend
```
public static <T> List<T> setOrAppend(List<T> list,
                                      int index,
                                      T element)
```
    设置或增加元素。当index小于List的长度时，替换指定位置的值，否则在尾部追加
    
    Type Parameters:
    
    T - 元素类型
    
    Parameters:
    
    list - List列表
    
    index - 位置
    
    element - 新元素
    
    Returns:
    
    原List
    
    Since:
    
    4.1.2
  - setOrPadding
```
public static <T> List<T> setOrPadding(List<T> list,
                                       int index,
                                       T element)
```
    在指定位置设置元素。当index小于List的长度时，替换指定位置的值，否则追加null直到到达index后，设置值
    
    Type Parameters:
    
    T - 元素类型
    
    Parameters:
    
    list - List列表
    
    index - 位置
    
    element - 新元素
    
    Returns:
    
    原List
    
    Since:
    
    5。8.4
  - setOrPadding
```
public static <T> List<T> setOrPadding(List<T> list,
                                       int index,
                                       T element,
                                       T paddingElement)
```
    在指定位置设置元素。当index小于List的长度时，替换指定位置的值，否则追加paddingElement直到到达index后，设置值
    注意：为避免OOM问题，此方法限制index的最大值为(list.size() + 1) * 10
    
    Type Parameters:
    
    T - 元素类型
    
    Parameters:
    
    list - List列表
    
    index - 位置
    
    element - 新元素
    
    paddingElement - 填充的值
    
    Returns:
    
    原List
    
    Since:
    
    5.8.4
  - setOrPadding
```
public static <T> List<T> setOrPadding(List<T> list,
                                       int index,
                                       T element,
                                       T paddingElement,
                                       int indexLimit)
```
    在指定位置设置元素。当index小于List的长度时，替换指定位置的值，否则追加paddingElement直到到达index后，设置值
    
    Type Parameters:
    
    T - 元素类型
    
    Parameters:
    
    list - List列表
    
    index - 位置
    
    element - 新元素
    
    paddingElement - 填充的值
    
    indexLimit - 最大索引限制
    
    Returns:
    
    原List
    
    Since:
    
    5.8.28
  - sub
```
public static <T> List<T> sub(List<T> list,
                              int start,
                              int end)
```
    截取集合的部分
    
    Type Parameters:
    
    T - 集合元素类型
    
    Parameters:
    
    list - 被截取的数组
    
    start - 开始位置（包含）
    
    end - 结束位置（不包含）
    
    Returns:
    
    截取后的数组，当开始位置超过最大时，返回空的List
  - sub
```
public static <T> List<T> sub(List<T> list,
                              int start,
                              int end,
                              int step)
```
    截取集合的部分
    此方法与List.subList(int, int) 不同在于子列表是新的副本，操作子列表不会影响原列表。
    
    Type Parameters:
    
    T - 集合元素类型
    
    Parameters:
    
    list - 被截取的数组
    
    start - 开始位置（包含）
    
    end - 结束位置（不包含）
    
    step - 步进
    
    Returns:
    
    截取后的数组，当开始位置超过最大时，返回空的List
    
    Since:
    
    4.0.6
  - lastIndexOf
```
public static <T> int lastIndexOf(List<T> list,
                                  Matcher<T> matcher)
```
    获取匹配规则定义中匹配到元素的最后位置
    此方法对于某些无序集合的位置信息，以转换为数组后的位置为准。
    
    Type Parameters:
    
    T - 元素类型
    
    Parameters:
    
    list - List集合
    
    matcher - 匹配器，为空则全部匹配
    
    Returns:
    
    最后一个位置
    
    Since:
    
    5.6.6
  - indexOfAll
```
public static <T> int[] indexOfAll(List<T> list,
                                   Matcher<T> matcher)
```
    获取匹配规则定义中匹配到元素的所有位置
    
    Type Parameters:
    
    T - 元素类型
    
    Parameters:
    
    list - 列表
    
    matcher - 匹配器，为空则全部匹配
    
    Returns:
    
    位置数组
    
    Since:
    
    5.2.5
  - unmodifiable
```
public static <T> List<T> unmodifiable(List<T> list)
```
    将对应List转换为不可修改的List
    
    Type Parameters:
    
    T - 元素类型
    
    Parameters:
    
    list - List
    
    Returns:
    
    不可修改List
    
    Since:
    
    5.2.6
  - empty
```
public static <T> List<T> empty()
```
    获取一个空List，这个空List不可变
    
    Type Parameters:
    
    T - 元素类型
    
    Returns:
    
    空的List
    
    Since:
    
    5.2.6
    
    See Also:
    
    Collections.emptyList()
  - partition
```
public static <T> List<List<T>> partition(List<T> list,
                                          int size)
```
    通过传入分区长度，将指定列表分区为不同的块，每块区域的长度相同（最后一块可能小于长度）
    分区是在原List的基础上进行的，返回的分区是不可变的抽象列表，原列表元素变更，分区中元素也会变更。
    需要特别注意的是，此方法调用List.subList(int, int)切分List，此方法返回的是原List的视图，也就是说原List有变更，切分后的结果也会变更。
    
    Type Parameters:
    
    T - 集合元素类型
    
    Parameters:
    
    list - 列表，为空时返回empty()
    
    size - 每个段的长度，当长度超过list长度时，size按照list长度计算，即只返回一个节点
    
    Returns:
    
    分段列表
    
    Since:
    
    5.4.5
  - split
```
public static <T> List<List<T>> split(List<T> list,
                                      int size)
```
    对集合按照指定长度分段，每一个段为单独的集合，返回这个集合的列表
    需要特别注意的是，此方法调用List.subList(int, int)切分List，此方法返回的是原List的视图，也就是说原List有变更，切分后的结果也会变更。
    
    Type Parameters:
    
    T - 集合元素类型
    
    Parameters:
    
    list - 列表，为空时返回empty()
    
    size - 每个段的长度，当长度超过list长度时，size按照list长度计算，即只返回一个节点
    
    Returns:
    
    分段列表
    
    Since:
    
    5.4.5
    
    See Also:
    
    partition(List, int)
  - splitAvg
```
public static <T> List<List<T>> splitAvg(List<T> list,
                                         int limit)
```
    将集合平均分成多个list，返回这个集合的列表
    例：
```
     ListUtil.splitAvg(null, 3);        // []
     ListUtil.splitAvg(Arrays.asList(1, 2, 3, 4), 2);   // [[1, 2], [3, 4]]
     ListUtil.splitAvg(Arrays.asList(1, 2, 3), 5);      // [[1], [2], [3], [], []]
     ListUtil.splitAvg(Arrays.asList(1, 2, 3), 2);      // [[1, 2], [3]]
 
```
    Type Parameters:
    
    T - 集合元素类型
    
    Parameters:
    
    list - 集合
    
    limit - 要均分成几个list
    
    Returns:
    
    分段列表
    
    Since:
    
    5.7.10
  - swapTo
```
public static <T> void swapTo(List<T> list,
                              T element,
                              Integer targetIndex)
```
    将指定元素交换到指定索引位置,其他元素的索引值不变
    交换会修改原List
    如果集合中有多个相同元素，只交换第一个找到的元素
    
    Type Parameters:
    
    T - 元素类型
    
    Parameters:
    
    list - 列表
    
    element - 需交换元素
    
    targetIndex - 目标索引
    
    Since:
    
    5.7.13
  - swapElement
```
public static <T> void swapElement(List<T> list,
                                   T element,
                                   T targetElement)
```
    将指定元素交换到指定元素位置,其他元素的索引值不变
    交换会修改原List
    如果集合中有多个相同元素，只交换第一个找到的元素
    
    Type Parameters:
    
    T - 元素类型
    
    Parameters:
    
    list - 列表
    
    element - 需交换元素
    
    targetElement - 目标元素
  - move
```
public static <T> List<T> move(List<T> list,
                               T element,
                               int newPosition)
```
    将元素移动到指定列表的新位置。
    - 如果元素不在列表中，则将其添加到新位置。
    - 如果元素已在列表中，则先移除它，然后再将其添加到新位置。
    Type Parameters:
    
    T - 列表和元素的通用类型。
    
    Parameters:
    
    list - 原始列表，元素将在这个列表上进行操作。
    
    element - 需要移动的元素。
    
    newPosition - 元素的新位置，从0开始计数，位置计算是以移除元素后的列表位置计算的
    
    Returns:
    
    更新后的列表。
    
    Since:
    
    5.8.29

Class ListUtil

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ListUtil

Method Detail

list

list

list

list

list

list

toList

toLinkedList

of

toCopyOnWriteArrayList

toList

toList

toList

toList

page

page

sort

sortByProperty

sortByPinyin

reverse

reverseNew

setOrAppend

setOrPadding

setOrPadding

setOrPadding

sub

sub

lastIndexOf

indexOfAll

unmodifiable

empty

partition

split

splitAvg

swapTo

swapElement

move