org.johnnei.javatorrent.torrent

Class Torrent.Builder

java.lang.Object

org.johnnei.javatorrent.torrent.Torrent.Builder

Enclosing class:

Torrent

public static final class Torrent.Builder
extends Object

A builder to create new instances of Torrent

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
Torrent	build() Creates a torrent without metadata information (the .torrent file is not present).
Torrent	buildFromMetata(File metadata, File downloadFolder) Creates a torrent with metadata information (the .torrent file is present).
boolean	canDownload() This method check if setHash(byte[]) has been called as depending on the configured BEPs that requirements before something is 'downloadable' changes.
Torrent.Builder	setHash(byte[] hash) Sets the hash of the torrent.
Torrent.Builder	setName(String name) Sets the display name for this torrent.
Torrent.Builder	setTorrentClient(TorrentClient torrentClient) Sets the torrent client on which this torrent will be registered.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

setTorrentClient

public Torrent.Builder setTorrentClient(TorrentClient torrentClient)

Sets the torrent client on which this torrent will be registered.

Parameters:

torrentClient - The client.

Returns:

The adjusted builder.

setHash

public Torrent.Builder setHash(byte[] hash)

Sets the hash of the torrent.

Parameters:

hash - The expected hash.

Returns:

The adjusted builder.

setName

public Torrent.Builder setName(String name)

Sets the display name for this torrent.

Parameters:

name - The name to set.

Returns:

The adjusted builder.

canDownload

public boolean canDownload()

This method check if setHash(byte[]) has been called as depending on the configured BEPs that requirements before something is 'downloadable' changes.

Returns:

true if the hash has been set.

build

public Torrent build()

Creates a torrent without metadata information (the .torrent file is not present).

Returns:

The newly created torrent.

buildFromMetata

public Torrent buildFromMetata(File metadata,
                               File downloadFolder)
                        throws IOException

Creates a torrent with metadata information (the .torrent file is present).

Parameters:

metadata - The metadata file to provision this torrent instance with.

downloadFolder - The folder in which the torrent should be downloaded.

Returns:

The newly created torrent.

Throws:

IOException - When the metadata file cannot be read.