StackTraceElement

FRAMES NO FRAMES

Overview

Package

Deprecated

Help

API Reference for EPL (ApamaDoc) 10.11.3.3

SUMMARY: IMPORT | CONSTANT | MEMBER | ACTION

DETAIL: IMPORT | CONSTANT | MEMBER | ACTION

com.apama.exceptions
Type StackTraceElement

Represents an entry in an exception stack trace.

A StackTraceElement type value is an object that contains information about one entry in the stack trace.

A com.apama.exceptions.Exception object contains a sequence of StackTrackElement objects, which indicate where an exception occurred. The correlator generates this sequence. You should not need to create StackTraceElement objects yourself. The first object in the sequence points to the line of code that caused the exception. The next object points to the action that contains the code that caused the exception. The next object points to the action that called that action, and so on.

The StackTraceElement type is defined in the com.apama.exceptions namespace. Typically, you specify using com.apama.exceptions.StackTraceElement so you can easily refer to StackTraceElement objects.

It is permissible to parse an event that contains a StackTraceElement object or a sequence of StackTraceElement objects.

See Also:: com.apama.exceptions.Exception#getStackTrace() - Exception.getStrackTrace() returns a sequence of StackTraceElement objects.

Action summary
`com.apama.exceptions.StackTraceElement`	`clone()` Create a copy of this stack trace element.
`string`	`getActionName()` Get the name of the action for this stack trace element.
`string`	`getFilename()` Get the name of the source file containing this stack trace element.
`integer`	`getLineNumber()` Get the line number of this stack trace element within the source file.
`string`	`getTypeName()` Get the name of the type containing the action for this stack trace element.
`integer`	`hash()` Get an integer hash representation of the underlying object.
`string`	`toString()` Convert this stack trace element to a string.

Action detail

clone

            com.apama.exceptions.StackTraceElement clone()

Create a copy of this stack trace element.

Returns:: A copy of this stack trace element.

getActionName

            string getActionName()

Get the name of the action for this stack trace element.

Returns:: The action name.

getFilename

            string getFilename()

Get the name of the source file containing this stack trace element.

Returns:: The source file name.

getLineNumber

            integer getLineNumber()

Get the line number of this stack trace element within the source file.

Returns:: The line number.

getTypeName

            string getTypeName()

Get the name of the type containing the action for this stack trace element.

Returns:: The type name.

hash

            integer hash()

Get an integer hash representation of the underlying object.

This function will return an integer evenly distributed over the whole range suitable for partitioning or indexing of that structure. Multiple different object can resolve to the same hash value.

Returns:: An integer respresentation of the underlying object.

toString

            string toString()

Convert this stack trace element to a string.

The string form is:

typeName.actionName() fileName:lineNumber

Returns:: This stack trace element as a string.