Hex (SCUBA 0.0.9 API)

java.lang.Object
- net.sf.scuba.util.Hex

```
public final class Hex
extends Object
```
Some static helper methods for dealing with hexadecimal notation.

Version:

$Revision: 183 $

Author:

Martijn Oostdijk ([email protected])

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`bytesToASCIIString(byte[] data)`
`static String`	`bytesToHexString(byte[] text)` Converts a byte array to capitalized hexadecimal text.
`static String`	`bytesToHexString(byte[] text, int numRow)`
`static String`	`bytesToHexString(byte[] text, int offset, int length)`
`static String`	`bytesToHexString(byte[] text, int offset, int length, int numRow)` Converts part of a byte array to capitalized hexadecimal text.
`static String`	`bytesToPrettyString(byte[] data)` Gets a human readable hexadecimal representation of `data` with spaces.
`static String`	`bytesToPrettyString(byte[] data, int columns, boolean useIndex, int indexPadWidth, String altIndex, boolean useASCII)` Gets a human readable hexadecimal representation of `data` with spaces and newlines in `columns` columns.
`static String`	`bytesToSpacedHexString(byte[] data)` Hexadecimal representation of `data` with spaces between individual bytes.
`static String`	`byteToHexString(byte b)` Converts the byte `b` to capitalized hexadecimal text.
`static byte`	`hexStringToByte(String text)` Converts the hexadecimal string in `text` to a byte.
`static byte[]`	`hexStringToBytes(String text)` Converts the hexadecimal string in `text` to a byte array.
`static int`	`hexStringToInt(String text)` Converts the hexadecimal string in `text` to an integer.
`static short`	`hexStringToShort(String text)` Converts the hexadecimal string in `text` to a short.
`static String`	`intToHexString(int n)` Converts the integer `n` to capitalized hexadecimal text.
`static String`	`shortToHexString(short s)` Converts the short `s` to capitalized hexadecimal text.
`static byte[][]`	`split(byte[] src, int width)` Splits the byte array `src` into a number of byte arrays of length `width`.
`static String`	`toHexString(byte[] text)` Converts a byte array to capitalized hexadecimal text.
`static String`	`toHexString(byte[] text, int numRow)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - byteToHexString
```
public static String byteToHexString(byte b)
```
    Converts the byte b to capitalized hexadecimal text. The result will have length 2 and only contain the characters '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'A', 'B', 'C', 'D', 'E', 'F'.
    
    Parameters:
    
    b - the byte to convert.
    
    Returns:
    
    capitalized hexadecimal text representation of b.
  - shortToHexString
```
public static String shortToHexString(short s)
```
    Converts the short s to capitalized hexadecimal text. The result will have length 4 and only contain the characters '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'A', 'B', 'C', 'D', 'E', 'F'.
    
    Parameters:
    
    s - the short to convert.
    
    Returns:
    
    capitalized hexadecimal text representation of s.
  - intToHexString
```
public static String intToHexString(int n)
```
    Converts the integer n to capitalized hexadecimal text. The result will have length 8 and only contain the characters '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'A', 'B', 'C', 'D', 'E', 'F'.
    
    Parameters:
    
    n - the integer to convert.
    
    Returns:
    
    capitalized hexadecimal text representation of n.
  - bytesToHexString
```
public static String bytesToHexString(byte[] text)
```
    Converts a byte array to capitalized hexadecimal text. The length of the resulting string will be twice the length of text and will only contain the characters '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'A', 'B', 'C', 'D', 'E', 'F'.
    
    Parameters:
    
    text - The byte array to convert.
    
    Returns:
    
    capitalized hexadecimal text representation of text.
  - bytesToHexString
```
public static String bytesToHexString(byte[] text,
                                      int numRow)
```
  - toHexString
```
public static String toHexString(byte[] text)
```
    Converts a byte array to capitalized hexadecimal text. The length of the resulting string will be twice the length of text and will only contain the characters '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'A', 'B', 'C', 'D', 'E', 'F'.
    
    Parameters:
    
    text - The byte array to convert.
    
    Returns:
    
    capitalized hexadecimal text representation of text.
  - toHexString
```
public static String toHexString(byte[] text,
                                 int numRow)
```
  - bytesToHexString
```
public static String bytesToHexString(byte[] text,
                                      int offset,
                                      int length,
                                      int numRow)
```
    Converts part of a byte array to capitalized hexadecimal text. Conversion starts at index offset until (excluding) index offset + length. The length of the resulting string will be twice the length text and will only contain the characters '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'A', 'B', 'C', 'D', 'E', 'F'.
    
    Parameters:
    
    text - the byte array to convert.
    
    offset - where to start.
    
    length - how many bytes to convert.
    
    numRow - number of bytes to be put one in one row of output
    
    Returns:
    
    capitalized hexadecimal text representation of text.
  - bytesToHexString
```
public static String bytesToHexString(byte[] text,
                                      int offset,
                                      int length)
```
  - hexStringToByte
```
public static byte hexStringToByte(String text)
                            throws NumberFormatException
```
    Converts the hexadecimal string in text to a byte.
    
    Parameters:
    
    text - the string to convert
    
    Returns:
    
    the byte encoded in text.
    
    Throws:
    
    NumberFormatException - if text does not contain a valid hexadecimal byte representation.
  - hexStringToShort
```
public static short hexStringToShort(String text)
                              throws NumberFormatException
```
    Converts the hexadecimal string in text to a short.
    
    Parameters:
    
    text - the string to convert
    
    Returns:
    
    the short encoded in text.
    
    Throws:
    
    NumberFormatException - if text does not contain a valid hexadecimal short representation.
  - hexStringToInt
```
public static int hexStringToInt(String text)
                          throws NumberFormatException
```
    Converts the hexadecimal string in text to an integer.
    
    Parameters:
    
    text - the string to convert
    
    Returns:
    
    the integer encoded in text.
    
    Throws:
    
    NumberFormatException - if text does not contain a valid hexadecimal integer representation.
  - hexStringToBytes
```
public static byte[] hexStringToBytes(String text)
                               throws NumberFormatException
```
    Converts the hexadecimal string in text to a byte array. If text has an odd number of characters, a 0 is inserted at the beginning.
    
    Parameters:
    
    text - the string to convert.
    
    Returns:
    
    the byte array representation of the hexadecimal string in text.
    
    Throws:
    
    NumberFormatException - if text does not contain a valid hexadecimal string.
  - bytesToSpacedHexString
```
public static String bytesToSpacedHexString(byte[] data)
```
    Hexadecimal representation of data with spaces between individual bytes.
    
    Parameters:
    
    data - the byte array to print.
    
    Returns:
    
    spaced hexadecimal representation of data.
  - bytesToASCIIString
```
public static String bytesToASCIIString(byte[] data)
```
  - split
```
public static byte[][] split(byte[] src,
                             int width)
```
    Splits the byte array src into a number of byte arrays of length width. (Plus one of length less than width if width does not divide the length of src.)
    
    Parameters:
    
    src - the byte array to split.
    
    width - a positive number.
    
    Returns:
    
    an array with the split contents
  - bytesToPrettyString
```
public static String bytesToPrettyString(byte[] data)
```
    Gets a human readable hexadecimal representation of data with spaces. Includes and index and ASCII representation.
    
    Parameters:
    
    data - the byte array to print.
    
    Returns:
    
    a hexadecimal representation of data.
  - bytesToPrettyString
```
public static String bytesToPrettyString(byte[] data,
                                         int columns,
                                         boolean useIndex,
                                         int indexPadWidth,
                                         String altIndex,
                                         boolean useASCII)
```
    Gets a human readable hexadecimal representation of data with spaces and newlines in columns columns. Will print an index before each line if useIndex is true. Will print an ASCII representation after each line if useASCII is true.
    
    Parameters:
    
    data - the byte array to print.
    
    columns - the number of bytes per line.
    
    useIndex - a boolean indicating whether each line should be started with an index.
    
    indexPadWidth - the padding width for index.
    
    altIndex - string to prefix if no index is used.
    
    useASCII - a boolean indicating whether each line should be ended with an ASCII representation of the bytes in that line.
    
    Returns:
    
    a hexadecimal representation of data.

Class Hex

Method Summary

Methods inherited from class java.lang.Object

Method Detail

byteToHexString

shortToHexString

intToHexString

bytesToHexString

bytesToHexString

toHexString

toHexString

bytesToHexString

bytesToHexString

hexStringToByte

hexStringToShort

hexStringToInt

hexStringToBytes

bytesToSpacedHexString

bytesToASCIIString

split

bytesToPrettyString

bytesToPrettyString