Package org.apache.hadoop.hbase.io.hfile

Class HFileContextBuilder

java.lang.Object

org.apache.hadoop.hbase.io.hfile.HFileContextBuilder

@Private
public class HFileContextBuilder
extends Object

A builder that helps in building up the HFileContext

Field Summary

Fields

Modifier and Type	Field	Description
private int	blockSize	Number of uncompressed bytes we allow per block.
private int	bytesPerChecksum	the number of bytes per checksum value
private CellComparator	cellComparator
private ChecksumType	checkSumType	the checksum type
private byte[]	columnFamily
private Compression.Algorithm	compression	Compression algorithm used
private boolean	compressTags	Whether tags to be compressed or not
private Encryption.Context	cryptoContext	Crypto context
private Compression.HFileDecompressionContext	decompressionContext
static final int	DEFAULT_BYTES_PER_CHECKSUM
private DataBlockEncoding	encoding
private long	fileCreateTime
private String	hfileName
private boolean	includesMvcc	Whether mvcc is to be included in the Read/Write
private boolean	includesTags	Whether tags are to be included in the Read/Write
private IndexBlockEncoding	indexBlockEncoding	the index block encoding type
private byte[]	tableName
private boolean	usesHBaseChecksum	Whether checksum is enabled or not

Constructor Summary

Constructors

Constructor	Description
HFileContextBuilder()
HFileContextBuilder(HFileContext hfc)	Use this constructor if you want to change a few settings only in another context.

Method Summary

Modifier and Type	Method	Description
HFileContext	build()
HFileContextBuilder	withBlockSize(int blockSize)
HFileContextBuilder	withBytesPerCheckSum(int bytesPerChecksum)
HFileContextBuilder	withCellComparator(CellComparator cellComparator)
HFileContextBuilder	withChecksumType(ChecksumType checkSumType)
HFileContextBuilder	withColumnFamily(byte[] columnFamily)
HFileContextBuilder	withCompression(Compression.Algorithm compression)
HFileContextBuilder	withCompressTags(boolean compressTags)
HFileContextBuilder	withCreateTime(long fileCreateTime)
HFileContextBuilder	withDataBlockEncoding(DataBlockEncoding encoding)
HFileContextBuilder	withDecompressionContext(Compression.HFileDecompressionContext decompressionContext)
HFileContextBuilder	withEncryptionContext(Encryption.Context cryptoContext)
HFileContextBuilder	withHBaseCheckSum(boolean useHBaseCheckSum)
HFileContextBuilder	withHFileName(String name)
HFileContextBuilder	withIncludesMvcc(boolean includesMvcc)
HFileContextBuilder	withIncludesTags(boolean includesTags)
HFileContextBuilder	withIndexBlockEncoding(IndexBlockEncoding indexBlockEncoding)
HFileContextBuilder	withTableName(byte[] tableName)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DEFAULT_BYTES_PER_CHECKSUM

public static final int DEFAULT_BYTES_PER_CHECKSUM

See Also:

• Constant Field Values

usesHBaseChecksum

private boolean usesHBaseChecksum

Whether checksum is enabled or not

includesMvcc

private boolean includesMvcc

Whether mvcc is to be included in the Read/Write

includesTags

private boolean includesTags

Whether tags are to be included in the Read/Write

compression

private Compression.Algorithm compression

Compression algorithm used

decompressionContext

@Nullable
private Compression.HFileDecompressionContext decompressionContext

compressTags

private boolean compressTags

Whether tags to be compressed or not

checkSumType

private ChecksumType checkSumType

the checksum type

bytesPerChecksum

private int bytesPerChecksum

the number of bytes per checksum value

blockSize

private int blockSize

Number of uncompressed bytes we allow per block.

encoding

private DataBlockEncoding encoding

indexBlockEncoding

private IndexBlockEncoding indexBlockEncoding

the index block encoding type

cryptoContext

private Encryption.Context cryptoContext

Crypto context

fileCreateTime

private long fileCreateTime

hfileName

private String hfileName

columnFamily

private byte[] columnFamily

tableName

private byte[] tableName

cellComparator

private CellComparator cellComparator

Constructor Details

HFileContextBuilder

public HFileContextBuilder()

HFileContextBuilder

public HFileContextBuilder(HFileContext hfc)

Use this constructor if you want to change a few settings only in another context.

Method Details

withHBaseCheckSum

public HFileContextBuilder withHBaseCheckSum(boolean useHBaseCheckSum)

withIncludesMvcc

public HFileContextBuilder withIncludesMvcc(boolean includesMvcc)

withIncludesTags

public HFileContextBuilder withIncludesTags(boolean includesTags)

withCompression

public HFileContextBuilder withCompression(Compression.Algorithm compression)

withDecompressionContext

public HFileContextBuilder withDecompressionContext(@Nullable
 Compression.HFileDecompressionContext decompressionContext)

withCompressTags

public HFileContextBuilder withCompressTags(boolean compressTags)

withChecksumType

public HFileContextBuilder withChecksumType(ChecksumType checkSumType)

withBytesPerCheckSum

public HFileContextBuilder withBytesPerCheckSum(int bytesPerChecksum)

withBlockSize

public HFileContextBuilder withBlockSize(int blockSize)

withDataBlockEncoding

public HFileContextBuilder withDataBlockEncoding(DataBlockEncoding encoding)

withIndexBlockEncoding

public HFileContextBuilder withIndexBlockEncoding(IndexBlockEncoding indexBlockEncoding)

withEncryptionContext

public HFileContextBuilder withEncryptionContext(Encryption.Context cryptoContext)

withCreateTime

public HFileContextBuilder withCreateTime(long fileCreateTime)

withHFileName

public HFileContextBuilder withHFileName(String name)

withColumnFamily

public HFileContextBuilder withColumnFamily(byte[] columnFamily)

withTableName

public HFileContextBuilder withTableName(byte[] tableName)

withCellComparator

public HFileContextBuilder withCellComparator(CellComparator cellComparator)

build

public HFileContext build()