org.apache.log4j.spi
Class LocationInfo
java.lang.Object
org.apache.log4j.spi.LocationInfo
- java.io.Serializable
public class LocationInfo
extends java.lang.Object
implements java.io.Serializable
The internal representation of caller location information.
static String | NA - When location information is not available the constant
NA is returned.
|
static LocationInfo | NA_LOCATION_INFO - NA_LOCATION_INFO is provided for compatibility with log4j 1.3.
|
String | fullInfo - All available caller information, in the format
fully.qualified.classname.of.caller.methodName(Filename.java:line)
|
LocationInfo(String file, String classname, String method, String line) - Create new instance.
|
LocationInfo(Throwable t, String fqnOfCallingClass) - Instantiate location information based on a Throwable.
|
String | getClassName() - Return the fully qualified class name of the caller making the
logging request.
|
String | getFileName() - Return the file name of the caller.
|
String | getLineNumber() - Returns the line number of the caller.
|
String | getMethodName() - Returns the method name of the caller.
|
NA
public static final String NA
When location information is not available the constant
NA
is returned. Current value of this string
constant is ?.
NA_LOCATION_INFO
public static final LocationInfo NA_LOCATION_INFO
NA_LOCATION_INFO is provided for compatibility with log4j 1.3.
fullInfo
public String fullInfo
All available caller information, in the format
fully.qualified.classname.of.caller.methodName(Filename.java:line)
LocationInfo
public LocationInfo(String file,
String classname,
String method,
String line)
Create new instance.
file
- source file nameclassname
- class namemethod
- methodline
- source line number
LocationInfo
public LocationInfo(Throwable t,
String fqnOfCallingClass)
Instantiate location information based on a Throwable. We
expect the Throwable
t
, to be in the format
java.lang.Throwable
...
at org.apache.log4j.PatternLayout.format(PatternLayout.java:413)
at org.apache.log4j.FileAppender.doAppend(FileAppender.java:183)
at org.apache.log4j.Category.callAppenders(Category.java:131)
at org.apache.log4j.Category.log(Category.java:512)
at callers.fully.qualified.className.methodName(FileName.java:74)
...
However, we can also deal with JIT compilers that "lose" the
location information, especially between the parentheses.
getClassName
public String getClassName()
Return the fully qualified class name of the caller making the
logging request.
getFileName
public String getFileName()
Return the file name of the caller.
This information is not always available.
getLineNumber
public String getLineNumber()
Returns the line number of the caller.
This information is not always available.
getMethodName
public String getMethodName()
Returns the method name of the caller.
Copyright 2000-2007 Apache Software Foundation.