com.entrust.toolkit.util

Class BinaryString

java.lang.Object

com.entrust.toolkit.util.BinaryString

public class BinaryString
extends java.lang.Object

This class represents a binary string; a sequence of characters that contains only '0' and '1' characters. It was designed to provide easy access to each bit in an ASN.1 BIT STRING.

Every binary string is internally represented as a StringBuffer, which has a certain capacity. As long as the length of the character sequence contained in the binary string does not exceed the capacity, it is not necessary to allocate a new internal buffer array. If the internal buffer overflows, it is automatically made larger.

Since:

7.0

See Also:

StringBuffer, BIT_STRING

Constructor Summary

Constructors

Constructor and Description
BinaryString(int initialCapacity) Creates a BinaryString object that holds not characters, but has the indicated initial capacity.
BinaryString(java.lang.String binaryString) Creates a BinaryString object using the characters contained in the indicated String.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isBitSet(int bitIndex) Checks if a given bit in the binary string is set (is '1').
void	setBit(int bitIndex) Sets a given bit in the binary string (ensures it is '1').
java.lang.String	toString() Converts a binary string to a String object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

BinaryString

public BinaryString(int initialCapacity)
             throws java.lang.IllegalArgumentException

Creates a BinaryString object that holds not characters, but has the indicated initial capacity.

Parameters:

initialCapacity - the number of characters the binary string is intended to hold

Throws:

java.lang.IllegalArgumentException - thrown if the initial capacity is a negative number

BinaryString

public BinaryString(java.lang.String binaryString)
             throws java.lang.IllegalArgumentException,
                    BinaryStringFormatException

Creates a BinaryString object using the characters contained in the indicated String.

Parameters:

binaryString - a String representation of the binary string

Throws:

java.lang.IllegalArgumentException - thrown if the binary string parameter is null

BinaryStringFormatException - thrown if the binary string parameter does not represent a binary string; it contains characters other than '0' or '1'

Method Detail

isBitSet

public boolean isBitSet(int bitIndex)

Checks if a given bit in the binary string is set (is '1'). If the bit index falls outside the actual binary string, false is automatically returned.

Parameters:

bitIndex - the index of the bit being checked

Returns:

boolean true if the bit is set; false otherwise

setBit

public void setBit(int bitIndex)

Sets a given bit in the binary string (ensures it is '1').

If the bit index falls outside currently allocated binary string, its capacity is automatically increased as necessary, '0's are appended up to the indicated bit index and a '1' is appended at the indicated bit index.

Parameters:

bitIndex - the index of the bit being set

Throws:

java.lang.IllegalArgumentException - thrown if the bit index is negative

toString

public java.lang.String toString()

Converts a binary string to a String object.

Overrides:

toString in class java.lang.Object