# HG changeset patch # User Jaikiran Pai # Date 1535208403 -19800 # Sat Aug 25 20:16:43 2018 +0530 # Node ID fbb71a7edc1aeeb6065e309a3efa67bc7ead6a3c # Parent 6c394ed56b07d453226e064bc011528cd89b7d69 JDK-7033681 Improve the javadoc of Arrays#toList() diff --git a/src/java.base/share/classes/java/util/Arrays.java b/src/java.base/share/classes/java/util/Arrays.java --- a/src/java.base/share/classes/java/util/Arrays.java +++ b/src/java.base/share/classes/java/util/Arrays.java @@ -28,6 +28,7 @@ import jdk.internal.HotSpotIntrinsicCandidate; import jdk.internal.util.ArraysSupport; +import java.io.Serializable; import java.lang.reflect.Array; import java.util.concurrent.ForkJoinPool; import java.util.function.BinaryOperator; @@ -4288,11 +4289,25 @@ // Misc /** - * Returns a fixed-size list backed by the specified array. (Changes to - * the returned list "write through" to the array.) This method acts - * as bridge between array-based and collection-based APIs, in - * combination with {@link Collection#toArray}. The returned list is - * serializable and implements {@link RandomAccess}. + * Returns a fixed-size list backed by the specified array. Changes made to + * the array will be visible in the returned list, and changes made to the + * list will be visible in the array. The returned list is + * {@link Serializable} and implements {@link RandomAccess}. + * + *

The returned list can be changed only in certain ways. Operations + * that would change the size of the returned list leave the list unchanged + * and throw {@link UnsupportedOperationException}. + * + * @apiNote + * This method acts as bridge between array-based and collection-based + * APIs, in combination with {@link Collection#toArray}. + * + *

This method provides a way to wrap an existing array: + *

+     *     Integer[] numbers = ...
+     *     ...
+     *     List<Integer> values = Arrays.asList(numbers);
+     * 
* *

This method also provides a convenient way to create a fixed-size * list initialized to contain several elements: @@ -4300,9 +4315,14 @@ * List<String> stooges = Arrays.asList("Larry", "Moe", "Curly"); * * + *

The list returned by this method is not + * + * unmodifiable + * * @param the class of the objects in the array * @param a the array by which the list will be backed * @return a list view of the specified array + * @throws NullPointerException if the passed array is {@code null} */ @SafeVarargs @SuppressWarnings("varargs")