PrettyPrintingUtils.java
01 /*
02  *
03  * Licensed to the Apache Software Foundation (ASF) under one
04  * or more contributor license agreements.  See the NOTICE file
05  * distributed with this work for additional information
06  * regarding copyright ownership.  The ASF licenses this file
07  * to you under the Apache License, Version 2.0 (the
08  * "License"); you may not use this file except in compliance
09  * with the License.  You may obtain a copy of the License at
10  *
11  *   http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing,
14  * software distributed under the License is distributed on an
15  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16  * KIND, either express or implied.  See the License for the
17  * specific language governing permissions and limitations
18  * under the License.
19  *
20  */
21 package org.apache.qpid.util;
22 
23 /**
24  * Contains pretty printing convenienve methods for producing formatted logging output, mostly for debugging purposes.
25  *
26  <p><table id="crc"><caption>CRC Card</caption>
27  <tr><th> Responsibilities <th> Collaborations
28  </table>
29  *
30  * @todo Drop this. There are already array pretty printing methods it java.utils.Arrays.
31  */
32 public class PrettyPrintingUtils
33 {
34     /**
35      * Pretty prints an array of ints as a string.
36      *
37      @param array The array to pretty print.
38      *
39      @return The pretty printed string.
40      */
41     public static String printArray(int[] array)
42     {
43         String result = "[";
44         for (int i = 0; i < array.length; i++)
45         {
46             result += array[i];
47             result += (i < (array.length - 1)) ", " "";
48         }
49 
50         result += "]";
51 
52         return result;
53     }
54 
55     /**
56      * Pretty prints an array of strings as a string.
57      *
58      @param array The array to pretty print.
59      *
60      @return The pretty printed string.
61      */
62     public static String printArray(String[] array)
63     {
64         String result = "[";
65         for (int i = 0; i < array.length; i++)
66         {
67             result += array[i];
68             result += (i < (array.length - 1)) ", " "";
69         }
70 
71         result += "]";
72 
73         return result;
74     }
75 }