bt.magnet

Class MagnetUri

java.lang.Object

bt.magnet.MagnetUri

public class MagnetUri
extends Object

Programmatic API for working with BEP-9 v1 magnet links.

Since:

1.3

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MagnetUri.Builder

Method Summary

Modifier and Type	Method and Description
Optional<String>	getDisplayName() Represents the "dn" parameter.
Collection<InetPeerAddress>	getPeerAddresses() Represents the collection of values of "x.pe" parameters.
TorrentId	getTorrentId() Represents the "xt" parameter.
Collection<String>	getTrackerUrls() Represents the collection of values of "tr" parameters.
static MagnetUri.Builder	torrentId(TorrentId torrentId) Start building a magnet link for a given torrent.

Methods inherited from class java.lang.Object

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

Method Detail

torrentId

public static MagnetUri.Builder torrentId(TorrentId torrentId)

Start building a magnet link for a given torrent.

Since:

1.3

getTorrentId

public TorrentId getTorrentId()

Represents the "xt" parameter. E.g. xt=urn:btih:af0d9aa01a9ae123a73802cfa58ccaf355eb19f1

Returns:

Torrent ID

Since:

1.3

getDisplayName

public Optional<String> getDisplayName()

Represents the "dn" parameter. Value is URL decoded. E.g. dn=Some%20Display%20Name => "Some Display Name"

Returns:

Suggested display name for the torrent

Since:

1.3

getTrackerUrls

public Collection<String> getTrackerUrls()

Represents the collection of values of "tr" parameters. Values are URL decoded. E.g. tr=http%3A%2F%2Fmytracker.com%3A6363&tr=udp%3A%2F%2Fothertrack.org%3A7777 => ["http://mytracker.com:6363", "udp://othertrack.org:7777"]

Returns:

Collection of tracker URLs

Since:

1.3

getPeerAddresses

public Collection<InetPeerAddress> getPeerAddresses()

Represents the collection of values of "x.pe" parameters. Values are URL decoded. E.g. x.pe=124.131.72.242%3A6891&x.pe=11.9.132.61%3A6900 => [124.131.72.242:6891, 11.9.132.61:6900]

Returns:

Collection of well-known peer addresses

Since:

1.3