Package org.apache.logging.log4j.message

Class ThreadDumpMessage

java.lang.Object

org.apache.logging.log4j.message.ThreadDumpMessage

All Implemented Interfaces:

Serializable, Message, org.apache.logging.log4j.util.StringBuilderFormattable

@AsynchronouslyFormattable
public class ThreadDumpMessage
extends Object
implements Message, org.apache.logging.log4j.util.StringBuilderFormattable

Captures information about all running Threads.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ThreadDumpMessage.ThreadInfoFactory	Factory to create Thread information.

Constructor Summary

Constructors

Constructor	Description
ThreadDumpMessage(String title)	Generate a ThreadDumpMessage with a title.

Method Summary

Modifier and Type	Method	Description
void	formatTo(StringBuilder sb)
String	getFormat()	Returns the title.
String	getFormattedMessage()	Returns the ThreadDump in printable format.
Object[]	getParameters()	Returns an array with a single element, a Map containing the ThreadInformation as the key.
Throwable	getThrowable()	Always returns null.
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

ThreadDumpMessage

public ThreadDumpMessage(String title)

Generate a ThreadDumpMessage with a title.

Parameters:

title - The title.

Method Details

toString

public String toString()

Overrides:

toString in class Object

getFormattedMessage

public String getFormattedMessage()

Returns the ThreadDump in printable format.

Specified by:

getFormattedMessage in interface Message

Returns:

the ThreadDump suitable for logging.

formatTo

public void formatTo(StringBuilder sb)

Specified by:

formatTo in interface org.apache.logging.log4j.util.StringBuilderFormattable

getFormat

public String getFormat()

Returns the title.

Specified by:

getFormat in interface Message

Returns:

the title.

getParameters

public 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.

getThrowable

public Throwable getThrowable()

Always returns null.

Specified by:

getThrowable in interface Message

Returns:

null