Package com.inductiveautomation.ignition.client.launch

Interface LaunchStep

All Known Implementing Classes:

AbstractLaunchStep, BaseStep, CacheStep, CheckManifestStep, ConnectStep, DownloadJarsStep, DownloadPyLibStep, DownloadRuntimeStep, DownloadTranslationsStep, StartupStep, TestStep

public interface LaunchStep

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	LaunchStep.StepState

Method Summary

Modifier and Type	Method	Description
void	addPropertyChangeListener(java.beans.PropertyChangeListener listener)
void	addPropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)
java.lang.String	getDescription()	Describe this step's purpose
java.lang.String	getMessage()	When active, this message describes what the step is currently doing
int	getProgress()	The current progress (when running), from 0 to 100
LaunchStep.StepState	getState()	The current state of this step
boolean	isIndeterminate()	If this step can currently not calculate its progress, it is considered indeterminate
void	log(java.lang.String message, java.lang.Object... args)
void	removePropertyChangeListener(java.beans.PropertyChangeListener listener)
void	removePropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)
void	run()
void	setIndeterminate(boolean indeterminate)
void	setMessage(java.lang.String message)
void	setMessagef(java.lang.String bundleKey, java.lang.Object... formatArgs)
void	setProgress(int progress)
void	setState(LaunchStep.StepState state)	Sets the state of the step

Method Detail

addPropertyChangeListener

void addPropertyChangeListener(java.lang.String propertyName,
                               java.beans.PropertyChangeListener listener)

addPropertyChangeListener

void addPropertyChangeListener(java.beans.PropertyChangeListener listener)

removePropertyChangeListener

void removePropertyChangeListener(java.beans.PropertyChangeListener listener)

removePropertyChangeListener

void removePropertyChangeListener(java.lang.String propertyName,
                                  java.beans.PropertyChangeListener listener)

getDescription

java.lang.String getDescription()

Describe this step's purpose

getMessage

java.lang.String getMessage()

When active, this message describes what the step is currently doing

isIndeterminate

boolean isIndeterminate()

If this step can currently not calculate its progress, it is considered indeterminate

getProgress

int getProgress()

The current progress (when running), from 0 to 100

setIndeterminate

void setIndeterminate(boolean indeterminate)

setProgress

void setProgress(int progress)

setMessage

void setMessage(java.lang.String message)

setMessagef

void setMessagef(java.lang.String bundleKey,
                 java.lang.Object... formatArgs)

log

void log(java.lang.String message,
         java.lang.Object... args)

getState

LaunchStep.StepState getState()

The current state of this step

setState

void setState(LaunchStep.StepState state)

Sets the state of the step

run

void run()
  throws java.lang.Exception

Throws:

java.lang.Exception