Package org.opends.quicksetup

Class ProgressDescriptor

java.lang.Object

org.opends.quicksetup.ProgressDescriptor

public class ProgressDescriptor
extends Object

This class is used to describe the current state of the installation. It contains the step in which the installation is, the current progress ratio, the progress bar message and the details message (the logs). This class is used directly by the ProgressPanel to update its content and has been designed to match the layout of that panel. However as it does not contain any dependency in terms of code with any Swing or UI package component it has been decided to leave it on the installer package. In general the progress bar message and the details messages (log) are in HTML form (but this class is independent of the format we use for the messages).

Constructor Summary

Constructors

Constructor	Description
ProgressDescriptor(ProgressStep step, Integer progressBarRatio, org.forgerock.i18n.LocalizableMessage progressBarMsg, org.forgerock.i18n.LocalizableMessage detailsMsg)	Constructor for the ProgressDescriptor.

Method Summary

Modifier and Type	Method	Description
org.forgerock.i18n.LocalizableMessage	getDetailsMsg()	Returns the details message (the log message) of the install.
org.forgerock.i18n.LocalizableMessage	getProgressBarMsg()	Returns the progress bar message.
Integer	getProgressBarRatio()	Returns the progress bar ratio (the percentage of the install that is completed).
ProgressStep	getProgressStep()	Returns the step of the install on which we are.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProgressDescriptor

public ProgressDescriptor(ProgressStep step,
                          Integer progressBarRatio,
                          org.forgerock.i18n.LocalizableMessage progressBarMsg,
                          org.forgerock.i18n.LocalizableMessage detailsMsg)

Constructor for the ProgressDescriptor.

Parameters:

step - the current install step.

progressBarRatio - the completed progress ratio (in percentage).

progressBarMsg - the message to be displayed in the progress bar.

detailsMsg - the logs.

Method Detail

getDetailsMsg

public org.forgerock.i18n.LocalizableMessage getDetailsMsg()

Returns the details message (the log message) of the install.

Returns:

the details message (the log message) of the install.

getProgressBarMsg

public org.forgerock.i18n.LocalizableMessage getProgressBarMsg()

Returns the progress bar message.

Returns:

the progress bar message.

getProgressBarRatio

public Integer getProgressBarRatio()

Returns the progress bar ratio (the percentage of the install that is completed).

Returns:

the progress bar ratio (the percentage of the install that is completed).

getProgressStep

public ProgressStep getProgressStep()

Returns the step of the install on which we are.

Returns:

the step of the install on which we are.