net.openhft.chronicle.core.threads

Class ThreadDump

java.lang.Object

net.openhft.chronicle.core.threads.ThreadDump

public class ThreadDump
extends Object

Utility class for monitoring and managing threads.

Provides functionality for collecting stack traces of threads and detecting unexpected thread creation, which can be useful in testing and debugging scenarios.

Field Summary

Fields

Modifier and Type	Field and Description
static String	IGNORE_THREAD_IF_IN_NAME

Constructor Summary

Constructors

Constructor and Description
ThreadDump() Constructs a ThreadDump instance, initializing the set of threads at the time of creation.

Method Summary

Modifier and Type	Method and Description
static void	add(Thread t, StackTrace stackTrace) Adds a thread with its stack trace to the map of monitored threads.
void	assertNoNewThreads() Asserts that no new threads are running beyond the ones that existed at the time this ThreadDump instance was created.
void	assertNoNewThreads(int delay, @NotNull TimeUnit delayUnit) Asserts that no new threads are running beyond the ones that existed at the time this ThreadDump instance was created.
static StackTrace	createdHereFor(Thread thread) Retrieves the stack trace for a given thread.
void	ignore(String threadName) Marks a thread to be ignored by the assertNoNewThreads() check.

Methods inherited from class java.lang.Object

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

Field Detail

IGNORE_THREAD_IF_IN_NAME

public static final String IGNORE_THREAD_IF_IN_NAME

See Also:

Constant Field Values

Constructor Detail

ThreadDump

public ThreadDump()

Constructs a ThreadDump instance, initializing the set of threads at the time of creation.

Method Detail

add

public static void add(Thread t,
                       StackTrace stackTrace)

Adds a thread with its stack trace to the map of monitored threads.

Parameters:

t - the thread to be monitored

stackTrace - the stack trace of the thread

createdHereFor

public static StackTrace createdHereFor(Thread thread)

Retrieves the stack trace for a given thread.

Parameters:

thread - the thread whose stack trace is to be retrieved

Returns:

the stack trace for the given thread

ignore

public void ignore(String threadName)

Marks a thread to be ignored by the assertNoNewThreads() check.

Parameters:

threadName - the name of the thread to be ignored

assertNoNewThreads

public void assertNoNewThreads()

Asserts that no new threads are running beyond the ones that existed at the time this ThreadDump instance was created. This method waits for a short period of time for threads to terminate before throwing an AssertionError if new threads are detected.

This method can be used in testing scenarios to ensure that no unexpected threads have been left running.

assertNoNewThreads

public void assertNoNewThreads(int delay,
                               @NotNull
                               @NotNull TimeUnit delayUnit)

Asserts that no new threads are running beyond the ones that existed at the time this ThreadDump instance was created. This method waits for a specified delay for threads to terminate before throwing an AssertionError if new threads are detected.

Parameters:

delay - the extra time to wait for threads to terminate

delayUnit - the time unit of the delay parameter