org.metastatic.jessie.pki.der

Class BitString

Implemented Interfaces:
Cloneable, Comparable, java.io.Serializable

public class BitString
extends java.lang.Object
implements Cloneable, Comparable, java.io.Serializable

Immutable representation of a bit string, which is equivalent to a byte array except some number of the rightmost bits are ignored. For example, this could be the bit string:
   00010101 11101101 11010xxx

Where the "xxx" represents three bits that should be ignored, and can have any value.

Author:
Casey Marshall (rsdio@metastatic.org)
See Also:
Serialized Form

Constructor Summary

BitString(byte[] bytes)
Create a new bit string.
BitString(byte[] bytes, int ignoredBits)
Create a new bit string.
BitString(byte[] bytes, int ignoredBits, boolean doShift)
Create a new bit string, shifting the given byte array if needed.
BitString(byte[] bytes, int offset, int length)
Create a new bit string.
BitString(byte[] bytes, int offset, int length, int ignoredBits)
Create a new bit string.
BitString(byte[] bytes, int offset, int length, int ignoredBits, boolean doShift)
Create a new bit string, shifting the given byte array if needed.

Method Summary

Object
clone()
int
compareTo(Object o)
boolean
equals(Object o)
int
getIgnoredBits()
Returns the number of ignored bits.
byte[]
getShiftedByteArray()
Returns this bit string as a byte array, with the ignored bits present.
int
size()
Returns the size, in bits, of this bit string.
boolean[]
toBooleanArray()
Return this bit string as a boolean array.
byte[]
toByteArray()
Return this bit string as a byte array, with the ignored bits trimmed off.
String
toString()

Constructor Details

BitString

public BitString(byte[] bytes)
Create a new bit string.
Parameters:
bytes - The byte array holding the bit string.

BitString

public BitString(byte[] bytes,
                 int ignoredBits)
Create a new bit string.
Parameters:
bytes - The byte array holding the bit string.
ignoredBits - The number of bits to ignore.

BitString

public BitString(byte[] bytes,
                 int ignoredBits,
                 boolean doShift)
Create a new bit string, shifting the given byte array if needed.
Parameters:
bytes - The byte array holding the bit string.
ignoredBits - The number of bits to ignore.
doShift - Pass true in this parameter if the byte array has not yet been shifted left by ignoredBits.

BitString

public BitString(byte[] bytes,
                 int offset,
                 int length)
Create a new bit string.
Parameters:
bytes - The byte array holding the bit string.
offset - The offset where the meaningful bytes begin.
length - The number of meaningful bytes.

BitString

public BitString(byte[] bytes,
                 int offset,
                 int length,
                 int ignoredBits)
Create a new bit string.
Parameters:
bytes - The byte array holding the bit string.
offset - The offset where the meaningful bytes begin.
length - The number of meaningful bytes.
ignoredBits - The number of bits to ignore.

BitString

public BitString(byte[] bytes,
                 int offset,
                 int length,
                 int ignoredBits,
                 boolean doShift)
Create a new bit string, shifting the given byte array if needed.
Parameters:
bytes - The byte array holding the bit string.
offset - The offset where the meaningful bytes begin.
length - The number of meaningful bytes.
ignoredBits - The number of bits to ignore.
doShift - Pass true in this parameter if the byte array has not yet been shifted left by ignoredBits.

Method Details

clone

public Object clone()

compareTo

public int compareTo(Object o)

equals

public boolean equals(Object o)

getIgnoredBits

public int getIgnoredBits()
Returns the number of ignored bits.
Returns:
The number of ignored bits.

getShiftedByteArray

public byte[] getShiftedByteArray()
Returns this bit string as a byte array, with the ignored bits present. The byte array is cloned every time this method is called to prevent modification.
Returns:
The byte array.

size

public int size()
Returns the size, in bits, of this bit string.
Returns:
The size of this bit string.

toBooleanArray

public boolean[] toBooleanArray()
Return this bit string as a boolean array. The value returned is of size size(), and each true value corresponding to each "1" in this bit string. The boolean array is cloned before it is returned.
Returns:
The boolean array.

toByteArray

public byte[] toByteArray()
Return this bit string as a byte array, with the ignored bits trimmed off. The byte array is cloned every time this method is called to prevent modification.
Returns:
The trimmed byte array.

toString

public String toString()