de.lmu.ifi.dbs.jfeaturelib

Class Progress

java.lang.Object

de.lmu.ifi.dbs.jfeaturelib.Progress

public class Progress
extends Object

The Progress class can be used in situations where an algorithm should fire updates about its progress. Valid progress values are in the range of [0,100]. Subsequent events should have increasing progress values.

Author:

graf

Field Summary

Fields

Modifier and Type	Field and Description
static Progress	END
static Progress	START

Constructor Summary

Constructors

Constructor and Description
Progress(int progress) Initialize the progress with an empty default message.
Progress(int progress, String message) Initialize the progress including a progress message.

Method Summary

Methods

Modifier and Type	Method and Description
String	getMessage()
static String	getName()
int	getProgress()

Methods inherited from class java.lang.Object

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

Field Detail

START

public static final Progress START

END

public static final Progress END

Constructor Detail

Progress

public Progress(int progress)

Initialize the progress with an empty default message.

Parameters:

progress - in [0,100]

Throws:

IllegalArgumentException - if progress is out of bounds

Progress

public Progress(int progress,
        String message)

Initialize the progress including a progress message.

Parameters:

progress - in [0,100]

message - the progress message.

Throws:

IllegalArgumentException - if progress is out of bounds

Method Detail

getProgress

public int getProgress()

Returns:

progress value in [0, 100]

getMessage

public String getMessage()

Returns:

progress message (never null)

getName

public static String getName()

Returns:

classname of the progress class for use in PropertyChangeEvents