/*
* CDDL HEADER START
*
* The contents of this file are subject to the terms of the
* Common Development and Distribution License, Version 1.0 only
* (the "License"). You may not use this file except in compliance
* with the License.
*
* You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
* or http://forgerock.org/license/CDDLv1.0.html.
* See the License for the specific language governing permissions
* and limitations under the License.
*
* When distributing Covered Code, include this CDDL HEADER in each
* file and include the License file at legal-notices/CDDLv1_0.txt.
* If applicable, add the following below this CDDL HEADER, with the
* fields enclosed by brackets "[]" replaced with your own identifying
* information:
* Portions Copyright [yyyy] [name of copyright owner]
*
* CDDL HEADER END
*
*
* Copyright 2006-2008 Sun Microsystems, Inc.
* Portions Copyright 2014 ForgeRock AS
*/
package org.opends.quicksetup;
import org.forgerock.i18n.LocalizableMessage;
/**
* 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).
*
*/
public class ProgressDescriptor {
private ProgressStep step;
private Integer progressBarRatio;
private LocalizableMessage progressBarMsg;
private LocalizableMessage detailsMsg;
/**
* Constructor for the ProgressDescriptor.
* @param step the current install step.
* @param progressBarRatio the completed progress ratio (in percentage).
* @param progressBarMsg the message to be displayed in the progress bar.
* @param detailsMsg the logs.
*/
public ProgressDescriptor(ProgressStep step,
Integer progressBarRatio, LocalizableMessage progressBarMsg, LocalizableMessage detailsMsg)
{
this.step = step;
this.progressBarRatio = progressBarRatio;
this.progressBarMsg = progressBarMsg;
this.detailsMsg = detailsMsg;
}
/**
* Returns the details message (the log message) of the install.
* @return the details message (the log message) of the install.
*/
public LocalizableMessage getDetailsMsg()
{
return detailsMsg;
}
/**
* Returns the progress bar message.
* @return the progress bar message.
*/
public LocalizableMessage getProgressBarMsg()
{
return progressBarMsg;
}
/**
* Returns the progress bar ratio (the percentage of the install that is
* completed).
* @return the progress bar ratio (the percentage of the install that is
* completed).
*/
public Integer getProgressBarRatio()
{
return progressBarRatio;
}
/**
* Returns the step of the install on which we are.
* @return the step of the install on which we are.
*/
public ProgressStep getProgressStep()
{
return step;
}
}