Class ArrayFill

src/main/java/org/apache/commons/lang3/ArrayFill.java:30–275

Fills and returns arrays in the fluent style. @since 3.14.0

 * @since 3.14.0
 */
public final class ArrayFill {

    /**
     * Fills and returns the given array, assigning {@code 0} to each element of the array.
     * <pre>
     * ArrayFill.fill(a, (byte) 0);
     * </pre>
     *
     * @param a   the array to fill (may be null).
     * @return the given array.
     * @see Arrays#fill(byte[],byte)
     * @see ArrayFill#fill(byte[],byte)
     * @since 3.21.0
     */
    public static byte[] clear(final byte[] a) {
        return fill(a, (byte) 0);
    }

    /**
     * Fills and returns the given array, assigning {@code '\0'} to each element of the array.
     * <p>
     * Equivalent to:
     * </p>
     * <pre>
     * ArrayFill.fill(a, '\0'); // and not '0'!
     * </pre>
     *
     * @param a   the array to fill (may be null).
     * @return the given array.
     * @see Arrays#fill(char[],char)
     * @see ArrayFill#fill(char[],char)
     * @see CharUtils#NUL
     * @since 3.21.0
     */
    public static char[] clear(final char[] a) {
        return fill(a, CharUtils.NUL); // and not '0'!
    }

    /**
     * Fills and returns the given array, assigning {@code '\0'} to each element of the array.
     * <p>
     * Equivalent to:
     * </p>
     * <pre>
     * ArrayFill.fill(a, fromIndex, toIndex, '\0'); // and not '0'!
     * </pre>
     *
     * @param a         the array to fill (may be null).
     * @param fromIndex the index of the first element (inclusive) to be filled with {@code '\0'}.
     * @param toIndex   the index of the last element (exclusive) to be filled with {@code '\0'}.
     * @return the given array.
     * @see Arrays#fill(char[], int, int, char)
     * @since 3.21.0
     */
    public static char[] clear(char[] a, int fromIndex, int toIndex) {
        return fill(a, fromIndex, toIndex, CharUtils.NUL);
    }