bt.data

Interface DataDescriptor

All Superinterfaces:

AutoCloseable, Closeable

public interface DataDescriptor
extends Closeable

Torrent's data descriptor. Provides access to individual chunks and status of torrent's data.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
BitSet	getAllPiecesForFiles(Set<TorrentFile> files) Get all pieces that contain any part of the set of files
LocalBitfield	getBitfield()
List<ChunkDescriptor>	getChunkDescriptors()
List<TorrentFile>	getFilesForPiece(int pieceIndex) Deprecated. use getAllPiecesForFiles(Set) or getPiecesWithOnlyFiles(Set) instead
long	getLeft() Get the amount of data left to verify
BitSet	getPiecesWithOnlyFiles(Set<TorrentFile> files) Get the set of pieces that only contain parts of the the set of files
DataReader	getReader() Get the data reader interface, which provides convenient ways to work with torrent's data (e.g.
boolean	startedAsSeed() Check if the torrent was finished upon initial hashing
void	waitForAllPieces() Wait for all of the pieces of the torrent to download

Methods inherited from interface java.io.Closeable

close

Method Detail

getChunkDescriptors

List<ChunkDescriptor> getChunkDescriptors()

Returns:

List of chunks in the same order as they appear in torrent's metainfo. Hence, index of a chunk in this list can be used as the index of the corresponding piece in data exchange between peers.

Since:

1.0

getBitfield

LocalBitfield getBitfield()

Returns:

Status of torrent's data.

Since:

1.0

getFilesForPiece

@Deprecated
List<TorrentFile> getFilesForPiece(int pieceIndex)

Deprecated. use getAllPiecesForFiles(Set) or getPiecesWithOnlyFiles(Set) instead

Get a list of files that a given piece index intersects

Returns:

A list of files that a given piece index intersects

Since:

1.7

getAllPiecesForFiles

BitSet getAllPiecesForFiles(Set<TorrentFile> files)

Get all pieces that contain any part of the set of files

Parameters:

files - the files the pieces are needed for

Returns:

All pieces that contain any part of the passed in files

Since:

1.10

getPiecesWithOnlyFiles

BitSet getPiecesWithOnlyFiles(Set<TorrentFile> files)

Get the set of pieces that only contain parts of the the set of files

Parameters:

files - the files the pieces are needed for

Returns:

The set of pieces that only contain parts of the passed in files

Since:

1.10

getReader

DataReader getReader()

Get the data reader interface, which provides convenient ways to work with torrent's data (e.g. read it in a stream-like fashion).

Returns:

Data reader

Since:

1.8

waitForAllPieces

void waitForAllPieces()
               throws InterruptedException

Wait for all of the pieces of the torrent to download

Throws:

InterruptedException

startedAsSeed

boolean startedAsSeed()

Check if the torrent was finished upon initial hashing

Returns:

true if the torrent file was complete upon initial hashing

getLeft

long getLeft()

Get the amount of data left to verify

Returns:

the amount of data left to verify

Since:

1.10