Public Member Function Documentation

new(scalar class, hash args)

The object constructor.

Parameters

class: The package name.
args: Optional. A hash of arguments.

Returns

(object) The new class object.

This function creates a new Debug object.

getExceptionInfo(scalar exception)

Gets a user-readable version of an exception.

Parameters

exception: The exception object.

Returns

A user-parse able exception stack.

This function is included to be consistent with other AE API implementations. While other language APIs include specific methods for returning the exception information, user sting and stack information for the exception, Perl's exception handling is not as granular. Like getExceptionUserString and getStack, this function calls yieldExceptionInfo to get a cleaned stack trace. As a result, all three methods return the same information.

getExceptionUserString(scalar exception)

Gets a user-readable version of an exception.

Parameters

exception: The exception object.

Returns

A user-parse able exception stack.

This function is included to be consistent with other AE API implementations. While other language APIs include specific methods for returning the exception information, user sting and stack information for the exception, Perl's exception handling is not as granular. Like getExceptionInfo and getStack, this function calls yieldExceptionInfo to get a cleaned stack trace. As a result, all three methods return the same information.

getStack(scalar exception)

Gets a user-readable version of an exception.

Parameters

exception: The exception object.

Returns

A user-parse able exception stack.

This function is included to be consistent with other AE API implementations. While other language APIs include specific methods for returning the exception information, user sting and stack information for the exception, Perl's exception handling is not as granular. Like getExceptionInfo and getExceptionUserString, this function calls yieldExceptionInfo to get a cleaned stack trace. As a result, all three methods return the same information.

yieldExceptionInfo(scalar exception)

Converts a nzae exception into a readable stack trace.

Parameters

exception: The exception object.

Returns

A user-parse able exception stack.

This function returns a stack trace appropriate for logging or sending to the user.

printStack(scalar exception)

Converts and prints a nzae exception.

Parameters

exception: The exception object.

Returns

None.

This function processes a stack trace into an appropriate form and prints to STDOUT.