HFileBlockDefaultEncodingContext (Apache HBase 1.4.11 API)

java.lang.Object
- org.apache.hadoop.hbase.io.encoding.HFileBlockDefaultEncodingContext

All Implemented Interfaces:

HFileBlockEncodingContext
```
@InterfaceAudience.Private
public class HFileBlockDefaultEncodingContext
extends Object
implements HFileBlockEncodingContext
```
A default implementation of HFileBlockEncodingContext. It will compress the data section as one continuous buffer.

See Also:
for the decompression part

Constructor Summary

Constructors
Constructor and Description
`HFileBlockDefaultEncodingContext(DataBlockEncoding encoding, byte[] headerBytes, HFileContext fileContext)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`close()` Releases the compressor this writer uses to compress blocks into the compressor pool.
`Bytes`	`compressAndEncrypt(byte[] data, int offset, int length)`
`BlockType`	`getBlockType()`
`DataBlockEncoding`	`getDataBlockEncoding()`
`EncodingState`	`getEncodingState()`
`HFileContext`	`getHFileContext()`
`TagCompressionContext`	`getTagCompressionContext()`
`void`	`postEncoding(BlockType blockType)` Do any action that needs to be performed after the encoding.
`void`	`prepareEncoding(DataOutputStream out)` prepare to start a new encoding.
`void`	`setEncodingState(EncodingState state)` Sets the encoding state.
`void`	`setTagCompressionContext(TagCompressionContext tagCompressionContext)`

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

- Constructor Detail
  - HFileBlockDefaultEncodingContext
```
public HFileBlockDefaultEncodingContext(DataBlockEncoding encoding,
                                byte[] headerBytes,
                                HFileContext fileContext)
```
    Parameters:
    encoding - encoding used
    headerBytes - dummy header bytes
    fileContext - HFile meta data
- Method Detail
  - prepareEncoding
```
public void prepareEncoding(DataOutputStream out)
                     throws IOException
```
    prepare to start a new encoding.
    
    Throws:
    
    IOException
  - postEncoding
```
public void postEncoding(BlockType blockType)
                  throws IOException
```
    Description copied from interface: HFileBlockEncodingContext
    
    Do any action that needs to be performed after the encoding. Compression is also included if a non-null compression algorithm is used
    
    Specified by:
    
    postEncoding in interface HFileBlockEncodingContext
    
    Throws:
    
    IOException
  - compressAndEncrypt
```
public Bytes compressAndEncrypt(byte[] data,
                       int offset,
                       int length)
                         throws IOException
```
    Specified by:
    
    compressAndEncrypt in interface HFileBlockEncodingContext
    
    Parameters:
    data - encoded bytes with header
    offset - the offset in encoded data to start at
    length - the number of encoded bytes
    
    Returns:
    Bytes with header which are ready to write out to disk. This is compressed and encrypted bytes applying the set compression algorithm and encryption. The bytes may be changed. If need a Bytes reference for later use, clone the bytes and use that. Null if the data doesn't need to be compressed and encrypted.
    
    Throws:
    
    IOException
  - getBlockType
```
public BlockType getBlockType()
```
    Specified by:
    
    getBlockType in interface HFileBlockEncodingContext
    
    Returns:
    the block type after encoding
  - close
```
public void close()
```
    Releases the compressor this writer uses to compress blocks into the compressor pool.
    
    Specified by:
    
    close in interface HFileBlockEncodingContext
  - getDataBlockEncoding
```
public DataBlockEncoding getDataBlockEncoding()
```
    Specified by:
    
    getDataBlockEncoding in interface HFileBlockEncodingContext
    
    Returns:
    the DataBlockEncoding encoding used
  - getHFileContext
```
public HFileContext getHFileContext()
```
    Specified by:
    
    getHFileContext in interface HFileBlockEncodingContext
    
    Returns:
    HFile context information
  - getTagCompressionContext
```
public TagCompressionContext getTagCompressionContext()
```
  - setTagCompressionContext
```
public void setTagCompressionContext(TagCompressionContext tagCompressionContext)
```
  - getEncodingState
```
public EncodingState getEncodingState()
```
    Specified by:
    
    getEncodingState in interface HFileBlockEncodingContext
    
    Returns:
    the encoding state
  - setEncodingState
```
public void setEncodingState(EncodingState state)
```
    Description copied from interface: HFileBlockEncodingContext
    
    Sets the encoding state.
    
    Specified by:
    
    setEncodingState in interface HFileBlockEncodingContext

Class HFileBlockDefaultEncodingContext

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HFileBlockDefaultEncodingContext

Method Detail

prepareEncoding

postEncoding

compressAndEncrypt

getBlockType

close

getDataBlockEncoding

getHFileContext

getTagCompressionContext

setTagCompressionContext

getEncodingState

setEncodingState