ariba.util.core
Class ArrayUtil

java.lang.Object
  ariba.util.core.ArrayUtil

public final class ArrayUtil
extends Object

Array Utilities. These are helper functions for dealing with arrays.

Method Summary

static Object[]	append(Object[] in, Object a) Helper function to append an Object to an array and return the new array.
static Object[]	array() Helper function to create a new empty Object array
static Object[]	array(List vector) Convert a List into an Object array with null check.
static Object[]	array(Object a) Helper function to create a new Object array containing one Object.
static Object[]	array(Object a, Object b) Helper function to create a new Object array containing two Objects.
static Object[]	array(Object a, Object b, Object c) Helper function to create a new Object array containing three Objects.
static Object[]	array(Object a, Object b, Object c, Object d) Helper function to create a new Object array containing four Objects.
static Object[]	array(Object a, Object b, Object c, Object d, Object e) Helper function to create a new Object array containing five Objects.
static Object[]	array(Object a, Object b, Object c, Object d, Object e, Object f) Helper function to create a new Object array containing six Objects.
static Object[]	array(Object a, Object b, Object c, Object d, Object e, Object f, Object g) Helper function to create a new Object array containing seven Objects.
static Object[]	array(Object a, Object b, Object c, Object d, Object e, Object f, Object g, Object h) Helper function to create a new Object array containing eight Objects.
static boolean	arrayEquals(Object[] a1, Object[] a2) Determines if the two arrays are equal Two arrays are equal if their size is identical and if for each position in the array, both corresponding elements are equal
static boolean	contains(Object[] array, Object x) Check if the array contains an object.
static boolean	containsIdentical(Object[] array, Object x) Check if the array contains an object.
static String	formatArray(String header, String[] args) Returns a String with the array printed as formatted text
static int	indexOf(Object[] array, Object x) Find the location of an object in the array Object.equals() is used to compare objects.
static boolean	nullOrEmptyArray(Object[] array) Determine if an Object array is null or empty.
static boolean	nullOrEmptyIntArray(int[] array) Determine if an int array is null or empty.
static Object[]	prepend(Object a, Object[] in) Helper function to prepend an Object to an array and return the new array.
static void	printArray(PrintStream out, String head, String[] args) Write an array into a PrintStream.
static void	reverse(Object[] objects) Reverses the order of the objects in this array.

Methods inherited from class java.lang.Object

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

Method Detail

array

public static Object[] array(List vector)

Convert a List into an Object array with null check.

Parameters:

vector - a List to pull the contents from

Returns:

a new Object array containing all elements of vector, or a new empty Object array if vector was null

array

public static Object[] array()

Helper function to create a new empty Object array

Returns:

a new empty Object array

array

public static Object[] array(Object a)

Helper function to create a new Object array containing one Object.

Parameters:

a - the first Object to add to the List

Returns:

a new Object array containing the specified object

array

public static Object[] array(Object a,
                             Object b)

Helper function to create a new Object array containing two Objects.

Parameters:

a - the first Object to add to the List

b - the second Object to add to the List

Returns:

a new Object array containing the specified objects

array

public static Object[] array(Object a,
                             Object b,
                             Object c)

Helper function to create a new Object array containing three Objects.

Parameters:

a - the first Object to add to the List

b - the second Object to add to the List

c - the third Object to add to the List

Returns:

a new Object array containing the specified objects

array

public static Object[] array(Object a,
                             Object b,
                             Object c,
                             Object d)

Helper function to create a new Object array containing four Objects.

Parameters:

a - the first Object to add to the List

b - the second Object to add to the List

c - the third Object to add to the List

d - the fourth Object to add to the List

Returns:

a new Object array containing the specified objects

array

public static Object[] array(Object a,
                             Object b,
                             Object c,
                             Object d,
                             Object e)

Helper function to create a new Object array containing five Objects.

Parameters:

a - the first Object to add to the List

b - the second Object to add to the List

c - the third Object to add to the List

d - the fourth Object to add to the List

e - the fifth Object to add to the List

Returns:

a new Object array containing the specified objects

array

public static Object[] array(Object a,
                             Object b,
                             Object c,
                             Object d,
                             Object e,
                             Object f)

Helper function to create a new Object array containing six Objects.

Parameters:

a - the first Object to add to the List

b - the second Object to add to the List

c - the third Object to add to the List

d - the fourth Object to add to the List

e - the fifth Object to add to the List

f - the sixth Object to add to the List

Returns:

a new Object array containing the specified objects

array

public static Object[] array(Object a,
                             Object b,
                             Object c,
                             Object d,
                             Object e,
                             Object f,
                             Object g)

Helper function to create a new Object array containing seven Objects.

Parameters:

a - the first Object to add to the List

b - the second Object to add to the List

c - the third Object to add to the List

d - the fourth Object to add to the List

e - the fifth Object to add to the List

f - the sixth Object to add to the List

g - the seventh Object to add to the List

Returns:

a new Object array containing the specified objects

array

public static Object[] array(Object a,
                             Object b,
                             Object c,
                             Object d,
                             Object e,
                             Object f,
                             Object g,
                             Object h)

Helper function to create a new Object array containing eight Objects.

Parameters:

a - the first Object to add to the List

b - the second Object to add to the List

c - the third Object to add to the List

d - the fourth Object to add to the List

e - the fifth Object to add to the List

f - the sixth Object to add to the List

g - the seventh Object to add to the List

h - the eighth Object to add to the List

Returns:

a new Object array containing the specified objects

prepend

public static Object[] prepend(Object a,
                               Object[] in)

Helper function to prepend an Object to an array and return the new array.

Parameters:

a - the Object to be prepended

in - the array to prepend a onto

Returns:

a new Object array containing a + the elements of in

append

public static Object[] append(Object[] in,
                              Object a)

Helper function to append an Object to an array and return the new array.

Parameters:

in - the array to prepend a onto

a - the Object to be appended

Returns:

a new Object array containing the elements of in + a

nullOrEmptyArray

public static boolean nullOrEmptyArray(Object[] array)

Determine if an Object array is null or empty.

Parameters:

array - the Object array to check

Returns:

true if array is null or empty, false otherwise

nullOrEmptyIntArray

public static boolean nullOrEmptyIntArray(int[] array)

Determine if an int array is null or empty.

Parameters:

array - the int array to check

Returns:

true if array is null or empty, false otherwise

printArray

public static void printArray(PrintStream out,
                              String head,
                              String[] args)

Write an array into a PrintStream.

Parameters:

out - a PrintStream to write the output to

head - a header to prefix the list with

args - the array of Strings to print

See Also:

formatArray(String, String[])

formatArray

public static String formatArray(String header,
                                 String[] args)

Returns a String with the array printed as formatted text

Parameters:

header - a header to prefix the list with

args - the array of Strings to print

Returns:

a String with the array printed as formatted text.

containsIdentical

public static boolean containsIdentical(Object[] array,
                                        Object x)

Check if the array contains an object. The == operator is used to compare objects

Parameters:

array - the array to check

x - the object to check for

Returns:

true if the object is in the array

contains

public static boolean contains(Object[] array,
                               Object x)

Check if the array contains an object. Object.equals() is used to compare objects.

Parameters:

array - the array to check

x - the object to check for

Returns:

true if the object is in the array

indexOf

public static int indexOf(Object[] array,
                          Object x)

Find the location of an object in the array Object.equals() is used to compare objects.

Parameters:

array - the array to check

x - The object to look for

Returns:

the index of the object, or -1 if it is not found

arrayEquals

public static boolean arrayEquals(Object[] a1,
                                  Object[] a2)

Determines if the two arrays are equal Two arrays are equal if their size is identical and if for each position in the array, both corresponding elements are equal

Parameters:

a1 - first array

a2 - second array

Returns:

true if the two arrays are equal

reverse

public static void reverse(Object[] objects)

Reverses the order of the objects in this array.

Parameters:

objects - the object array