com.izforge.izpack.event

Class AbstractProgressInstallerListener

java.lang.Object

com.izforge.izpack.api.event.AbstractInstallerListener

com.izforge.izpack.event.AbstractProgressInstallerListener

All Implemented Interfaces:

InstallationListener, InstallerListener

Direct Known Subclasses:

AntActionInstallerListener, BSFInstallerListener, ChmodInstallerListener, ConfigurationInstallerListener, ProgressBarInstallerListener, RegistryInstallerListener, SummaryLoggerInstallerListener

public abstract class AbstractProgressInstallerListener
extends AbstractInstallerListener

An InstallerListener that may notify ProgressListeners.

Author:

Tim Anderson

Constructor Summary

Constructors

Constructor and Description
AbstractProgressInstallerListener(InstallData installData) Constructs an AbstractProgressInstallerListener.
AbstractProgressInstallerListener(InstallData installData, ProgressNotifiers notifiers) Constructs an AbstractProgressInstallerListener.

Method Summary

Modifier and Type	Method and Description
protected InstallData	getInstallData() Returns the installation data.
protected String	getMessage(String id) Helper to return a localised message, given its identifier.
protected int	getProgressNotifierId() Returns the progress notifier id of this listener.
protected ProgressNotifiers	getProgressNotifiers() Returns the progress notifiers.
protected boolean	notifyProgress() Determines if listeners should notify a ProgressListener.
protected void	setProgressNotifier() Register this listener as a progress notifier.

Methods inherited from class com.izforge.izpack.api.event.AbstractInstallerListener

afterDir, afterFile, afterPack, afterPacks, beforeDir, beforeFile, beforePack, beforePacks, beforePacks, initialise, isFileListener

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractProgressInstallerListener

public AbstractProgressInstallerListener(InstallData installData)

Constructs an AbstractProgressInstallerListener.

Parameters:

installData - the installation data

AbstractProgressInstallerListener

public AbstractProgressInstallerListener(InstallData installData,
                                         ProgressNotifiers notifiers)

Constructs an AbstractProgressInstallerListener.

Parameters:

installData - the installation data

notifiers - the progress notifiers. May be null

Method Detail

notifyProgress

protected boolean notifyProgress()

Determines if listeners should notify a ProgressListener.

Returns:

true if the ProgressListener should be notified

getProgressNotifierId

protected int getProgressNotifierId()

Returns the progress notifier id of this listener.

Returns:

the progress notifier id of this listener, or 0 if this is not registered

setProgressNotifier

protected void setProgressNotifier()

Register this listener as a progress notifier.

getProgressNotifiers

protected ProgressNotifiers getProgressNotifiers()

Returns the progress notifiers.

Returns:

the progress notifiers, or null if none was supplied at construction

getInstallData

protected InstallData getInstallData()

Returns the installation data.

Returns:

the installation data

getMessage

protected String getMessage(String id)

Helper to return a localised message, given its identifier.

Parameters:

id - the message identifier

Returns:

the corresponding message, or id if it doesn't exist