Package org.johnnei.javatorrent.phases

Class PhaseRegulator

java.lang.Object

org.johnnei.javatorrent.phases.PhaseRegulator

public class PhaseRegulator
extends Object

The system which is being used to configure the transitions between IDownloadPhases.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PhaseRegulator.Builder	A builder-pattern styled class to created the PhaseRegulator configuration.

Method Summary

Modifier and Type	Method	Description
IDownloadPhase	createInitialPhase(TorrentClient torrentClient, Torrent torrent)	Creates an instance of the initial IDownloadPhase for the given Torrent.
Optional<IDownloadPhase>	createNextPhase(IDownloadPhase phase, TorrentClient torrentClient, Torrent torrent)	Creates an instance of the next IDownloadPhase for the given Torrent.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

createInitialPhase

public IDownloadPhase createInitialPhase(TorrentClient torrentClient,
                                         Torrent torrent)

Creates an instance of the initial IDownloadPhase for the given Torrent.

Parameters:

torrentClient - The client on which the torrent is registered

torrent - The torrent for which the phase is created.

Returns:

The newly created IDownloadPhase instance.

createNextPhase

public Optional<IDownloadPhase> createNextPhase(IDownloadPhase phase,
                                                TorrentClient torrentClient,
                                                Torrent torrent)

Creates an instance of the next IDownloadPhase for the given Torrent.

Parameters:

phase - The phase which has been completed.

torrentClient - The client on which the torrent is registered

torrent - The torrent for which the phase is created.

Returns:

The newly created IDownloadPhase instance.

toString

public String toString()

Overrides:

toString in class Object