com.tplan.robot.scripting

Class AbstractConfigurationException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.tplan.robot.scripting.SyntaxErrorException

com.tplan.robot.scripting.AbstractConfigurationException

All Implemented Interfaces:

ConfigurationIssue, Serializable, Runnable

Direct Known Subclasses:

MisconfigurationException

public abstract class AbstractConfigurationException
extends SyntaxErrorException
implements ConfigurationIssue, Runnable

Abstract exception to be thrown when automation fails for a missing component or a misconfigured feature.

Since:

7.0

See Also:

Serialized Form

T-Plan Robot Enterprise, (C) 2009-2022 T-Plan Limited. All rights reserved.

Constructor Summary

Constructors

Constructor and Description
AbstractConfigurationException(String exceptionMessage, String popupMessage, String okButton, Icon okIcon) Constructor.

Method Summary

Modifier and Type	Method and Description
int	getPriority() Get the priority between 0 (lowest) and 100 (highest).
boolean	handle() Called on GUI shut down.
abstract void	ok() Method do be called when user selects the OK button.
void	run()
void	setOwner(TestScriptInterpret t) Set the test script that produced this throwable.

Methods inherited from class com.tplan.robot.scripting.SyntaxErrorException

addStackItems, getElement, getErrorDescriptions, getErrorLocations, getLineIndex, getScriptFile, getStack, setElement, setLineIndex, setScriptFile

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AbstractConfigurationException

public AbstractConfigurationException(String exceptionMessage,
                                      String popupMessage,
                                      String okButton,
                                      Icon okIcon)

Constructor.

Parameters:

exceptionMessage - the exception message.

popupMessage - the message to be displayed to the user (may be HTML).

okButton - text of the OK button.

okIcon - icon for the OK button.

Method Detail

handle

public boolean handle()

Description copied from interface: ConfigurationIssue

Called on GUI shut down. Implementations are suggested to display a pop up with some explanation. The method may also throw an exception to indicate that all other recorded throwables should be discarded and not processed.

Specified by:

handle in interface ConfigurationIssue

Returns:

true if the GUI shut down should be interrupted.

setOwner

public void setOwner(TestScriptInterpret t)

Description copied from interface: ConfigurationIssue

Set the test script that produced this throwable.

Specified by:

setOwner in interface ConfigurationIssue

Parameters:

t - the owning test script.

getPriority

public int getPriority()

Description copied from interface: ConfigurationIssue

Get the priority between 0 (lowest) and 100 (highest). If there are multiple throwables recorded during the automation the priority will set the processing order.

Specified by:

getPriority in interface ConfigurationIssue

Returns:

the priority between 0 and 100.

run

public void run()

Specified by:

run in interface Runnable

ok

public abstract void ok()

Method do be called when user selects the OK button.