InputBitStream (Apache Flex - FlexJS: Compiler: Parent 0.8.0-SNAPSHOT API)

java.lang.Object
- java.io.InputStream
- - org.apache.flex.swf.io.InputBitStream

All Implemented Interfaces:

Closeable, AutoCloseable
```
public class InputBitStream
extends InputStream
```
Implementation of InputBitStream. This implementation allows you to swap the underlying InputStream source with another one.
InputBitStream doesn't buffer the source InputStream internally. It has one byte buffer for reading SWF bit-values. The buffer is filled 8 bits at a time. All the bit value methods read from this buffer.
If a SWF file is compressed, InputBitStream uses an InflaterInputStream to decompress the source input.

Constructor Summary

Constructors
Constructor and Description

InputBitStream(byte[] bytes)

InputBitStream(InputStream in)
Create an InputBitStream.

Constructors
Constructor and Description
`InputBitStream(byte[] bytes)`
`InputBitStream(InputStream in)` Create an `InputBitStream`.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`byteAlign()` Discard the data left in the bit value cache.
`long`	`getOffset()` Get the offset of the read cursor.
`long`	`getReadBoundary()` Get the read boundary.
`int`	`read()`
`byte[]`	`read(int length)` Read raw bytes.
`boolean`	`readBit()` Read 1-bit boolean value.
`protected int`	`readBits(int length)` Read multiple bits as a padded int.
`protected int`	`readByte()` This helps to mute the `IOException`.
`double`	`readDOUBLE()` Read 64-bit floating-point number
`long`	`readEncodedU32()` Read encoded unsigned 32-bit integer
`float`	`readFB(int length)` Read fixed-point bit values.
`float`	`readFIXED()` Read 32-bit 16.16 fixed point number.
`float`	`readFIXED8()` Read 16-bit 8.8 fixed point number
`float`	`readFLOAT()` Read 32-bit floating-point number
`int`	`readSB(int length)` Read signed bit values.
`short`	`readSI16()` Read 16-bit signed integer.
`int`	`readSI32()` Read 32-bit signed integer.
`long`	`readSI64()` Read 64-bit signed integer.
`byte`	`readSI8()` Read 8-bit signed integer.
`String`	`readString()` Read string.
`byte[]`	`readToBoundary()` Read all the bytes from the current position up to the read boundary.
`int`	`readUB(int length)` Read unsigned bit values.
`int`	`readUI16()` Read 16-bit unsigned integer.
`int`	`readUI24()` Read 24-bit unsigned integer.
`long`	`readUI32()` Read 32-bit unsigned integer.
`short`	`readUI8()` Read 8-bit unsigned integer.
`void`	`setCompress(Header.Compression compression)` Set if the InputStream is a compressed SWF stream.
`void`	`setReadBoundary(long offset)` Set the read boundary.

Methods inherited from class java.io.InputStream
available, close, mark, markSupported, read, read, reset, skip

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.io.Closeable
close

- Constructor Detail
  - InputBitStream
```
public InputBitStream(InputStream in)
```
    Create an InputBitStream.
    
    Parameters:
    in - source InputStream
  - InputBitStream
```
public InputBitStream(byte[] bytes)
```
- Method Detail
  - byteAlign
```
public void byteAlign()
```
    Discard the data left in the bit value cache. Always call this method after reading bit values and before reading other byte-aligned data.
  - read
```
public int read()
         throws IOException
```
    Specified by:
    
    read in class InputStream
    
    Throws:
    
    IOException
  - read
```
public byte[] read(int length)
```
    Read raw bytes.
    
    Parameters:
    length - number of bytes to read
    
    Returns:
    array of bytes
  - readBit
```
public boolean readBit()
```
    Read 1-bit boolean value.
    
    Returns:
    boolean
  - readBits
```
protected int readBits(int length)
```
    Read multiple bits as a padded int.
    
    Parameters:
    length - number of bits to read
    
    Returns:
    The value that was read.
  - readByte
```
protected int readByte()
```
    This helps to mute the IOException. If there's no data in the source input stream, calling this method will raise an runtime exception.
    All the methods implementing IInputBitStream should call this method when consuming the next byte from the input stream.
    
    Returns:
    next byte in the input stream
  - readDOUBLE
```
public double readDOUBLE()
```
    Read 64-bit floating-point number
    
    Returns:
    double
  - readEncodedU32
```
public long readEncodedU32()
```
    Read encoded unsigned 32-bit integer
    
    Returns:
    integer
  - readFB
```
public float readFB(int length)
```
    Read fixed-point bit values. Fixed-point bit values are 32-bit 16.16 signed, fixed-point numbers. That is, the high 16 bits represent the number before the decimal point, and the low 16 bits represent the number after the decimal point. A fixed-point bit value is identical to a signed-bit value, but the interpretation is different. For example, a 19-bit, signed-bit value of 0x30000 is interpreted as 196608 decimal. The 19-bit, fixed-point bit value 0x30000 is interpreted as 3.0. The format of this value is effectively 3.16 rather than 16.16.
    
    Parameters:
    length - number of bits to read
    
    Returns:
    integer
  - readFIXED
```
public float readFIXED()
```
    Read 32-bit 16.16 fixed point number.
    
    Returns:
    fixed point number
  - readFIXED8
```
public float readFIXED8()
```
    Read 16-bit 8.8 fixed point number
    
    Returns:
    fixed point number
  - readFLOAT
```
public float readFLOAT()
```
    Read 32-bit floating-point number
    
    Returns:
    float
  - readSB
```
public int readSB(int length)
```
    Read signed bit values.
    
    Parameters:
    length - number of bits to read
    
    Returns:
    integer
  - readSI16
```
public short readSI16()
```
    Read 16-bit signed integer.
    
    Returns:
    integer
  - readSI32
```
public int readSI32()
```
    Read 32-bit signed integer.
    
    Returns:
    integer
  - readSI64
```
public long readSI64()
```
    Read 64-bit signed integer.
    
    Returns:
    integer
  - readSI8
```
public byte readSI8()
```
    Read 8-bit signed integer.
    
    Returns:
    integer
  - readString
```
public String readString()
```
    Read string.
    
    Returns:
    string
  - readUB
```
public int readUB(int length)
```
    Read unsigned bit values.
    
    Parameters:
    length - number of bits to read
    
    Returns:
    integer
  - readUI16
```
public int readUI16()
```
    Read 16-bit unsigned integer.
    
    Returns:
    integer
  - readUI24
```
public int readUI24()
```
    Read 24-bit unsigned integer.
    
    Returns:
    integer
  - readUI32
```
public long readUI32()
```
    Read 32-bit unsigned integer.
    
    Returns:
    integer
  - readUI8
```
public short readUI8()
```
    Read 8-bit unsigned integer.
    
    Returns:
    integer
  - setCompress
```
public void setCompress(Header.Compression compression)
                 throws IOException
```
    Set if the InputStream is a compressed SWF stream.
    
    Throws:
    
    IOException
  - readToBoundary
```
public byte[] readToBoundary()
```
    Read all the bytes from the current position up to the read boundary. This is useful for reading SWF tags with variable length field at the end, like DoABC.
    
    Returns:
    byte array
  - getOffset
```
public long getOffset()
```
    Get the offset of the read cursor.
    
    Returns:
    offset
  - setReadBoundary
```
public void setReadBoundary(long offset)
```
    Set the read boundary. Reading beyond the boundary will raise exception.
    The read boundary can move forward and backward. This is because DefineSprite has nested tags. The read boundary for a DefineSprite tag is at the end of all the nested tags, but it moves backwards when starting to read the nested ones.
    
    Parameters:
    offset - boundary offset to the beginning of the stream.
  - getReadBoundary
```
public long getReadBoundary()
```
    Get the read boundary.
    
    Returns:
    read boundary

Class InputBitStream

Constructor Summary

Method Summary

Methods inherited from class java.io.InputStream

Methods inherited from class java.lang.Object

Methods inherited from interface java.io.Closeable

Constructor Detail

InputBitStream

InputBitStream

Method Detail

byteAlign

read

read

readBit

readBits

readByte

readDOUBLE

readEncodedU32

readFB

readFIXED

readFIXED8

readFLOAT

readSB

readSI16

readSI32

readSI64

readSI8

readString

readUB

readUI16

readUI24

readUI32

readUI8

setCompress

readToBoundary

getOffset

setReadBoundary

getReadBoundary