/* * $Id$ * * Copyright 2006, The jCoderZ.org Project. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are * met: * * * Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * * Redistributions in binary form must reproduce the above * copyright notice, this list of conditions and the following * disclaimer in the documentation and/or other materials * provided with the distribution. * * Neither the name of the jCoderZ.org Project nor the names of * its contributors may be used to endorse or promote products * derived from this software without specific prior written * permission. * * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS "AS IS" AND * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ package org.jcoderz.commons.util; import java.lang.reflect.Array; /** * This class contains a static factory that allows arrays to be viewed as * lists. * * @author Michael Griffel */ public final class ArraysUtil { /** * No constructor for util class. */ private ArraysUtil () { // No instances allowed - contains only static utility // functions. } /** * Returns a string representation of the contents of given object * with special care for potential arrays. For none array objects * the toString method is invoked, for arrays the content of the * array is converted. If the array contains other arrays as * elements, they are also get their content dumped. *

* The value returned by this method is equal to the value that * would be returned by Arrays.asList(a).toString(), unless * array is null, in which case "null" is * returned. *

* This method is useful to dump the content of the array in a * tracing method, e.g.: * * 

     * logger.entering(
     *  CLASSNAME, "foo(Object[])", ArraysUtil.toString(array));
     *
* * @param array The array whose string representation to return. * @return A string representation of array. */ public static String toString (Object array) { return toString(array, 0); } /** * Returns a string representation of the contents of given * object with special care for potential arrays, the output is * cut - for each potentially contained array - to maxSize. * *

* If one of the contained arrays contains more than maxSize * elements, the dump is stopped and the number of total elements * is printed in the output, for the particular array. *

* * @param array The array whose string representation to return. * @param maxSize the maximum number of elements to print, will * be ignored if set to 0 or below. * @return A string representation of array. * @see #toString(Object) */ public static String toString (Object array, int maxSize) { final StringBuffer sb = new StringBuffer(); appendArray(sb, array, maxSize); return sb.toString(); } /** * Returns a string representation of the contents of the * specified array. * If the array contains other arrays as elements, they are converted * to strings by the {@link Object#toString}method inherited * from Object, which describes their identities * rather than their contents. *

* The value returned by this method is equal to the value that would be * returned by Arrays.asList(a).toString(), unless array * is null, in which case "null" is returned. *

* This method is useful to dump the content of the array in a tracing * method, e.g.: * 

    * logger.entering(
    *     CLASSNAME, "foo(Object[])", ArraysUtil.toString(array));
    *
* @param array The array whose string representation to return. * @return A string representation of array. */ public static String toString (Object[] array) { return toString(array, 0); } /** * Returns a string representation of the contents of the specified * array with a maxSize limitation. *

* The value returned by this method is equal to the value that would be * returned by Arrays.asList(a).toString(), unless array * is null, in which case "null" is returned. *

* This method is useful to dump the content of the array in a tracing * method, e.g.: * 

    * logger.entering(
    *     CLASSNAME, "foo(Object[])", ArraysUtil.toString(array));
    *
* @param array The array whose string representation to return. * @param maxSize the maximum number of elements to print, will * be ignored if set to 0 or below. * @return A string representation of array. */ public static String toString (Object[] array, int maxSize) { final StringBuffer sb = new StringBuffer(); appendArray(sb, array, maxSize); return sb.toString(); } /** * Returns a string representation of the contents of the specified * array. *

* The value dumps all int stored in the given array. *

* This method is useful to dump the content of the array in a tracing * method, e.g.: * 

    * logger.entering(
    *     CLASSNAME, "foo(int[])", ArraysUtil.toString(array));
    *
* @param array The array whose string representation to return. * @return A string representation of array. */ public static String toString (int[] array) { return toString(array, 0); } /** * Returns a string representation of the contents of the specified * array. *

* The value dumps all short stored in the given array. *

* This method is useful to dump the content of the array in a tracing * method, e.g.: * 

     * logger.entering(
     *     CLASSNAME, "foo(short[])", ArraysUtil.toString(array));
     *
* @param array The array whose string representation to return. * @return A string representation of array. */ public static String toString (short[] array) { return toString(array, 0); } /** * Returns a string representation of the contents of the * specified array. *

* The value dumps all long stored in the given array. *

* This method is useful to dump the content of the array in a tracing * method, e.g.: * 

      * logger.entering(
      *     CLASSNAME, "foo(long[])", ArraysUtil.toString(array));
      *
* @param array The array whose string representation to return. * @return A string representation of array. */ public static String toString (long[] array) { return toString(array, 0); } /** * Returns a string representation of the contents of the specified * array. *

* The value dumps all byte values stored in the given array. *

* This method is useful to dump the content of the array in a tracing * method, e.g.: * 

       * logger.entering(
       *     CLASSNAME, "foo(byte[])", ArraysUtil.toString(array));
       *
* @param array The array whose string representation to return. * @return A string representation of array. */ public static String toString (byte[] array) { return toString(array, 0); } /** * Returns a string representation of the contents of the specified * array. *

* The value dumps all char values stored in the given array. *

* This method is useful to dump the content of the array in a tracing * method, e.g.: * 

        * logger.entering(
        *     CLASSNAME, "foo(char[])", ArraysUtil.toString(array));
        *
* @param array The array whose string representation to return. * @return A string representation of array. */ public static String toString (char[] array) { return toString(array, 0); } /** * Returns a string representation of the contents of the specified * array. *

* The value dumps all boolean values stored in the given array. *

* This method is useful to dump the content of the array in a * tracing method, e.g.: * * 

     * logger.entering(
     *     CLASSNAME, "foo(boolean[])", ArraysUtil.toString(array));
     *
* * @param array The array whose string representation to return. * @return A string representation of array. */ public static String toString (boolean[] array) { return toString(array, 0); } private static void appendArray ( StringBuffer buf, Object array, int maxSize) { if (array == null) { buf.append("null"); } else if (!array.getClass().isArray()) { buf.append(array); } else { final int length = Array.getLength(array); buf.append('['); for (int i = 0; i < length; i++) { if (i != 0) { if (i == maxSize) { buf.append(",... in total "); buf.append(length); buf.append(" Elements"); break; } buf.append(", "); } appendArray(buf, Array.get(array, i), maxSize); } buf.append(']'); } } }