1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212
/* * @(#)StackTraceElement.java 1.11 05/11/17 * * Copyright 2006 Sun Microsystems, Inc. All rights reserved. * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. */ package java.lang; /** * An element in a stack trace, as returned by {@link * 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 */ public final class StackTraceElement implements java.io.Serializable { // Normally initialized by VM (public constructor added in 1.5) private String declaringClass; private String methodName; private String fileName; private int lineNumber; /** * Creates a stack trace element representing the specified execution * point. * * @param declaringClass the fully qualified name of the class containing * the execution point represented by the stack trace element * @param methodName the name of the method containing the execution point * represented by the stack trace element * @param fileName the name of the file containing the execution point * represented by the stack trace element, or <tt>null</tt> if * this information is unavailable * @param 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 <tt>declaringClass</tt> or * <tt>methodName</tt> is null * @since 1.5 */ public StackTraceElement(String declaringClass, String methodName, String fileName, int lineNumber) { if (declaringClass == null) throw new NullPointerException("Declaring class is null"); if (methodName == null) throw new NullPointerException("Method name is null"); this.declaringClass = declaringClass; this.methodName = methodName; this.fileName = fileName; this.lineNumber = lineNumber; } /** * Returns the name of the source file containing the execution point * represented by this stack trace element. Generally, this corresponds * to the <tt>SourceFile</tt> attribute of the relevant <tt>class</tt> * file (as per <i>The Java Virtual Machine Specification</i>, 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 <tt>null</tt> if * this information is unavailable. */ public String getFileName() { return fileName; } /** * Returns the line number of the source line containing the execution * point represented by this stack trace element. Generally, this is * derived from the <tt>LineNumberTable</tt> attribute of the relevant * <tt>class</tt> file (as per <i>The Java Virtual Machine * Specification</i>, 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 int getLineNumber() { return lineNumber; } /** * 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 <tt>Class</tt> containing * the execution point represented by this stack trace element. */ public String getClassName() { return declaringClass; } /** * 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 <i>special method name</i>, <tt><init></tt> or * <tt><clinit></tt>, as per Section 3.9 of <i>The Java Virtual * Machine Specification</i>. * * @return the name of the method containing the execution point * represented by this stack trace element. */ public String getMethodName() { return methodName; } /** * Returns true if the method containing the execution point * represented by this stack trace element is a native method. * * @return <tt>true</tt> if the method containing the execution point * represented by this stack trace element is a native method. */ public boolean isNativeMethod() { return lineNumber == -2; } /** * 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: * <ul> * <li> * <tt>"MyClass.mash(MyClass.java:9)"</tt> - Here, <tt>"MyClass"</tt> * is the <i>fully-qualified name</i> of the class containing the * execution point represented by this stack trace element, * <tt>"mash"</tt> is the name of the method containing the execution * point, <tt>"MyClass.java"</tt> is the source file containing the * execution point, and <tt>"9"</tt> is the line number of the source * line containing the execution point. * <li> * <tt>"MyClass.mash(MyClass.java)"</tt> - As above, but the line * number is unavailable. * <li> * <tt>"MyClass.mash(Unknown Source)"</tt> - As above, but neither * the file name nor the line number are available. * <li> * <tt>"MyClass.mash(Native Method)"</tt> - 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. * </ul> * @see Throwable#printStackTrace() */ public String toString() { return getClassName() + "." + methodName + (isNativeMethod() ? "(Native Method)" : (fileName != null && lineNumber >= 0 ? "(" + fileName + ":" + lineNumber + ")" : (fileName != null ? "("+fileName+")" : "(Unknown Source)"))); } /** * Returns true if the specified object is another * <tt>StackTraceElement</tt> instance representing the same execution * point as this instance. Two stack trace elements <tt>a</tt> and * <tt>b</tt> are equal if and only if: * <pre> * equals(a.getFileName(), b.getFileName()) && * a.getLineNumber() == b.getLineNumber()) && * equals(a.getClassName(), b.getClassName()) && * equals(a.getMethodName(), b.getMethodName()) * </pre> * where <tt>equals</tt> is defined as: * <pre> * static boolean equals(Object a, Object b) { * return a==b || (a != null && a.equals(b)); * } * </pre> * * @param obj the object to be compared with this stack trace element. * @return true if the specified object is another * <tt>StackTraceElement</tt> instance representing the same * execution point as this instance. */ public boolean equals(Object obj) { if (obj==this) return true; if (!(obj instanceof StackTraceElement)) return false; StackTraceElement e = (StackTraceElement)obj; return e.declaringClass.equals(declaringClass) && e.lineNumber == lineNumber && eq(methodName, e.methodName) && eq(fileName, e.fileName); } private static boolean eq(Object a, Object b) { return a==b || (a != null && a.equals(b)); } /** * Returns a hash code value for this stack trace element. */ public int hashCode() { int result = 31*declaringClass.hashCode() + methodName.hashCode(); result = 31*result + (fileName == null ? 0 : fileName.hashCode()); result = 31*result + lineNumber; return result; } private static final long serialVersionUID = 6992337162326171013L; }