org.apache.hudi.io.hfile

Enum HFileBlockType

java.lang.Object

java.lang.Enum<HFileBlockType>

org.apache.hudi.io.hfile.HFileBlockType

All Implemented Interfaces:

Serializable, Comparable<HFileBlockType>

public enum HFileBlockType
extends Enum<HFileBlockType>

Represents the HFile block type. These types are copied from HBase HFile definition to maintain compatibility. Do not delete or reorder the enums as the ordinal is used as the block type ID.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HFileBlockType.BlockCategory

Enum Constant Summary

Enum Constants

Enum Constant and Description
BLOOM_CHUNK Bloom filter block, version 2
DATA Data block
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)

Method Summary

Modifier and Type	Method and Description
int	getId() Uses this instead of Enum.ordinal().
static HFileBlockType	parse(byte[] buf, int offset) Parses the block type from the block magic.
void	readAndCheckMagic(DataInputStream in) Reads a magic record of the length DataSize.MAGIC_LENGTH from the given stream and expects it to match this block type.
static HFileBlockType	valueOf(String name) Returns the enum constant of this type with the specified name.
static HFileBlockType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DATA

public static final HFileBlockType DATA

Data block

ENCODED_DATA

public static final HFileBlockType ENCODED_DATA

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

LEAF_INDEX

public static final HFileBlockType LEAF_INDEX

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

BLOOM_CHUNK

public static final HFileBlockType BLOOM_CHUNK

Bloom filter block, version 2

META

public static final HFileBlockType META

Meta blocks

INTERMEDIATE_INDEX

public static final HFileBlockType INTERMEDIATE_INDEX

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

ROOT_INDEX

public static final HFileBlockType ROOT_INDEX

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

FILE_INFO

public static final HFileBlockType FILE_INFO

File info, version 2

GENERAL_BLOOM_META

public static final HFileBlockType GENERAL_BLOOM_META

General Bloom filter metadata, version 2

DELETE_FAMILY_BLOOM_META

public static final HFileBlockType DELETE_FAMILY_BLOOM_META

Delete Family Bloom filter metadata, version 2

TRAILER

public static final HFileBlockType TRAILER

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

INDEX_V1

public static final HFileBlockType INDEX_V1

Block index magic string in version 1

Method Detail

values

public static HFileBlockType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (HFileBlockType c : HFileBlockType.values())
    System.out.println(c);

Returns:

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

valueOf

public static HFileBlockType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

parse

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

Parses the block type from the block magic.

Parameters:

buf - input data.

offset - offset to start reading.

Returns:

the block type.

Throws:

IOException - if the block magic is invalid.

getId

public int getId()

Uses 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.

readAndCheckMagic

public void readAndCheckMagic(DataInputStream in)
                       throws IOException

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

Parameters:

in - input data.

Throws:

IOException - when the magic is invalid.