Asn1BitString

java.lang.Object
- com.objsys.asn1j.runtime.Asn1Type
- - com.objsys.asn1j.runtime.Asn1BitString

All Implemented Interfaces:

Asn1TypeIF, java.io.Serializable, java.lang.Cloneable
```
public class Asn1BitString
extends Asn1Type
```
This is a container class for holding the components of an ASN.1 bit string value.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static short`	`ASN1VALUE` The ASN1VALUE constant describes the string format for hex or binary digit value.
`static short`	`BITS` The BITS constant describes the string format for binary digit value (e.g. only 0 and 1 digits).
`static short`	`HEX` The HEX constant describes the string format for hex digit value (e.g. 0123456789ABCDEF).
`static short`	`HEXBIN` The HEXBIN constant describes the string format for hex or binary digit value (e.g. 0xAA 10xxxxxx).
`protected java.util.HashMap<java.lang.Integer,java.lang.String>`	`mPositionsToNames`
`short`	`mStringFormat` The mStringFormat variable can be used to set the string format for print or event handler or toString() functions.
`static short`	`NAMEDBITS` The NAMEDBITS constant describes the string format as a list of bit position names (where applicable) followed by 1 or 0 in parentheses.
`int`	`numbits` This variable contains the number of bits in the bit string value.
`static Asn1Tag`	`TAG` The TAG constant describes the universal tag for this data type (UNIVERSAL 3).
`boolean`	`trimZeroBits` This variable describes whether trailing zero bits should be truncated.
`byte[]`	`value` This variable holds the bit string value.

Fields inherited from class com.objsys.asn1j.runtime.Asn1Type
BIT_STRING, BMPString, BOOLEAN, DATE, DATE_TIME, DURATION, ENUMERATED, EOC, EXTERNAL, GeneralString, GeneralTime, GraphicString, IA5String, INTEGER, mNonParameterizedTypeName, NULL, NumericString, OBJECT_IDENTIFIER, ObjectDescriptor, OCTET_STRING, OID_IRI, OpenType, PrintableString, REAL, RELATIVE_OID_IRI, RelativeOID, SEQUENCE, SET, T61String, TeletexString, TIME, TIME_OF_DAY, UniversalString, UTCTime, UTF8String, VideotexString, VisibleString

Constructor Summary

Constructors
Constructor and Description
`Asn1BitString()` This constructor creates an empty bit string that can be used in a decode method call to receive a bit string value.
`Asn1BitString(java.util.BitSet bitSet)` This constructor initializes a bit string from the given BitSet object.
`Asn1BitString(boolean[] bitValues)` This constructor initializes a bit string from the given boolean array.
`Asn1BitString(byte[] data)` This constructor initializes a bit string with the given bytes, using all 8 bits of every byte.
`Asn1BitString(int numbits_, byte[] data)` This constructor initializes a bit string with the given number of bits and data.
`Asn1BitString(java.lang.String value_)` This constructor parses the given ASN.1 value text (either a binary or hex data string) and assigns the values to the internal bit string.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`baseDecode(Asn1PerDecodeBuffer buffer)` This method decodes an ASN.1 bit string value using the packed encoding rules (PER).
`protected void`	`baseDecode(Asn1PerDecodeBuffer buffer, long lower, long upper)` This method decodes a sized ASN.1 bit string value using the packed encoding rules (PER).
`protected void`	`baseEncode(Asn1PerEncodeBuffer buffer, long minEncLen)` This method encodes the bit string as an unconstrained ASN.1 bit string value using the packed encoding rules (PER).
`protected void`	`baseEncode(Asn1PerEncodeBuffer buffer, long lower, long upper)` This method encodes a size-constrained ASN.1 bit string value using the packed encoding rules (PER).
`void`	`clear(int bitno)` This method clears the given bit in the bit string.
`void`	`decode(Asn1BerDecodeBuffer buffer, boolean explicit, int implicitLength)` This method decodes an ASN.1 bit string value using the BER or DER encoding rules.
`void`	`decode(Asn1JsonDecodeBuffer buffer)` Decode ASN.1 BIT STRING from JSON.
`void`	`decode(Asn1MderDecodeBuffer buffer, int length)` Decode a BIT STRING from the MDER encoding into this object.
`void`	`decode(Asn1NasDecodeBuffer buffer, int numbits)` Decode the given number of bits from the buffer.
`void`	`decode(Asn1OerDecodeBuffer buffer)` This method decodes an ASN.1 BIT STRING that was encoded according to OER.
`void`	`decode(Asn1PerDecodeBuffer buffer)` This method decodes an ASN.1 bit string value using the packed encoding rules (PER).
`void`	`decode(Asn1PerDecodeBuffer buffer, long lower, long upper)` This method decodes a sized ASN.1 bit string value using the packed encoding rules (PER).
`void`	`decode(Asn1PerDecodeBuffer buffer, long lower, java.lang.Object upper)` This method decodes a sized ASN.1 bit string value using the packed encoding rules (PER).
`void`	`decode(Asn1PerDecodeBuffer buffer, java.lang.Object lower, long upper)` This method decodes a sized ASN.1 bit string value using the packed encoding rules (PER).
`void`	`decode(Asn1PerDecodeBuffer buffer, java.lang.Object lower, java.lang.Object upper)` This method decodes a sized ASN.1 bit string value using the packed encoding rules (PER).
`void`	`decodeContent(Asn1OerDecodeBuffer buffer, int numOctets, int unusedBits)` This method decodes an ASN.1 BIT STRING's content that was encoded according to OER, given the total number of octets and the number of unused bits in the last octet.
`void`	`decodeRemainingBits(Asn1NasDecodeBuffer buffer)` Decode all remaining bits in the current container from the buffer.
`void`	`decodeString(Asn1JsonDecodeBuffer buffer, int numbits)` Decode ASN.1 BIT STRING from JSON.
`void`	`decodeV72(Asn1JsonDecodeBuffer buffer)` Decode ASN.1 bit string from JSON.
`void`	`decodeXER(java.lang.String buffer, java.lang.String attrs)` This method decodes ASN.1 8-bit character string types including IA5String, PrintableString, NumericString, etc.
`void`	`decodeXML(java.lang.String buffer, java.lang.String attrs)` This method decodes an ASN.1 BIT STRING using the XML schema encoding rules.
`int`	`encode(Asn1BerEncodeBuffer buffer, boolean explicit)` This method encodes an ASN.1 bit string value using the BER or DER encoding rules.
`void`	`encode(Asn1BerOutputStream out, boolean explicit)` This method encodes and writes to the stream an ASN.1 bit string value including the UNIVERSAL tag value and length if explicit tagging is specified.
`void`	`encode(Asn1JsonOutputStream outstream)` Encode ASN.1 BIT STRING to JSON.
`void`	`encode(Asn1MderOutputStream out, int length)` Encode this BIT STRING into the MDER encoding.
`void`	`encode(Asn1OerEncodeBuffer buffer)` This method encodes this ASN.1 BIT STRING value, according to OER.
`void`	`encode(Asn1PerEncodeBuffer buffer)` This method encodes this bit string using the packed encoding rules (PER).
`void`	`encode(Asn1PerEncodeBuffer buffer, long lower, long upper)`
`void`	`encode(Asn1PerEncodeBuffer buffer, long lower, java.lang.Object upper)` This method encodes a size-constrained ASN.1 bit string value using the packed encoding rules (PER).
`void`	`encode(Asn1PerEncodeBuffer buffer, java.lang.Object lower, long upper)` This method encodes a size-constrained ASN.1 bit string value using the packed encoding rules (PER).
`void`	`encode(Asn1PerEncodeBuffer buffer, java.lang.Object lower, java.lang.Object upper)` This method encodes a size-constrained ASN.1 bit string value using the packed encoding rules (PER).
`void`	`encode(Asn1PerOutputStream out)` This method encodes an unconstrained ASN.1 bit string value using the packed encoding rules (PER)into the stream.
`void`	`encode(Asn1PerOutputStream out, long lower, long upper)` This method encodes a size-constrained ASN.1 bit string value using the packed encoding rules (PER) into the stream.
`void`	`encode(Asn1XerEncoder buffer, java.lang.String elemName)` This method encodes ASN.1 bit string type using the XML encoding rules (XER).
`void`	`encode(Asn1XmlEncoder buffer, java.lang.String elemName, java.lang.String nsPrefix)` This method encodes ASN.1 bit string type using the XML Encoding as specified in the XML schema standard.
`void`	`encode(Asn1XmlEncoder buffer, java.lang.String elemName, java.lang.String nsPrefix, java.lang.String[] namedbits, int[] namedbitindex)` This method encodes ASN.1 bit string type using the XML Encoding as specified in the XML schema standard.
`void`	`encodeAsString(Asn1JsonOutputStream outstream)` Encode ASN.1 BIT STRING to JSON.
`void`	`encodeContent(Asn1OerEncodeBuffer buffer)` This method encodes the content of an ASN.1 bit string value, according to OER.
`void`	`encodeV72(Asn1JsonOutputStream outstream)` Encode this bit string to JSON.
`boolean`	`equals(int nbits, byte[] value)` This method compares this bit string value to the given value for equality.
`boolean`	`equals(java.lang.Object bs_)` This method compares this bit string value to the given value for equality.
`java.lang.String`	`getAsn1TypeName()` This method gets the ASN.1 type name.
`int`	`getLength()` This method will return the length of the BIT STRING in bits.
`protected int`	`getOerEffectiveMin()` Return the lower bound for the OER effective size constraint.
`int`	`hashCode()` This method returns the hashCode for this bit string.
`boolean`	`isNamedBitStr(java.lang.String buffer)` This method determines is the input character string represented as named bit string or as bits sequence.
`boolean`	`isSet(int bitno)` This method tests if the given bit in the bit string is set or not.
`void`	`set(int bitno)` This method will set the given bit number to one (1).
`void`	`set(int bitno, boolean bvalue)` This method will set the given bit number to the given boolean value.
`static void`	`skip(Asn1PerDecodeBuffer buffer)` This method skips an ASN.1 BIT STRING value using the packed encoding rules (PER).
`static void`	`skip(Asn1PerDecodeBuffer buffer, long lower, long upper)` This method skips a sized ASN.1 bit string value using the packed encoding rules (PER).
`boolean[]`	`toBoolArray()` This method converts the bit string stored in this object to a boolean array.
`java.lang.String`	`toHexString()` This method will return a hex string representation of the bit string value.
`java.io.InputStream`	`toInputStream()` This method will return a byte array input stream representation of the bit string value.
`java.lang.String`	`toString()` This method will return a string representation of the BIT STRING value.
`protected int`	`trim(int minLength)` This method will trim trailing zero bits from this BIT STRING.

Methods inherited from class com.objsys.asn1j.runtime.Asn1Type
_setKey, _setLicLocation, clone, decode, decode, decode, decode, decode, decode, decode, decode, decode, decode, encode, encode, encode, encode, encode, encodeAsOpenType, equals, getNonParameterizedTypeName, getTypeName, indent, indent, isOpenType, matchTag, matchTag, pdiag, print, print, print, setNonParameterizedTypeName, setOpenType

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - TAG
```
public static final Asn1Tag TAG
```
    The TAG constant describes the universal tag for this data type (UNIVERSAL 3).
  - mPositionsToNames
```
protected java.util.HashMap<java.lang.Integer,java.lang.String> mPositionsToNames
```
  - HEX
```
public static final short HEX
```
    The HEX constant describes the string format for hex digit value (e.g. 0123456789ABCDEF).
    
    See Also:
    
    Constant Field Values
  - BITS
```
public static final short BITS
```
    The BITS constant describes the string format for binary digit value (e.g. only 0 and 1 digits).
    
    See Also:
    
    Constant Field Values
  - ASN1VALUE
```
public static final short ASN1VALUE
```
    The ASN1VALUE constant describes the string format for hex or binary digit value. The binary string value will end with letter 'B' and hex string value will end with letter 'H' (e.g. '0101'B or '11'H ). If the number of bits is less than or equal to 16, than it will be printed as Binary String, else as Hex String.
    
    See Also:
    
    Constant Field Values
  - HEXBIN
```
public static final short HEXBIN
```
    The HEXBIN constant describes the string format for hex or binary digit value (e.g. 0xAA 10xxxxxx).
    
    See Also:
    
    Constant Field Values
  - NAMEDBITS
```
public static final short NAMEDBITS
```
    The NAMEDBITS constant describes the string format as a list of bit position names (where applicable) followed by 1 or 0 in parentheses.
    
    See Also:
    
    Constant Field Values
  - mStringFormat
```
public short mStringFormat
```
    The mStringFormat variable can be used to set the string format for print or event handler or toString() functions. The possible options are: HEX, BITS, ASN1VALUE, HEXBIN HEXBIN is the default format.
  - numbits
```
public transient int numbits
```
    This variable contains the number of bits in the bit string value.
  - value
```
public transient byte[] value
```
    This variable holds the bit string value. These are the bits that are encoded when encode is invoked. It is also where the decoded bit string is stored after a decode operation.
  - trimZeroBits
```
public boolean trimZeroBits
```
    This variable describes whether trailing zero bits should be truncated. This is required when encoding a named bit string using CER, DER, PER, or C-OER. By default, no trimming is done.
- Constructor Detail
  - Asn1BitString
```
public Asn1BitString()
```
    This constructor creates an empty bit string that can be used in a decode method call to receive a bit string value.
  - Asn1BitString
```
public Asn1BitString(int numbits_,
                     byte[] data)
```
    This constructor initializes a bit string with the given number of bits and data.
    
    Parameters:
    
    numbits_ - Number of bits
    
    data - Binary bit string contents
  - Asn1BitString
```
public Asn1BitString(byte[] data)
```
    This constructor initializes a bit string with the given bytes, using all 8 bits of every byte.
    
    Parameters:
    
    data - Binary bit string contents
  - Asn1BitString
```
public Asn1BitString(boolean[] bitValues)
```
    This constructor initializes a bit string from the given boolean array. Each array position corresponds to a bit in the bit string.
    
    Parameters:
    
    bitValues - The boolean array
  - Asn1BitString
```
public Asn1BitString(java.lang.String value_)
              throws Asn1ValueParseException
```
    This constructor parses the given ASN.1 value text (either a binary or hex data string) and assigns the values to the internal bit string. Examples of valid value formats are as follows: Binary string: '11010010111001'B Hex string: '0fa56920014abc'H
    
    Parameters:
    
    value_ - The ASN.1 value specification text
    
    Throws:
    
    Asn1ValueParseException
  - Asn1BitString
```
public Asn1BitString(java.util.BitSet bitSet)
```
    This constructor initializes a bit string from the given BitSet object.
    
    Parameters:
    
    bitSet - Java BitSet object
- Method Detail
  - getAsn1TypeName
```
public java.lang.String getAsn1TypeName()
```
    This method gets the ASN.1 type name.
    
    Overrides:
    
    getAsn1TypeName in class Asn1Type
  - clear
```
public void clear(int bitno)
```
    This method clears the given bit in the bit string.
    
    Parameters:
    
    bitno - Number of bit to clear. Bit numbers start at zero and with the MSB of the first byte and progress from left to right.
  - decode
```
public void decode(Asn1BerDecodeBuffer buffer,
                   boolean explicit,
                   int implicitLength)
            throws Asn1Exception,
                   java.io.IOException
```
    This method decodes an ASN.1 bit string value using the BER or DER encoding rules. The UNIVERSAL tag value and length are decoded if explicit tagging is specified.
    
    Specified by:
    
    decode in interface Asn1TypeIF
    
    Overrides:
    
    decode in class Asn1Type
    
    Parameters:
    
    buffer - Decode message buffer object
    
    explicit - Flag indicating element is explicitly tagged
    
    implicitLength - Length of contents if implicit
    
    Throws:
    
    Asn1Exception
    
    java.io.IOException
  - encode
```
public int encode(Asn1BerEncodeBuffer buffer,
                  boolean explicit)
           throws Asn1Exception
```
    This method encodes an ASN.1 bit string value using the BER or DER encoding rules. The UNIVERSAL tag value and length are encoded if explicit tagging is specified.
    
    Specified by:
    
    encode in interface Asn1TypeIF
    
    Overrides:
    
    encode in class Asn1Type
    
    Parameters:
    
    buffer - Encode message buffer object
    
    explicit - Flag indicating explicit tagging should be done
    
    Returns:
    
    Length of component or negative status value
    
    Throws:
    
    Asn1Exception
  - baseDecode
```
protected final void baseDecode(Asn1PerDecodeBuffer buffer)
                         throws Asn1Exception,
                                java.io.IOException
```
    This method decodes an ASN.1 bit string value using the packed encoding rules (PER). The string is assumed to not contain a size constraint. This method is guaranteed non-reentrant.
    
    Parameters:
    
    buffer - Decode message buffer object
    
    Throws:
    
    Asn1Exception
    
    java.io.IOException
  - decode
```
public void decode(Asn1PerDecodeBuffer buffer)
            throws Asn1Exception,
                   java.io.IOException
```
    This method decodes an ASN.1 bit string value using the packed encoding rules (PER). The string is assumed to not contain a size constraint.
    
    Specified by:
    
    decode in interface Asn1TypeIF
    
    Overrides:
    
    decode in class Asn1Type
    
    Parameters:
    
    buffer - Decode message buffer object
    
    Throws:
    
    Asn1Exception
    
    java.io.IOException
  - baseDecode
```
protected final void baseDecode(Asn1PerDecodeBuffer buffer,
                                long lower,
                                long upper)
                         throws Asn1Exception,
                                java.io.IOException
```
    This method decodes a sized ASN.1 bit string value using the packed encoding rules (PER). This method is guaranteed non-reentrant.
    
    Parameters:
    
    buffer - Decode message buffer object
    
    lower - Lower bound (inclusive) of size constraint
    
    upper - Upper bound (inclusive) of size constraint
    
    Throws:
    
    java.io.IOException
    
    Asn1Exception
  - decode
```
public void decode(Asn1PerDecodeBuffer buffer,
                   long lower,
                   long upper)
            throws Asn1Exception,
                   java.io.IOException
```
    This method decodes a sized ASN.1 bit string value using the packed encoding rules (PER).
    
    Parameters:
    
    buffer - Decode message buffer object
    
    lower - Lower bound (inclusive) of size constraint
    
    upper - Upper bound (inclusive) of size constraint
    
    Throws:
    
    java.io.IOException
    
    Asn1Exception
  - decode
```
public void decode(Asn1PerDecodeBuffer buffer,
                   long lower,
                   java.lang.Object upper)
            throws Asn1Exception,
                   java.io.IOException
```
    This method decodes a sized ASN.1 bit string value using the packed encoding rules (PER). This method is invoked when the MAX keyword is used as a boundary.
    
    Parameters:
    
    buffer - Decode message buffer object
    
    lower - Lower bound (inclusive) of size constraint
    
    upper - Upper bound (inclusive) of size constraint
    
    Throws:
    
    java.io.IOException
    
    Asn1Exception
  - decode
```
public void decode(Asn1PerDecodeBuffer buffer,
                   java.lang.Object lower,
                   long upper)
            throws Asn1Exception,
                   java.io.IOException
```
    This method decodes a sized ASN.1 bit string value using the packed encoding rules (PER). This method is invoked when the MIN keyword is used as a boundary.
    
    Parameters:
    
    buffer - Decode message buffer object
    
    lower - Lower bound (inclusive) of size constraint
    
    upper - Upper bound (inclusive) of size constraint
    
    Throws:
    
    java.io.IOException
    
    Asn1Exception
  - decode
```
public void decode(Asn1PerDecodeBuffer buffer,
                   java.lang.Object lower,
                   java.lang.Object upper)
            throws Asn1Exception,
                   java.io.IOException
```
    This method decodes a sized ASN.1 bit string value using the packed encoding rules (PER). This method is invoked when the MIN and MAX keywords are used as a boundary.
    
    Parameters:
    
    buffer - Decode message buffer object
    
    lower - Lower bound (inclusive) of size constraint
    
    upper - Upper bound (inclusive) of size constraint
    
    Throws:
    
    java.io.IOException
    
    Asn1Exception
  - skip
```
public static void skip(Asn1PerDecodeBuffer buffer)
                 throws Asn1Exception,
                        java.io.IOException
```
    This method skips an ASN.1 BIT STRING value using the packed encoding rules (PER). The string is assumed to not be size constrained.
    
    Parameters:
    
    buffer - Decode message buffer object
    
    Throws:
    
    Asn1Exception
    
    java.io.IOException
  - skip
```
public static void skip(Asn1PerDecodeBuffer buffer,
                        long lower,
                        long upper)
                 throws Asn1Exception,
                        java.io.IOException
```
    This method skips a sized ASN.1 bit string value using the packed encoding rules (PER).
    
    Parameters:
    
    buffer - Decode message buffer object
    
    lower - Lower bound (inclusive) of size constraint
    
    upper - Upper bound (inclusive) of size constraint
    
    Throws:
    
    java.io.IOException
    
    Asn1Exception
  - baseEncode
```
protected final void baseEncode(Asn1PerEncodeBuffer buffer,
                                long minEncLen)
                         throws Asn1Exception,
                                java.io.IOException
```
    This method encodes the bit string as an unconstrained ASN.1 bit string value using the packed encoding rules (PER). The value to be encoded is stored in the 'numbits' and 'value' public member variables within this class. It does not trim trailing zeros. It will add trailing zeros if necessary, in accordance with minEncLen. This method is guaranteed non-reentrant.
    
    Parameters:
    
    buffer - Encode message buffer object
    
    minEncLen - Minimum number of bits to encode. Trailing zero bits are added, if necessary. Pass 0 if no trailing zero bits should ever be added.
    
    Throws:
    
    Asn1Exception
    
    java.io.IOException
  - encode
```
public void encode(Asn1PerEncodeBuffer buffer)
            throws Asn1Exception,
                   java.io.IOException
```
    This method encodes this bit string using the packed encoding rules (PER). The value to be encoded is stored in the 'numbits' and 'value' public member variables within this class. The implementation here will encode as an unconstrained bit string, trimming away any trailing zero bits if trimZeroBits is set. Subclasses may override this method to encode according to the represented ASN.1 type.
    
    Specified by:
    
    encode in interface Asn1TypeIF
    
    Overrides:
    
    encode in class Asn1Type
    
    Parameters:
    
    buffer - Encode message buffer object
    
    Throws:
    
    Asn1Exception
    
    java.io.IOException
  - baseEncode
```
protected final void baseEncode(Asn1PerEncodeBuffer buffer,
                                long lower,
                                long upper)
                         throws Asn1Exception,
                                java.io.IOException
```
    This method encodes a size-constrained ASN.1 bit string value using the packed encoding rules (PER). The value to be encoded is stored in the 'numbits' and 'value' public member variables within this class. This method is guaranteed non-reentrant.
    
    Parameters:
    
    buffer - Encode message buffer object
    
    lower - Lower bound (inclusive) of size constraint
    
    upper - Upper bound (inclusive) of size constraint
    
    Throws:
    
    java.io.IOException
    
    Asn1Exception
  - encode
```
public void encode(Asn1PerEncodeBuffer buffer,
                   long lower,
                   long upper)
            throws Asn1Exception,
                   java.io.IOException
```
    Throws:
    
    Asn1Exception
    
    java.io.IOException
  - encode
```
public void encode(Asn1PerEncodeBuffer buffer,
                   long lower,
                   java.lang.Object upper)
            throws Asn1Exception,
                   java.io.IOException
```
    This method encodes a size-constrained ASN.1 bit string value using the packed encoding rules (PER). The value to be encoded is stored in the 'numbits' and 'value' public member variables within this class. This method is called when the MAX keyword is used in code generation.
    
    Parameters:
    
    buffer - Encode message buffer object
    
    lower - Lower bound (inclusive) of size constraint
    
    upper - Upper bound (inclusive) of size constraint
    
    Throws:
    
    java.io.IOException
    
    Asn1Exception
  - encode
```
public void encode(Asn1PerEncodeBuffer buffer,
                   java.lang.Object lower,
                   long upper)
            throws Asn1Exception,
                   java.io.IOException
```
    This method encodes a size-constrained ASN.1 bit string value using the packed encoding rules (PER). The value to be encoded is stored in the 'numbits' and 'value' public member variables within this class. This method is called when the MIN keyword is used in code generation.
    
    Parameters:
    
    buffer - Encode message buffer object
    
    lower - Lower bound (inclusive) of size constraint
    
    upper - Upper bound (inclusive) of size constraint
    
    Throws:
    
    java.io.IOException
    
    Asn1Exception
  - encode
```
public void encode(Asn1PerEncodeBuffer buffer,
                   java.lang.Object lower,
                   java.lang.Object upper)
            throws Asn1Exception,
                   java.io.IOException
```
    This method encodes a size-constrained ASN.1 bit string value using the packed encoding rules (PER). The value to be encoded is stored in the 'numbits' and 'value' public member variables within this class. This method is called when both the MIN and MAX keywords are used in code generation.
    
    Parameters:
    
    buffer - Encode message buffer object
    
    lower - Lower bound (inclusive) of size constraint
    
    upper - Upper bound (inclusive) of size constraint
    
    Throws:
    
    java.io.IOException
    
    Asn1Exception
  - decode
```
public final void decode(Asn1NasDecodeBuffer buffer,
                         int numbits)
                  throws java.io.IOException
```
    Decode the given number of bits from the buffer.
    
    Parameters:
    
    buffer -
    
    numbits -
    
    Throws:
    
    java.io.IOException
  - decodeRemainingBits
```
public final void decodeRemainingBits(Asn1NasDecodeBuffer buffer)
                               throws java.io.IOException
```
    Decode all remaining bits in the current container from the buffer. Containers are set by pushing/popping container lengths on/off the buffer's container stack. If no containers are on the stack, this decodes all remaining bits from the buffer.
    
    Parameters:
    
    buffer -
    
    Throws:
    
    java.io.IOException
  - decode
```
public void decode(Asn1MderDecodeBuffer buffer,
                   int length)
            throws Asn1Exception,
                   java.io.IOException
```
    Decode a BIT STRING from the MDER encoding into this object. Exactly the given length of bits will be decoded.
    
    Parameters:
    
    length - This should be 8, 16, or 32, as these are the only lengths MDER supports. However, this is not checked here as it should be able to be checked at code generation time.
    
    Throws:
    
    java.io.IOException
    
    Asn1Exception
  - decodeContent
```
public final void decodeContent(Asn1OerDecodeBuffer buffer,
                                int numOctets,
                                int unusedBits)
                         throws java.io.IOException
```
    This method decodes an ASN.1 BIT STRING's content that was encoded according to OER, given the total number of octets and the number of unused bits in the last octet.
    
    Parameters:
    
    buffer - Decode message buffer object
    
    numOctets - Total number of octets encoding the content, including the final, partial octet (if unusedBits > 0)
    
    unusedBits - # of unused bits in last octet.
    
    Throws:
    
    java.io.IOException
  - decode
```
public void decode(Asn1OerDecodeBuffer buffer)
            throws java.io.IOException
```
    This method decodes an ASN.1 BIT STRING that was encoded according to OER. This assumes the BIT STRING was not fixed-size constrained, so that the length and unused bits are in the encoding. Subclasses can override this method to simply call decodeContent for fixed-size constrained BIT STRINGs.
    
    Overrides:
    
    decode in class Asn1Type
    
    Parameters:
    
    buffer - Decode message buffer object
    
    Throws:
    
    java.io.IOException
  - encodeContent
```
public final void encodeContent(Asn1OerEncodeBuffer buffer)
```
    This method encodes the content of an ASN.1 bit string value, according to OER. (The length determinant and # of unused bits is not encoded.)
    
    Parameters:
    
    buffer - Encode message buffer object
  - encode
```
public void encode(Asn1OerEncodeBuffer buffer)
            throws java.io.IOException
```
    This method encodes this ASN.1 BIT STRING value, according to OER. This encodes the length determinant and # of unused bits, assuming that the BIT STRING is not fixed-size constrained. Subclasses may override this to simply call encodeContent for fixed-size constrained strings.
    
    Overrides:
    
    encode in class Asn1Type
    
    Parameters:
    
    buffer - Encode message buffer object
    
    Throws:
    
    java.io.IOException
  - getOerEffectiveMin
```
protected int getOerEffectiveMin()
```
    Return the lower bound for the OER effective size constraint. When trimZeroBits is set, this controls the trimming done for OER encoding. Subclasses must override this to return the correct value if the BIT STRING has named bits and the effective size constraint has a lower bound other than zero.
  - encode
```
public void encode(Asn1XerEncoder buffer,
                   java.lang.String elemName)
            throws java.io.IOException,
                   Asn1Exception
```
    This method encodes ASN.1 bit string type using the XML encoding rules (XER).
    
    Specified by:
    
    encode in interface Asn1TypeIF
    
    Overrides:
    
    encode in class Asn1Type
    
    Parameters:
    
    buffer - Encode message buffer object
    
    elemName - XML element name used to wrap string
    
    Throws:
    
    java.io.IOException - Any exception thrown by the underlying stream.
    
    Asn1Exception - Thrown, if operation is failed.
  - decodeXER
```
public void decodeXER(java.lang.String buffer,
                      java.lang.String attrs)
               throws Asn1Exception
```
    This method decodes ASN.1 8-bit character string types including IA5String, PrintableString, NumericString, etc. using the XML encoding rules (XER).
    
    Parameters:
    
    buffer - String containing data to be decoded
    
    attrs - Attributes string from element tag
    
    Throws:
    
    Asn1Exception
  - encode
```
public void encode(Asn1XmlEncoder buffer,
                   java.lang.String elemName,
                   java.lang.String nsPrefix,
                   java.lang.String[] namedbits,
                   int[] namedbitindex)
            throws java.io.IOException,
                   Asn1Exception
```
    This method encodes ASN.1 bit string type using the XML Encoding as specified in the XML schema standard.
    
    Parameters:
    
    buffer - Encode message buffer object
    
    elemName - XML element name used to wrap string
    
    nsPrefix - XML element name space prefix
    
    namedbits - Array of named bits
    
    namedbitindex - Arrat of named bits index values
    
    Throws:
    
    java.io.IOException
    
    Asn1Exception
  - encode
```
public void encode(Asn1XmlEncoder buffer,
                   java.lang.String elemName,
                   java.lang.String nsPrefix)
            throws java.io.IOException,
                   Asn1Exception
```
    This method encodes ASN.1 bit string type using the XML Encoding as specified in the XML schema standard.
    
    Overrides:
    
    encode in class Asn1Type
    
    Parameters:
    
    buffer - Encode message buffer object
    
    elemName - XML element name used to wrap string
    
    nsPrefix - XML element namespace prefix
    
    Throws:
    
    java.io.IOException
    
    Asn1Exception
  - decodeXML
```
public void decodeXML(java.lang.String buffer,
                      java.lang.String attrs)
               throws Asn1Exception
```
    This method decodes an ASN.1 BIT STRING using the XML schema encoding rules.
    
    Specified by:
    
    decodeXML in interface Asn1TypeIF
    
    Overrides:
    
    decodeXML in class Asn1Type
    
    Parameters:
    
    buffer - String containing data to be decoded
    
    attrs - Attributes string from element tag
    
    Throws:
    
    Asn1Exception
  - isNamedBitStr
```
public boolean isNamedBitStr(java.lang.String buffer)
```
    This method determines is the input character string represented as named bit string or as bits sequence. It is used for XML decoding.
    
    Parameters:
    
    buffer - Bit string as string to be tested.
    
    Returns:
    
    true, if bit string is represented as sequnece of identifiers.
  - decodeV72
```
public void decodeV72(Asn1JsonDecodeBuffer buffer)
               throws java.io.IOException
```
    Decode ASN.1 bit string from JSON. This provides ObjSys-specific behavior that predates ITU-T X.697.
    
    Parameters:
    
    buffer -
    
    Throws:
    
    java.io.IOException
  - encodeV72
```
public void encodeV72(Asn1JsonOutputStream outstream)
               throws java.io.IOException
```
    Encode this bit string to JSON. This provides ObjSys-specific behavior that predates ITU-T X.697.
    
    Parameters:
    
    outstream - The output JSON stream.
    
    Throws:
    
    java.io.IOException
  - decode
```
public void decode(Asn1JsonDecodeBuffer buffer)
            throws java.io.IOException
```
    Decode ASN.1 BIT STRING from JSON. This class's implementation decodes from a JSON object, as required by X.697 for a BIT STRING that is not constrained to a fixed length. Subclasses must override this for a BIT STRING that is constrained to a fixed length.
    
    Overrides:
    
    decode in class Asn1Type
    
    Parameters:
    
    buffer -
    
    Throws:
    
    java.io.IOException
  - decodeString
```
public final void decodeString(Asn1JsonDecodeBuffer buffer,
                               int numbits)
                        throws java.io.IOException
```
    Decode ASN.1 BIT STRING from JSON. This function decodes from a JSON string, as required by X.697 for a BIT STRING that is constrained to a fixed length. This function ensures that the given number of bits are decoded and that unused bits are zero.
    
    Parameters:
    
    buffer -
    
    numbits - The constrained length.
    
    Throws:
    
    java.io.IOException
  - encode
```
public void encode(Asn1JsonOutputStream outstream)
            throws java.io.IOException
```
    Encode ASN.1 BIT STRING to JSON. This class's implementation encodes to a JSON object, as required by X.697 for a BIT STRING that is not constrained to a fixed length. Subclasses must override this for a BIT STRING that is constrained to a fixed length.
    
    Overrides:
    
    encode in class Asn1Type
    
    Parameters:
    
    outstream - The output JSON stream.
    
    Throws:
    
    java.io.IOException
  - encodeAsString
```
public final void encodeAsString(Asn1JsonOutputStream outstream)
                          throws java.io.IOException
```
    Encode ASN.1 BIT STRING to JSON. This function encodes to a JSON string, as required by X.697 for a BIT STRING that is constrained to a fixed length.
    
    Parameters:
    
    outstream - The output JSON stream.
    
    Throws:
    
    java.io.IOException
  - equals
```
public boolean equals(int nbits,
                      byte[] value)
```
    This method compares this bit string value to the given value for equality. This method assumes all unused bits in the last byte are set to zero.
    
    Parameters:
    
    nbits - Number of bits
    
    value - Byte array containing bit data
  - equals
```
public boolean equals(java.lang.Object bs_)
```
    This method compares this bit string value to the given value for equality. This method assumes all unused bits in the last byte are set to zero.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    bs_ - Bit string object to compare for equality
  - hashCode
```
public int hashCode()
```
    This method returns the hashCode for this bit string.
    
    Overrides:
    
    hashCode in class Asn1Type
  - getLength
```
public int getLength()
              throws Asn1InvalidLengthException
```
    This method will return the length of the BIT STRING in bits.
    
    Overrides:
    
    getLength in class Asn1Type
    
    Returns:
    
    Number of bits.
    
    Throws:
    
    Asn1InvalidLengthException
  - isSet
```
public boolean isSet(int bitno)
```
    This method tests if the given bit in the bit string is set or not.
    
    Parameters:
    
    bitno - Number of bit to set. Bit numbers start at zero and with the MSB of the first byte and progress from left to right.
    
    Returns:
    
    Bit value (true or false)
  - toBoolArray
```
public boolean[] toBoolArray()
```
    This method converts the bit string stored in this object to a boolean array.
    
    Returns:
    
    Boolean array value
  - set
```
public void set(int bitno,
                boolean bvalue)
```
    This method will set the given bit number to the given boolean value. It will expand the existing bit array if it needs to, setting any added bits, except bitno, to 0.
    
    Parameters:
    
    bitno - Number of bit to set. Bit numbers start at zero and with the MSB of the first byte and progress from left to right.
    
    bvalue - Bit value (true or false)
  - set
```
public void set(int bitno)
```
    This method will set the given bit number to one (1). It will expand the existing bit array if it needs to.
    
    Parameters:
    
    bitno - Number of bit to set. Bit numbers start at zero and with the MSB of the first byte and progress from left to right.
  - toInputStream
```
public java.io.InputStream toInputStream()
```
    This method will return a byte array input stream representation of the bit string value.
    
    Returns:
    
    Reference to input stream object
  - toHexString
```
public java.lang.String toHexString()
```
    This method will return a hex string representation of the bit string value. The output format is a string of hex bytes with no extra delimiting characters (ex. 0D56EF).
    
    Returns:
    
    Stringified representation of the value
  - toString
```
public java.lang.String toString()
```
    This method will return a string representation of the BIT STRING value. The output format is a string of hex digits/binary digits according to the value set for mStringFormat variable.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    Stringified representation of the value
  - trim
```
protected int trim(int minLength)
```
    This method will trim trailing zero bits from this BIT STRING. To trim all trailing zero bits, pass 0 for minLength;
    
    Parameters:
    
    minLength - The minimum length to trim down to; do not trim the string to be shorter than this.
    
    Returns:
    
    Adjusted bit count.
  - encode
```
public void encode(Asn1BerOutputStream out,
                   boolean explicit)
            throws Asn1Exception,
                   java.io.IOException
```
    This method encodes and writes to the stream an ASN.1 bit string value including the UNIVERSAL tag value and length if explicit tagging is specified. This overloaded version uses the Basic Encoding Rules (BER).
    
    Specified by:
    
    encode in interface Asn1TypeIF
    
    Overrides:
    
    encode in class Asn1Type
    
    Parameters:
    
    out - BER Output Stream object
    
    explicit - Flag indicating explicit tagging should be done
    
    Throws:
    
    java.io.IOException - Any exception thrown by the underlying OutputStream.
    
    Asn1Exception - Thrown, if operation is failed.
  - encode
```
public void encode(Asn1PerOutputStream out)
            throws Asn1Exception,
                   java.io.IOException
```
    This method encodes an unconstrained ASN.1 bit string value using the packed encoding rules (PER)into the stream. The value to be encoded is stored in the 'numbits' and 'value' public member variables within this class.
    
    Specified by:
    
    encode in interface Asn1TypeIF
    
    Overrides:
    
    encode in class Asn1Type
    
    Parameters:
    
    out - PER Output Stream object
    
    Throws:
    
    java.io.IOException - Any exception thrown by the Asn1PerOutputStream.
    
    Asn1Exception - Thrown, if operation is failed.
  - encode
```
public void encode(Asn1PerOutputStream out,
                   long lower,
                   long upper)
            throws Asn1Exception,
                   java.io.IOException
```
    This method encodes a size-constrained ASN.1 bit string value using the packed encoding rules (PER) into the stream. The value to be encoded is stored in the 'numbits' and 'value' public member variables within this class.
    
    Parameters:
    
    out - PER Output Stream object
    
    lower - Lower bound (inclusive) of size constraint
    
    upper - Upper bound (inclusive) of size constraint
    
    Throws:
    
    java.io.IOException - Any exception thrown by the Asn1PerOutputStream.
    
    Asn1Exception - Thrown, if operation is failed.
  - encode
```
public void encode(Asn1MderOutputStream out,
                   int length)
            throws Asn1Exception,
                   java.io.IOException
```
    Encode this BIT STRING into the MDER encoding. The length of this BIT STRING must match the given length.
    
    Parameters:
    
    length - This should be 8, 16, or 32, as these are the only lengths MDER supports. However, this is not checked here as it should be able to be checked at code generation time. We only check here that the actual and given lengths match.
    
    Throws:
    
    Asn1Exception
    
    java.io.IOException

Class Asn1BitString

Field Summary

Fields inherited from class com.objsys.asn1j.runtime.Asn1Type

Constructor Summary

Method Summary

Methods inherited from class com.objsys.asn1j.runtime.Asn1Type

Methods inherited from class java.lang.Object

Field Detail

TAG

mPositionsToNames

HEX

BITS

ASN1VALUE

HEXBIN

NAMEDBITS

mStringFormat

numbits

value

trimZeroBits

Constructor Detail

Asn1BitString

Asn1BitString

Asn1BitString

Asn1BitString

Asn1BitString

Asn1BitString

Method Detail

getAsn1TypeName

clear

decode

encode

baseDecode

decode

baseDecode

decode

decode

decode

decode

skip

skip

baseEncode

encode

baseEncode

encode

encode

encode

encode

decode

decodeRemainingBits

decode

decodeContent

decode

encodeContent

encode

getOerEffectiveMin

encode

decodeXER

encode

encode

decodeXML

isNamedBitStr

decodeV72

encodeV72

decode

decodeString

encode

encodeAsString

equals

equals

hashCode

getLength

isSet

toBoolArray

set

set

toInputStream

toHexString

toString

trim

encode