DefaultBitOutputStream (htsjdk 2.8.1 API)

java.lang.Object
- java.io.OutputStream
- - htsjdk.samtools.cram.io.DefaultBitOutputStream

All Implemented Interfaces:: BitOutputStream, Closeable, Flushable, AutoCloseable

public class DefaultBitOutputStream
extends OutputStream
implements BitOutputStream

Constructor Summary

Constructors
Constructor and Description

DefaultBitOutputStream(OutputStream delegate)

Constructors
Constructor and Description
`DefaultBitOutputStream(OutputStream delegate)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()`
`void`	`flush()`
`String`	`toString()`
`void`	`write(boolean bit)` Write a single bit specified in the boolean argument.
`void`	`write(boolean bit, long repeat)` Write a single bit specified in the boolean argument repeatedly.
`void`	`write(byte b)`
`void`	`write(byte[] b)`
`void`	`write(byte[] b, int off, int length)`
`void`	`write(byte bitContainer, int nofBits)` Write specified number of bits supplied in the byte value.
`void`	`write(int value)`
`void`	`write(int bitContainer, int nofBits)` Write specified number of bits supplied in the integer value.
`void`	`write(long bitContainer, int nofBits)` Write specified number of bits supplied in the long value.

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

- Constructor Detail
  - DefaultBitOutputStream
```
public DefaultBitOutputStream(OutputStream delegate)
```
- Method Detail
  - write
```
public void write(byte b)
           throws IOException
```
    Throws:
    
    IOException
  - write
```
public void write(int value)
           throws IOException
```
    Specified by:
    
    write in class OutputStream
    
    Throws:
    
    IOException
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - write
```
public void write(long bitContainer,
                  int nofBits)
           throws IOException
```
    Description copied from interface: BitOutputStream
    
    Write specified number of bits supplied in the long value. The method is naturally limited to 64 bits max.
    
    Specified by:
    
    write in interface BitOutputStream
    
    Parameters:
    
    bitContainer - an integer containing the bits to be written out
    
    nofBits - the number of bits to written out, minimum 0, maximum 64.
    
    Throws:
    
    IOException - as per streaming contract in java.
  - write
```
public void write(int bitContainer,
                  int nofBits)
           throws IOException
```
    Description copied from interface: BitOutputStream
    
    Write specified number of bits supplied in the integer value. The method is naturally limited to 32 bits max.
    
    Specified by:
    
    write in interface BitOutputStream
    
    Parameters:
    
    bitContainer - an integer containing the bits to be written out
    
    nofBits - the number of bits to written out, minimum 0, maximum 32.
    
    Throws:
    
    IOException - as per streaming contract in java.
  - write
```
public void write(byte bitContainer,
                  int nofBits)
           throws IOException
```
    Description copied from interface: BitOutputStream
    
    Write specified number of bits supplied in the byte value. The method is naturally limited to 8 bits max.
    
    Specified by:
    
    write in interface BitOutputStream
    
    Parameters:
    
    bitContainer - an integer containing the bits to be written out
    
    nofBits - the number of bits to written out, minimum 0, maximum 8.
    
    Throws:
    
    IOException - as per streaming contract in java.
  - write
```
public void write(boolean bit)
           throws IOException
```
    Description copied from interface: BitOutputStream
    
    Write a single bit specified in the boolean argument.
    
    Specified by:
    
    write in interface BitOutputStream
    
    Parameters:
    
    bit - emit 1 if true, 0 otherwise.
    
    Throws:
    
    IOException - as per streaming contract in java.
  - write
```
public void write(boolean bit,
                  long repeat)
           throws IOException
```
    Description copied from interface: BitOutputStream
    
    Write a single bit specified in the boolean argument repeatedly.
    
    Specified by:
    
    write in interface BitOutputStream
    
    Parameters:
    
    bit - emit 1 if true, 0 otherwise.
    
    repeat - the number of bits to emit.
    
    Throws:
    
    IOException - as per streaming contract in java.
  - close
```
public void close()
           throws IOException
```
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
    
    Overrides:
    
    close in class OutputStream
    
    Throws:
    
    IOException
  - flush
```
public void flush()
           throws IOException
```
    Specified by:
    
    flush in interface Flushable
    
    Overrides:
    
    flush in class OutputStream
    
    Throws:
    
    IOException
  - write
```
public void write(byte[] b)
           throws IOException
```
    Overrides:
    
    write in class OutputStream
    
    Throws:
    
    IOException
  - write
```
public void write(byte[] b,
                  int off,
                  int length)
           throws IOException
```
    Overrides:
    
    write in class OutputStream
    
    Throws:
    
    IOException

Class DefaultBitOutputStream

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DefaultBitOutputStream

Method Detail

write

write

toString

write

write

write

write

write

close

flush

write

write