DumpUtils.java

/*
 * Copyright 2003,2004 Peter Lee, Colin Crist
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */

package hermes.util;

import java.io.StringWriter;

/**
 * Utilities for displaying byte[]s in lines with hex offsets.
 */
public class DumpUtils
{
   public static final int DUMP_AS_HEX = 1;
   public static final int DUMP_AS_ALPHA = 2;
   public static final int DUMP_AS_STRING = 3;
   public static final int DUMP_AS_HEX_AND_ALPHA = 4;
   public static final int ROW_LEN = 16;

   public static String dumpBinary(byte[] data, int mode)
   {
      int maxSize = 5 * 1024 * 1024 ;
      
      return mode == DUMP_AS_STRING ? TextUtils.toAsciiString(data) : dumpBinaryEx(data, mode, maxSize);
   }

   private static String dumpBinaryEx(byte[] data, int mode, int maxSize)
   {
      StringWriter b = new StringWriter();

      int c = 0;

      if (data != null)
      {
         while (c < data.length)
         {
            int max = Math.min(ROW_LEN, data.length - c);

            byte[] row = new byte[max];
            for (int i = 0; i < row.length; i++)
               row[i] = data[c + i];

            switch (mode)
            {
               case DUMP_AS_ALPHA:
                  dumpBinaryLineAsAlpha(b, c, row);
                  break;
               case DUMP_AS_HEX:
                  dumpBinaryLineAsHex(b, c, row);
                  break;
               case DUMP_AS_HEX_AND_ALPHA:
                  dumpBinaryLineAsHexAndAlpha(b, c, row);
                  break;
            }
            c += ROW_LEN;
            
            if (c > maxSize)
            {
               b.append("Message too big");
               break ;
            }
         }
      }
      else
      {
         b.append("No payload.");
      }

      return b.toString();
   }

   public static void dumpBinaryLineAsHexAndAlpha(StringWriter b, long offset, byte[] data)
   {
      b.append(TextUtils.leftPadLong(offset, 8));
      b.append(" - ");
      b.append(TextUtils.leftAlign(TextUtils.toHexString(data, true), ROW_LEN * 3));
      b.append(" - ");
      b.append(TextUtils.toAsciiString(data));
      b.append("\r\n");
   }

   public static void dumpBinaryLineAsHex(StringWriter b, long offset, byte[] data)
   {
      b.append(TextUtils.leftPadLong(offset, 8));
      b.append(" - ");
      b.append(TextUtils.toHexString(data, true));
      b.append("\r\n");
   }

   public static void dumpBinaryLineAsAlpha(StringWriter b, long offset, byte[] data)
   {
      b.append(TextUtils.leftPadLong(offset, 8));
      b.append(" - ");
      b.append(TextUtils.toAsciiString(data));
      b.append("\r\n");
   }

   public static void dumpBinaryLineAsHexAndEBCDIC(StringWriter b, long offset, char[] mappings, byte[] data, int rowLen)
   {
      b.append(TextUtils.leftPadLong(offset, 8));
      b.append(" - ");
      b.append(TextUtils.leftAlign(TextUtils.toHexString(data, true), rowLen * 3));
      b.append(" - ");
      b.append(EBCDICtoASCII(mappings, data));
      b.append("\r\n");
   }
   
   public static String EBCDICtoASCII(char[] mappings, byte[] data)
   {
      StringBuffer messageBuffer = new StringBuffer();
      for (int j = 0; j < data.length; j++)
      {
         int n = data[j];
         if (n < 0)
         {
            n = 256 + n;
         }
         messageBuffer.append(mappings[n]);
      }
      return messageBuffer.toString();
   }
   
}