Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

gnu.java.security.der

Class BitString

Implemented Interfaces:
Cloneable, Comparable<T>
public class BitString
extends Object
implements Cloneable, Comparable<T>
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.

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
hashCode()
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()

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

BitString

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

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.
Throws:
IllegalArgumentException - If ignoredBits is negative or greater than 7.
NullPointerException - If bytes is null.

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.
Throws:
IllegalArgumentException - If ignoredBits is negative or greater than 7.
NullPointerException - If bytes is null.

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.
Throws:
NullPointerException - If bytes is null.

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.
Throws:
IllegalArgumentException - If ignoredBits is negative or greater than 7.
NullPointerException - If bytes is null.

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.
Throws:
IllegalArgumentException - If ignoredBits is negative or greater than 7.
NullPointerException - If bytes is null.

Method Details

clone

public Object clone()
Overrides:
clone in interface Object

compareTo

public int compareTo(Object o)

equals

public boolean equals(Object o)
Overrides:
equals in interface Object

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.

hashCode

public int hashCode()
Overrides:
hashCode in interface Object

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()
Overrides:
toString in interface Object
BitString.java -- Java representation of the BIT STRING type. Copyright (C) 2003 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.

Overview Package Class Use Source Tree Index Deprecated About