bt.torrent.maker

Class TorrentBuilder

java.lang.Object

bt.torrent.maker.TorrentBuilder

public class TorrentBuilder
extends Object

A builder pattern to make torrent files conforming to BEP-003

Constructor Summary

Constructors

Constructor and Description
TorrentBuilder()

Method Summary

Modifier and Type	Method and Description
TorrentBuilder	addAnnounceGroup(Collection<String> announceGroup)
TorrentBuilder	addFile(Path file) Add a file to be included within the torrent
TorrentBuilder	addFiles(Path... files)
TorrentBuilder	announce(String announce)
byte[]	build() Build the torrent
TorrentBuilder	createdBy(String createdBy) Set the author of the torrent stored in the created by flag.
TorrentBuilder	creationDate(Date creationDate) Set the creation date of the torrent.
String	getAnnounce()
List<List<String>>	getAnnounceGroups()
String	getCreatedBy()
long	getCreationDate() creationDate(Date)
List<Path>	getFiles()
int	getHashingBufferSize() Get the digest buffer size
int	getMaxNumOpenFiles() maxNumOpenFiles(int)
int	getNumHashingThreads()
int	getPieceSize()
Path	getRootPath()
TorrentBuilder	hashingBufferSize(int hashingBufferSize) Set the size of the io buffer used for reading from files to verify their digest.
boolean	isPrivate() privateFlag(boolean)
TorrentBuilder	maxNumOpenFiles(int maxNumOpenFiles) Set the max number of open files during torrent creation.
TorrentBuilder	numHashingThreads(int numHashingThreads) Set the number of threads used to create sha1 hashes for the torrent being created any value less than 1 will use Java's common fork join pool.
TorrentBuilder	pieceSize(int pieceSize) Set the piece size of the torrent.
TorrentBuilder	privateFlag(boolean isPrivate) Set whether this torrent is a private torrent.
TorrentBuilder	rootPath(Path rootPath) Set the root path of the torrent

Methods inherited from class java.lang.Object

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

Constructor Detail

TorrentBuilder

public TorrentBuilder()

Method Detail

getFiles

public List<Path> getFiles()

getAnnounce

public String getAnnounce()

getRootPath

public Path getRootPath()

getPieceSize

public int getPieceSize()

addFiles

public TorrentBuilder addFiles(Path... files)

addFile

public TorrentBuilder addFile(Path file)

Add a file to be included within the torrent

Parameters:

file - the file to include in the torrent

Returns:

the torrent builder

announce

public TorrentBuilder announce(String announce)

rootPath

public TorrentBuilder rootPath(Path rootPath)

Set the root path of the torrent

Parameters:

rootPath - the root path of the torrent

Returns:

the torrent builder

pieceSize

public TorrentBuilder pieceSize(int pieceSize)

Set the piece size of the torrent. Must be a power of 2

Parameters:

pieceSize - the piece size of the torrent

Returns:

the torrent builder

getCreatedBy

public String getCreatedBy()

createdBy

public TorrentBuilder createdBy(String createdBy)

Set the author of the torrent stored in the created by flag. MetadataConstants.CREATED_BY_KEY

Parameters:

createdBy - the string to put in the created by position

getCreationDate

public long getCreationDate()

creationDate(Date)

creationDate

public TorrentBuilder creationDate(Date creationDate)

Set the creation date of the torrent. Defaults to the time which the torrent is built

Parameters:

creationDate - the creation date of the torrent

isPrivate

public boolean isPrivate()

privateFlag(boolean)

privateFlag

public TorrentBuilder privateFlag(boolean isPrivate)

Set whether this torrent is a private torrent. See BEP-0027

Parameters:

isPrivate - whether the torrent should be marked as private

getMaxNumOpenFiles

public int getMaxNumOpenFiles()

maxNumOpenFiles(int)

maxNumOpenFiles

public TorrentBuilder maxNumOpenFiles(int maxNumOpenFiles)

Set the max number of open files during torrent creation. This is useful if you are creating a torrent which contains many different files and you want to minimize opening the same file when computing hashes while not exceeding the open file descriptor limit

Parameters:

maxNumOpenFiles - the max number of files that will be opened concurrently during torrent creation.

getNumHashingThreads

public int getNumHashingThreads()

numHashingThreads

public TorrentBuilder numHashingThreads(int numHashingThreads)

Set the number of threads used to create sha1 hashes for the torrent being created any value less than 1 will use Java's common fork join pool. ForkJoinPool.commonPool()

Parameters:

numHashingThreads - the number of threads used to create hashes

Returns:

the torrent builder

addAnnounceGroup

public TorrentBuilder addAnnounceGroup(Collection<String> announceGroup)

getAnnounceGroups

public List<List<String>> getAnnounceGroups()

getHashingBufferSize

public int getHashingBufferSize()

Get the digest buffer size

Returns:

the size of the digest buffer

hashingBufferSize

public TorrentBuilder hashingBufferSize(int hashingBufferSize)

Set the size of the io buffer used for reading from files to verify their digest.

Parameters:

hashingBufferSize - the size of the digest buffer

build

public byte[] build()

Build the torrent

Returns:

the created torrent file's bytes