org.apache.logging.log4j.message

Class ThreadDumpMessage

java.lang.Object

org.apache.logging.log4j.message.ThreadDumpMessage

All Implemented Interfaces:

java.io.Serializable, Message, StringBuilderFormattable

@AsynchronouslyFormattable
public class ThreadDumpMessage
extends java.lang.Object
implements Message, StringBuilderFormattable

Captures information about all running Threads.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	ThreadDumpMessage.BasicThreadInfoFactory Factory to create basic thread information.
private static class	ThreadDumpMessage.ExtendedThreadInfoFactory Factory to create extended thread information.
private static class	ThreadDumpMessage.ThreadDumpMessageProxy Proxy pattern used to serialize the ThreadDumpMessage.
private static interface	ThreadDumpMessage.ThreadInfoFactory Factory to create Thread information.

Field Summary

Fields

Modifier and Type	Field and Description
private static ThreadDumpMessage.ThreadInfoFactory	FACTORY
private java.lang.String	formattedMessage
private static long	serialVersionUID
private java.util.Map<ThreadInformation,java.lang.StackTraceElement[]>	threads
private java.lang.String	title

Constructor Summary

Constructors

Modifier	Constructor and Description
	ThreadDumpMessage(java.lang.String title) Generate a ThreadDumpMessage with a title.
private	ThreadDumpMessage(java.lang.String formattedMsg, java.lang.String title)

Method Summary

Modifier and Type	Method and Description
void	formatTo(java.lang.StringBuilder sb) Writes a text representation of this object into the specified StringBuilder, ideally without allocating temporary objects.
java.lang.String	getFormat() Returns the title.
java.lang.String	getFormattedMessage() Returns the ThreadDump in printable format.
java.lang.Object[]	getParameters() Returns an array with a single element, a Map containing the ThreadInformation as the key.
java.lang.Throwable	getThrowable() Always returns null.
private void	readObject(java.io.ObjectInputStream stream)
java.lang.String	toString()
protected java.lang.Object	writeReplace() Creates a ThreadDumpMessageProxy that can be serialized.

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

FACTORY

private static final ThreadDumpMessage.ThreadInfoFactory FACTORY

threads

private volatile java.util.Map<ThreadInformation,java.lang.StackTraceElement[]> threads

title

private final java.lang.String title

formattedMessage

private java.lang.String formattedMessage

Constructor Detail

ThreadDumpMessage

public ThreadDumpMessage(java.lang.String title)

Generate a ThreadDumpMessage with a title.

Parameters:

title - The title.

ThreadDumpMessage

private ThreadDumpMessage(java.lang.String formattedMsg,
                          java.lang.String title)

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getFormattedMessage

public java.lang.String getFormattedMessage()

Returns the ThreadDump in printable format.

Specified by:

getFormattedMessage in interface Message

Returns:

the ThreadDump suitable for logging.

formatTo

public void formatTo(java.lang.StringBuilder sb)

Description copied from interface: StringBuilderFormattable

Writes a text representation of this object into the specified StringBuilder, ideally without allocating temporary objects.

Specified by:

formatTo in interface StringBuilderFormattable

Parameters:

sb - the StringBuilder to write into

getFormat

public java.lang.String getFormat()

Returns the title.

Specified by:

getFormat in interface Message

Returns:

the title.

getParameters

public java.lang.Object[] getParameters()

Returns an array with a single element, a Map containing the ThreadInformation as the key. and the StackTraceElement array as the value;

Specified by:

getParameters in interface Message

Returns:

the "parameters" to this Message.

writeReplace

protected java.lang.Object writeReplace()

Creates a ThreadDumpMessageProxy that can be serialized.

Returns:

a ThreadDumpMessageProxy.

readObject

private void readObject(java.io.ObjectInputStream stream)
                 throws java.io.InvalidObjectException

Throws:

java.io.InvalidObjectException

getThrowable

public java.lang.Throwable getThrowable()

Always returns null.

Specified by:

getThrowable in interface Message

Returns:

null