io microsphere util ArrayUtils

ArrayUtils

Type: Class | Module: microsphere-java-core | Package: io.microsphere.util | Since: 1.0.0

Source: microsphere-java-core/src/main/java/io/microsphere/util/ArrayUtils.java

Overview

The utilities class for Array

Declaration

public abstract class ArrayUtils implements Utils

Author: Mercy

Version Information

Introduced in: 1.0.0
Current Project Version: 0.3.20-SNAPSHOT

Version Compatibility

This component is tested and compatible with the following Java versions:

Java Version	Status
Java 8	✅ Compatible
Java 11	✅ Compatible
Java 17	✅ Compatible
Java 21	✅ Compatible
Java 25	✅ Compatible

Examples

Method Examples

`of`

String[] strings = ArrayUtils.of("one", "two", "three");
Integer[] integers = ArrayUtils.of(1, 2, 3);

`ofBooleans`

boolean[] booleans = ArrayUtils.ofBooleans(true, false, true);

`ofBytes`

byte[] bytes = ArrayUtils.ofBytes((byte) 1, (byte) 2, (byte) 3);

`ofChars`

char[] chars = ArrayUtils.ofChars('a', 'b', 'c');

`ofShorts`

short[] shorts = ArrayUtils.ofShorts((short) 1, (short) 2, (short) 3);

`ofInts`

int[] ints = ArrayUtils.ofInts(1, 2, 3);

`ofLongs`

long[] longs = ArrayUtils.ofLongs(1L, 2L, 3L);

`ofFloats`

float[] floats = ArrayUtils.ofFloats(1.0f, 2.0f, 3.0f);

`ofDoubles`

double[] doubles = ArrayUtils.ofDoubles(1.0, 2.0, 3.0);

`ofArray`

String[] strings = ArrayUtils.ofArray("one", "two", "three");
Integer[] integers = ArrayUtils.ofArray(1, 2, 3);

`nullSafeArray`

String[] nonNullArray = ArrayUtils.nullSafeArray(null); // returns an empty String array
String[] anotherNonNullArray = ArrayUtils.nullSafeArray(new String[] {"one", "two"}); // returns the original array

`length`

int length = ArrayUtils.length(new boolean[] { true, false }); // returns 2
int nullArrayLength = ArrayUtils.length((boolean[]) null); // returns 0

`length`

int length = ArrayUtils.length(new byte[] { 1, 2 }); // returns 2
int nullArrayLength = ArrayUtils.length((byte[]) null); // returns 0

`length`

int length = ArrayUtils.length(new char[] { 'a', 'b' }); // returns 2
int nullArrayLength = ArrayUtils.length((char[]) null); // returns 0

`length`

int length = ArrayUtils.length(new short[] { 1, 2 }); // returns 2
int nullArrayLength = ArrayUtils.length((short[]) null); // returns 0

`length`

int length = ArrayUtils.length(new int[] { 1, 2, 3 }); // returns 3
int nullArrayLength = ArrayUtils.length((int[]) null); // returns 0

`length`

int length = ArrayUtils.length(new long[] { 1L, 2L }); // returns 2
int nullArrayLength = ArrayUtils.length((long[]) null); // returns 0

`length`

int length = ArrayUtils.length(new float[] { 1.0f, 2.0f }); // returns 2
int nullArrayLength = ArrayUtils.length((float[]) null); // returns 0

`length`

int length = ArrayUtils.length(new double[] { 1.0, 2.0 }); // returns 2
int nullArrayLength = ArrayUtils.length((double[]) null); // returns 0

`length`

Integer[] integers = {1, 2, 3};
int length = ArrayUtils.length(integers); // returns 3

String[] strings = null;
int nullArrayLength = ArrayUtils.length(strings); // returns 0

Usage

Maven Dependency

Add the following dependency to your pom.xml:

<dependency>
    <groupId>io.github.microsphere-projects</groupId>
    <artifactId>microsphere-java-core</artifactId>
    <version>${microsphere-java.version}</version>
</dependency>

Tip: Use the BOM (microsphere-java-dependencies) for consistent version management. See the Getting Started guide.

Import

import io.microsphere.util.ArrayUtils;

API Reference

Public Methods

Method	Description
`of`	An empty immutable `boolean` array.
`ofBooleans`	Creates a new `boolean` array from the provided elements.
`ofBytes`	Creates a new `byte` array from the provided elements.
`ofChars`	Creates a new `char` array from the provided elements.
`ofShorts`	Creates a new `short` array from the provided elements.
`ofInts`	Creates a new `int` array from the provided elements.
`ofLongs`	Creates a new `long` array from the provided elements.
`ofFloats`	Creates a new `float` array from the provided elements.
`ofDoubles`	Creates a new `double` array from the provided elements.
`ofArray`	Creates an array from the provided elements.
`nullSafeArray`	Returns a non-null array. If the provided array is `null`, an empty array is returned instead.
`length`	Returns the length of the provided array.
`length`	Returns the length of the provided byte array.
`length`	Returns the length of the provided char array.
`length`	Returns the length of the provided short array.
`length`	Returns the length of the provided int array.
`length`	Returns the length of the provided long array.
`length`	Returns the length of the provided float array.
`length`	Returns the length of the provided double array.
`length`	Returns the length of the provided array.

Method Details

`ofBooleans`

public static boolean[] ofBooleans(boolean... values)

Creates a new boolean array from the provided elements.

This method returns an array containing the specified elements. The type of the returned array is explicitly defined by the method's return type.

Example Usage

`boolean[] booleans = ArrayUtils.ofBooleans(true, false, true);
`

`ofBytes`

public static byte[] ofBytes(byte... values)

Creates a new byte array from the provided elements.

This method returns an array containing the specified elements. The type of the returned array is explicitly defined by the method's return type.

Example Usage

`byte[] bytes = ArrayUtils.ofBytes((byte) 1, (byte) 2, (byte) 3);
`

`ofChars`

public static char[] ofChars(char... values)

Creates a new char array from the provided elements.

This method returns an array containing the specified elements. The type of the returned array is explicitly defined by the method's return type.

Example Usage

`char[] chars = ArrayUtils.ofChars('a', 'b', 'c');
`

`ofShorts`

public static short[] ofShorts(short... values)

Creates a new short array from the provided elements.

This method returns an array containing the specified elements. The type of the returned array is explicitly defined by the method's return type.

Example Usage

`short[] shorts = ArrayUtils.ofShorts((short) 1, (short) 2, (short) 3);
`

`ofInts`

public static int[] ofInts(int... values)

Creates a new int array from the provided elements.

This method returns an array containing the specified elements. The type of the returned array is explicitly defined by the method's return type.

Example Usage

`int[] ints = ArrayUtils.ofInts(1, 2, 3);
`

`ofLongs`

public static long[] ofLongs(long... values)

Creates a new long array from the provided elements.

This method returns an array containing the specified elements. The type of the returned array is explicitly defined by the method's return type.

Example Usage

`long[] longs = ArrayUtils.ofLongs(1L, 2L, 3L);
`

`ofFloats`

public static float[] ofFloats(float... values)

Creates a new float array from the provided elements.

This method returns an array containing the specified elements. The type of the returned array is explicitly defined by the method's return type.

Example Usage

`float[] floats = ArrayUtils.ofFloats(1.0f, 2.0f, 3.0f);
`

`ofDoubles`

public static double[] ofDoubles(double... values)

Creates a new double array from the provided elements.

This method returns an array containing the specified elements. The type of the returned array is explicitly defined by the method's return type.

Example Usage

`double[] doubles = ArrayUtils.ofDoubles(1.0, 2.0, 3.0);
`

`ofArray`

public static <T> T[] ofArray(T... values)

Creates an array from the provided elements.

This method returns an array containing the specified elements. The type of the returned array is inferred from the type of the first element passed, or from the context if the method is used in a typed assignment.

Example Usage

`String[] strings = ArrayUtils.ofArray("one", "two", "three");
Integer[] integers = ArrayUtils.ofArray(1, 2, 3);
`

`nullSafeArray`

public static <T> T[] nullSafeArray(T... values)

Returns a non-null array. If the provided array is null, an empty array is returned instead.

This method is useful for avoiding NullPointerException when working with arrays that may be null. It ensures that you always have a valid array to work with, even if the original array was null.

Example Usage

`String[] nonNullArray = ArrayUtils.nullSafeArray(null); // returns an empty String array
String[] anotherNonNullArray = ArrayUtils.nullSafeArray(new String[] {"one", "two"`); // returns the original array
}