org.apache.bookkeeper.mledger.offload.jcloud.impl

Class OffloadIndexBlockBuilderImpl

java.lang.Object

org.apache.bookkeeper.mledger.offload.jcloud.impl.OffloadIndexBlockBuilderImpl

All Implemented Interfaces:

OffloadIndexBlockBuilder

public class OffloadIndexBlockBuilderImpl
extends Object
implements OffloadIndexBlockBuilder

Interface for builder of index block used for offload a ledger to long term storage.

Constructor Summary

Constructors

Constructor and Description
OffloadIndexBlockBuilderImpl()

Method Summary

Modifier and Type	Method and Description
OffloadIndexBlockBuilder	addBlock(long firstEntryId, int partId, int blockSize) Add one payload block related information into index block.
OffloadIndexBlock	build() Finalize the immutable OffloadIndexBlock.
OffloadIndexBlock	fromStream(InputStream is) Construct OffloadIndex from an InputStream.
OffloadIndexBlockBuilder	withDataBlockHeaderLength(long dataHeaderLength) Specify the length of the block headers in the data object.
OffloadIndexBlockBuilder	withDataObjectLength(long dataObjectLength) Specify the length of data object this index is associated with.
OffloadIndexBlockBuilder	withLedgerMetadata(org.apache.bookkeeper.client.api.LedgerMetadata metadata) Build index block with the passed in ledger metadata.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.bookkeeper.mledger.offload.jcloud.OffloadIndexBlockBuilder

create

Constructor Detail

OffloadIndexBlockBuilderImpl

public OffloadIndexBlockBuilderImpl()

Method Detail

withDataObjectLength

public OffloadIndexBlockBuilder withDataObjectLength(long dataObjectLength)

Description copied from interface: OffloadIndexBlockBuilder

Specify the length of data object this index is associated with.

Specified by:

withDataObjectLength in interface OffloadIndexBlockBuilder

Parameters:

dataObjectLength - the length of the data object

withDataBlockHeaderLength

public OffloadIndexBlockBuilder withDataBlockHeaderLength(long dataHeaderLength)

Description copied from interface: OffloadIndexBlockBuilder

Specify the length of the block headers in the data object.

Specified by:

withDataBlockHeaderLength in interface OffloadIndexBlockBuilder

Parameters:

dataHeaderLength - the length of the headers

withLedgerMetadata

public OffloadIndexBlockBuilder withLedgerMetadata(org.apache.bookkeeper.client.api.LedgerMetadata metadata)

Description copied from interface: OffloadIndexBlockBuilder

Build index block with the passed in ledger metadata.

Specified by:

withLedgerMetadata in interface OffloadIndexBlockBuilder

Parameters:

metadata - the ledger metadata

addBlock

public OffloadIndexBlockBuilder addBlock(long firstEntryId,
                                         int partId,
                                         int blockSize)

Description copied from interface: OffloadIndexBlockBuilder

Add one payload block related information into index block. It contains the first entryId in payload block, the payload block Id, and payload block size. This information will be used to consist one index entry in OffloadIndexBlock.

Specified by:

addBlock in interface OffloadIndexBlockBuilder

Parameters:

firstEntryId - the first entryId in payload block

partId - the payload block Id

blockSize - the payload block size

fromStream

public OffloadIndexBlock fromStream(InputStream is)
                             throws IOException

Description copied from interface: OffloadIndexBlockBuilder

Construct OffloadIndex from an InputStream.

Specified by:

fromStream in interface OffloadIndexBlockBuilder

Throws:

IOException

build

public OffloadIndexBlock build()

Description copied from interface: OffloadIndexBlockBuilder

Finalize the immutable OffloadIndexBlock.

Specified by:

build in interface OffloadIndexBlockBuilder