HFileContextBuilder (Apache HBase 1.2.12 API)

java.lang.Object
- org.apache.hadoop.hbase.io.hfile.HFileContextBuilder

@InterfaceAudience.Private
public class HFileContextBuilder
extends Object

A builder that helps in building up the HFileContext

Field Summary

Fields
Modifier and Type	Field and Description
`private int`	`blocksize` Number of uncompressed bytes we allow per block.
`private int`	`bytesPerChecksum` the number of bytes per checksum value
`private ChecksumType`	`checksumType` the checksum type
`private Compression.Algorithm`	`compression` Compression algorithm used
`private boolean`	`compressTags` Whether tags to be compressed or not
`private Encryption.Context`	`cryptoContext` Crypto context
`static int`	`DEFAULT_BYTES_PER_CHECKSUM`
`private DataBlockEncoding`	`encoding`
`private long`	`fileCreateTime`
`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 boolean`	`usesHBaseChecksum` Whether checksum is enabled or not

Constructor Summary

Constructors
Constructor and Description

HFileContextBuilder()

Constructors
Constructor and Description
`HFileContextBuilder()`

Method Summary

Methods
Modifier and Type	Method and Description
`HFileContext`	`build()`
`HFileContextBuilder`	`withBlockSize(int blockSize)`
`HFileContextBuilder`	`withBytesPerCheckSum(int bytesPerChecksum)`
`HFileContextBuilder`	`withChecksumType(ChecksumType checkSumType)`
`HFileContextBuilder`	`withCompression(Compression.Algorithm compression)`
`HFileContextBuilder`	`withCompressTags(boolean compressTags)`
`HFileContextBuilder`	`withCreateTime(long fileCreateTime)`
`HFileContextBuilder`	`withDataBlockEncoding(DataBlockEncoding encoding)`
`HFileContextBuilder`	`withEncryptionContext(Encryption.Context cryptoContext)`
`HFileContextBuilder`	`withHBaseCheckSum(boolean useHBaseCheckSum)`
`HFileContextBuilder`	`withIncludesMvcc(boolean includesMvcc)`
`HFileContextBuilder`	`withIncludesTags(boolean includesTags)`

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

Field Detail
- 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
- 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
```
- cryptoContext
```
private Encryption.Context cryptoContext
```
  Crypto context
- fileCreateTime
```
private long fileCreateTime
```

Constructor Detail
- HFileContextBuilder
```
public HFileContextBuilder()
```

Method Detail

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)

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)

withEncryptionContext

public HFileContextBuilder withEncryptionContext(Encryption.Context cryptoContext)

withCreateTime

public HFileContextBuilder withCreateTime(long fileCreateTime)

build
```
public HFileContext build()
```

Class HFileContextBuilder

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_BYTES_PER_CHECKSUM

usesHBaseChecksum

includesMvcc

includesTags

compression

compressTags

checksumType

bytesPerChecksum

blocksize

encoding

cryptoContext

fileCreateTime

Constructor Detail

HFileContextBuilder

Method Detail

withHBaseCheckSum

withIncludesMvcc

withIncludesTags

withCompression

withCompressTags

withChecksumType

withBytesPerCheckSum

withBlockSize

withDataBlockEncoding

withEncryptionContext

withCreateTime

build