cern.gp.util

Class ArrayUtil

java.lang.Object

cern.gp.util.ArrayUtil

public final class ArrayUtil
extends java.lang.Object

Utility methods for manipulating and displaying Arrays

Author:

Vito Baggiolini

Constructor Summary

Constructors

Constructor and Description
ArrayUtil()

Method Summary

Modifier and Type	Method and Description
static boolean	allElementsSameType(java.lang.Object[] array) An utility method that checks whether all the elements in the array are of the same type it returns false if the array contains a mix of classes and sub-classes of the Array component type.
static java.lang.Object	concatArrays(java.lang.Object[][] origMatrix) An utility method that concatenates many arrays to one.
static java.lang.Object	concatArrays(java.lang.Object[][] origMatrix, int totalLength) An utility method that concatenates many arrays to one.
static java.lang.Object	concatArrays(java.lang.Object[] one, java.lang.Object[] two, java.lang.Class componentType) An utility method that concatenates two arrays to one
static java.lang.Object	concatArrays(java.lang.Object[] one, java.lang.Object[] two, java.lang.Object[] three, java.lang.Class componentType) An utility method that concatenates three arrays to one
static void	printArray(java.lang.Object[] array, int indent) utility method, prints out an array using the toString() method of the members.
static java.lang.Object	pruneNullElements(java.lang.Object[] array) A utility method that cuts off null-elements at the end of an array.
static java.lang.Object	pruneNullElements(java.lang.Object[] array, boolean onlyAtEnd) prunes the null elements at the tail of an array.
static void	sleep(long millis) Utility method, sleeps for the indicated millis.
static java.lang.String	toString(java.lang.Object[] array, int indent, boolean oneLine, boolean numbered) utility method, transforms the array into a String that can either be multi-line or on one line.

Methods inherited from class java.lang.Object

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

Constructor Detail

ArrayUtil

public ArrayUtil()

Method Detail

concatArrays

public static java.lang.Object concatArrays(java.lang.Object[] one,
                                            java.lang.Object[] two,
                                            java.lang.Class componentType)

An utility method that concatenates two arrays to one

Parameters:

one - the first array

two - the second array

componentType - the class of the component of the array to be returned

Returns:

an array of type componentType with the concatenation of the two arrays

concatArrays

public static java.lang.Object concatArrays(java.lang.Object[] one,
                                            java.lang.Object[] two,
                                            java.lang.Object[] three,
                                            java.lang.Class componentType)

An utility method that concatenates three arrays to one

Parameters:

one - the first array

two - the second array

three - the third array

componentType - the class of the component of the array to be returned

Returns:

an array of type componentType with the concatenation of the two arrays

concatArrays

public static java.lang.Object concatArrays(java.lang.Object[][] origMatrix)

An utility method that concatenates many arrays to one. The type and the length of the returned array are derived from the type of the origMatrix parameter

Parameters:

origMatrix - an array of arrays (a Matrix)

Returns:

an array with the concatenated values

concatArrays

public static java.lang.Object concatArrays(java.lang.Object[][] origMatrix,
                                            int totalLength)

An utility method that concatenates many arrays to one. The type of the returned array are derived from the type of the origMatrix parameter, the length is specified.

Parameters:

origMatrix - an array of arrays (a Matrix), can contain null elements

totalLength - the length of the resulting array, must be large enough

Returns:

an array with the concatenated values

printArray

public static void printArray(java.lang.Object[] array,
                              int indent)

utility method, prints out an array using the toString() method of the members.

Parameters:

array - can be null

indent - the level of indents (tabs) that precede the output, can be negative

toString

public static java.lang.String toString(java.lang.Object[] array,
                                        int indent,
                                        boolean oneLine,
                                        boolean numbered)

utility method, transforms the array into a String that can either be multi-line or on one line.

Parameters:

array - the array to be transformed, can be null

indent - the number of tabs to be used for indenting

oneLine - if true, a String containing a single line is returned, if false, return characters ("\n") are integrated into the returned string.

numbered - if true, each element is preceded by its index in the array

Returns:

a string with the array contents, formated as requested

pruneNullElements

public static java.lang.Object pruneNullElements(java.lang.Object[] array)

A utility method that cuts off null-elements at the end of an array.

Returns:

a new array with only the non-null elements and the corresponding length

pruneNullElements

public static java.lang.Object pruneNullElements(java.lang.Object[] array,
                                                 boolean onlyAtEnd)

prunes the null elements at the tail of an array. In the present implementation, onlyAtEnd must be true

Parameters:

array - the array to be pruned

onlyAtEnd - -- must be true

allElementsSameType

public static boolean allElementsSameType(java.lang.Object[] array)

An utility method that checks whether all the elements in the array are of the same type it returns false if the array contains a mix of classes and sub-classes of the Array component type.

Parameters:

array - the array to be checked

Returns:

true if all array elements are of the same class

sleep

public static void sleep(long millis)

Utility method, sleeps for the indicated millis. Useful because it can be called in user programs without need to code the try/catch clauses.

Parameters:

millis - the milliseconds to sleep