Module io.jstach.rainbowgum

Package io.jstach.rainbowgum

Interface LogEvent.Caller

Enclosing interface:

LogEvent

public static sealed interface LogEvent.Caller

Caller info usually derived from Stack walking.

Method Summary

Modifier and Type	Method	Description
String	className()	See StackWalker.StackFrame.getClassName().
@Nullable String	fileNameOrNull()	See StackWalker.StackFrame.getFileName().
LogEvent.Caller	freeze()	Make the caller info immutable.
int	lineNumber()	See StackWalker.StackFrame.getLineNumber().
String	methodName()	See StackWalker.StackFrame.getMethodName().
static LogEvent.Caller	of(StackWalker.StackFrame stackFrame)	Creates caller info from a stack frame.
static @Nullable LogEvent.Caller	ofDepthOrNull(int depth)	Returns caller from a certain depth or null
static String	toString(@Nullable LogEvent.Caller caller)	Convenience toString for caller.

Method Details

of

static LogEvent.Caller of(StackWalker.StackFrame stackFrame)

Creates caller info from a stack frame.

Parameters:

stackFrame - stack frame must have StackWalker.Option.RETAIN_CLASS_REFERENCE.

Returns:

caller info.

ofDepthOrNull

static @Nullable LogEvent.Caller ofDepthOrNull(int depth)

Returns caller from a certain depth or null

Parameters:

depth - how deep in the stack to pull stack frame.

Returns:

caller or null.

className

String className()

See StackWalker.StackFrame.getClassName().

Returns:

class name.

fileNameOrNull

@Nullable String fileNameOrNull()

See StackWalker.StackFrame.getFileName().

Returns:

file name.

lineNumber

int lineNumber()

See StackWalker.StackFrame.getLineNumber().

Returns:

line number.

methodName

String methodName()

See StackWalker.StackFrame.getMethodName().

Returns:

method name.

freeze

LogEvent.Caller freeze()

Make the caller info immutable.

Returns:

immutable caller info and if this is already immutable return this.

toString

static String toString(@Nullable LogEvent.Caller caller)

Convenience toString for caller.

Parameters:

caller - if caller is null the string "null" will be returned.

Returns:

string representation.