org.apache.hadoop.hbase.io.encoding

Interface HFileBlockEncodingContext

All Known Implementing Classes:

HFileBlockDefaultEncodingContext

@InterfaceAudience.Private
public interface HFileBlockEncodingContext

An encoding context that is created by a writer's encoder, and is shared across the writer's whole lifetime.

See Also:

for decoding

Method Summary

Modifier and Type	Method and Description
void	close() Releases the resources used.
Bytes	compressAndEncrypt(byte[] data, int offset, int length)
BlockType	getBlockType()
DataBlockEncoding	getDataBlockEncoding()
EncodingState	getEncodingState()
HFileContext	getHFileContext()
void	postEncoding(BlockType blockType) Do any action that needs to be performed after the encoding.
void	setEncodingState(EncodingState state) Sets the encoding state.

Method Detail

getBlockType

BlockType getBlockType()

Returns:

the block type after encoding

getDataBlockEncoding

DataBlockEncoding getDataBlockEncoding()

Returns:

the DataBlockEncoding encoding used

postEncoding

void postEncoding(BlockType blockType)
           throws IOException

Do any action that needs to be performed after the encoding. Compression is also included if a non-null compression algorithm is used

Throws:

IOException

close

void close()

Releases the resources used.

getHFileContext

HFileContext getHFileContext()

Returns:

HFile context information

setEncodingState

void setEncodingState(EncodingState state)

Sets the encoding state.

getEncodingState

EncodingState getEncodingState()

Returns:

the encoding state

compressAndEncrypt

Bytes compressAndEncrypt(byte[] data,
                         int offset,
                         int length)
                  throws IOException

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