jp.cssj.rsr

Interface RandomBuilder

All Known Subinterfaces:

Sequential

All Known Implementing Classes:

AbstractRandomAccessFileBuilder, FileRandomBuilder, NopRandomBuilder, RandomBuilderMeasurer, RandomBuilderPositionSupport, RandomBuilderWrapper, StreamRandomBuilder

public interface RandomBuilder

断片化されたデータを構築するためのインターフェースです。

addBlock または insertBlockBefore により新たな断片を追加します。 断片は追加順に0,1,2,3...というIDが振られます。 IDは断片の挿入または断片にデータを追加する際の識別のために使うことができます。

インスタンスが Sequential インターフェースを実装している場合は、 もともと順次的なデータであり、insertBlockBefore を使う必要がないことを示します。 この場合、addBlock を呼び出さずに Sequential インターフェースのメソッドを呼ぶことで効率良くデータを構築することができます。

Version:

$Id: RandomBuilder.java 1565 2018-07-04 11:51:25Z miyabe $

Author:

MIYABE Tatsuhiko

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	RandomBuilder.PositionInfo 断片の位置情報です。

Method Summary

Modifier and Type	Method and Description
void	addBlock() 断片を末尾に追加します。
void	closeBlock(int id) 断片への書き込みを終了します。 この呼び出しは必須ではありませんが、データの構築を効率化する可能性があります。
void	dispose() 構築のためのリソースを破棄します。
void	finish() データの構築を完了します。
RandomBuilder.PositionInfo	getPositionInfo() 構築中の各断片の先頭位置を得るためのオブジェクトを返します。
void	insertBlockBefore(int anchorId) 指定した断片の直前に断片を挿入します。
boolean	supportsPositionInfo() 位置情報をサポートしているかどうかを返します。
void	write(int id, byte[] b, int off, int len) 断片にデータを追加します。

Method Detail

addBlock

void addBlock()
       throws IOException

断片を末尾に追加します。

Throws:

IOException

insertBlockBefore

void insertBlockBefore(int anchorId)
                throws IOException

指定した断片の直前に断片を挿入します。

Parameters:

anchorId - 断片のID。

Throws:

IOException

write

void write(int id,
           byte[] b,
           int off,
           int len)
    throws IOException

断片にデータを追加します。

Parameters:

id - 断片のID。

b - バイト列。

off - バイト列中のデータの開始位置。

len - バイト列中のデータの長さ。

Throws:

IOException

supportsPositionInfo

boolean supportsPositionInfo()

位置情報をサポートしているかどうかを返します。

Returns:

位置情報をサポートしていればtrue。

getPositionInfo

RandomBuilder.PositionInfo getPositionInfo()
                                    throws UnsupportedOperationException

構築中の各断片の先頭位置を得るためのオブジェクトを返します。

Returns:

位置情報。

Throws:

UnsupportedOperationException

closeBlock

void closeBlock(int id)
         throws IOException

断片への書き込みを終了します。 この呼び出しは必須ではありませんが、データの構築を効率化する可能性があります。

Parameters:

id - 断片のID。

Throws:

IOException

finish

void finish()
     throws IOException

データの構築を完了します。

Throws:

IOException

dispose

void dispose()

構築のためのリソースを破棄します。

RandomBuilder は処理のために一時ファイルなどのリソースを使用するため、 不要となったオブジェクトに対しては必ずdispose()を呼び出してください。