ByteArray ("Entrust Authority Security Toolkit for the Java Platform")

java.lang.Object
- com.entrust.toolkit.util.ByteArray

```
public class ByteArray
extends java.lang.Object
```
This class provides byte array operations.
The class itself represents a byte array, and it provides operations that can be performed on the byte array. All internal data is wiped following use so that no unnecessary copies of the byte array exist in memory.

Constructor Summary

Constructors
Constructor and Description
`ByteArray()` The default constructor.
`ByteArray(java.math.BigInteger bi)` Creates a new `ByteArray` object that contains a copy of the bytes the specified `BigInteger` represents.
`ByteArray(byte[] ba)` Creates a new `ByteArray` object that contains a copy of the contents of the specified byte array.
`ByteArray(ByteArray byteArray)` Creates a new `ByteArray` object that contains a copy of the contents of the specified `ByteArray`.
`ByteArray(long l)` Creates a new `ByteArray` object that contains a copy of the bytes in the specified long value.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`append(byte b)` Appends a byte to this `ByteArray` object.
`void`	`append(byte[] ba)` Appends a byte array to this `ByteArray` object.
`static byte[]`	`append(byte[] ba1, byte[] ba2)` Appends one byte array to another.
`static byte[]`	`append(byte[] ba1, byte[] ba2, int off, int len)` Appends a section of one byte array to another.
`void`	`append(ByteArray byteArray)` Appends a `ByteArray` object to this `ByteArray` object.
`int`	`calculateASNLength()` Deprecated. this function was intended for internal JTK use only; deprecated since 6.1
`void`	`fromHexString(java.lang.String hexString)` Sets the byte array the object contains by from a hexadecimal string.
`byte[]`	`getArray()` Returns the byte array this object contains.
`int`	`getLength()` Returns the length of the byte array this object contains.
`boolean`	`isEqual(byte[] ba)` Checks if the byte array this object is identical to the specified byte array.
`boolean`	`isEqual(ByteArray byteArray)` Checks if this `ByteArray` object is identical to the specified `ByteArray` object.
`void`	`removeLeadingZeros()` Checks the beginning of the byte array this object contains for bytes 0x00.
`void`	`setArray(byte[] ba)` Sets the byte array this object contains to be a copy of the specified byte array.
`void`	`tail(int offset)` Truncates the beginning of byte array this object contains.
`static byte`	`toByte(int i)` Deprecated. has the same effect as a direct cast, please use this instead, ex: byte b = (byte)-234823; deprecated since 6.1
`java.lang.String`	`toHexString()` Converts the byte array this object contains to a hexadecimal string of format 012345..., where every two characters represent the hexadecimal value of a single byte.
`static int`	`toInt(byte b)` Deprecated. this function was intended for internal JTK use only; deprecated since 6.1
`void`	`truncate(int length)` Truncates the end of the byte array this object contains.
`void`	`wipe()` Wipes all internal data.

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

- Constructor Detail
  - ByteArray
```
public ByteArray()
```
    The default constructor.
  - ByteArray
```
public ByteArray(byte[] ba)
```
    Creates a new ByteArray object that contains a copy of the contents of the specified byte array.
    If the provided byte array is null, then the ByteArray created will also contain a null byte array.
    
    Parameters:
    
    ba - a byte array
  - ByteArray
```
public ByteArray(ByteArray byteArray)
```
    Creates a new ByteArray object that contains a copy of the contents of the specified ByteArray.
    If the provided ByteArray contains a null byte array, then the ByteArray created will also contain a null byte array.
    
    Parameters:
    
    byteArray - a ByteArray object
  - ByteArray
```
public ByteArray(long l)
```
    Creates a new ByteArray object that contains a copy of the bytes in the specified long value.
    
    Parameters:
    
    l - a long value
  - ByteArray
```
public ByteArray(java.math.BigInteger bi)
```
    Creates a new ByteArray object that contains a copy of the bytes the specified BigInteger represents.
    This is done by converting the BigInteger to it's two's-complement representation using big-endian byte-order (most significant byte is in the zeroth element).
    
    Parameters:
    
    bi - a BigInteger value
- Method Detail
  - append
```
public static byte[] append(byte[] ba1,
                            byte[] ba2)
```
    Appends one byte array to another.
    The byte array specified by ba2 is appended to ba1. This is done by creating a new byte array and copying the contents of ba1 into the first part of the new byte array, and the contents of ba2 into the remainder.
    
    Note
    
    Unlike the corresponding secure API SecureUtils.append(byte[], byte[]), this API does not wipe either ba1 or ba2
    
    Parameters:
    
    ba1 - the byte[] to which ba2 will be appended
    
    ba2 - the byte[] that will be appended to ba1
    
    Returns:
    
    the byte[] resulting from append operation
  - append
```
public static byte[] append(byte[] ba1,
                            byte[] ba2,
                            int off,
                            int len)
```
    Appends a section of one byte array to another.
    A specified section of the byte array denoted by the argument ba2, is appended to ba1. This is done by creating a new byte array and copying the contents of ba1 into the first part of the new byte array, and the specified contents of ba2 into the remainder.
    
    The specified contents of ba2 are the bytes starting at off and extending for len bytes.
    
    Note
    
    Unlike the corresponding secure API SecureUtils.append(byte[], byte[], int, int), this API does not wipe either ba1 or ba2
    
    Parameters:
    
    ba1 - the byte[] to which part of ba2 will be appended
    
    ba2 - the byte[] that will be appended to ba1
    
    off - the location of the start of the data in ba2 that will be appended to ba1
    
    len - the number of bytes from ba2 to append to ba1
    
    Returns:
    
    the byte[] resulting from append operation
  - getArray
```
public byte[] getArray()
```
    Returns the byte array this object contains.
    It returns the actual byte array, not a copy.
    
    Returns:
    
    the byte array this object contains
  - setArray
```
public void setArray(byte[] ba)
```
    Sets the byte array this object contains to be a copy of the specified byte array.
    
    Parameters:
    
    ba - a byte array
  - getLength
```
public int getLength()
```
    Returns the length of the byte array this object contains.
    
    Returns:
    
    the length of the byte array this object contains
  - isEqual
```
public boolean isEqual(byte[] ba)
```
    Checks if the byte array this object is identical to the specified byte array.
    
    Parameters:
    
    ba - the byte array to compare with
    
    Returns:
    
    true if the byte arrays are identical; false otherwise
  - isEqual
```
public boolean isEqual(ByteArray byteArray)
```
    Checks if this ByteArray object is identical to the specified ByteArray object.
    Two ByteArray objects are considered "equal" if the byte arrays they contain are identical.
    
    Parameters:
    
    byteArray - the ByteArray object to compare with
    
    Returns:
    
    true if the ByteArray objects are identical; false otherwise
  - append
```
public void append(byte[] ba)
```
    Appends a byte array to this ByteArray object.
    The specified byte array is simply appended to the end of the byte array that this object contains.
    
    Parameters:
    
    ba - the byte array to be appended
  - append
```
public void append(byte b)
```
    Appends a byte to this ByteArray object.
    The specified byte is simply appended to the end of the byte array that this object contains.
    
    Parameters:
    
    b - the byte to be appended
  - append
```
public void append(ByteArray byteArray)
```
    Appends a ByteArray object to this ByteArray object.
    The byte array that the specified ByteArray object contains is simply appended to the end of the byte array that this object contains.
    
    Parameters:
    
    byteArray - the ByteArray object to be appended
  - tail
```
public void tail(int offset)
          throws java.lang.IllegalArgumentException
```
    Truncates the beginning of byte array this object contains.
    All bytes before the indicated offset are discarded.
    
    Parameters:
    
    offset - the number of bytes that will be truncated from the beginning of the byte array this object contains
    
    Throws:
    
    java.lang.IllegalArgumentException - thrown if the offset is less than zero, or greater than the length of the byte array this object contains
  - truncate
```
public void truncate(int length)
              throws java.lang.IllegalArgumentException
```
    Truncates the end of the byte array this object contains.
    All bytes after the indicated length are discarded.
    
    Parameters:
    
    length - the length at which to truncate the byte array this object contains
    
    Throws:
    
    java.lang.IllegalArgumentException - thrown if length is less than zero, or greater than the length of the byte array this object contains
  - removeLeadingZeros
```
public void removeLeadingZeros()
```
    Checks the beginning of the byte array this object contains for bytes 0x00.
    Any leading sequence of zero bytes are discarded.
  - wipe
```
public void wipe()
```
    Wipes all internal data.
  - toHexString
```
public java.lang.String toHexString()
```
    Converts the byte array this object contains to a hexadecimal string of format 012345..., where every two characters represent the hexadecimal value of a single byte.
    Each byte will be converted into a string in the following range (00..FF).
    
    Returns:
    
    a hexadecimal string representation of the byte array this object contains
  - fromHexString
```
public void fromHexString(java.lang.String hexString)
                   throws java.lang.IllegalArgumentException,
                          java.lang.NumberFormatException
```
    Sets the byte array the object contains by from a hexadecimal string.
    The hexadecimal must contain only hexadecimal digits that are not separated by any other character. The conversion is not case sensitive.
    
    Parameters:
    
    hexString - a hexadecimal string
    
    Throws:
    
    java.lang.IllegalArgumentException - thrown if the string does not contain an even number of characters (all hexadecimal strings contain an even number of characters)
    
    java.lang.NumberFormatException - thrown if the string contains any characters that are not hexadecimal digits [0..9],[A..F],[a..f]
  - toByte
```
public static byte toByte(int i)
```
    Deprecated. has the same effect as a direct cast, please use this instead, ex: byte b = (byte)-234823; deprecated since 6.1
    
    Converts a positive integer on the range [0..256] into a signed byte on the range [-128..127].
    No error checking is done, since the converstion will raise runtime errors if the values passed are invalid.
    
    Parameters:
    
    i - a positive integer
    
    Returns:
    
    the signed byte representation of the positive integer
  - toInt
```
public static int toInt(byte b)
```
    Deprecated. this function was intended for internal JTK use only; deprecated since 6.1
    
    Converts a byte to the positive integer that it represents.
    This is a hack for getting around the fact that Java doesn't allow unsigned bytes.
    
    Parameters:
    
    b - a signed byte
    
    Returns:
    
    an integer representing the unsigned byte
  - calculateASNLength
```
public int calculateASNLength()
```
    Deprecated. this function was intended for internal JTK use only; deprecated since 6.1
    
    Calculates the length of an ASN.1 DER-encoded object from the DER encoding, and returns it.
    
    Returns:
    
    the value of the length bits

Class ByteArray

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ByteArray

ByteArray

ByteArray

ByteArray

ByteArray

Method Detail

append

append

getArray

setArray

getLength

isEqual

isEqual

append

append

append

tail

truncate

removeLeadingZeros

wipe

toHexString

fromHexString

toByte

toInt

calculateASNLength