bt.torrent

Interface TorrentRegistry

All Known Implementing Classes:

AdhocTorrentRegistry

public interface TorrentRegistry

Registry of all torrents known to the current runtime.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
Optional<TorrentDescriptor>	getDescriptor(Torrent torrent) Deprecated. since 1.3 in favor of getDescriptor(TorrentId)
Optional<TorrentDescriptor>	getDescriptor(TorrentId torrentId) Get a torrent descriptor for a given torrent, if exists.
TorrentDescriptor	getOrCreateDescriptor(Torrent torrent, Storage storage) Deprecated. since 1.3 in favor of more clearly named register(Torrent, Storage, FileDownloadCompleteCallback)
Optional<Torrent>	getTorrent(TorrentId torrentId) Get a torrent with a given torrent ID, if exists.
Collection<TorrentId>	getTorrentIds() Get all torrents, that have been registered in the runtime.
Collection<Torrent>	getTorrents() Get all torrents, that have been registered in the runtime.
boolean	isSupportedAndActive(TorrentId torrentId)
TorrentDescriptor	register(TorrentId torrentId) Get an existing torrent descriptor for a given torrent ID or create a new one if it does not exist.
TorrentDescriptor	register(Torrent torrent, Storage storage, FileDownloadCompleteCallback fileCompletionCallback) Get an existing torrent descriptor for a given torrent or create a new one if it does not exist.
void	registerSessionState(TorrentId torrentId, TorrentSessionState state) Register a session state for the specified torrent

Method Detail

getTorrents

Collection<Torrent> getTorrents()

Get all torrents, that have been registered in the runtime.

Returns:

All registered torrents

Since:

1.2

getTorrentIds

Collection<TorrentId> getTorrentIds()

Get all torrents, that have been registered in the runtime.

Returns:

All registered torrents

Since:

1.3

getTorrent

Optional<Torrent> getTorrent(TorrentId torrentId)

Get a torrent with a given torrent ID, if exists.

Returns:

Optional.empty() if this torrent ID is not known to the current runtime.

Since:

1.0

getDescriptor

Optional<TorrentDescriptor> getDescriptor(Torrent torrent)

Deprecated. since 1.3 in favor of getDescriptor(TorrentId)

Get a torrent descriptor for a given torrent, if exists.

Returns:

Optional.empty() if torrent descriptor hasn't been created yet.

Since:

1.0

getDescriptor

Optional<TorrentDescriptor> getDescriptor(TorrentId torrentId)

Get a torrent descriptor for a given torrent, if exists.

Returns:

Optional.empty() if torrent descriptor hasn't been created yet.

Since:

1.3

getOrCreateDescriptor

TorrentDescriptor getOrCreateDescriptor(Torrent torrent,
                                        Storage storage)

Deprecated. since 1.3 in favor of more clearly named register(Torrent, Storage, FileDownloadCompleteCallback)

Get an existing torrent descriptor for a given torrent or create a new one if it does not exist.

Parameters:

storage - Storage to use for storing this torrent's files. Will be used when creating a new torrent descriptor.

Returns:

Torrent descriptor

Since:

1.0

register

TorrentDescriptor register(Torrent torrent,
                           Storage storage,
                           FileDownloadCompleteCallback fileCompletionCallback)

Get an existing torrent descriptor for a given torrent or create a new one if it does not exist.

Parameters:

storage - Storage to use for storing this torrent's files. Will be used when creating a new torrent descriptor.

Returns:

Torrent descriptor

Since:

1.3

registerSessionState

void registerSessionState(TorrentId torrentId,
                          TorrentSessionState state)

Register a session state for the specified torrent

Parameters:

torrentId - the torrent id

state - the session state of the torrent

Since:

1.10

register

TorrentDescriptor register(TorrentId torrentId)

Get an existing torrent descriptor for a given torrent ID or create a new one if it does not exist.

Returns:

Torrent descriptor

Since:

1.3

isSupportedAndActive

boolean isSupportedAndActive(TorrentId torrentId)