ThreadDumpMessage (log4j-api 2.20.0)

java.lang.Object
- org.apache.logging.log4j.message.ThreadDumpMessage

All Implemented Interfaces:

Serializable, Message, StringBuilderFormattable
```
@AsynchronouslyFormattable
public class ThreadDumpMessage
extends 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

static interface ThreadDumpMessage.ThreadInfoFactory
Factory to create Thread information.

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

Constructor Summary

Constructors
Constructor and Description

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

Constructors
Constructor and Description
`ThreadDumpMessage(String title)` Generate a ThreadDumpMessage with a title.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`formatTo(StringBuilder sb)` Writes a text representation of this object into the specified `StringBuilder`, ideally without allocating temporary objects.
`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()`
`protected 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

- Constructor Detail
  - ThreadDumpMessage
```
public ThreadDumpMessage(String title)
```
    Generate a ThreadDumpMessage with a title.
    
    Parameters:
    
    title - The title.
- Method Detail
  - 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)
```
    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 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.
  - writeReplace
```
protected Object writeReplace()
```
    Creates a ThreadDumpMessageProxy that can be serialized.
    
    Returns:
    
    a ThreadDumpMessageProxy.
  - getThrowable
```
public Throwable getThrowable()
```
    Always returns null.
    
    Specified by:
    
    getThrowable in interface Message
    
    Returns:
    
    null

Copyright © 1999-2023 The Apache Software Foundation. All Rights Reserved.
Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation.

Class ThreadDumpMessage

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ThreadDumpMessage

Method Detail

toString

getFormattedMessage

formatTo

getFormat

getParameters

writeReplace

getThrowable