Class org.as2lib.regexp.PatternSyntaxException

Description

Unchecked exception thrown to indicate a syntax error in a regular-expression pattern.

Field Index

Inherited from Error

message, name

Method Index

new PatternSyntaxException()
getDescription(), getIndex(), getMessage(), getPattern()

Inherited from Exception

Inherited from AbstractThrowable

Constructor Detail

PatternSyntaxException

public function PatternSyntaxException(description:String, thrower:Pattern, args:FunctionArguments)

Constructs a new instance of this class.

Parameters

descriptionA description of the error
throwerThe erroneous Pattern's instance thrown exception
argsArguments of the function thrown exception

Method Detail

getIndex

public function getIndex(Void):Number

Retrieves the error index.

Return

The approximate index in the pattern of the error

getDescription

public function getDescription(Void):String

Retrieves the description of the error.

Return

The description of the error

getPattern

public function getPattern(Void):String

Retrieves the erroneous regular-expression pattern.

Return

The erroneous pattern

getMessage

public function getMessage(Void):String

Returns a multi-line string containing the description of the syntax error and its index, the erroneous regular-expression pattern, and a visual indication of the error index within the pattern.

Return

The full detail message

Specified By

getMessage() in org.as2lib.env.except.Throwable

Overrides

getMessage() in org.as2lib.env.except.AbstractThrowable