net.sozal.stackwriter.api

Class StackWriter

java.lang.Object

net.sozal.stackwriter.api.StackWriter

public final class StackWriter
extends Object

Entry point for the StackWriter API.

Author:

serkan

Method Summary

Modifier and Type	Method and Description
static void	addAppPackage(String newAppPackage) Ignores the errors thrown (directly or indirectly) from any class under the given package.
static void	addIgnoredExceptionType(Class<? extends Throwable> exceptionType) Marks the given exception type to be ignored on error.
static StackWriterService	getStackWriterService()
static void	registerErrorListener(ErrorListener errorListener) Registers the given error listener.
static void	setStackWriterService(StackWriterService stackWriterService)
static Frame[]	takeSnapshot() Takes snapshot of the current callstack with the active frames.
static Frame[]	takeSnapshot(int startDepth, int maxFrameCount) Takes snapshot of the current callstack from the given start depth with the active frames at most as given max frame count.
static Frame[]	takeSnapshotWithMaxFrameCount(int maxFrameCount) Takes snapshot of the current callstack with the active frames at most as given max frame count.
static Frame[]	takeSnapshotWithStartDepth(int startDepth) Takes snapshot of the current callstack from the given start depth with the active frames.
static void	useErrorFilter(ErrorFilter errorFilter) Uses the given error filter while filtering errors.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getStackWriterService

public static StackWriterService getStackWriterService()

setStackWriterService

public static void setStackWriterService(StackWriterService stackWriterService)

takeSnapshot

public static Frame[] takeSnapshot()

Takes snapshot of the current callstack with the active frames.

Returns:

the collected active frames in the current callstack

takeSnapshot

public static Frame[] takeSnapshot(int startDepth,
                                   int maxFrameCount)

Takes snapshot of the current callstack from the given start depth with the active frames at most as given max frame count.

Parameters:

startDepth - depth in the current callstack to start collecting frames

maxFrameCount - max frame count to be collected

Returns:

the collected active frames in the current callstack

takeSnapshotWithStartDepth

public static Frame[] takeSnapshotWithStartDepth(int startDepth)

Takes snapshot of the current callstack from the given start depth with the active frames.

Parameters:

startDepth - depth in the current callstack to start collecting frames

Returns:

the collected active frames in the current callstack

takeSnapshotWithMaxFrameCount

public static Frame[] takeSnapshotWithMaxFrameCount(int maxFrameCount)

Takes snapshot of the current callstack with the active frames at most as given max frame count.

Parameters:

maxFrameCount - max frame count to be collected

Returns:

the collected active frames in the current callstack

addAppPackage

public static void addAppPackage(String newAppPackage)

Ignores the errors thrown (directly or indirectly) from any class under the given package.

Parameters:

newAppPackage - the package to ignore errors thrown from

addIgnoredExceptionType

public static void addIgnoredExceptionType(Class<? extends Throwable> exceptionType)

Marks the given exception type to be ignored on error.

Parameters:

exceptionType - the exception type to be marked as ignored on error.

useErrorFilter

public static void useErrorFilter(ErrorFilter errorFilter)

Uses the given error filter while filtering errors.

Parameters:

errorFilter - the error filter to be used while filtering errors

registerErrorListener

public static void registerErrorListener(ErrorListener errorListener)

Registers the given error listener.

Parameters:

errorListener - the error listener to be registered