speiger.src.collections.utils

Class SanityChecks

java.lang.Object

speiger.src.collections.utils.SanityChecks

public class SanityChecks
extends java.lang.Object

Helper class that provides functions that are shared within the library. On top of that it provides some helper functions that allow control of some internals of the Library

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_ARRAY_SIZE Max Possible ArraySize without the JVM Crashing

Constructor Summary

Constructors

Constructor and Description
SanityChecks()

Method Summary

Modifier and Type	Method and Description
static boolean	canParallelTask() Returns if the current thread-pool can handle Multi-threading tasks
static byte	castToByte(int value) Internal function to cast a Integer to a Byte
static char	castToChar(int value) Internal function to cast a Integer to a Character
static float	castToFloat(double value) Internal function to cast a Double to a Double
static short	castToShort(int value) Internal function to cast a Integer to a Short
static void	checkArrayCapacity(int arraySize, int offset, int accessSize) Internal function that checks if the given array-size is big enough for the access.
static java.util.Random	getRandom()
static <T> void	invokeAsyncTask(java.util.concurrent.ForkJoinTask<T> task) Helper method to start a ForkJoinTask.
static void	invokeAsyncTask(java.lang.Runnable task) A Helper method to start a Async Task.
static <T> void	invokeTask(java.util.concurrent.ForkJoinTask<T> task) Helper method to start a ForkJoinTask.
static boolean	isForcedAsync() Helper method to detect if the Current Thread forces not to await task completion.
static boolean	isForcedTaskPool() Helper method to detect if the current thread forces to execute tasks in the current Thread-pool if it is a ForkJoinPool.
static void	setForcedAsync(boolean value) Helper method to decide if the current thread should forcefully not wait on tasks to be completed.
static void	setForcedTaskPool(boolean value) Helper method to decide if it should be checked for if the current thread is a ThreadPool Worker (ForkJoinPool Worker to be specific) and if tasks should be delegated into it.
static void	setForceIgnoreParallelism(boolean value) Helper method to decide if Parallelism should be checked or not.
static void	setWorkPool(java.util.concurrent.ForkJoinPool pool) Helper method to control what ForkJoinPool is being used for any given task.

Methods inherited from class java.lang.Object

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

Field Detail

MAX_ARRAY_SIZE

public static final int MAX_ARRAY_SIZE

Max Possible ArraySize without the JVM Crashing

See Also:

Constant Field Values

Constructor Detail

SanityChecks

public SanityChecks()

Method Detail

castToByte

public static byte castToByte(int value)

Internal function to cast a Integer to a Byte

Parameters:

value - that should be turned into a byte

Returns:

the value as a byte

Throws:

java.lang.IllegalStateException - if the value does not fit within a byte

castToShort

public static short castToShort(int value)

Internal function to cast a Integer to a Short

Parameters:

value - that should be turned into a short

Returns:

the value as a short

Throws:

java.lang.IllegalStateException - if the value does not fit within a short

castToChar

public static char castToChar(int value)

Internal function to cast a Integer to a Character

Parameters:

value - that should be turned into a char

Returns:

the value as a char

Throws:

java.lang.IllegalStateException - if the value does not fit within a char

castToFloat

public static float castToFloat(double value)

Internal function to cast a Double to a Double

Parameters:

value - that should be turned into a float

Returns:

the value as a float

Throws:

java.lang.IllegalStateException - if the value does not fit within a float

checkArrayCapacity

public static void checkArrayCapacity(int arraySize,
                                      int offset,
                                      int accessSize)

Internal function that checks if the given array-size is big enough for the access.

Parameters:

arraySize - the size of the Array

offset - the offset of the access

accessSize - the length of the access

Throws:

java.lang.IllegalStateException - if offset or accessSize is negative or the range goes out of the array-size

canParallelTask

public static boolean canParallelTask()

Returns if the current thread-pool can handle Multi-threading tasks

Returns:

true if the thread-count is bigger the 1

invokeTask

public static <T> void invokeTask(java.util.concurrent.ForkJoinTask<T> task)

Helper method to start a ForkJoinTask. This method will await the finalization of said task

Type Parameters:

T - the type of the task

Parameters:

task - the Task to invoke

invokeAsyncTask

public static <T> void invokeAsyncTask(java.util.concurrent.ForkJoinTask<T> task)

Helper method to start a ForkJoinTask. This method will not await the finalization of said task

Type Parameters:

T - the type of the task

Parameters:

task - the Task to invoke

invokeAsyncTask

public static void invokeAsyncTask(java.lang.Runnable task)

A Helper method to start a Async Task. This method will not await the finalization of said task

Parameters:

task - the Task to invoke

setWorkPool

public static void setWorkPool(java.util.concurrent.ForkJoinPool pool)

Helper method to control what ForkJoinPool is being used for any given task.

Parameters:

pool - The ForkJoinPool that should receive the tasks. If null ForkJoinPool.commonPool() is set instead

Note:

this method is not thread-save. It is only there to provide control over how Library specific Threaded tasks are handled.

isForcedAsync

public static boolean isForcedAsync()

Helper method to detect if the Current Thread forces not to await task completion.

Returns:

if the Current Thread has not to await task completion.

isForcedTaskPool

public static boolean isForcedTaskPool()

Helper method to detect if the current thread forces to execute tasks in the current Thread-pool if it is a ForkJoinPool.

Returns:

if the task checks the current pool to be executed in if it is valid.

setForcedAsync

public static void setForcedAsync(boolean value)

Helper method to decide if the current thread should forcefully not wait on tasks to be completed.

Parameters:

value - it tasks should not be awaited for

setForcedTaskPool

public static void setForcedTaskPool(boolean value)

Helper method to decide if it should be checked for if the current thread is a ThreadPool Worker (ForkJoinPool Worker to be specific) and if tasks should be delegated into it.

Parameters:

value - if the current thread should check if it is a ThreadPoolWorker.

setForceIgnoreParallelism

public static void setForceIgnoreParallelism(boolean value)

Helper method to decide if Parallelism should be checked or not.

Parameters:

value - if the Parallelism should be ignored

getRandom

public static java.util.Random getRandom()

Returns:

Thread Specific Random needed for internal functions in this library.