com.screenscraper.concurrent

Enum ThreadGroupManager

java.lang.Object

java.lang.Enum<ThreadGroupManager>

com.screenscraper.concurrent.ThreadGroupManager

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ThreadGroupManager>

public enum ThreadGroupManager
extends java.lang.Enum<ThreadGroupManager>

A simple manager for tracking thread groups

Version:

1.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
Manager The manager instance

Method Summary

Modifier and Type	Method and Description
java.lang.ThreadGroup	getBackgroundTaskThreadGroup() Returns the default thread group for the background tasks
java.lang.ThreadGroup	getMainThreadGroup() Returns the main thread group for the thread manager
java.lang.ThreadGroup	getNamedChildGroup(java.lang.ThreadGroup parentGroup, java.lang.String name) Gets the thread group with the given name from the parent (immediate children only)
java.lang.ThreadGroup	getNamedChildGroup(java.lang.ThreadGroup parentGroup, java.lang.String name, java.util.function.Function<? super java.lang.String,? extends java.lang.ThreadGroup> mappingFunction) Gets the thread group with the given name from the parent (immediate children only).
java.lang.ThreadGroup	getNamedGroup(java.lang.String name) Returns a thread group with the given name, or creates one as a child of the system group if none currently exists
java.lang.ThreadGroup	getNamedGroup(java.lang.String name, java.util.function.Function<? super java.lang.String,? extends java.lang.ThreadGroup> mappingFunction) Returns a thread group with the given name, or creates one using the mapping function if none currently exists
java.lang.ThreadGroup	getSystemThreadGroup() Returns the system thread group for the JVM
static ThreadGroupManager	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ThreadGroupManager[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Manager

public static final ThreadGroupManager Manager

The manager instance

Method Detail

values

public static ThreadGroupManager[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ThreadGroupManager c : ThreadGroupManager.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ThreadGroupManager valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getSystemThreadGroup

public java.lang.ThreadGroup getSystemThreadGroup()

Returns the system thread group for the JVM

Returns:

The system thread group for the JVM

getMainThreadGroup

public java.lang.ThreadGroup getMainThreadGroup()

Returns the main thread group for the thread manager

Returns:

The main thread group for the thread manager

getBackgroundTaskThreadGroup

@NotNull
public java.lang.ThreadGroup getBackgroundTaskThreadGroup()

Returns the default thread group for the background tasks

Returns:

The default thread group for the background tasks

getNamedGroup

@NotNull
public java.lang.ThreadGroup getNamedGroup(@NotNull
                                                     java.lang.String name)

Returns a thread group with the given name, or creates one as a child of the system group if none currently exists

Parameters:

name - The name of the group to get

Returns:

The group

getNamedGroup

@NotNull
public java.lang.ThreadGroup getNamedGroup(@NotNull
                                                     java.lang.String name,
                                                     @NotNull
                                                     java.util.function.Function<? super java.lang.String,? extends java.lang.ThreadGroup> mappingFunction)

Returns a thread group with the given name, or creates one using the mapping function if none currently exists

Parameters:

name - The name of the group to get

mappingFunction - The function used to create the thread group if it doesn't already exist

Returns:

The group, or creates one using the mapping function if none currently exists

getNamedChildGroup

@Nullable
public java.lang.ThreadGroup getNamedChildGroup(@NotNull
                                                           java.lang.ThreadGroup parentGroup,
                                                           @NotNull
                                                           java.lang.String name)

Gets the thread group with the given name from the parent (immediate children only)

Parameters:

parentGroup - The parent group

name - The name of the child group to get

Returns:

The Thread group, or null if there wasn't a matching group

getNamedChildGroup

@NotNull
public java.lang.ThreadGroup getNamedChildGroup(@NotNull
                                                          java.lang.ThreadGroup parentGroup,
                                                          @NotNull
                                                          java.lang.String name,
                                                          @NotNull
                                                          java.util.function.Function<? super java.lang.String,? extends java.lang.ThreadGroup> mappingFunction)

Gets the thread group with the given name from the parent (immediate children only). If no such group exists, one is created using the given function

Parameters:

parentGroup - The parent group

name - The name of the child group to get

mappingFunction - A function used to create the thread group if it doesn't exist currently

Returns:

The Thread group