com.ebay.bascomtask.core

Enum SpawnMode

java.lang.Object

java.lang.Enum<SpawnMode>

com.ebay.bascomtask.core.SpawnMode

All Implemented Interfaces:

Serializable, Comparable<SpawnMode>

public enum SpawnMode
extends Enum<SpawnMode>

Defines thread spawning behavior for the BascomTask framework.

Author:

Brendan McCarthy

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALWAYS_SPAWN Always spawn except for 'light' task methods.
DONT_SPAWN_UNLESS_EXPLICIT Don't spawn unless a TaskInterface.runSpawned() request is made on a task.
NEVER_MAIN Avoid using main (calling thread) to execute task methods, spawning threads instead, unless the task methods are marked as 'light'.
NEVER_SPAWN Never spawn under any circumstance.
WHEN_NEEDED Spawn whenever more than one task can be started at the same time.
WHEN_NEEDED_NO_REUSE Like WHEN_NEEDED, but avoids any attempt to reuse main thread for processing.

Method Summary

Modifier and Type	Method and Description
boolean	isMainThreadReusable() Returns true if this mode allows for the main thread can be picked up while idle and otherwise waiting for a CompletableFuture to complete, and used to to process spawning task methods.
static SpawnMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static SpawnMode[]	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

WHEN_NEEDED

public static final SpawnMode WHEN_NEEDED

Spawn whenever more than one task can be started at the same time. This is the default behavior.

WHEN_NEEDED_NO_REUSE

public static final SpawnMode WHEN_NEEDED_NO_REUSE

Like WHEN_NEEDED, but avoids any attempt to reuse main thread for processing. That 'reuse' occurs when the main thread is sitting idle with no work to do while spawned threads need themselves to spawn threads.

NEVER_MAIN

public static final SpawnMode NEVER_MAIN

Avoid using main (calling thread) to execute task methods, spawning threads instead, unless the task methods are marked as 'light'. This keeps the calling thread free for other purposes.

ALWAYS_SPAWN

public static final SpawnMode ALWAYS_SPAWN

Always spawn except for 'light' task methods. This is a stronger assertion then NEVER_MAIN, as the main thread will similarly not execute any tasks. Every task will run in its own logical thread (as in a pull from the thread pool, where physical threads may of course be reused).

NEVER_SPAWN

public static final SpawnMode NEVER_SPAWN

Never spawn under any circumstance. Every task will be run in the calling thread when activated.

DONT_SPAWN_UNLESS_EXPLICIT

public static final SpawnMode DONT_SPAWN_UNLESS_EXPLICIT

Don't spawn unless a TaskInterface.runSpawned() request is made on a task.

Method Detail

values

public static SpawnMode[] 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 (SpawnMode c : SpawnMode.values())
    System.out.println(c);

Returns:

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

valueOf

public static SpawnMode valueOf(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:

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

NullPointerException - if the argument is null

isMainThreadReusable

public boolean isMainThreadReusable()

Returns true if this mode allows for the main thread can be picked up while idle and otherwise waiting for a CompletableFuture to complete, and used to to process spawning task methods.

Returns:

true iff main thread is reusable