Package org.moeaframework.algorithm.extension

Class ProgressExtension

java.lang.Object

org.moeaframework.algorithm.extension.ProgressExtension

All Implemented Interfaces:

Extension

public class ProgressExtension
extends Object
implements Extension

Extends an algorithm to track and report progress.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ProgressExtension.DefaultProgressListener	Default progress listener that displays information to standard output.
static class	ProgressExtension.ProgressEvent	A progress event, including the percent complete, elapsed time, and estimated remaining time.
static interface	ProgressExtension.ProgressListener	Interface used to listen for progress reports provided by this extension.

Constructor Summary

Constructors

Constructor	Description
ProgressExtension()	Constructs a new extension for tracking progress.

Method Summary

Modifier and Type	Method	Description
void	addListener(ProgressExtension.ProgressListener listener)	Adds the given listener to receive progress reports.
void	onInitialize(Algorithm algorithm)	Called when an algorithm is being initialized.
void	onRun(Algorithm algorithm, TerminationCondition terminationCondition)	Called when starting a new run of the algorithm.
void	onStep(Algorithm algorithm)	Called after each step of the algorithm.
void	onTerminate(Algorithm algorithm)	Called after the termination of an algorithm.
void	removeListener(ProgressExtension.ProgressListener listener)	Removes the given listener so it no longer receives progress reports.
ProgressExtension	withListener(ProgressExtension.ProgressListener listener)	Adds the given listener to receive progress reports.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.moeaframework.algorithm.extension.Extension

onRegister

Constructor Details

ProgressExtension

public ProgressExtension()

Constructs a new extension for tracking progress.

Method Details

onRun

public void onRun(Algorithm algorithm,
 TerminationCondition terminationCondition)

Description copied from interface: Extension

Called when starting a new run of the algorithm. This can be used to check the termination conditions.

Specified by:

onRun in interface Extension

Parameters:

algorithm - the algorithm associated with this extension

terminationCondition - the termination condition used for the run

onStep

public void onStep(Algorithm algorithm)

Description copied from interface: Extension

Called after each step of the algorithm.

Specified by:

onStep in interface Extension

Parameters:

algorithm - the algorithm associated with this extension

onInitialize

public void onInitialize(Algorithm algorithm)

Description copied from interface: Extension

Called when an algorithm is being initialized.

Specified by:

onInitialize in interface Extension

Parameters:

algorithm - the algorithm associated with this extension

onTerminate

public void onTerminate(Algorithm algorithm)

Description copied from interface: Extension

Called after the termination of an algorithm.

Specified by:

onTerminate in interface Extension

Parameters:

algorithm - the algorithm associated with this extension

withListener

public ProgressExtension withListener(ProgressExtension.ProgressListener listener)

Adds the given listener to receive progress reports.

Parameters:

listener - the listener to receive progress reports

Returns:

a reference to this extension

addListener

public void addListener(ProgressExtension.ProgressListener listener)

Adds the given listener to receive progress reports.

Parameters:

listener - the listener to receive progress reports

removeListener

public void removeListener(ProgressExtension.ProgressListener listener)

Removes the given listener so it no longer receives progress reports.

Parameters:

listener - the listener to no longer receive progress reports