Package org.johnnei.javatorrent.phases

Class PhaseRegulator.Builder

java.lang.Object

org.johnnei.javatorrent.phases.PhaseRegulator.Builder

Enclosing class:

PhaseRegulator

public static class PhaseRegulator.Builder
extends Object

A builder-pattern styled class to created the PhaseRegulator configuration.

Constructor Summary

Constructors

Constructor	Description
Builder()	Creates a new PhaseRegulator.Builder instance without any IDownloadPhase configured.

Method Summary

Modifier and Type	Method	Description
PhaseRegulator	build()
<T extends IDownloadPhase> PhaseRegulator.Builder	registerInitialPhase(Class<T> phase, BiFunction<TorrentClient,Torrent,T> phaseSupplier)	Registers the initial IDownloadPhase
<T extends IDownloadPhase> PhaseRegulator.Builder	registerInitialPhase(Class<T> phase, BiFunction<TorrentClient,Torrent,T> phaseSupplier, Class<? extends IDownloadPhase> nextPhase)	Registers the initial IDownloadPhase
<T extends IDownloadPhase> PhaseRegulator.Builder	registerPhase(Class<T> phase, BiFunction<TorrentClient,Torrent,T> phaseSupplier)	Registers a new transition to the given IDownloadPhase
<T extends IDownloadPhase> PhaseRegulator.Builder	registerPhase(Class<T> phase, BiFunction<TorrentClient,Torrent,T> phaseSupplier, Class<? extends IDownloadPhase> nextPhase)	Registers a new transition to the given IDownloadPhase

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Creates a new PhaseRegulator.Builder instance without any IDownloadPhase configured.

Method Detail

registerInitialPhase

public <T extends IDownloadPhase> PhaseRegulator.Builder registerInitialPhase(Class<T> phase,
                                                                              BiFunction<TorrentClient,Torrent,T> phaseSupplier)

Registers the initial IDownloadPhase

Type Parameters:

T - The type of the IDownloadPhase

Parameters:

phase - The initial phase

phaseSupplier - The BiFunction which is capable of creating phase instances.

Returns:

This PhaseRegulator.Builder with updated configuration.

registerInitialPhase

public <T extends IDownloadPhase> PhaseRegulator.Builder registerInitialPhase(Class<T> phase,
                                                                              BiFunction<TorrentClient,Torrent,T> phaseSupplier,
                                                                              Class<? extends IDownloadPhase> nextPhase)

Registers the initial IDownloadPhase

Type Parameters:

T - The type of the IDownloadPhase

Parameters:

phase - The initial phase

phaseSupplier - The BiFunction which is capable of creating phase instances.

nextPhase - The phase to transition to when phase has completed.

Returns:

This PhaseRegulator.Builder with updated configuration.

registerPhase

public <T extends IDownloadPhase> PhaseRegulator.Builder registerPhase(Class<T> phase,
                                                                       BiFunction<TorrentClient,Torrent,T> phaseSupplier)

Registers a new transition to the given IDownloadPhase

Type Parameters:

T - The type of the IDownloadPhase

Parameters:

phase - The phase from which the transition happens.

phaseSupplier - The BiFunction which is capable of creating phase instances.

Returns:

This PhaseRegulator.Builder with updated configuration.

registerPhase

public <T extends IDownloadPhase> PhaseRegulator.Builder registerPhase(Class<T> phase,
                                                                       BiFunction<TorrentClient,Torrent,T> phaseSupplier,
                                                                       Class<? extends IDownloadPhase> nextPhase)

Registers a new transition to the given IDownloadPhase

Type Parameters:

T - The type of the IDownloadPhase

Parameters:

phase - The phase from which the transition happens.

phaseSupplier - The BiFunction which is capable of creating phase instances.

nextPhase - The phase to transition to when phase has completed.

Returns:

This PhaseRegulator.Builder with updated configuration.

build

public PhaseRegulator build()

Returns:

The newly created configured instance of PhaseRegulator