commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From sand...@apache.org
Subject cvs commit: jakarta-commons-sandbox/util/src/test/org/apache/commons/util HexDumpTest.java BitFieldTest.java
Date Wed, 30 Jan 2002 06:40:06 GMT
sanders     02/01/29 22:40:06

  Modified:    util/src/test/org/apache/commons/util BitFieldTest.java
  Added:       util/src/java/org/apache/commons/util HexDump.java
               util/src/test/org/apache/commons/util HexDumpTest.java
  Log:
  Added HexDump utility from POI.
  
  Revision  Changes    Path
  1.1                  jakarta-commons-sandbox/util/src/java/org/apache/commons/util/HexDump.java
  
  Index: HexDump.java
  ===================================================================
  /*
   * $Header: /home/cvs/jakarta-commons-sandbox/util/src/java/org/apache/commons/util/HexDump.java,v
1.1 2002/01/30 06:40:05 sanders Exp $
   * $Revision: 1.1 $
   * $Date: 2002/01/30 06:40:05 $
   *
   * ====================================================================
   *
   * The Apache Software License, Version 1.1
   *
   * Copyright (c) 2002 The Apache Software Foundation.  All rights
   * reserved.
   *
   * Redistribution and use in source and binary forms, with or without
   * modification, are permitted provided that the following conditions
   * are met:
   *
   * 1. Redistributions of source code must retain the above copyright
   *    notice, this list of conditions and the following disclaimer.
   *
   * 2. 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.
   *
   * 3. The end-user documentation included with the redistribution, if
   *    any, must include the following acknowlegement:
   *       "This product includes software developed by the
   *        Apache Software Foundation (http://www.apache.org/)."
   *    Alternately, this acknowlegement may appear in the software itself,
   *    if and wherever such third-party acknowlegements normally appear.
   *
   * 4. The names "The Jakarta Project", "Commons", and "Apache Software
   *    Foundation" must not be used to endorse or promote products derived
   *    from this software without prior written permission. For written
   *    permission, please contact apache@apache.org.
   *
   * 5. Products derived from this software may not be called "Apache"
   *    nor may "Apache" appear in their names without prior written
   *    permission of the Apache Group.
   *
   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED 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 APACHE SOFTWARE FOUNDATION OR
   * ITS 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.
   * ====================================================================
   *
   * This software consists of voluntary contributions made by many
   * individuals on behalf of the Apache Software Foundation.  For more
   * information on the Apache Software Foundation, please see
   * <http://www.apache.org/>.
   *
   */
  
  
  package org.apache.commons.util;
  
  
  import java.io.IOException;
  import java.io.OutputStream;
  
  
  /**
   * dump data in hexadecimal format; derived from a HexDump utility I
   * wrote in June 2001
   *
   * Taken from the POI project
   *
   * @author Scott Sanders (sanders at apache dot org)
   * @author Marc Johnson
   * @version $Revision: 1.1 $ $Date: 2002/01/30 06:40:05 $
   */
  
  public class HexDump {
  
      // all static methods, so no need for a public constructor
      private HexDump() {
      }
  
      /**
       * dump an array of bytes to an OutputStream
       *
       * @param data the byte array to be dumped
       * @param offset its offset, whatever that might mean
       * @param stream the OutputStream to which the data is to be
       *               written
       * @param index initial index into the byte array
       *
       * @exception IOException is thrown if anything goes wrong writing
       *            the data to stream
       * @exception ArrayIndexOutOfBoundsException if the index is
       *            outside the data array's bounds
       * @exception IllegalArgumentException if the output stream is
       *            null
       */
  
      public static void dump(final byte[] data, final long offset,
                              final OutputStream stream, final int index)
              throws IOException, ArrayIndexOutOfBoundsException,
              IllegalArgumentException {
          if ((index < 0) || (index >= data.length)) {
              throw new ArrayIndexOutOfBoundsException(
                      "illegal index: " + index + " into array of length "
                      + data.length);
          }
          if (stream == null) {
              throw new IllegalArgumentException("cannot write to nullstream");
          }
          long display_offset = offset + index;
          StringBuffer buffer = new StringBuffer(74);
  
          for (int j = index; j < data.length; j += 16) {
              int chars_read = data.length - j;
  
              if (chars_read > 16) {
                  chars_read = 16;
              }
              buffer.append(dump(display_offset)).append(' ');
              for (int k = 0; k < 16; k++) {
                  if (k < chars_read) {
                      buffer.append(dump(data[k + j]));
                  } else {
                      buffer.append("  ");
                  }
                  buffer.append(' ');
              }
              for (int k = 0; k < chars_read; k++) {
                  if ((data[k + j] >= ' ') && (data[k + j] < 127)) {
                      buffer.append((char) data[k + j]);
                  } else {
                      buffer.append('.');
                  }
              }
              buffer.append(EOL);
              stream.write(buffer.toString().getBytes());
              stream.flush();
              buffer.setLength(0);
              display_offset += chars_read;
          }
      }
  
      public static final String EOL =
              System.getProperty("line.separator");
      private static final StringBuffer _lbuffer = new StringBuffer(8);
      private static final StringBuffer _cbuffer = new StringBuffer(2);
      private static final char _hexcodes[] =
              {
                  '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'A', 'B', 'C', 'D',
                  'E', 'F'
              };
      private static final int _shifts[] =
              {
                  28, 24, 20, 16, 12, 8, 4, 0
              };
  
      private static StringBuffer dump(final long value) {
          _lbuffer.setLength(0);
          for (int j = 0; j < 8; j++) {
              _lbuffer
                      .append(_hexcodes[((int) (value >> _shifts[j])) & 15]);
          }
          return _lbuffer;
      }
  
      private static StringBuffer dump(final byte value) {
          _cbuffer.setLength(0);
          for (int j = 0; j < 2; j++) {
              _cbuffer.append(_hexcodes[(value >> _shifts[j + 6]) & 15]);
          }
          return _cbuffer;
      }
  }
  
  
  
  1.2       +8 -8      jakarta-commons-sandbox/util/src/test/org/apache/commons/util/BitFieldTest.java
  
  Index: BitFieldTest.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons-sandbox/util/src/test/org/apache/commons/util/BitFieldTest.java,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- BitFieldTest.java	30 Jan 2002 05:52:44 -0000	1.1
  +++ BitFieldTest.java	30 Jan 2002 06:40:06 -0000	1.2
  @@ -1,7 +1,7 @@
   /*
  - * $Header: /home/cvs/jakarta-commons-sandbox/util/src/test/org/apache/commons/util/BitFieldTest.java,v
1.1 2002/01/30 05:52:44 sanders Exp $
  - * $Revision: 1.1 $
  - * $Date: 2002/01/30 05:52:44 $
  + * $Header: /home/cvs/jakarta-commons-sandbox/util/src/test/org/apache/commons/util/BitFieldTest.java,v
1.2 2002/01/30 06:40:06 sanders Exp $
  + * $Revision: 1.2 $
  + * $Date: 2002/01/30 06:40:06 $
    *
    * ====================================================================
    *
  @@ -69,22 +69,22 @@
    * @author Scott Sanders (sanders at apache dot org)
    * @author Marc Johnson
    * @author Glen Stampoultzis (gstamp@iprimus.com.au)
  - * @version $Id: BitFieldTest.java,v 1.1 2002/01/30 05:52:44 sanders Exp $
  + * @version $Id: BitFieldTest.java,v 1.2 2002/01/30 06:40:06 sanders Exp $
    */
   
  -public class TestBitField
  +public class BitFieldTest
       extends TestCase
   {
       private static BitField bf_multi  = new BitField(0x3F80);
       private static BitField bf_single = new BitField(0x4000);
   
       /**
  -     * Constructor TestBitField
  +     * Constructor BitFieldTest
        *
        * @param name
        */
   
  -    public TestBitField(String name)
  +    public BitFieldTest(String name)
       {
           super(name);
       }
  @@ -329,6 +329,6 @@
       public static void main(String [] ignored_args)
       {
           System.out.println("Testing util.BitField functionality");
  -        junit.textui.TestRunner.run(TestBitField.class);
  +        junit.textui.TestRunner.run(BitFieldTest.class);
       }
   }
  
  
  
  1.1                  jakarta-commons-sandbox/util/src/test/org/apache/commons/util/HexDumpTest.java
  
  Index: HexDumpTest.java
  ===================================================================
  /*
   * $Header: /home/cvs/jakarta-commons-sandbox/util/src/test/org/apache/commons/util/HexDumpTest.java,v
1.1 2002/01/30 06:40:06 sanders Exp $
   * $Revision: 1.1 $
   * $Date: 2002/01/30 06:40:06 $
   *
   * ====================================================================
   *
   * The Apache Software License, Version 1.1
   *
   * Copyright (c) 1999-2002 The Apache Software Foundation.  All rights
   * reserved.
   *
   * Redistribution and use in source and binary forms, with or without
   * modification, are permitted provided that the following conditions
   * are met:
   *
   * 1. Redistributions of source code must retain the above copyright
   *    notice, this list of conditions and the following disclaimer.
   *
   * 2. 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.
   *
   * 3. The end-user documentation included with the redistribution, if
   *    any, must include the following acknowlegement:
   *       "This product includes software developed by the
   *        Apache Software Foundation (http://www.apache.org/)."
   *    Alternately, this acknowlegement may appear in the software itself,
   *    if and wherever such third-party acknowlegements normally appear.
   *
   * 4. The names "The Jakarta Project", "Commons", and "Apache Software
   *    Foundation" must not be used to endorse or promote products derived
   *    from this software without prior written permission. For written
   *    permission, please contact apache@apache.org.
   *
   * 5. Products derived from this software may not be called "Apache"
   *    nor may "Apache" appear in their names without prior written
   *    permission of the Apache Group.
   *
   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED 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 APACHE SOFTWARE FOUNDATION OR
   * ITS 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.
   * ====================================================================
   *
   * This software consists of voluntary contributions made by many
   * individuals on behalf of the Apache Software Foundation.  For more
   * information on the Apache Software Foundation, please see
   * <http://www.apache.org/>.
   *
   */
  
  
  package org.apache.commons.util;
  
  
  import java.io.ByteArrayOutputStream;
  import java.io.IOException;
  
  import junit.framework.TestCase;
  
  
  /**
   * @author Scott Sanders (sanders at apache dot org)
   * @author Marc Johnson (mjohnson at apache dot org)
   * @version $Revision: 1.1 $ $Date: 2002/01/30 06:40:06 $
   */
  
  public class HexDumpTest extends TestCase {
  
      /**
       * Creates new HexDumpTest
       *
       * @param name
       */
  
      public HexDumpTest(String name) {
          super(name);
      }
  
      private char toHex(final int n) {
          char[] hexChars =
                  {
                      '0', '1', '2', '3', '4', '5', '6', '7',
                      '8', '9', 'A', 'B', 'C', 'D', 'E', 'F'
                  };
  
          return hexChars[n % 16];
      }
  
      /**
       * test dump method
       *
       * @exception IOException
       */
  
      public void testDump()
              throws IOException {
          byte[] testArray = new byte[256];
  
          for (int j = 0; j < 256; j++) {
              testArray[j] = (byte) j;
          }
          ByteArrayOutputStream stream = new ByteArrayOutputStream();
  
          HexDump.dump(testArray, 0, stream, 0);
          byte[] outputArray = new byte[16 * (73 + HexDump.EOL.length())];
  
          for (int j = 0; j < 16; j++) {
              int offset = (73 + HexDump.EOL.length()) * j;
  
              outputArray[offset++] = (byte) '0';
              outputArray[offset++] = (byte) '0';
              outputArray[offset++] = (byte) '0';
              outputArray[offset++] = (byte) '0';
              outputArray[offset++] = (byte) '0';
              outputArray[offset++] = (byte) '0';
              outputArray[offset++] = (byte) toHex(j);
              outputArray[offset++] = (byte) '0';
              outputArray[offset++] = (byte) ' ';
              for (int k = 0; k < 16; k++) {
                  outputArray[offset++] = (byte) toHex(j);
                  outputArray[offset++] = (byte) toHex(k);
                  outputArray[offset++] = (byte) ' ';
              }
              for (int k = 0; k < 16; k++) {
                  outputArray[offset++] = (byte) toAscii((j * 16) + k);
              }
              System.arraycopy(HexDump.EOL.getBytes(), 0, outputArray, offset,
                      HexDump.EOL.getBytes().length);
          }
          byte[] actualOutput = stream.toByteArray();
  
          assertEquals("array size mismatch", outputArray.length,
                  actualOutput.length);
          for (int j = 0; j < outputArray.length; j++) {
              assertEquals("array[ " + j + "] mismatch", outputArray[j],
                      actualOutput[j]);
          }
  
          // verify proper behavior with non-zero offset
          stream = new ByteArrayOutputStream();
          HexDump.dump(testArray, 0x10000000, stream, 0);
          outputArray = new byte[16 * (73 + HexDump.EOL.length())];
          for (int j = 0; j < 16; j++) {
              int offset = (73 + HexDump.EOL.length()) * j;
  
              outputArray[offset++] = (byte) '1';
              outputArray[offset++] = (byte) '0';
              outputArray[offset++] = (byte) '0';
              outputArray[offset++] = (byte) '0';
              outputArray[offset++] = (byte) '0';
              outputArray[offset++] = (byte) '0';
              outputArray[offset++] = (byte) toHex(j);
              outputArray[offset++] = (byte) '0';
              outputArray[offset++] = (byte) ' ';
              for (int k = 0; k < 16; k++) {
                  outputArray[offset++] = (byte) toHex(j);
                  outputArray[offset++] = (byte) toHex(k);
                  outputArray[offset++] = (byte) ' ';
              }
              for (int k = 0; k < 16; k++) {
                  outputArray[offset++] = (byte) toAscii((j * 16) + k);
              }
              System.arraycopy(HexDump.EOL.getBytes(), 0, outputArray, offset,
                      HexDump.EOL.getBytes().length);
          }
          actualOutput = stream.toByteArray();
          assertEquals("array size mismatch", outputArray.length,
                  actualOutput.length);
          for (int j = 0; j < outputArray.length; j++) {
              assertEquals("array[ " + j + "] mismatch", outputArray[j],
                      actualOutput[j]);
          }
  
          // verify proper behavior with negative offset
          stream = new ByteArrayOutputStream();
          HexDump.dump(testArray, 0xFF000000, stream, 0);
          outputArray = new byte[16 * (73 + HexDump.EOL.length())];
          for (int j = 0; j < 16; j++) {
              int offset = (73 + HexDump.EOL.length()) * j;
  
              outputArray[offset++] = (byte) 'F';
              outputArray[offset++] = (byte) 'F';
              outputArray[offset++] = (byte) '0';
              outputArray[offset++] = (byte) '0';
              outputArray[offset++] = (byte) '0';
              outputArray[offset++] = (byte) '0';
              outputArray[offset++] = (byte) toHex(j);
              outputArray[offset++] = (byte) '0';
              outputArray[offset++] = (byte) ' ';
              for (int k = 0; k < 16; k++) {
                  outputArray[offset++] = (byte) toHex(j);
                  outputArray[offset++] = (byte) toHex(k);
                  outputArray[offset++] = (byte) ' ';
              }
              for (int k = 0; k < 16; k++) {
                  outputArray[offset++] = (byte) toAscii((j * 16) + k);
              }
              System.arraycopy(HexDump.EOL.getBytes(), 0, outputArray, offset,
                      HexDump.EOL.getBytes().length);
          }
          actualOutput = stream.toByteArray();
          assertEquals("array size mismatch", outputArray.length,
                  actualOutput.length);
          for (int j = 0; j < outputArray.length; j++) {
              assertEquals("array[ " + j + "] mismatch", outputArray[j],
                      actualOutput[j]);
          }
  
          // verify proper behavior with non-zero index
          stream = new ByteArrayOutputStream();
          HexDump.dump(testArray, 0x10000000, stream, 0x81);
          outputArray = new byte[(8 * (73 + HexDump.EOL.length())) - 1];
          for (int j = 0; j < 8; j++) {
              int offset = (73 + HexDump.EOL.length()) * j;
  
              outputArray[offset++] = (byte) '1';
              outputArray[offset++] = (byte) '0';
              outputArray[offset++] = (byte) '0';
              outputArray[offset++] = (byte) '0';
              outputArray[offset++] = (byte) '0';
              outputArray[offset++] = (byte) '0';
              outputArray[offset++] = (byte) toHex(j + 8);
              outputArray[offset++] = (byte) '1';
              outputArray[offset++] = (byte) ' ';
              for (int k = 0; k < 16; k++) {
                  int index = 0x81 + (j * 16) + k;
  
                  if (index < 0x100) {
                      outputArray[offset++] = (byte) toHex(index / 16);
                      outputArray[offset++] = (byte) toHex(index);
                  } else {
                      outputArray[offset++] = (byte) ' ';
                      outputArray[offset++] = (byte) ' ';
                  }
                  outputArray[offset++] = (byte) ' ';
              }
              for (int k = 0; k < 16; k++) {
                  int index = 0x81 + (j * 16) + k;
  
                  if (index < 0x100) {
                      outputArray[offset++] = (byte) toAscii(index);
                  }
              }
              System.arraycopy(HexDump.EOL.getBytes(), 0, outputArray, offset,
                      HexDump.EOL.getBytes().length);
          }
          actualOutput = stream.toByteArray();
          assertEquals("array size mismatch", outputArray.length,
                  actualOutput.length);
          for (int j = 0; j < outputArray.length; j++) {
              assertEquals("array[ " + j + "] mismatch", outputArray[j],
                      actualOutput[j]);
          }
  
          // verify proper behavior with negative index
          try {
              HexDump.dump(testArray, 0x10000000, new ByteArrayOutputStream(),
                      -1);
              fail("should have caught ArrayIndexOutOfBoundsException on negative index");
          } catch (ArrayIndexOutOfBoundsException ignored_exception) {
  
              // as expected
          }
  
          // verify proper behavior with index that is too large
          try {
              HexDump.dump(testArray, 0x10000000, new ByteArrayOutputStream(),
                      testArray.length);
              fail("should have caught ArrayIndexOutOfBoundsException on large index");
          } catch (ArrayIndexOutOfBoundsException ignored_exception) {
  
              // as expected
          }
  
          // verify proper behavior with null stream
          try {
              HexDump.dump(testArray, 0x10000000, null, 0);
              fail("should have caught IllegalArgumentException on negative index");
          } catch (IllegalArgumentException ignored_exception) {
  
              // as expected
          }
      }
  
      private char toAscii(final int c) {
          char rval = '.';
  
          if ((c >= 32) && (c <= 126)) {
              rval = (char) c;
          }
          return rval;
      }
  
      /**
       * main method to run the unit tests
       *
       * @param ignored_args
       */
  
      public static void main(String[] ignored_args) {
          System.out.println("Testing util.HexDump functionality");
          junit.textui.TestRunner.run(HexDumpTest.class);
      }
  }
  
  
  

--
To unsubscribe, e-mail:   <mailto:commons-dev-unsubscribe@jakarta.apache.org>
For additional commands, e-mail: <mailto:commons-dev-help@jakarta.apache.org>


Mime
View raw message