java.lang.StackTraceElement

public final class java.lang

StackTraceElement

Java SE 6

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

Constructors

public

StackTraceElement(String declaringClass, String methodName, String fileName, int lineNumber) Details

Creates a stack trace element representing the specified execution point.

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	NullPointerException: if `declaringClass` or `methodName` is null
since	1.5

Methods

public boolean

equals(Object obj) Details

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.getFileName(), b.getFileName()) &&
     a.getLineNumber() == b.getLineNumber()) &&
     equals(a.getClassName(), b.getClassName()) &&
     equals(a.getMethodName(), b.getMethodName())

where equals is defined as:

     static boolean equals(Object a, Object b) {
         return a==b || (a != null && a.equals(b));
     }

obj	the object to be compared with this stack trace element.
return	true if the specified object is another `StackTraceElement` instance representing the same execution point as this instance.

public int

hashCode()
Returns a hash code value for this stack trace element.

public String

toString() Details

Returns a string representation of this stack trace element. The format of this string depends on the implementation, but the following examples may be regarded as typical:

"MyClass.mash(MyClass.java:9)" - Here, "MyClass" is the fully-qualified name of the class containing the execution point represented by this stack trace element, "mash" is the name of the method containing the execution point, "MyClass.java" is the source file containing the execution point, and "9" is the line number of the source line containing the execution point.
"MyClass.mash(MyClass.java)" - As above, but the line number is unavailable.
"MyClass.mash(Unknown Source)" - As above, but neither the file name nor the line number are available.
"MyClass.mash(Native Method)" - As above, but neither the file name nor the line number are available, and the method containing the execution point is known to be a native method.

See also

printStackTrace()

Properties

public String

getClassName() Details

Returns the fully qualified name of the class containing the execution point represented by this stack trace element.

return the fully qualified name of the Class containing the execution point represented by this stack trace element.

public String

getFileName() Details

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 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.

return 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() Details

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 4.7.8).

return

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.

public String

getMethodName() Details

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 3.9 of The Java Virtual Machine Specification.

return

the name of the method containing the execution point represented by this stack trace element.

public boolean

isNativeMethod() Details

Returns true if the method containing the execution point represented by this stack trace element is a native method.

return true if the method containing the execution point represented by this stack trace element is a native method.

About DocWeb · Bundles · Export · Export All

Top 10 · Statistics · Login

About Sun · Contact · Privacy · Terms of Use · Trademarks

Java SE 6