com.tplan.robot.scripting

Class SyntaxErrorException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.tplan.robot.scripting.SyntaxErrorException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AbstractConfigurationException

public class SyntaxErrorException
extends Exception

Exception thrown during test script validation indicating that the script contains a syntax error.

See Also:

Serialized Form

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

Constructor Summary

Constructors

Constructor and Description
SyntaxErrorException() Constructs a new exception with null as its detail message.
SyntaxErrorException(String message) Constructs a new exception with null as its detail message.
SyntaxErrorException(String message, int[] errorLocations, List errorDescriptions) Constructs a new exception with the specified detail message.The cause is not initialized, and may subsequently be initialized by a call to Throwable.initCause(java.lang.Throwable).
SyntaxErrorException(String message, Throwable cause) Constructs a new exception with null as its detail message.

Method Summary

Modifier and Type	Method and Description
void	addStackItems(Collection<ScriptLocation> loc) Populate the stack.
Element	getElement()
List	getErrorDescriptions()
int[]	getErrorLocations()
int	getLineIndex()
File	getScriptFile()
List<ScriptLocation>	getStack() Get the stack which locates the place of the error including the procedure calls (levels).
void	setElement(Element element)
void	setLineIndex(int lineIndex)
void	setScriptFile(File scriptFile)

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

SyntaxErrorException

public SyntaxErrorException()

Constructs a new exception with null as its detail message. The cause is not initialized, and may subsequently be initialized by a call to Throwable.initCause(java.lang.Throwable).

SyntaxErrorException

public SyntaxErrorException(String message)

Constructs a new exception with null as its detail message. The cause is not initialized, and may subsequently be initialized by a call to Throwable.initCause(java.lang.Throwable).

Parameters:

message - the detail message. The detail message is saved for later retrieval by the Throwable.getMessage() method.

SyntaxErrorException

public SyntaxErrorException(String message,
                            Throwable cause)

Constructs a new exception with null as its detail message. The cause is not initialized, and may subsequently be initialized by a call to Throwable.initCause(java.lang.Throwable).

Parameters:

message - the detail message. The detail message is saved for later retrieval by the Throwable.getMessage() method.

cause - throwable causing this exception to be thrown.

SyntaxErrorException

public SyntaxErrorException(String message,
                            int[] errorLocations,
                            List errorDescriptions)

Constructs a new exception with the specified detail message.The cause is not initialized, and may subsequently be initialized by a call to Throwable.initCause(java.lang.Throwable).

Parameters:

message - the detail message. The detail message is saved for later retrieval by the Throwable.getMessage() method.

errorLocations - error locations (indices).

errorDescriptions - the list of error descriptions.

Method Detail

getErrorLocations

public int[] getErrorLocations()

getErrorDescriptions

public List getErrorDescriptions()

getElement

public Element getElement()

setElement

public void setElement(Element element)

getScriptFile

public File getScriptFile()

setScriptFile

public void setScriptFile(File scriptFile)

getLineIndex

public int getLineIndex()

setLineIndex

public void setLineIndex(int lineIndex)

getStack

public List<ScriptLocation> getStack()

Get the stack which locates the place of the error including the procedure calls (levels).

Returns:

the stack containing the script locations.

Since:

3.4.2

addStackItems

public void addStackItems(Collection<ScriptLocation> loc)

Populate the stack.

Parameters:

loc - a collection of stack items (script locations).

Since:

3.4.2