首页 > 代码库 > Util包中Arrays

Util包中Arrays

 

java.util
类 Arrays

java.lang.Object 
  -java.util.Arrays


public class Arrays extends Object

此类包含用来操作数组(比如排序和搜索)的各种方法。此类还包含一个允许将数组作为列表来查看的静态工厂。

除非特别注明,否则如果指定数组引用为 null,则此类中的方法都会抛出 NullPointerException

此类中所含方法的文档都包括对实现 的简短描述。应该将这些描述视为实现注意事项,而不应将它们视为规范 的一部分。实现者应该可以随意替代其他算法,只要遵循规范本身即可。(例如,sort(Object[]) 使用的算法不必是一个合并排序算法,但它必须是稳定的。)

此类是 Java Collections Framework 的成员。

 

从以下版本开始:
1.2

方法摘要
static <T> List<T> asList(T... a)
          返回一个受指定数组支持的固定大小的列表。
static int binarySearch(T[] a, T key)
          使用二分搜索法来搜索指定的 byte 型数组,以获得指定的值。
static int binarySearch(T[] a, int fromIndex, int toIndex, T key)
          使用二分搜索法来搜索指定的 byte 型数组的范围,以获得指定的值。
static <T> int
binarySearch(T[] a, int fromIndex, int toIndex, T key, Comparator<? super T> c)
          使用二分搜索法来搜索指定数组的范围,以获得指定对象。
static <T> int
binarySearch(T[] a, T key, Comparator<? super T> c)
          使用二分搜索法来搜索指定数组,以获得指定对象。
static <T> T[]
copyOf(T[] original, int newLength)
          复制指定的数组,截取或用 null 填充(如有必要),以使副本具有指定的长度。
static <T,U> T[]
copyOf(U[] original, int newLength, Class<? extends T[]> newType)
          复制指定的数组,截取或用 null 填充(如有必要),以使副本具有指定的长度。
static <T> T[]
copyOfRange(T[] original, int from, int to)
          将指定数组的指定范围复制到一个新数组。
static <T,U> T[]
copyOfRange(U[] original, int from, int to, Class<? extends T[]> newType)
          将指定数组的指定范围复制到一个新数组。
static boolean deepEquals(Object[] a1, Object[] a2)
          如果两个指定数组彼此是深层相等 的,则返回 true
static int deepHashCode(Object[] a)
          基于指定数组的“深层内容”返回哈希码。
static String deepToString(Object[] a)
          返回指定数组“深层内容”的字符串表示形式。
static boolean equals(T[] a, T[] a2)
          如果两个指定的 T 型数组彼此相等,则返回 true
static void fill(T[] a, int fromIndex, int toIndex, T val)
          将指定的 T引用分配给指定T数组指定范围中的每个元素。
static void fill(T[] a, T val)
          将指定的 T引用分配给指定T数组的每个元素。
static int hashCode(T[] a)
          基于指定数组的内容返回哈希码。
static void sort(T[] a)
          对指定的 byte 型数组按数字升序进行排序。
static void sort(T[] a, int fromIndex, int toIndex)
          对指定 byte 型数组的指定范围按数字升序进行排序。
static <T> void
sort(T[] a, Comparator<? super T> c)
          根据指定比较器产生的顺序对指定对象数组进行排序。
static <T> void
sort(T[] a, int fromIndex, int toIndex, Comparator<? super T> c)
          根据指定比较器产生的顺序对指定对象数组的指定范围进行排序。
static String toString(T[] a)
          返回指定数组内容的字符串表示形式。

从类 java.lang.Object 继承的方法
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait


public static <T> List<T> asList(T... a)
返回一个受指定数组支持的固定大小的列表。(对返回列表的更改会“直接写”到数组。)此方法同 Collection.toArray() 一起,充当了基于数组的 API 与基于 collection 的 API 之间的桥梁。返回的列表是可序列化的,并且实现了 RandomAccess

此方法还提供了一个创建固定长度的列表的便捷方法,该列表被初始化为包含多个元素:

     List<String> stooges = Arrays.asList("Larry", "Moe", "Curly"); 
参数:
a - 支持列表的数组。
返回:
指定数组的列表视图。
 

binarySearch

public static int binarySearch(T[] a,
                               T key)
使用二分搜索法来搜索指定的 T 型数组,以获得指定的值。必须在进行此调用之前对数组进行排序(通过 sort(T[]) 方法)。如果没有对数组进行排序,则结果是不确定的。如果数组包含多个带有指定值的元素,则无法保证找到的是哪一个。

 

参数:
a - 要搜索的数组
key - 要搜索的值
返回:
如果它包含在数组中,则返回搜索键的索引;否则返回 (-(插入点) - 1)插入点 被定义为将键插入数组的那一点:即第一个大于此键的元素索引,如果数组中的所有元素都小于指定的键,则为 a.length。注意,这保证了当且仅当此键被找到时,返回的值将 >= 0。
 

binarySearch
public static int binarySearch(T[] a,
                               int fromIndex,
                               int toIndex,
                               T key)
使用二分搜索法来搜索指定的 byte 型数组的范围,以获得指定的值。必须在进行此调用之前对范围进行排序(通过 sort(T[], int, int) 方法)。如果没有对范围进行排序,则结果是不确定的。如果范围包含多个带有指定值的元素,则无法保证找到的是哪一个。

 

参数:
a - 要搜索的数组
fromIndex - 要搜索的第一个元素的索引(包括)
toIndex - 要搜索的最后一个元素的索引(不包括)
key - 要搜索的值
返回:
如果它包含在数组的指定范围内,则返回搜索键的索引;否则返回 (-(插入点) - 1)插入点 被定义为将键插入数组的那一点:即范围中第一个大于此键的元素索引,如果范围中的所有元素都小于指定的键,则为 toIndex。注意,这保证了当且仅当此键被找到时,返回的值将 >= 0。
抛出:
IllegalArgumentException - 如果 fromIndex > toIndex
ArrayIndexOutOfBoundsException - 如果 fromIndex < 0 或 toIndex > a.length
从以下版本开始:
1.6 


binarySearch
public static <T> int binarySearch(T[] a,
                                   int fromIndex,
                                   int toIndex,
                                   T key,
                                   Comparator<? super T> c)
使用二分搜索法来搜索指定数组的范围,以获得指定对象。在进行此调用之前,必须根据指定的比较器(通过 sort(T[], int, int, Comparator) 方法)对范围进行升序排序。如果没有对范围进行排序,则结果是不确定的。如果范围包含多个等于指定对象的元素,则无法保证找到的是哪一个。

 

参数:
a - 要搜索的数组
fromIndex - 要搜索的第一个元素的索引(包括)
toIndex - 要搜索的最后一个元素的索引(不包括)
key - 要搜索的值
c - 用来对数组进行排序的比较器。null 值指示应该使用元素的自然顺序。
返回:
如果它包含在数组的指定范围内,则返回搜索键的索引;否则返回 (-(插入点) - 1)插入点 被定义为将键插入数组的那一点:即范围中第一个大于此键的元素索引,如果范围中的所有元素都小于指定的键,则为 toIndex。注意,这保证了当且仅当此键被找到时,返回的值将 >= 0。
抛出:
ClassCastException - 如果范围包含使用指定的比较器不可相互比较 的元素,或者使用此比较器无法相互比较搜索键与范围中的元素。
IllegalArgumentException - 如果 fromIndex > toIndex
ArrayIndexOutOfBoundsException - 如果 fromIndex < 0 或 toIndex > a.length
从以下版本开始:
1.6 


copyOf
public static T[] copyOf(T[] original,
                               int newLength)
复制指定的数组,截取或用 默认值 填充(如有必要),以使副本具有指定的长度。对于在原数组和副本中都有效的所有索引,这两个数组将包含相同的值。对于在副本中有效而在原数组无效的所有索引,副本将包含 默认值 。当且仅当指定长度大于原数组的长度时,这些索引存在。

 

参数:
original - 要复制的数组
newLength - 要返回的副本的长度
返回:
原数组的副本,截取或用 默认值  元素填充以获得指定的长度
抛出:
NegativeArraySizeException - 如果 newLength 为负
NullPointerException - 如果 original 为 null
从以下版本开始:
1.6 


copyOf

public static <T,U> T[] copyOf(U[] original,
                               int newLength,
                               Class<? extends T[]> newType)
复制指定的数组,截取或用 null 填充(如有必要),以使副本具有指定的长度。对于在原数组和副本中都有效的所有索引,这两个数组将包含相同的值。对于在副本中有效而在原数组无效的所有索引,副本将包含 null。当且仅当指定长度大于原数组的长度时,这些索引存在。所得数组属于 newType 类。

 

参数:
original - 要复制的数组
newLength - 要返回的副本的长度
newType - 要返回的副本的类
返回:
原数组的副本,截取或用 null 填充以获得指定的长度
抛出:
NegativeArraySizeException - 如果 newLength 为负
NullPointerException - 如果 original 为 null
ArrayStoreException - 如果从 original 中复制的元素不属于存储在 newType 类数组中的运行时类型
从以下版本开始:
1.6 


copyOfRange

public static T[] copyOfRange(T[] original,
                                 int from,
                                 int to)
将指定数组的指定范围复制到一个新数组。该范围的初始索引 (from) 必须位于 0 和 original.length(包括)之间。original[from] 处的值放入副本的初始元素中(除非 from == original.lengthfrom == to)。原数组中后续元素的值放入副本的后续元素。该范围的最后索引 (to) (必须大于等于 from)可以大于 original.length,在这种情况下,(T)默认值 被放入索引大于等于 original.length - from 的副本的所有元素中。返回数组的长度为 to - from

 

参数:
original - 将要从其复制一个范围的数组
from - 要复制的范围的初始索引(包括)
to - 要复制的范围的最后索引(不包括)。(此索引可以位于数组范围之外)。
返回:
包含取自原数组指定范围的新数组,截取或用 0 填充以获得所需长度
抛出:
ArrayIndexOutOfBoundsException - 如果 from < 0from > original.length()
IllegalArgumentException - 如果 from > to
NullPointerException - 如果 original 为 null
从以下版本开始:
1.6 


copyOfRange

public static <T,U> T[] copyOfRange(U[] original,
                                    int from,
                                    int to,
                                    Class<? extends T[]> newType)
将指定数组的指定范围复制到一个新数组。该范围的初始索引 (from) 必须位于 0 和 original.length(包括)之间。original[from] 处的值放入副本的初始元素中(除非 from == original.lengthfrom == to)。原数组中后续元素的值放入副本的后续元素。该范围的最后索引 (to) (必须大于等于 from)可以大于 original.length,在这种情况下,null 被放入索引大于等于 original.length - from 的副本的所有元素中。返回数组的长度为 to - from。所得数组属于 newType 类。

 

参数:
original - 将要从其复制一个范围的数组
from - 要复制的范围的初始索引(包括)
to - 要复制的范围的最后索引(不包括)。(此索引可以位于数组范围之外)。
newType - 要返回的副本的类
返回:
包含取自原数组指定范围的新数组,截取或用 null 填充以获得所需长度
抛出:
ArrayIndexOutOfBoundsException - 如果 from < 0from > original.length()
IllegalArgumentException - 如果 from > to
NullPointerException - 如果 original 为 null
ArrayStoreException - 如果从 original 复制的元素不属于可以存储在 newType 类数组中的运行时类型。
从以下版本开始:
1.6 



deepEquals

public static boolean deepEquals(Object[] a1,
                                 Object[] a2)
如果两个指定数组彼此是深层相等 的,则返回 true。与 equals(Object[],Object[]) 方法不同,此方法适用于任意深度的嵌套数组。

如果两个数组引用均为 null,或者它们引用了包含相同元素数量的数组,并且两个数组中的所有相应元素对都是深层相等的,则认为这两个数组引用是深层相等的。

如果满足以下任意条件之一,则两个 null 元素 e1e2 可能是深层相等的:

  • e1e2 都是对象引用类型的数组,并且 Arrays.deepEquals(e1, e2) 将返回 true。
  • e1e2 都是相同基本类型的数组,并且 Arrays.equals(e1, e2) 的适当重载将返回 true。
  • e1 == e2
  • e1.equals(e2) 将返回 true。
注意,此定义支持任意深度的 null 元素。

如果指定数组中的任意一个数组,直接或间接通过一个或多个数组级别,包含数组本身作为其元素,则此方法的行为是不确定的。

 

参数:
a1 - 将测试其相等性的一个数组
a2 - 将测试其相等性的另一个数组
返回:
如果两个数组相等,则返回 true
从以下版本开始:
1.5
另请参见:
equals(Object[],Object[])


deepHashCode

public static int deepHashCode(Object[] a)
基于指定数组的“深层内容”返回哈希码。如果数组包含作为元素的其他数组,则哈希码将基于其内容,并以此类推,直至无穷。所以,在将自身包含为一个元素的数组上,直接或间接通过一个或多个数组级别来调用此方法是不可接受的。这种调用的行为是不确定的。

对于任何两个满足 Arrays.deepEquals(a, b) 的数组 ab,也可以说 Arrays.deepHashCode(a) == Arrays.deepHashCode(b)

对此方法返回值的计算类似于对列表上的 List.hashCode() 返回值的计算,该列表以相同的顺序包含与 a 数组相同的元素,但有一点不同:如果数组 ae 元素本身是一个数组,则不能通过调用 e.hashCode() 计算其哈希码,但是,如果 e 是一个基本类型数组,则可以通过调用 Arrays.hashCode(e) 的适当重载来计算其哈希码,或者,如果 e 是一个引用类型数组,则可以通过递归调用 Arrays.deepHashCode(e) 来计算其哈希码。如果 anull,则此方法返回 0。

 

参数:
a - 将计算其基于深层内容的哈希码的数组
返回:
a 数组基于深层内容的哈希码
从以下版本开始:
1.5
另请参见:
hashCode(Object[])



deepToString

public static String deepToString(Object[] a)
返回指定数组“深层内容”的字符串表示形式。如果数组包含作为元素的其他数组,则字符串表示形式包含其内容等。此方法是为了将多维数组转换为字符串而设计的。

字符串表示形式由数组的元素列表组成,括在方括号("[]")中。相邻元素用字符 ", "(逗号加空格)分隔。这些元素通过 String.valueOf(Object) 转换为字符串,除非它们是自身的数组。

如果元素 e 是一个基本类型的数组,则通过调用 Arrays.toString(e) 的适当重载将它转换为字符串。如果元素 e 是一个引用类型的数组,则通过递归调用此方法将它转换为字符串。

为了避免无限递归,如果指定数组包含本身作为其元素,或者包含通过一个或多个数组级别对其自身的间接引用,则将自引用转换为字符串 "[...]"。例如,只包含对自身进行引用的数组将呈现为 "[[...]]"

如果指定数组为 null,则此方法返回 "null"

 

参数:
a - 返回其字符串表示形式的数组
返回:
a 的字符串表示形式
从以下版本开始:
1.5


equals

public static boolean equals(T[] a,
                             T[] a2)
如果两个指定的 T 数组彼此相等,则返回 true。如果两个数组包含相同数量的元素,并且两个数组中的所有相应元素对都是相等的,则认为这两个数组是相等的。如果 (e1==null ? e2==null : e1.equals(e2)),则认为 e1e2 这两个对象是相等的 。换句话说,如果两个数组以相同顺序包含相同的元素,则两个数组是相等的。此外,如果两个数组引用都为 null,则认为它们是相等的。

 

参数:
a - 将测试其相等性的一个数组
a2 - 将测试其相等性的另一个数组
返回:
     如果两个数组相等,则返回 true

fill

public static void fill(T[] a,
                        int fromIndex,
                        int toIndex,
                        T val)
将指定的 T 值分配给指定 T 型数组指定范围中的每个元素。填充的范围从索引 fromIndex(包括)一直到索引 toIndex(不包括)。(如果 fromIndex==toIndex,则填充范围为空。)

 

参数:
a - 要填充的数组
fromIndex - 要使用指定值填充的第一个元素的索引(包括)
toIndex - 要使用指定值填充的最后一个元素的索引(不包括)
val - 要存储在数组所有元素中的值
抛出:
IllegalArgumentException - 如果 fromIndex > toIndex
ArrayIndexOutOfBoundsException - 如果 fromIndex < 0toIndex > a.length


fill

public static void fill(T[] a,
                        T val)
将指定的 T 值分配给指定 T 型数组的每个元素。
参数:
a - 要填充的数组
val - 要存储在数组所有元素中的值
 


hashCode

public static int hashCode(T[] a)
基于指定数组的内容返回哈希码。如果数组包含作为元素的其他数组,则哈希码将基于其标识,而不是基于其内容。所以,在将自身包含为一个元素的数组上,直接或间接通过一个或多个数组级别来调用此方法是可接受的。

对于任何两个满足 Arrays.equals(a, b) 的数组 ab,也可以说 Arrays.hashCode(a) == Arrays.hashCode(b)

此方法返回的值等于 Arrays.asList(a).hashCode() 返回的值,除非 anull,在这种情况下返回 0

 

参数:
a - 将计算其基于内容的哈希码的数组
返回:
a 数组基于内容的哈希码
从以下版本开始:
1.5
另请参见:
deepHashCode(T[])

sort

public static void sort(Object[] a)
根据元素的自然顺序对指定对象数组按升序进行排序。数组中的所有元素都必须实现 Comparable 接口。此外,数组中的所有元素都必须是可相互比较的(也就是说,对于数组中的任何 e1e2 元素而言,e1.compareTo(e2) 不得抛出 ClassCastException)。

保证此排序是稳定的:不会因调用 sort 方法而对相等的元素进行重新排序。

该排序算法是一个经过修改的合并排序算法(其中,如果低子列表中的最高元素小于高子列表中的最低元素,则忽略合并)。此算法提供可保证的 n*log(n) 性能。

 

参数:
a - 要排序的数组
抛出:
ClassCastException - 如果数组包含不可相互比较的 的元素(例如,字符串和整数)。


sort
public static void sort(T[] a,
                        int fromIndex,
                        int toIndex)
根据元素的自然顺序对指定对象数组的指定范围按升序进行排序。排序的范围从索引 fromIndex(包括)一直到索引 toIndex(不包括)。(如果 fromIndex==toIndex,则排序范围为空。)此范围中的所有元素都必须实现 Comparable 接口。此外,此范围中的所有元素都必须是可相互比较的(也就是说,对于数组中的任何 e1e2 元素而言,e1.compareTo(e2) 不得抛出 ClassCastException)。

保证此排序是稳定的:不会因调用 sort 方法而对相等的元素进行重新排序。

该排序算法是一个经过修改的合并排序算法(其中,如果低子列表中的最高元素小于高子列表中的最低元素,则忽略合并)。此算法提供可保证的 n*log(n) 性能。

 

参数:
a - 要排序的数组
fromIndex - 要排序的第一个元素的索引(包括)
toIndex - 要排序的最后一个元素的索引(不包括)
抛出:
IllegalArgumentException - 如果 fromIndex > toIndex
ArrayIndexOutOfBoundsException - 如果 fromIndex < 0toIndex > a.length
ClassCastException - 如果数组包含不可相互比较的 的元素(例如,字符串和整数)。


sort

public static <T> void sort(T[] a,
                            Comparator<? super T> c)
根据指定比较器产生的顺序对指定对象数组进行排序。数组中的所有元素都必须是通过指定比较器可相互比较的(也就是说,对于数组中的任何 e1e2 元素而言,c.compare(e1, e2) 不得抛出 ClassCastException)。

保证此排序是稳定的:不会因调用 sort 方法而对相等的元素进行重新排序。

该排序算法是一个经过修改的合并排序算法(其中,如果低子列表中的最高元素小于高子列表中的最低元素,则忽略合并)。此算法提供可保证的 n*log(n) 性能。

 

参数:
a - 要排序的数组
c - 确定数组顺序的比较器。null 值指示应该使用元素的自然顺序。
抛出:
ClassCastException - 如果数组包含使用指定的比较器不可相互比较的 的元素。


sort

public static <T> void sort(T[] a,
                            int fromIndex,
                            int toIndex,
                            Comparator<? super T> c)
根据指定比较器产生的顺序对指定对象数组的指定范围进行排序。排序的范围从索引 fromIndex(包括)一直到索引 toIndex(不包括)。(如果 fromIndex==toIndex,则排序范围为空。)此范围内的所有元素都必须是通过指定比较器可相互比较的(也就是说,对于该范围中的任何 e1e2 元素而言,c.compare(e1, e2) 不得抛出 ClassCastException)。

保证此排序是稳定的:不会因调用 sort 方法而对相等的元素进行重新排序。

该排序算法是一个经过修改的合并排序算法(其中,如果低子列表中的最高元素小于高子列表中的最低元素,则忽略合并)。此算法提供可保证的 n*log(n) 性能。

 

参数:
a - 要排序的数组
fromIndex - 要排序的第一个元素的索引(包括)
toIndex - 要排序的最后一个元素的索引(不包括)
c - 确定数组顺序的比较器。null 值指示应该使用元素的自然顺序。
抛出:
ClassCastException - 如果数组包含使用指定的比较器不可相互比较的 的元素。
IllegalArgumentException - 如果 fromIndex > toIndex
ArrayIndexOutOfBoundsException - 如果 fromIndex < 0toIndex > a.length


toString

public static String toString(T[] a)
返回指定数组内容的字符串表示形式。如果数组包含作为元素的其他数组,则通过从 T 中继承的 T.toString() 方法将它们转换为字符串,这描述了它们的标识,而不是它们的内容。

此方法返回的值等于 Arrays.asList(a).toString() 返回的值,除非 anull,在这种情况下返回 "null"

 

参数:
a - 返回其字符串表示形式的数组
返回:
a 的字符串表示形式
从以下版本开始:
1.5
另请参见:
deepToString(Object[])








Util包中Arrays