HFileContext (Apache HBase 1.2.12 API)

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

All Implemented Interfaces:

Cloneable, HeapSize
```
@InterfaceAudience.Private
public class HFileContext
extends Object
implements HeapSize, Cloneable
```
This carries the information on some of the meta data about the HFile. This meta data is used across the HFileWriter/Readers and the HFileBlocks. This helps to add new information to the HFile.

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`	`compressAlgo` Compression algorithm used
`private boolean`	`compressTags` Whether tags to be compressed or not
`private Encryption.Context`	`cryptoContext` Encryption algorithm and key used
`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
`HFileContext()`
`HFileContext(boolean useHBaseChecksum, boolean includesMvcc, boolean includesTags, Compression.Algorithm compressAlgo, boolean compressTags, ChecksumType checksumType, int bytesPerChecksum, int blockSize, DataBlockEncoding encoding, Encryption.Context cryptoContext, long fileCreateTime)`
`HFileContext(HFileContext context)` Copy constructor

Method Summary

Methods
Modifier and Type	Method and Description
`HFileContext`	`clone()`
`int`	`getBlocksize()`
`int`	`getBytesPerChecksum()`
`ChecksumType`	`getChecksumType()`
`Compression.Algorithm`	`getCompression()`
`DataBlockEncoding`	`getDataBlockEncoding()`
`Encryption.Context`	`getEncryptionContext()`
`long`	`getFileCreateTime()`
`long`	`heapSize()` HeapSize implementation NOTE : The heapsize should be altered as and when new state variable are added
`boolean`	`isCompressedOrEncrypted()`
`boolean`	`isCompressTags()`
`boolean`	`isIncludesMvcc()`
`boolean`	`isIncludesTags()`
`boolean`	`isUseHBaseChecksum()`
`void`	`setCompression(Compression.Algorithm compressAlgo)`
`void`	`setCompressTags(boolean compressTags)`
`void`	`setDataBlockEncoding(DataBlockEncoding encoding)`
`void`	`setEncryptionContext(Encryption.Context cryptoContext)`
`void`	`setFileCreateTime(long fileCreateTime)`
`void`	`setIncludesMvcc(boolean includesMvcc)`
`void`	`setIncludesTags(boolean includesTags)`
`String`	`toString()`

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, 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
- compressAlgo
```
private Compression.Algorithm compressAlgo
```
  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
```
  Encryption algorithm and key used
- fileCreateTime
```
private long fileCreateTime
```

Constructor Detail

HFileContext
```
public HFileContext()
```

HFileContext
```
public HFileContext(HFileContext context)
```
Copy constructor

Parameters:
context -

HFileContext

public HFileContext(boolean useHBaseChecksum,
            boolean includesMvcc,
            boolean includesTags,
            Compression.Algorithm compressAlgo,
            boolean compressTags,
            ChecksumType checksumType,
            int bytesPerChecksum,
            int blockSize,
            DataBlockEncoding encoding,
            Encryption.Context cryptoContext,
            long fileCreateTime)

Method Detail

isCompressedOrEncrypted
```
public boolean isCompressedOrEncrypted()
```
Returns:
true when on-disk blocks from this file are compressed, and/or encrypted; false otherwise.

getCompression

public Compression.Algorithm getCompression()

setCompression

public void setCompression(Compression.Algorithm compressAlgo)

isUseHBaseChecksum
```
public boolean isUseHBaseChecksum()
```

isIncludesMvcc
```
public boolean isIncludesMvcc()
```

setIncludesMvcc

public void setIncludesMvcc(boolean includesMvcc)

isIncludesTags
```
public boolean isIncludesTags()
```

setIncludesTags

public void setIncludesTags(boolean includesTags)

setFileCreateTime

public void setFileCreateTime(long fileCreateTime)

isCompressTags
```
public boolean isCompressTags()
```

setCompressTags

public void setCompressTags(boolean compressTags)

getChecksumType
```
public ChecksumType getChecksumType()
```

getBytesPerChecksum
```
public int getBytesPerChecksum()
```

getBlocksize
```
public int getBlocksize()
```

getFileCreateTime
```
public long getFileCreateTime()
```

getDataBlockEncoding

public DataBlockEncoding getDataBlockEncoding()

setDataBlockEncoding

public void setDataBlockEncoding(DataBlockEncoding encoding)

getEncryptionContext

public Encryption.Context getEncryptionContext()

setEncryptionContext

public void setEncryptionContext(Encryption.Context cryptoContext)

heapSize
```
public long heapSize()
```
HeapSize implementation NOTE : The heapsize should be altered as and when new state variable are added

Specified by:

heapSize in interface HeapSize

Returns:
heap size of the HFileContext

clone
```
public HFileContext clone()
```
Overrides:

clone in class Object

toString
```
public String toString()
```
Overrides:

toString in class Object

Class HFileContext

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_BYTES_PER_CHECKSUM

usesHBaseChecksum

includesMvcc

includesTags

compressAlgo

compressTags

checksumType

bytesPerChecksum

blocksize

encoding

cryptoContext

fileCreateTime

Constructor Detail

HFileContext

HFileContext

HFileContext

Method Detail

isCompressedOrEncrypted

getCompression

setCompression

isUseHBaseChecksum

isIncludesMvcc

setIncludesMvcc

isIncludesTags

setIncludesTags

setFileCreateTime

isCompressTags

setCompressTags

getChecksumType

getBytesPerChecksum

getBlocksize

getFileCreateTime

getDataBlockEncoding

setDataBlockEncoding

getEncryptionContext

setEncryptionContext

heapSize

clone

toString