org.midica.file.read

Class ParseException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.midica.file.read.ParseException

All Implemented Interfaces:

java.io.Serializable

public class ParseException
extends java.lang.Exception

Exceptions of this class can be thrown if an error occurs while parsing a file. It can be used for different file types.

Author:

Jan Trukenmüller

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	causedByBlockCond
private boolean	causedByInvalidVar
private java.io.File	file
private boolean	isLastAdded
private java.lang.String	lineContent
private int	lineNumber
private static long	serialVersionUID
private java.util.Deque<StackTraceElement>	stackTrace

Constructor Summary

Constructors

Constructor and Description
ParseException() Throws a generic parse exception without a detail message.
ParseException(java.lang.String message) Throws an exception including a detail message.

Method Summary

Modifier and Type	Method and Description
private void	addLastElementIfNotYetDone() Adds the final element to the stack trace, if not yet done.
java.io.File	getFile() Returns the parsed file.
java.lang.String	getFullMessage() Returns the message including file name, line number, line content and/or stack trace, whatever is available.
java.lang.String	getLineContent() Returns the content of the line causing the exception.
int	getLineNumber() Returns the line number of the parsed file where the exception occured.
java.util.Deque<StackTraceElement>	getStackTraceElements() Returns a clone of the stack trace.
void	setCausedByBlockConditions() Marks this exeption as being caused by if/elsif/else conditions of a nestable block.
void	setCausedByInvalidVar(java.lang.String varName) Marks this exeption as being caused by an invalid variable or parameter name.
void	setFile(java.io.File file) Sets the parsed file.
void	setLineContentIfNotYetDone(java.lang.String line) Sets the content of the line that was parsed when the exception has been thrown, if not yet done.
void	setLineNumber(int lineNumber) Sets the line number of the parsed file where the exception occured.
void	setStackTrace(java.util.Deque<StackTraceElement> stack) Sets the given call stack.

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

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

lineNumber

private int lineNumber

file

private java.io.File file

stackTrace

private java.util.Deque<StackTraceElement> stackTrace

lineContent

private java.lang.String lineContent

isLastAdded

private boolean isLastAdded

causedByBlockCond

private boolean causedByBlockCond

causedByInvalidVar

private boolean causedByInvalidVar

Constructor Detail

ParseException

public ParseException()

Throws a generic parse exception without a detail message.

ParseException

public ParseException(java.lang.String message)

Throws an exception including a detail message.

Parameters:

message -

Method Detail

getLineNumber

public int getLineNumber()

Returns the line number of the parsed file where the exception occured.

Returns:

Line number of the exception.

setLineNumber

public void setLineNumber(int lineNumber)

Sets the line number of the parsed file where the exception occured.

Parameters:

lineNumber - Line number of the exception.

setLineContentIfNotYetDone

public void setLineContentIfNotYetDone(java.lang.String line)

Sets the content of the line that was parsed when the exception has been thrown, if not yet done. If a line content is already set, this will not be overridden. This is the case if an exception occurs in an included file.

Parameters:

line - MidicaPL line content.

getLineContent

public java.lang.String getLineContent()

Returns the content of the line causing the exception.

This is only used for unit tests.

Returns:

line content

setCausedByBlockConditions

public void setCausedByBlockConditions()

Marks this exeption as being caused by if/elsif/else conditions of a nestable block.

setCausedByInvalidVar

public void setCausedByInvalidVar(java.lang.String varName)

Marks this exeption as being caused by an invalid variable or parameter name.

Parameters:

varName - the variable or parameter name causing the problem

getFile

public java.io.File getFile()

Returns the parsed file.

Returns:

file name

setFile

public void setFile(java.io.File file)

Sets the parsed file.

Parameters:

file - Parsed file.

setStackTrace

public void setStackTrace(java.util.Deque<StackTraceElement> stack)

Sets the given call stack.

Parameters:

stack - the call stack to be set.

getFullMessage

public java.lang.String getFullMessage()

Returns the message including file name, line number, line content and/or stack trace, whatever is available.

Returns:

error message including more information, if available.

getStackTraceElements

public java.util.Deque<StackTraceElement> getStackTraceElements()

Returns a clone of the stack trace.

Returns:

clone of the stack trace.

addLastElementIfNotYetDone

private void addLastElementIfNotYetDone()

Adds the final element to the stack trace, if not yet done.