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

Enum Class BlockType

java.lang.Object

java.lang.Enum<BlockType>

org.apache.hadoop.hbase.io.hfile.BlockType

All Implemented Interfaces:

Serializable, Comparable<BlockType>, Constable

@Private
public enum BlockType
extends Enum<BlockType>

Various types of HFile blocks. Ordinal values of these enum constants must not be relied upon. The values in the enum appear in the order they appear in a version 2 HFile.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	BlockType.BlockCategory

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BLOOM_CHUNK	Bloom filter block, version 2
DATA	Data block, both versions
DELETE_FAMILY_BLOOM_META	Delete Family Bloom filter metadata, version 2
ENCODED_DATA	An encoded data block (e.g.
FILE_INFO	File info, version 2
GENERAL_BLOOM_META	General Bloom filter metadata, version 2
INDEX_V1	Block index magic string in version 1
INTERMEDIATE_INDEX	Intermediate-level version 2 index in the non-data block section
LEAF_INDEX	Version 2 leaf index block.
META	Meta blocks
ROOT_INDEX	Root index block, also used for the single-level meta index, version 2
TRAILER	Fixed file trailer, both versions (always just a magic string)

Field Summary

Fields

Modifier and Type	Field	Description
private final byte[]	magic
static final int	MAGIC_LENGTH
private final BlockType.BlockCategory	metricCat

Constructor Summary

Constructors

Modifier	Constructor	Description
private	BlockType(String magicStr, BlockType.BlockCategory metricCat)

Method Summary

Modifier and Type	Method	Description
BlockType.BlockCategory	getCategory()
int	getId()	Use this instead of Enum.ordinal().
final boolean	isBloom()	Returns whether this block category is bloom filter
final boolean	isData()	Returns whether this block type is encoded or unencoded data block
final boolean	isIndex()	Returns whether this block category is index
static BlockType	parse(byte[] buf, int offset, int length)
int	put(byte[] bytes, int offset)	Put the magic record out to the specified byte array position.
static BlockType	read(DataInputStream in)
static BlockType	read(ByteBuff buf)
void	readAndCheck(DataInputStream in)	Reads a magic record of the length MAGIC_LENGTH from the given stream and expects it to match this block type.
void	readAndCheck(ByteBuffer in)	Reads a magic record of the length MAGIC_LENGTH from the given byte buffer and expects it to match this block type.
static BlockType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static BlockType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.
void	write(DataOutput out)
void	write(ByteBuffer buf)
void	write(ByteBuff buf)
void	writeToStream(OutputStream out)

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

DATA

public static final BlockType DATA

Data block, both versions

ENCODED_DATA

public static final BlockType ENCODED_DATA

An encoded data block (e.g. with prefix compression), version 2

LEAF_INDEX

public static final BlockType LEAF_INDEX

Version 2 leaf index block. Appears in the data block section

BLOOM_CHUNK

public static final BlockType BLOOM_CHUNK

Bloom filter block, version 2

META

public static final BlockType META

Meta blocks

INTERMEDIATE_INDEX

public static final BlockType INTERMEDIATE_INDEX

Intermediate-level version 2 index in the non-data block section

ROOT_INDEX

public static final BlockType ROOT_INDEX

Root index block, also used for the single-level meta index, version 2

FILE_INFO

public static final BlockType FILE_INFO

File info, version 2

GENERAL_BLOOM_META

public static final BlockType GENERAL_BLOOM_META

General Bloom filter metadata, version 2

DELETE_FAMILY_BLOOM_META

public static final BlockType DELETE_FAMILY_BLOOM_META

Delete Family Bloom filter metadata, version 2

TRAILER

public static final BlockType TRAILER

Fixed file trailer, both versions (always just a magic string)

INDEX_V1

public static final BlockType INDEX_V1

Block index magic string in version 1

Field Details

MAGIC_LENGTH

public static final int MAGIC_LENGTH

See Also:

• Constant Field Values

magic

private final byte[] magic

metricCat

private final BlockType.BlockCategory metricCat

Constructor Details

BlockType

private BlockType(String magicStr,
 BlockType.BlockCategory metricCat)

Method Details

values

public static BlockType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static BlockType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getId

public int getId()

Use this instead of Enum.ordinal(). They work exactly the same, except DATA and ENCODED_DATA get the same id using this method (overridden for ENCODED_DATA).

Returns:

block type id from 0 to the number of block types - 1

writeToStream

public void writeToStream(OutputStream out)
                   throws IOException

Throws:

IOException

write

public void write(DataOutput out)
           throws IOException

Throws:

IOException

write

public void write(ByteBuffer buf)

write

public void write(ByteBuff buf)

getCategory

public BlockType.BlockCategory getCategory()

parse

public static BlockType parse(byte[] buf,
 int offset,
 int length)
                       throws IOException

Throws:

IOException

read

public static BlockType read(DataInputStream in)
                      throws IOException

Throws:

IOException

read

public static BlockType read(ByteBuff buf)
                      throws IOException

Throws:

IOException

put

public int put(byte[] bytes,
 int offset)

Put the magic record out to the specified byte array position.

Parameters:

bytes - the byte array

offset - position in the array

Returns:

incremented offset

readAndCheck

public void readAndCheck(DataInputStream in)
                  throws IOException

Reads a magic record of the length MAGIC_LENGTH from the given stream and expects it to match this block type.

Throws:

IOException

readAndCheck

public void readAndCheck(ByteBuffer in)
                  throws IOException

Reads a magic record of the length MAGIC_LENGTH from the given byte buffer and expects it to match this block type.

Throws:

IOException

isData

public final boolean isData()

Returns whether this block type is encoded or unencoded data block

isIndex

public final boolean isIndex()

Returns whether this block category is index

isBloom

public final boolean isBloom()

Returns whether this block category is bloom filter