net.sandius.rembulan.load

Class LoaderException

java.lang.Object

java.lang.Throwable

java.lang.Exception

net.sandius.rembulan.load.LoaderException

All Implemented Interfaces:

Serializable

public class LoaderException
extends Exception

An exception thrown when loading Lua chunks to indicate that the input cannot be parsed, compiled or loaded as a function.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
LoaderException(Throwable cause, String sourceFileName) Constructs a new LoaderException without line information or the indication that the cause of this error may have been a partial input.
LoaderException(Throwable cause, String sourceFileName, int sourceLine, boolean partialInput) Constructs a new LoaderException with the specified cause, the file name sourceFileName, the line sourceLine where the error occurred, and indicating in the flag partialInput whether the cause of the error may have been caused by a partial input (i.e., an unexpected EOF).

Method Summary

Modifier and Type	Method and Description
String	getLuaStyleErrorMessage() Returns a Lua-style error message for this loader exception.
String	getSourceFileName() Returns the file name of the program that caused this exception.
int	getSourceLine() Returns the line in the source file that caused the exception.
boolean	isPartialInputError() Returns true if this LoaderException was caused by an unexpected EOF when processing the Lua program.

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

Constructor Detail

LoaderException

public LoaderException(Throwable cause,
                       String sourceFileName,
                       int sourceLine,
                       boolean partialInput)

Constructs a new LoaderException with the specified cause, the file name sourceFileName, the line sourceLine where the error occurred, and indicating in the flag partialInput whether the cause of the error may have been caused by a partial input (i.e., an unexpected EOF).

Parameters:

cause - the cause of the error, must not be null

sourceFileName - source file name, may be null when source file information is omitted

sourceLine - the line in the source where the error occurred, may be non-positive when this information is omitted

partialInput - a flag indicating whether the cause of the error may have been an unexpected EOF

Throws:

NullPointerException - if cause is null

LoaderException

public LoaderException(Throwable cause,
                       String sourceFileName)

Constructs a new LoaderException without line information or the indication that the cause of this error may have been a partial input.

Parameters:

cause - the cause of the error, must not be null

sourceFileName - source file name, may be null when source file information is omitted

Throws:

NullPointerException - if cause is null

Method Detail

isPartialInputError

public boolean isPartialInputError()

Returns true if this LoaderException was caused by an unexpected EOF when processing the Lua program.

Returns:

true if this exception was caused by an unexpected EOF

getSourceFileName

public String getSourceFileName()

Returns the file name of the program that caused this exception. May return null if this information is not available.

Returns:

file name of the program, or null when this information is not available

getSourceLine

public int getSourceLine()

Returns the line in the source file that caused the exception. May return a number lesser than 1 when this information is not available.

Returns:

line that caused this error, or a number lesser than 1 if this information is not available

getLuaStyleErrorMessage

public String getLuaStyleErrorMessage()

Returns a Lua-style error message for this loader exception.

The format of this error message is:

     "SourceFileName:SourceLine: CauseMessage"
 

When no source file name is available, the source information prefix is omitted (i.e., the error message is equal to CauseMessage); when no source line information is available, the SourceLine string is equal to "?".

CauseMessage is the error message as returner by the cause of this exception.

Returns:

a Lua-style error message for this loader exception