Class BERBitString

java.lang.Object

netscape.ldap.ber.stream.BERElement

netscape.ldap.ber.stream.BERBitString

All Implemented Interfaces:

Serializable

public class BERBitString
extends BERElement

This class is for the BitString object. Note that the BitSet class has a bug: size() returns the size of the internal allocated memory rather than the number of bits. Current work-around is to maintain the number of bits ourselves in m_value_num_bits. Change is required when BitSet is fixed.

ENCODING RULE:
  Primitive Definite length.
  tag = 0x03

Version:

1.0 seeAlso CCITT X.209

See Also:

• Serialized Form

Field Summary

Fields inherited from class BERElement

ANY, APPLICATION, BITSTRING, BOOLEAN, CHOICE, CONSTRUCTED, CONTEXT, ENUMERATED, EOC, EXOP_REQ_OID, EXOP_REQ_VALUE, EXOP_RES_OID, EXOP_RES_VALUE, GENERALSTRING, GRAPHICSTRING, IA5STRING, INTEGER, MRA_DNATTRS, MRA_OID, MRA_TYPE, MRA_VALUE, NULL, NUMERICSTRING, OBJECTID, OCTETSTRING, PRIMITIVE, PRINTABLESTRING, PRIVATE, REAL, SASLCONTEXT, SEQUENCE, SET, SK_MATCHRULE, SK_REVERSE, SR_ATTRTYPE, TAG, TELETEXSTRING, UNIVERSAL, UTCTIME, VIDEOTEXSTRING, VISIBLESTRING

Modifier and Type	Field	Description
static final int	ANY
static final int	APPLICATION
static final int	BITSTRING
static final int	BOOLEAN	Possible element types.
static final int	CHOICE
static final int	CONSTRUCTED
static final int	CONTEXT
static final int	ENUMERATED
static final int	EOC	Possible tags.
static final int	EXOP_REQ_OID
static final int	EXOP_REQ_VALUE
static final int	EXOP_RES_OID
static final int	EXOP_RES_VALUE
static final int	GENERALSTRING
static final int	GRAPHICSTRING
static final int	IA5STRING
static final int	INTEGER
static final int	MRA_DNATTRS
static final int	MRA_OID
static final int	MRA_TYPE
static final int	MRA_VALUE
static final int	NULL
static final int	NUMERICSTRING
static final int	OBJECTID
static final int	OCTETSTRING
static final int	PRIMITIVE
static final int	PRINTABLESTRING
static final int	PRIVATE
static final int	REAL
static final int	SASLCONTEXT
static final int	SEQUENCE
static final int	SET
static final int	SK_MATCHRULE
static final int	SK_REVERSE
static final int	SR_ATTRTYPE
static final int	TAG	Internal (non-transmitted) tags.
static final int	TELETEXSTRING
static final int	UNIVERSAL
static final int	UTCTIME
static final int	VIDEOTEXSTRING
static final int	VISIBLESTRING

Constructor Summary

Constructors

Constructor	Description
BERBitString(InputStream stream, int[] bytes_read)	Constructs a bitstring element from an input stream (for primitive encodings).
BERBitString(BitSet value)	Constructs a boolean element.
BERBitString(BERTagDecoder decoder, InputStream stream, int[] bytes_read)	Constructs a bitstring element from an input stream (for constructed encodings).

Method Summary

Modifier and Type	Method	Description
int	getSize()	Gets the number of bits.
int	getType()	Gets the element type.
BitSet	getValue()	Gets the bitstring value.
String	toString()	Gets the string representation.
void	write(OutputStream stream)	Sends the BER encoding directly to a stream.

Methods inherited from class BERElement

byteToHexString, getElement, readLengthOctets, readTwosComplement, readUnsignedBinary, sendDefiniteLength

Modifier and Type	Method	Description
String	byteToHexString(byte value)	Converts byte to hex string.
static BERElement	getElement(BERTagDecoder decoder, InputStream stream, int[] bytes_read)	Gets a ber element from the input stream.
static int	readLengthOctets(InputStream stream, int[] bytes_read)	Reads and decodes a length byte and then that many octets from the input stream.
protected int	readTwosComplement(InputStream stream, int[] bytes_read, int length)	Reads the two's complement representation of an integer from an input stream.
protected int	readUnsignedBinary(InputStream stream, int[] bytes_read, int length)	Reads a number of bytes from an input stream and form an integer..
static void	sendDefiniteLength(OutputStream stream, int num_content_octets)	Writes length octets (definite length only) to stream.

Methods inherited from class Object

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

Constructor Details

BERBitString

public BERBitString(BitSet value)

Constructs a boolean element.

Parameters:

value - boolean value

BERBitString

public BERBitString(BERTagDecoder decoder,
 InputStream stream,
 int[] bytes_read)
             throws IOException

Constructs a bitstring element from an input stream (for constructed encodings).

Parameters:

stream - source

bytes_read - array of 1 int; value incremented by number of bytes read from stream

Throws:

IOException - failed to construct

BERBitString

public BERBitString(InputStream stream,
 int[] bytes_read)
             throws IOException

Constructs a bitstring element from an input stream (for primitive encodings).

Parameters:

stream - source

bytes_read - array of 1 int; value incremented by number of bytes read from stream

Throws:

IOException - failed to construct

Method Details

write

public void write(OutputStream stream)
           throws IOException

Sends the BER encoding directly to a stream. Always sends in primitive form.

Specified by:

write in class BERElement

Parameters:

stream - output stream

Throws:

IOException

getValue

public BitSet getValue()

Gets the bitstring value.

getSize

public int getSize()

Gets the number of bits.

Returns:

bit numbers.

getType

public int getType()

Gets the element type.

Specified by:

getType in class BERElement

Returns:

element type.

toString

public String toString()

Gets the string representation.

Specified by:

toString in class BERElement

Returns:

string representation of tag.