|
FlexDoc/Javadoc 2.0 Demo Java Doc |
Class StackTraceElement
java.lang.StackTraceElement
All Implemented Interfaces:
public final class StackTraceElement
An element in a stack trace, as returned by
Throwable.getStackTrace(). Each element represents a single stack frame.
All stack frames except for the one at the top of the stack represent
a method invocation. The frame at the top of the stack represents the
execution point at which the stack trace was generated. Typically,
this is the point at which the throwable corresponding to the stack trace
was created.
Since:
1.4
Author:
Josh Bloch
See Also:
Constructor Summary |
Creates a stack trace element representing the specified execution
point.
|
Creates a stack trace element representing the specified execution
point.
|
Method Summary |
boolean |
Returns true if the specified object is another
StackTraceElement instance representing the same execution
point as this instance.
|
|
Returns the name of the class loader of the class containing the
execution point represented by this stack trace element.
|
|
Returns the fully qualified name of the class containing the
execution point represented by this stack trace element.
|
|
Returns the name of the source file containing the execution point
represented by this stack trace element.
|
int |
Returns the line number of the source line containing the execution
point represented by this stack trace element.
|
|
Returns the name of the method containing the execution point
represented by this stack trace element.
|
|
Returns the module name of the module containing the execution point
represented by this stack trace element.
|
|
Returns the module version of the module containing the execution point
represented by this stack trace element.
|
int |
Returns a hash code value for this stack trace element.
|
boolean |
Returns true if the method containing the execution point
represented by this stack trace element is a native method.
|
|
Returns a string representation of this stack trace element.
|
Methods inherited from class java.lang. Object |
|
Creates a stack trace element representing the specified execution
point. The
module name and
module version of the stack trace element will
be
null.
Parameters:
declaringClass - the fully qualified name of the class containing
the execution point represented by the stack trace element
methodName - the name of the method containing the execution point
represented by the stack trace element
fileName - the name of the file containing the execution point
represented by the stack trace element, or null if
this information is unavailable
lineNumber - the line number of the source line containing the
execution point represented by this stack trace element, or
a negative number if this information is unavailable. A value
of -2 indicates that the method containing the execution point
is a native method
Throws:
Since:
1.5
Creates a stack trace element representing the specified execution
point.
Parameters:
classLoaderName - the class loader name if the class loader of
the class containing the execution point represented by
the stack trace is named; otherwise
null
moduleName - the module name if the class containing the
execution point represented by the stack trace is in a named
module; otherwise null
moduleVersion - the module version if the class containing the
execution point represented by the stack trace is in a named
module that has a version; otherwise null
declaringClass - the fully qualified name of the class containing
the execution point represented by the stack trace element
methodName - the name of the method containing the execution point
represented by the stack trace element
fileName - the name of the file containing the execution point
represented by the stack trace element, or null if
this information is unavailable
lineNumber - the line number of the source line containing the
execution point represented by this stack trace element, or
a negative number if this information is unavailable. A value
of -2 indicates that the method containing the execution point
is a native method
Throws:
Since:
9
Returns the name of the source file containing the execution point
represented by this stack trace element. Generally, this corresponds
to the
SourceFile attribute of the relevant
class
file (as per
The Java Virtual Machine Specification, Section
{@jvms 4.7.7}). In some systems, the name may refer to some source code unit
other than a file, such as an entry in source repository.
Returns:
the name of the file containing the execution point
represented by this stack trace element, or null if
this information is unavailable.
public int getLineNumber |
() |
Returns the line number of the source line containing the execution
point represented by this stack trace element. Generally, this is
derived from the
LineNumberTable attribute of the relevant
class file (as per
The Java Virtual Machine
Specification, Section {@jvms 4.7.8}).
Returns:
the line number of the source line containing the execution
point represented by this stack trace element, or a negative
number if this information is unavailable.
Returns the module name of the module containing the execution point
represented by this stack trace element.
Returns:
the module name of the Module containing the execution
point represented by this stack trace element; null
if the module name is not available.
Since:
9
See Also:
public String getModuleVersion |
() |
Returns the module version of the module containing the execution point
represented by this stack trace element.
Returns:
the module version of the Module containing the execution
point represented by this stack trace element; null
if the module version is not available.
Since:
9
See Also:
public String getClassLoaderName |
() |
Returns the name of the class loader of the class containing the
execution point represented by this stack trace element.
Returns:
the name of the class loader of the class containing the execution
point represented by this stack trace element; null
if the class loader is not named.
Since:
9
See Also:
Returns the fully qualified name of the class containing the
execution point represented by this stack trace element.
Returns:
the fully qualified name of the Class containing
the execution point represented by this stack trace element.
Returns the name of the method containing the execution point
represented by this stack trace element. If the execution point is
contained in an instance or class initializer, this method will return
the appropriate
special method name,
<init> or
<clinit>, as per Section {@jvms 3.9} of
The Java Virtual
Machine Specification.
Returns:
the name of the method containing the execution point
represented by this stack trace element.
public boolean isNativeMethod |
() |
Returns true if the method containing the execution point
represented by this stack trace element is a native method.
Returns:
true if the method containing the execution point
represented by this stack trace element is a native method.
Returns a string representation of this stack trace element.
Overrides:
Returns:
a string representation of the object.
See Also:
Returns true if the specified object is another
StackTraceElement instance representing the same execution
point as this instance. Two stack trace elements
a and
b are equal if and only if:
equals(a.getClassLoaderName(), b.getClassLoaderName()) &&
equals(a.getModuleName(), b.getModuleName()) &&
equals(a.getModuleVersion(), b.getModuleVersion()) &&
equals(a.getClassName(), b.getClassName()) &&
equals(a.getMethodName(), b.getMethodName())
equals(a.getFileName(), b.getFileName()) &&
a.getLineNumber() == b.getLineNumber()
where
equals has the semantics of
Objects.equals.
Overrides:
Parameters:
obj - the object to be compared with this stack trace element.
Returns:
true if the specified object is another
StackTraceElement instance representing the same
execution point as this instance.
See Also:
Returns a hash code value for this stack trace element.
Overrides:
Returns:
a hash code value for this object.
See Also:
|
FlexDoc/Javadoc 2.0 Demo Java Doc |
FlexDoc/Javadoc is a template-driven programming tool for rapid development of any Javadoc-based Java API documentation generators (i.e. doclets). If you need to customize your Javadoc without writing a full-blown doclet from scratch,
FlexDoc/Javadoc may be the only tool able to help you! Find out more at
www.flexdoc.xyz