java.lang
Class StackTraceElement

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by java.lang.StackTraceElement
All Implemented Interfaces:
Serializable sample code for java.io.Serializable definition code for java.io.Serializable

public final class StackTraceElement
extends Object sample code for java.lang.Object definition code for java.lang.Object
implements Serializable sample code for java.io.Serializable definition code for java.io.Serializable

An element in a stack trace, as returned by Throwable.getStackTrace() sample code for java.lang.Throwable.getStackTrace() definition code for java.lang.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
See Also:
Serialized Form

Constructor Summary
StackTraceElement sample code for java.lang.StackTraceElement.StackTraceElement(java.lang.String, java.lang.String, java.lang.String, int) definition code for java.lang.StackTraceElement.StackTraceElement(java.lang.String, java.lang.String, java.lang.String, int) (String sample code for java.lang.String definition code for java.lang.String  declaringClass, String sample code for java.lang.String definition code for java.lang.String  methodName, String sample code for java.lang.String definition code for java.lang.String  fileName, int lineNumber)
          Creates a stack trace element representing the specified execution point.
 
Method Summary
 boolean equals sample code for java.lang.StackTraceElement.equals(java.lang.Object) definition code for java.lang.StackTraceElement.equals(java.lang.Object) (Object sample code for java.lang.Object definition code for java.lang.Object  obj)
          Returns true if the specified object is another StackTraceElement instance representing the same execution point as this instance.
 String sample code for java.lang.String definition code for java.lang.String getClassName sample code for java.lang.StackTraceElement.getClassName() definition code for java.lang.StackTraceElement.getClassName() ()
          Returns the fully qualified name of the class containing the execution point represented by this stack trace element.
 String sample code for java.lang.String definition code for java.lang.String getFileName sample code for java.lang.StackTraceElement.getFileName() definition code for java.lang.StackTraceElement.getFileName() ()
          Returns the name of the source file containing the execution point represented by this stack trace element.
 int getLineNumber sample code for java.lang.StackTraceElement.getLineNumber() definition code for java.lang.StackTraceElement.getLineNumber() ()
          Returns the line number of the source line containing the execution point represented by this stack trace element.
 String sample code for java.lang.String definition code for java.lang.String getMethodName sample code for java.lang.StackTraceElement.getMethodName() definition code for java.lang.StackTraceElement.getMethodName() ()
          Returns the name of the method containing the execution point represented by this stack trace element.
 int hashCode sample code for java.lang.StackTraceElement.hashCode() definition code for java.lang.StackTraceElement.hashCode() ()
          Returns a hash code value for this stack trace element.
 boolean isNativeMethod sample code for java.lang.StackTraceElement.isNativeMethod() definition code for java.lang.StackTraceElement.isNativeMethod() ()
          Returns true if the method containing the execution point represented by this stack trace element is a native method.
 String sample code for java.lang.String definition code for java.lang.String toString sample code for java.lang.StackTraceElement.toString() definition code for java.lang.StackTraceElement.toString() ()
          Returns a string representation of this stack trace element.
 
Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
clone sample code for java.lang.Object.clone() definition code for java.lang.Object.clone() , finalize sample code for java.lang.Object.finalize() definition code for java.lang.Object.finalize() , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
 

Constructor Detail

StackTraceElement sample code for java.lang.StackTraceElement(java.lang.String, java.lang.String, java.lang.String, int) definition code for java.lang.StackTraceElement(java.lang.String, java.lang.String, java.lang.String, int)

public StackTraceElement(String sample code for java.lang.String definition code for java.lang.String  declaringClass,
                         String sample code for java.lang.String definition code for java.lang.String  methodName,
                         String sample code for java.lang.String definition code for java.lang.String  fileName,
                         int lineNumber)
Creates a stack trace element representing the specified execution point.

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:
NullPointerException sample code for java.lang.NullPointerException definition code for java.lang.NullPointerException - if declaringClass or methodName is null
Since:
1.5
Method Detail

getFileName sample code for java.lang.StackTraceElement.getFileName() definition code for java.lang.StackTraceElement.getFileName()

public String sample code for java.lang.String definition code for java.lang.String  getFileName()
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.

Returns:
the name of the file containing the execution point represented by this stack trace element, or null if this information is unavailable.

getLineNumber sample code for java.lang.StackTraceElement.getLineNumber() definition code for java.lang.StackTraceElement.getLineNumber()

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

getClassName sample code for java.lang.StackTraceElement.getClassName() definition code for java.lang.StackTraceElement.getClassName()

public String sample code for java.lang.String definition code for java.lang.String  getClassName()
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.

getMethodName sample code for java.lang.StackTraceElement.getMethodName() definition code for java.lang.StackTraceElement.getMethodName()

public String sample code for java.lang.String definition code for java.lang.String  getMethodName()
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.

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

isNativeMethod sample code for java.lang.StackTraceElement.isNativeMethod() definition code for java.lang.StackTraceElement.isNativeMethod()

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.

toString sample code for java.lang.StackTraceElement.toString() definition code for java.lang.StackTraceElement.toString()

public String sample code for java.lang.String definition code for java.lang.String  toString()
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:

Overrides:
toString sample code for java.lang.Object.toString() definition code for java.lang.Object.toString() in class Object sample code for java.lang.Object definition code for java.lang.Object
Returns:
a string representation of the object.
See Also:
Throwable.printStackTrace() sample code for java.lang.Throwable.printStackTrace() definition code for java.lang.Throwable.printStackTrace()

equals sample code for java.lang.StackTraceElement.equals(java.lang.Object) definition code for java.lang.StackTraceElement.equals(java.lang.Object)

public boolean equals(Object sample code for java.lang.Object definition code for java.lang.Object  obj)
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));
     }
 

Overrides:
equals sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) in class Object sample code for java.lang.Object definition code for java.lang.Object
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:
Object.hashCode() sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() , Hashtable sample code for java.util.Hashtable definition code for java.util.Hashtable

hashCode sample code for java.lang.StackTraceElement.hashCode() definition code for java.lang.StackTraceElement.hashCode()

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

Overrides:
hashCode sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() in class Object sample code for java.lang.Object definition code for java.lang.Object
Returns:
a hash code value for this object.
See Also:
Object.equals(java.lang.Object) sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) , Hashtable sample code for java.util.Hashtable definition code for java.util.Hashtable