Class ArrayFill

java.lang.Object

org.apache.commons.lang3.ArrayFill

public final class ArrayFill
extends Object

Fills and returns arrays in the fluent style.

Since:

3.14.0

Method Summary

Modifier and Type	Method	Description
static byte[]	clear(byte[] a)	Fills and returns the given array, assigning 0 to each element of the array.
static char[]	clear(char[] a)	Fills and returns the given array, assigning '\0' to each element of the array.
static char[]	clear(char[] a, int fromIndex, int toIndex)	Fills and returns the given array, assigning '\0' to each element of the array.
static boolean[]	fill(boolean[] a, boolean val)	Fills and returns the given array, assigning the given boolean value to each element of the array.
static byte[]	fill(byte[] a, byte val)	Fills and returns the given array, assigning the given byte value to each element of the array.
static char[]	fill(char[] a, char val)	Fills and returns the given array, assigning the given char value to each element of the array.
static char[]	fill(char[] a, int fromIndex, int toIndex, char val)	Fills and returns the given array, assigning the given char value to each element of the array.
static double[]	fill(double[] a, double val)	Fills and returns the given array, assigning the given double value to each element of the array.
static float[]	fill(float[] a, float val)	Fills and returns the given array, assigning the given float value to each element of the array.
static int[]	fill(int[] a, int val)	Fills and returns the given array, assigning the given int value to each element of the array.
static long[]	fill(long[] a, long val)	Fills and returns the given array, assigning the given long value to each element of the array.
static short[]	fill(short[] a, short val)	Fills and returns the given array, assigning the given short value to each element of the array.
static <T, E extends Throwable> T[]	fill(T[] array, FailableIntFunction<? extends T, E> generator)	Fills and returns the given array, using the provided generator function to compute each element.
static <T> T[]	fill(T[] a, T val)	Fills and returns the given array, assigning the given T value to each element of the array.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

clear

public static byte[] clear(byte[] a)

Fills and returns the given array, assigning 0 to each element of the array.

ArrayFill.fill(a, (byte) 0);

Parameters:

a - The array to fill (may be null).

Returns:

The given array.

Since:

3.21.0

See Also:

• Arrays.fill(byte[],byte)
• fill(byte[],byte)

clear

public static char[] clear(char[] a)

Fills and returns the given array, assigning '\0' to each element of the array.

Equivalent to:

ArrayFill.fill(a, '\0'); // and not '0'!

Parameters:

a - The array to fill (may be null).

Returns:

The given array.

Since:

3.21.0

See Also:

• Arrays.fill(char[],char)
• fill(char[],char)
• CharUtils.NUL

clear

public static char[] clear(char[] a,
 int fromIndex,
 int toIndex)

Fills and returns the given array, assigning '\0' to each element of the array.

Equivalent to:

ArrayFill.fill(a, fromIndex, toIndex, '\0'); // and not '0'!

Parameters:

a - The array to fill (may be null).

fromIndex - The index of the first element (inclusive) to be filled with '\0'.

toIndex - The index of the last element (exclusive) to be filled with '\0'.

Returns:

The given array.

Since:

3.21.0

See Also:

• Arrays.fill(char[], int, int, char)

fill

public static boolean[] fill(boolean[] a,
 boolean val)

Fills and returns the given array, assigning the given boolean value to each element of the array.

Parameters:

a - The array to fill (may be null).

val - The value to store in all elements of the array.

Returns:

The given array.

Since:

3.18.0

See Also:

• Arrays.fill(boolean[],boolean)

fill

public static byte[] fill(byte[] a,
 byte val)

Fills and returns the given array, assigning the given byte value to each element of the array.

Parameters:

a - The array to fill (may be null).

val - The value to store in all elements of the array.

Returns:

The given array.

See Also:

• Arrays.fill(byte[],byte)

fill

public static char[] fill(char[] a,
 char val)

Fills and returns the given array, assigning the given char value to each element of the array.

Parameters:

a - The array to fill (may be null).

val - The value to store in all elements of the array.

Returns:

The given array.

See Also:

• Arrays.fill(char[],char)

fill

public static char[] fill(char[] a,
 int fromIndex,
 int toIndex,
 char val)

Fills and returns the given array, assigning the given char value to each element of the array.

Parameters:

a - The array to fill (may be null).

fromIndex - The index of the first element (inclusive) to be filled with the specified value.

toIndex - The index of the last element (exclusive) to be filled with the specified value.

val - The value to store in all elements of the array.

Returns:

The given array.

Since:

3.21.0

See Also:

• Arrays.fill(char[], int, int, char)

fill

public static double[] fill(double[] a,
 double val)

Fills and returns the given array, assigning the given double value to each element of the array.

Parameters:

a - The array to fill (may be null).

val - The value to store in all elements of the array.

Returns:

The given array.

See Also:

• Arrays.fill(double[],double)

fill

public static float[] fill(float[] a,
 float val)

Fills and returns the given array, assigning the given float value to each element of the array.

Parameters:

a - The array to fill (may be null).

val - The value to store in all elements of the array.

Returns:

The given array.

See Also:

• Arrays.fill(float[],float)

fill

public static int[] fill(int[] a,
 int val)

Fills and returns the given array, assigning the given int value to each element of the array.

Parameters:

a - The array to fill (may be null).

val - The value to store in all elements of the array.

Returns:

The given array.

See Also:

• Arrays.fill(int[],int)

fill

public static long[] fill(long[] a,
 long val)

Fills and returns the given array, assigning the given long value to each element of the array.

Parameters:

a - The array to fill (may be null).

val - The value to store in all elements of the array.

Returns:

The given array.

See Also:

• Arrays.fill(long[],long)

fill

public static short[] fill(short[] a,
 short val)

Fills and returns the given array, assigning the given short value to each element of the array.

Parameters:

a - The array to fill (may be null).

val - The value to store in all elements of the array.

Returns:

The given array.

See Also:

• Arrays.fill(short[],short)

fill

public static <T, E extends Throwable> T[] fill(T[] array,
 FailableIntFunction<? extends T, E> generator)
                                         throws E

Fills and returns the given array, using the provided generator function to compute each element. Like Arrays.setAll(Object[], IntFunction) with exception support.

If the generator function throws an exception, it is relayed to the caller and the array is left in an indeterminate state.

If the input array or generator function is null, nothing happens.

Type Parameters:

T - type of elements of the array.

E - The kind of thrown exception or error.

Parameters:

array - array to fill (may be null).

generator - A function accepting an index and producing the desired value for that position.

Returns:

The input array.

Throws:

E - Thrown by the given generator.

Since:

3.18.0

See Also:

• Arrays.setAll(Object[], IntFunction)

fill

public static <T> T[] fill(T[] a,
 T val)

Fills and returns the given array, assigning the given T value to each element of the array.

Type Parameters:

T - The array type.

Parameters:

a - The array to fill (may be null).

val - The value to store in all elements of the array.

Returns:

The given array.

See Also:

• Arrays.fill(Object[],Object)