TorrentBuilder (jlibtorrent 1.2.0.18 API)

java.lang.Object
- com.frostwire.jlibtorrent.TorrentBuilder

public final class TorrentBuilder
extends java.lang.Object

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface TorrentBuilder.Listener

static class TorrentBuilder.Result

Nested Classes
Modifier and Type	Class and Description
`static interface`	`TorrentBuilder.Listener`
`static class`	`TorrentBuilder.Result`

Field Summary

Fields
Modifier and Type	Field and Description
`static create_flags_t`	`MERKLE` This will create a merkle hash tree torrent.
`static create_flags_t`	`MODIFICATION_TIME` This will include the file modification time as part of the torrent.
`static create_flags_t`	`MUTABLE_TORRENT_SUPPORT` To create a torrent that can be updated via a mutable torrent (see BEP38_).
`static create_flags_t`	`OPTIMIZE_ALIGNMENT` This will insert pad files to align the files to piece boundaries, for optimized disk-I/O.
`static create_flags_t`	`SYMLINKS` If this flag is set, files that are symlinks get a symlink attribute set on them and their data will not be included in the torrent.

Constructor Summary

Constructors
Constructor and Description

TorrentBuilder()

Constructors
Constructor and Description
`TorrentBuilder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TorrentBuilder`	`addCollection(java.lang.String value)` Add collections of similar torrents.
`TorrentBuilder`	`addCollections(java.util.List<java.lang.String> value)`
`TorrentBuilder`	`addHttpSeed(java.lang.String value)` This adds a HTTP seed to the torrent.
`TorrentBuilder`	`addHttpSeeds(java.util.List<java.lang.String> value)`
`TorrentBuilder`	`addNode(Pair<java.lang.String,java.lang.Integer> value)` This adds a DHT node to the torrent.
`TorrentBuilder`	`addNodes(java.util.List<Pair<java.lang.String,java.lang.Integer>> value)`
`TorrentBuilder`	`addSimilarTorrent(Sha1Hash value)` Add similar torrents (by info-hash).
`TorrentBuilder`	`addSimilarTorrents(java.util.List<Sha1Hash> value)`
`TorrentBuilder`	`addTracker(Pair<java.lang.String,java.lang.Integer> value)`
`TorrentBuilder`	`addTracker(java.lang.String url)`
`TorrentBuilder`	`addTracker(java.lang.String url, int tier)` Adds a tracker to the torrent.
`TorrentBuilder`	`addTrackers(java.util.List<Pair<java.lang.String,java.lang.Integer>> value)`
`TorrentBuilder`	`addUrlSeed(java.lang.String value)` This adds a url seed to the torrent.
`TorrentBuilder`	`addUrlSeeds(java.util.List<java.lang.String> value)`
`int`	`alignment()`
`TorrentBuilder`	`alignment(int value)` Used when pad files are enabled.
`java.util.List<java.lang.String>`	`collections()`
`java.lang.String`	`comment()` The comment for the torrent.
`TorrentBuilder`	`comment(java.lang.String value)` Sets the comment for the torrent.
`java.lang.String`	`creator()` The creator of the torrent.
`TorrentBuilder`	`creator(java.lang.String value)` Sets the creator of the torrent.
`create_flags_t`	`flags()`
`TorrentBuilder`	`flags(create_flags_t value)` Specifies options for the torrent creation.
`TorrentBuilder.Result`	`generate()` This function will generate a result withe the .torrent file as a bencode tree.
`java.util.List<java.lang.String>`	`httpSeeds()`
`boolean`	`isPrivate()`
`TorrentBuilder.Listener`	`listener()`
`TorrentBuilder`	`listener(TorrentBuilder.Listener value)`
`java.util.List<Pair<java.lang.String,java.lang.Integer>>`	`nodes()`
`int`	`padFileLimit()`
`TorrentBuilder`	`padFileLimit(int value)` If a ``pad_size_limit`` is specified (other than -1), any file larger than the specified number of bytes will be preceded by a pad file to align it with the start of a piece.
`java.io.File`	`path()`
`TorrentBuilder`	`path(java.io.File value)` Adds the file specified by `value`
`int`	`pieceSize()`
`TorrentBuilder`	`pieceSize(int value)` The size of each piece in bytes.
`TorrentBuilder`	`setPrivate(boolean value)` Sets the private flag of the torrent.
`java.util.List<Sha1Hash>`	`similarTorrents()`
`java.util.List<Pair<java.lang.String,java.lang.Integer>>`	`trackers()`
`java.util.List<java.lang.String>`	`urlSeeds()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - OPTIMIZE_ALIGNMENT
```
public static final create_flags_t OPTIMIZE_ALIGNMENT
```
    This will insert pad files to align the files to piece boundaries, for optimized disk-I/O. This will minimize the number of bytes of pad- files, to keep the impact down for clients that don't support them.
  - MERKLE
```
public static final create_flags_t MERKLE
```
    This will create a merkle hash tree torrent. A merkle torrent cannot be opened in clients that don't specifically support merkle torrents. The benefit is that the resulting torrent file will be much smaller and not grow with more pieces. When this option is specified, it is recommended to have a fairly small piece size, say 64 kiB. When creating merkle torrents, the full hash tree is also generated and should be saved off separately.
  - MODIFICATION_TIME
```
public static final create_flags_t MODIFICATION_TIME
```
    This will include the file modification time as part of the torrent. This is not enabled by default, as it might cause problems when you create a torrent from separate files with the same content, hoping to yield the same info-hash. If the files have different modification times, with this option enabled, you would get different info-hashes for the files.
  - SYMLINKS
```
public static final create_flags_t SYMLINKS
```
    If this flag is set, files that are symlinks get a symlink attribute set on them and their data will not be included in the torrent. This is useful if you need to reconstruct a file hierarchy which contains symlinks.
  - MUTABLE_TORRENT_SUPPORT
```
public static final create_flags_t MUTABLE_TORRENT_SUPPORT
```
    To create a torrent that can be updated via a *mutable torrent* (see BEP38_). This also needs to be enabled for torrents that update another torrent.
    BEP38: http://www.bittorrent.org/beps/bep_0038.html
- Constructor Detail
  - TorrentBuilder
```
public TorrentBuilder()
```
- Method Detail
  - path
```
public java.io.File path()
```
    Returns:
  - path
```
public TorrentBuilder path(java.io.File value)
```
    Adds the file specified by value
    
    Parameters:
    
    value -
    
    Returns:
  - pieceSize
```
public int pieceSize()
```
    Returns:
  - pieceSize
```
public TorrentBuilder pieceSize(int value)
```
    The size of each piece in bytes. It must be a multiple of 16 kiB. If a piece size of 0 is specified, a pieceSize will be calculated such that the torrent file is roughly 40 kB.
    
    Parameters:
    
    value -
    
    Returns:
  - padFileLimit
```
public int padFileLimit()
```
    Returns:
  - padFileLimit
```
public TorrentBuilder padFileLimit(int value)
```
    If a ``pad_size_limit`` is specified (other than -1), any file larger than the specified number of bytes will be preceded by a pad file to align it with the start of a piece. The pad_file_limit is ignored unless the OPTIMIZE_ALIGNMENT flag is passed. Typically it doesn't make sense to set this any lower than 4kiB.
    
    Parameters:
    
    value -
    
    Returns:
  - flags
```
public create_flags_t flags()
```
    Returns:
  - flags
```
public TorrentBuilder flags(create_flags_t value)
```
    Specifies options for the torrent creation. It can be any combination of the flags defined by create_flags_t
    
    Parameters:
    
    value -
    
    Returns:
  - alignment
```
public int alignment()
```
    Returns:
  - alignment
```
public TorrentBuilder alignment(int value)
```
    Used when pad files are enabled. This is the size eligible files are aligned to. The default is -1, which means the piece size of the torrent.
    
    Parameters:
    
    value -
    
    Returns:
  - comment
```
public java.lang.String comment()
```
    The comment for the torrent. The comment in a torrent file is optional.
    
    Returns:
  - comment
```
public TorrentBuilder comment(java.lang.String value)
```
    Sets the comment for the torrent. The comment in a torrent file is optional.
    
    Parameters:
    
    value -
    
    Returns:
  - creator
```
public java.lang.String creator()
```
    The creator of the torrent. This is optional.
    
    Returns:
  - creator
```
public TorrentBuilder creator(java.lang.String value)
```
    Sets the creator of the torrent. This is optional.
    
    Parameters:
    
    value -
    
    Returns:
  - urlSeeds
```
public java.util.List<java.lang.String> urlSeeds()
```
    Returns:
  - addUrlSeeds
```
public TorrentBuilder addUrlSeeds(java.util.List<java.lang.String> value)
```
    Parameters:
    
    value -
    
    Returns:
  - addUrlSeed
```
public TorrentBuilder addUrlSeed(java.lang.String value)
```
    This adds a url seed to the torrent. You can have any number of url seeds. For a single file torrent, this should be an HTTP url, pointing to a file with identical content as the file of the torrent. For a multi-file torrent, it should point to a directory containing a directory with the same name as this torrent, and all the files of the torrent in it.
    
    Parameters:
    
    value -
    
    Returns:
  - httpSeeds
```
public java.util.List<java.lang.String> httpSeeds()
```
    Returns:
  - addHttpSeeds
```
public TorrentBuilder addHttpSeeds(java.util.List<java.lang.String> value)
```
    Parameters:
    
    value -
    
    Returns:
  - addHttpSeed
```
public TorrentBuilder addHttpSeed(java.lang.String value)
```
    This adds a HTTP seed to the torrent. You can have any number of url seeds. For a single file torrent, this should be an HTTP url, pointing to a file with identical content as the file of the torrent. For a multi-file torrent, it should point to a directory containing a directory with the same name as this torrent, and all the files of the torrent in it.
    
    Parameters:
    
    value -
    
    Returns:
  - nodes
```
public java.util.List<Pair<java.lang.String,java.lang.Integer>> nodes()
```
    Returns:
  - addNodes
```
public TorrentBuilder addNodes(java.util.List<Pair<java.lang.String,java.lang.Integer>> value)
```
    Parameters:
    
    value -
    
    Returns:
  - addNode
```
public TorrentBuilder addNode(Pair<java.lang.String,java.lang.Integer> value)
```
    This adds a DHT node to the torrent. This especially useful if you're creating a tracker less torrent. It can be used by clients to bootstrap their DHT node from. The node is a hostname and a port number where there is a DHT node running. You can have any number of DHT nodes in a torrent.
    
    Parameters:
    
    value -
    
    Returns:
  - trackers
```
public java.util.List<Pair<java.lang.String,java.lang.Integer>> trackers()
```
    Returns:
  - addTrackers
```
public TorrentBuilder addTrackers(java.util.List<Pair<java.lang.String,java.lang.Integer>> value)
```
    Parameters:
    
    value -
    
    Returns:
  - addTracker
```
public TorrentBuilder addTracker(Pair<java.lang.String,java.lang.Integer> value)
```
    Parameters:
    
    value -
    
    Returns:
  - addTracker
```
public TorrentBuilder addTracker(java.lang.String url,
                                 int tier)
```
    Adds a tracker to the torrent. This is not strictly required, but most torrents use a tracker as their main source of peers. The url should be an http:// or udp:// url to a machine running a bittorrent tracker that accepts announces for this torrent's info-hash. The tier is the fallback priority of the tracker. All trackers with tier 0 are tried first (in any order). If all fail, trackers with tier 1 are tried. If all of those fail, trackers with tier 2 are tried, and so on.
    
    Parameters:
    
    url -
    
    tier -
    
    Returns:
  - addTracker
```
public TorrentBuilder addTracker(java.lang.String url)
```
    Parameters:
    
    url -
    
    Returns:
  - isPrivate
```
public boolean isPrivate()
```
    Returns:
  - setPrivate
```
public TorrentBuilder setPrivate(boolean value)
```
    Sets the private flag of the torrent.
    Torrents with the private flag set ask clients to not use any other sources than the tracker for peers, and to not advertise itself publicly, apart from the tracker.
    
    Parameters:
    
    value -
    
    Returns:
  - similarTorrents
```
public java.util.List<Sha1Hash> similarTorrents()
```
    Returns:
  - addSimilarTorrents
```
public TorrentBuilder addSimilarTorrents(java.util.List<Sha1Hash> value)
```
    Parameters:
    
    value -
    
    Returns:
  - addSimilarTorrent
```
public TorrentBuilder addSimilarTorrent(Sha1Hash value)
```
    Add similar torrents (by info-hash).
    Similar torrents are expected to share some files with this torrent. Torrents sharing a collection name with this torrent are also expected to share files with this torrent. A torrent may have more than one collection and more than one similar torrents. For more information, see BEP 38.
    BEP 38: http://www.bittorrent.org/beps/bep_0038.html
    
    Parameters:
    
    value -
    
    Returns:
  - collections
```
public java.util.List<java.lang.String> collections()
```
    Returns:
  - addCollections
```
public TorrentBuilder addCollections(java.util.List<java.lang.String> value)
```
    Parameters:
    
    value -
    
    Returns:
  - addCollection
```
public TorrentBuilder addCollection(java.lang.String value)
```
    Add collections of similar torrents.
    Similar torrents are expected to share some files with this torrent. Torrents sharing a collection name with this torrent are also expected to share files with this torrent. A torrent may have more than one collection and more than one similar torrents. For more information, see BEP 38.
    BEP 38: http://www.bittorrent.org/beps/bep_0038.html
    
    Parameters:
    
    value -
    
    Returns:
  - listener
```
public TorrentBuilder.Listener listener()
```
    Returns:
  - listener
```
public TorrentBuilder listener(TorrentBuilder.Listener value)
```
    Parameters:
    
    value -
    
    Returns:
  - generate
```
public TorrentBuilder.Result generate()
                               throws java.io.IOException
```
    This function will generate a result withe the .torrent file as a bencode tree.
    
    Returns:
    
    Throws:
    
    java.io.IOException

Class TorrentBuilder

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

OPTIMIZE_ALIGNMENT

MERKLE

MODIFICATION_TIME

SYMLINKS

MUTABLE_TORRENT_SUPPORT

Constructor Detail

TorrentBuilder

Method Detail

path

path

pieceSize

pieceSize

padFileLimit

padFileLimit

flags

flags

alignment

alignment

comment

comment

creator

creator

urlSeeds

addUrlSeeds

addUrlSeed

httpSeeds

addHttpSeeds

addHttpSeed

nodes

addNodes

addNode

trackers

addTrackers

addTracker

addTracker

addTracker

isPrivate

setPrivate

similarTorrents

addSimilarTorrents

addSimilarTorrent

collections

addCollections

addCollection

listener

listener

generate