com.inductiveautomation.ignition.client.launch.steps

Class AbstractLaunchStep

java.lang.Object

com.inductiveautomation.ignition.client.launch.steps.AbstractLaunchStep

All Implemented Interfaces:

LaunchStep

Direct Known Subclasses:

BaseStep

public abstract class AbstractLaunchStep
extends java.lang.Object
implements LaunchStep

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AbstractLaunchStep.LockedAction<T>

Nested classes/interfaces inherited from interface com.inductiveautomation.ignition.client.launch.LaunchStep

LaunchStep.StepState

Field Summary

Fields

Modifier and Type	Field and Description
protected java.beans.PropertyChangeSupport	changeSupport

Constructor Summary

Constructors

Constructor and Description
AbstractLaunchStep()

Method Summary

Modifier and Type	Method and Description
void	addPropertyChangeListener(java.beans.PropertyChangeListener listener)
void	addPropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)
protected void	firePropertyChange(java.lang.String propertyName, java.lang.Object oldValue, java.lang.Object newValue)
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
protected abstract java.lang.String	getString(java.lang.String resourceKey) Abstraction to accommodate different methods of looking up bundle strings
boolean	isIndeterminate() If this step can currently not calculate its progress, it is considered indeterminate
protected abstract void	log(java.lang.String message, java.lang.Object... args) Abstraction to accommodate different logging methods
protected static java.net.HttpURLConnection	newConnection(java.lang.String url)
protected static java.net.HttpURLConnection	newConnection(java.lang.String url, int readTimeout)
void	removePropertyChangeListener(java.beans.PropertyChangeListener listener)
void	removePropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)
static <T> T	runLockedAction(LaunchContext context, AbstractLaunchStep step, AbstractLaunchStep.LockedAction<T> action) Runs an action only after obtaining the file lock on resources.lck
void	setIndeterminate(boolean indeterminate)
void	setMessage(java.lang.String message) Sets the message to this literal string
protected void	setMessagef(java.lang.String bundleKey, java.lang.Object... formatArgs) Sets the message after passing the key through the bundle, and the result through String.format()
void	setProgress(int progress)
void	setState(LaunchStep.StepState state) Sets the state of the step

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.inductiveautomation.ignition.client.launch.LaunchStep

getDescription, run

Field Detail

changeSupport

protected java.beans.PropertyChangeSupport changeSupport

Constructor Detail

AbstractLaunchStep

public AbstractLaunchStep()

Method Detail

newConnection

protected static java.net.HttpURLConnection newConnection(java.lang.String url)
                                                   throws java.io.IOException,
                                                          java.net.MalformedURLException,
                                                          java.net.ProtocolException

Throws:

java.io.IOException

java.net.MalformedURLException

java.net.ProtocolException

newConnection

protected static java.net.HttpURLConnection newConnection(java.lang.String url,
                                                          int readTimeout)
                                                   throws java.io.IOException,
                                                          java.net.MalformedURLException,
                                                          java.net.ProtocolException

Throws:

java.io.IOException

java.net.MalformedURLException

java.net.ProtocolException

getString

protected abstract java.lang.String getString(java.lang.String resourceKey)

Abstraction to accommodate different methods of looking up bundle strings

log

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

Abstraction to accommodate different logging methods

getMessage

public java.lang.String getMessage()

Description copied from interface: LaunchStep

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

Specified by:

getMessage in interface LaunchStep

getProgress

public int getProgress()

Description copied from interface: LaunchStep

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

Specified by:

getProgress in interface LaunchStep

getState

public LaunchStep.StepState getState()

Description copied from interface: LaunchStep

The current state of this step

Specified by:

getState in interface LaunchStep

isIndeterminate

public boolean isIndeterminate()

Description copied from interface: LaunchStep

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

Specified by:

isIndeterminate in interface LaunchStep

runLockedAction

public static <T> T runLockedAction(LaunchContext context,
                                    AbstractLaunchStep step,
                                    AbstractLaunchStep.LockedAction<T> action)
                             throws java.lang.Exception

Runs an action only after obtaining the file lock on resources.lck

Throws:

java.lang.Exception

setMessagef

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

Sets the message after passing the key through the bundle, and the result through String.format()

setMessage

public void setMessage(java.lang.String message)

Sets the message to this literal string

Specified by:

setMessage in interface LaunchStep

setProgress

public void setProgress(int progress)

Specified by:

setProgress in interface LaunchStep

setState

public void setState(LaunchStep.StepState state)

Description copied from interface: LaunchStep

Sets the state of the step

Specified by:

setState in interface LaunchStep

setIndeterminate

public void setIndeterminate(boolean indeterminate)

Specified by:

setIndeterminate in interface LaunchStep

firePropertyChange

protected void firePropertyChange(java.lang.String propertyName,
                                  java.lang.Object oldValue,
                                  java.lang.Object newValue)

addPropertyChangeListener

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

Specified by:

addPropertyChangeListener in interface LaunchStep

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)

Specified by:

addPropertyChangeListener in interface LaunchStep

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)

Specified by:

removePropertyChangeListener in interface LaunchStep

removePropertyChangeListener

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

Specified by:

removePropertyChangeListener in interface LaunchStep