org.openpnp.spi.base

Class AbstractJobProcessor

java.lang.Object

org.openpnp.spi.base.AbstractJobProcessor

All Implemented Interfaces:

JobProcessor, PropertySheetHolder, WizardConfigurable

Direct Known Subclasses:

AbstractPnpJobProcessor

public abstract class AbstractJobProcessor
extends java.lang.Object
implements JobProcessor

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AbstractJobProcessor.Retryable
static class	AbstractJobProcessor.State

Nested classes/interfaces inherited from interface org.openpnp.spi.JobProcessor

JobProcessor.JobProcessorException, JobProcessor.TextStatusListener

Nested classes/interfaces inherited from interface org.openpnp.spi.PropertySheetHolder

PropertySheetHolder.PropertySheet

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<JobProcessor.TextStatusListener>	textStatusListeners

Constructor Summary

Constructors

Constructor and Description
AbstractJobProcessor()

Method Summary

Modifier and Type	Method and Description
void	addTextStatusListener(JobProcessor.TextStatusListener listener)
protected void	fireJobState(java.util.List<Signaler> signalers, AbstractJobProcessor.State state)
protected void	fireTextStatus(java.lang.String format, java.lang.Object... params)
PropertySheetHolder[]	getChildPropertySheetHolders()
Wizard	getConfigurationWizard() Gets a Wizard that can be used to configure this object.
javax.swing.Action[]	getPropertySheetHolderActions()
javax.swing.Icon	getPropertySheetHolderIcon()
java.lang.String	getPropertySheetHolderTitle()
PropertySheetHolder.PropertySheet[]	getPropertySheets()
void	removeTextStatusListener(JobProcessor.TextStatusListener listener)
static void	retry(int maxTries, AbstractJobProcessor.Retryable r) Call the Retryable's action method until it either does not throw an Exception or it is called maxTries number of times.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openpnp.spi.JobProcessor

abort, initialize, isSteppingToNextMotion, next

Field Detail

textStatusListeners

protected java.util.List<JobProcessor.TextStatusListener> textStatusListeners

Constructor Detail

AbstractJobProcessor

public AbstractJobProcessor()

Method Detail

getPropertySheetHolderTitle

public java.lang.String getPropertySheetHolderTitle()

Specified by:

getPropertySheetHolderTitle in interface PropertySheetHolder

getChildPropertySheetHolders

public PropertySheetHolder[] getChildPropertySheetHolders()

Specified by:

getChildPropertySheetHolders in interface PropertySheetHolder

getPropertySheetHolderActions

public javax.swing.Action[] getPropertySheetHolderActions()

Specified by:

getPropertySheetHolderActions in interface PropertySheetHolder

getPropertySheets

public PropertySheetHolder.PropertySheet[] getPropertySheets()

Specified by:

getPropertySheets in interface PropertySheetHolder

getPropertySheetHolderIcon

public javax.swing.Icon getPropertySheetHolderIcon()

Specified by:

getPropertySheetHolderIcon in interface PropertySheetHolder

getConfigurationWizard

public Wizard getConfigurationWizard()

Description copied from interface: WizardConfigurable

Gets a Wizard that can be used to configure this object.

Specified by:

getConfigurationWizard in interface WizardConfigurable

Returns:

addTextStatusListener

public void addTextStatusListener(JobProcessor.TextStatusListener listener)

Specified by:

addTextStatusListener in interface JobProcessor

removeTextStatusListener

public void removeTextStatusListener(JobProcessor.TextStatusListener listener)

Specified by:

removeTextStatusListener in interface JobProcessor

fireTextStatus

protected void fireTextStatus(java.lang.String format,
                              java.lang.Object... params)

fireJobState

protected void fireJobState(java.util.List<Signaler> signalers,
                            AbstractJobProcessor.State state)

retry

public static void retry(int maxTries,
                         AbstractJobProcessor.Retryable r)
                  throws java.lang.Exception

Call the Retryable's action method until it either does not throw an Exception or it is called maxTries number of times. If the method throws an Exception each time then this method will throw the final Exception.

Parameters:

maxTries -

r -

Throws:

java.lang.Exception