Class StandardStackTracePrinter

java.lang.Object

org.springframework.boot.logging.StandardStackTracePrinter

All Implemented Interfaces:

StackTracePrinter

public final class StandardStackTracePrinter
extends Object
implements StackTracePrinter

StackTracePrinter that prints a standard form stack trace. This printer produces a result in a similar form to Throwable.printStackTrace(), but offers more customization options.

Since:

3.5.0

Author:

Phillip Webb

Method Summary

Modifier and Type	Method	Description
void	printStackTrace(Throwable throwable, Appendable out)	Prints a stack trace for the given Throwable.
static StandardStackTracePrinter	rootFirst()	Return a StandardStackTracePrinter that prints the stack trace with the root exception first (the opposite of Throwable.printStackTrace()).
static StandardStackTracePrinter	rootLast()	Return a StandardStackTracePrinter that prints the stack trace with the root exception last (the same as Throwable.printStackTrace()).
StandardStackTracePrinter	withCommonFrames()	Return a new StandardStackTracePrinter from this one that will print all common frames rather the replacing them with the "... N more" message.
StandardStackTracePrinter	withFilter(Predicate<Throwable> predicate)	Return a new StandardStackTracePrinter from this one that will only include throwables (excluding caused and suppressed) that match the given predicate.
StandardStackTracePrinter	withFormatter(Function<Throwable, String> formatter)	Return a new StandardStackTracePrinter from this one uses the specified formatter to create a string representation of a throwable.
StandardStackTracePrinter	withFrameFilter(BiPredicate<Integer, StackTraceElement> predicate)	Return a new StandardStackTracePrinter from this one that will only include frames that match the given predicate.
StandardStackTracePrinter	withFrameFormatter(Function<StackTraceElement, String> frameFormatter)	Return a new StandardStackTracePrinter from this one uses the specified formatter to create a string representation of a frame.
StandardStackTracePrinter	withHashes()	Return a new StandardStackTracePrinter from this one that generates and prints hashes for each stacktrace.
StandardStackTracePrinter	withHashes(boolean hashes)	Return a new StandardStackTracePrinter from this one that changes if hashes should be generated and printed for each stacktrace.
StandardStackTracePrinter	withHashes(@Nullable ToIntFunction<StackTraceElement> frameHasher)
StandardStackTracePrinter	withLineSeparator(String lineSeparator)	Return a new StandardStackTracePrinter from this one that print the stack trace using the specified line separator.
StandardStackTracePrinter	withMaximumLength(int maximumLength)	Return a new StandardStackTracePrinter from this one that will use ellipses to truncate output longer that the specified length.
StandardStackTracePrinter	withMaximumThrowableDepth(int maximumThrowableDepth)	Return a new StandardStackTracePrinter from this one that filter frames (including caused and suppressed) deeper then the specified maximum.
StandardStackTracePrinter	withoutSuppressed()	Return a new StandardStackTracePrinter from this one that will not print suppressed items.

Methods inherited from class Object

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

Methods inherited from interface StackTracePrinter

printStackTraceToString

Method Details

printStackTrace

public void printStackTrace(Throwable throwable,
 Appendable out)
                     throws IOException

Description copied from interface: StackTracePrinter

Prints a stack trace for the given Throwable.

Specified by:

printStackTrace in interface StackTracePrinter

Parameters:

throwable - the throwable that should have its stack trace printed

out - the destination to write output

Throws:

IOException - on IO error

withCommonFrames

public StandardStackTracePrinter withCommonFrames()

Return a new StandardStackTracePrinter from this one that will print all common frames rather the replacing them with the "... N more" message.

Returns:

a new StandardStackTracePrinter instance

withoutSuppressed

public StandardStackTracePrinter withoutSuppressed()

Return a new StandardStackTracePrinter from this one that will not print suppressed items.

Returns:

a new StandardStackTracePrinter instance

withMaximumLength

public StandardStackTracePrinter withMaximumLength(int maximumLength)

Return a new StandardStackTracePrinter from this one that will use ellipses to truncate output longer that the specified length.

Parameters:

maximumLength - the maximum length that can be printed

Returns:

a new StandardStackTracePrinter instance

withMaximumThrowableDepth

public StandardStackTracePrinter withMaximumThrowableDepth(int maximumThrowableDepth)

Return a new StandardStackTracePrinter from this one that filter frames (including caused and suppressed) deeper then the specified maximum.

Parameters:

maximumThrowableDepth - the maximum throwable depth

Returns:

a new StandardStackTracePrinter instance

withFilter

public StandardStackTracePrinter withFilter(Predicate<Throwable> predicate)

Return a new StandardStackTracePrinter from this one that will only include throwables (excluding caused and suppressed) that match the given predicate.

Parameters:

predicate - the predicate used to filter the throwable

Returns:

a new StandardStackTracePrinter instance

withFrameFilter

public StandardStackTracePrinter withFrameFilter(BiPredicate<Integer, StackTraceElement> predicate)

Return a new StandardStackTracePrinter from this one that will only include frames that match the given predicate.

Parameters:

predicate - the predicate used to filter frames

Returns:

a new StandardStackTracePrinter instance

withLineSeparator

public StandardStackTracePrinter withLineSeparator(String lineSeparator)

Return a new StandardStackTracePrinter from this one that print the stack trace using the specified line separator.

Parameters:

lineSeparator - the line separator to use

Returns:

a new StandardStackTracePrinter instance

withFormatter

public StandardStackTracePrinter withFormatter(Function<Throwable, String> formatter)

Return a new StandardStackTracePrinter from this one uses the specified formatter to create a string representation of a throwable.

Parameters:

formatter - the formatter to use

Returns:

a new StandardStackTracePrinter instance

See Also:

• withLineSeparator(String)

withFrameFormatter

public StandardStackTracePrinter withFrameFormatter(Function<StackTraceElement, String> frameFormatter)

Return a new StandardStackTracePrinter from this one uses the specified formatter to create a string representation of a frame.

Parameters:

frameFormatter - the frame formatter to use

Returns:

a new StandardStackTracePrinter instance

See Also:

• withLineSeparator(String)

withHashes

public StandardStackTracePrinter withHashes()

Return a new StandardStackTracePrinter from this one that generates and prints hashes for each stacktrace.

Returns:

a new StandardStackTracePrinter instance

withHashes

public StandardStackTracePrinter withHashes(boolean hashes)

Return a new StandardStackTracePrinter from this one that changes if hashes should be generated and printed for each stacktrace.

Parameters:

hashes - if hashes should be added

Returns:

a new StandardStackTracePrinter instance

withHashes

public StandardStackTracePrinter withHashes(@Nullable ToIntFunction<StackTraceElement> frameHasher)

rootLast

public static StandardStackTracePrinter rootLast()

Return a StandardStackTracePrinter that prints the stack trace with the root exception last (the same as Throwable.printStackTrace()).

Returns:

a StandardStackTracePrinter that prints the stack trace root last

rootFirst

public static StandardStackTracePrinter rootFirst()

Return a StandardStackTracePrinter that prints the stack trace with the root exception first (the opposite of Throwable.printStackTrace()).

Returns:

a StandardStackTracePrinter that prints the stack trace root first