java.lang

Class StackTraceElement

Implemented Interfaces:
Serializable

public final class StackTraceElement
extends Object
implements Serializable

One function call or stack trace element. Gives information about the execution point such as the source file name, the line number, the fully qualified class name, the method name and whether this method is native, if this information is known.
Since:
1.4
See Also:
Serialized Form

Constructor Summary

StackTraceElement(String className, String methodName, String fileName, int lineNumber)
Create a new StackTraceElement representing a given source location.

Method Summary

boolean
equals(Object o)
Returns true if the given object is also a StackTraceElement and all attributes, except the native flag, are equal (either the same attribute between the two elments are null, or both satisfy Object.equals).
String
getClassName()
Returns the fully qualified class name, or null if unknown.
String
getFileName()
Returns the name of the file, or null if unknown.
int
getLineNumber()
Returns the line number in the file, or a negative number if unknown.
String
getMethodName()
Returns the method name in the class, or null if unknown.
int
hashCode()
Returns the hashCode of this StackTraceElement.
boolean
isNativeMethod()
Returns true if the method is native, or false if it is not or unknown.
String
toString()
Returns a string representation of this stack trace element.

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

StackTraceElement

public StackTraceElement(String className,
                         String methodName,
                         String fileName,
                         int lineNumber)
Create a new StackTraceElement representing a given source location.
Parameters:
className - the fully qualified name of the class
methodName - the name of the method
fileName - the name of the file, null if unknown
lineNumber - the line in the file, negative if unknown, or -2 if this method is native
Since:
1.5

Method Details

equals

public boolean equals(Object o)
Returns true if the given object is also a StackTraceElement and all attributes, except the native flag, are equal (either the same attribute between the two elments are null, or both satisfy Object.equals).
Overrides:
equals in interface Object
Parameters:
o - the object to compare
Returns:
true if the two are equal

getClassName

public String getClassName()
Returns the fully qualified class name, or null if unknown.
Returns:
the class name

getFileName

public String getFileName()
Returns the name of the file, or null if unknown. This is usually obtained from the SourceFile attribute of the class file format, if present.
Returns:
the file name

getLineNumber

public int getLineNumber()
Returns the line number in the file, or a negative number if unknown. This is usually obtained from the LineNumberTable attribute of the method in the class file format, if present.
Returns:
the line number

getMethodName

public String getMethodName()
Returns the method name in the class, or null if unknown. If the execution point is in a constructor, the name is <init>; if the execution point is in the class initializer, the name is <clinit>.
Returns:
the method name

hashCode

public int hashCode()
Returns the hashCode of this StackTraceElement. This implementation computes the hashcode by xor-ing the hashcode of all attributes except the native flag.
Overrides:
hashCode in interface Object
Returns:
the hashcode

isNativeMethod

public boolean isNativeMethod()
Returns true if the method is native, or false if it is not or unknown.
Returns:
whether the method is native

toString

public String toString()
Returns a string representation of this stack trace element. The returned String is implementation specific. This implementation returns the following String: "[class][.][method]([file][:line])". If the fully qualified class name or the method is unknown it is omitted including the point seperator. If the source file name is unknown it is replaced by "Unknown Source" if the method is not native or by "Native Method" if the method is native. If the line number is unknown it and the colon are omitted.
Overrides:
toString in interface Object
Returns:
a string representation of this execution point

StackTraceElement.java -- One function call or call stack element Copyright (C) 2001, 2002, 2004, 2005, 2006 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.