Primitive-Collections/src/main/java/speiger/src/collections/utils/SanityChecks.java

package speiger.src.collections.utils;

import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

import java.util.Random;
import java.util.concurrent.ForkJoinPool;
import java.util.concurrent.ForkJoinTask;

/**
 * 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
 */
public final class SanityChecks
{
	/** Max Possible ArraySize without the JVM Crashing */
	public static final int MAX_ARRAY_SIZE = Integer.MAX_VALUE - 8;
	private static ForkJoinPool WORK_POOL = ForkJoinPool.commonPool();
	private static boolean FORCE_IGNORE_PARALLELISM = false;
	private static final ThreadLocal<Random> RANDOM = ThreadLocal.withInitial(Random::new);
	private static final ThreadLocal<Boolean> FORCE_ASYNC = ThreadLocal.withInitial(() -> false);
	private static final ThreadLocal<Boolean> FORCE_TASK_POOL = ThreadLocal.withInitial(() -> false);
	
	/**
	 * Internal function to cast a Integer to a Byte
	 * @param value that should be turned into a byte
	 * @return the value as a byte
	 * @throws IllegalStateException if the value does not fit within a byte
	 */
	public static byte castToByte(int value) {
		if(value > Byte.MAX_VALUE || value < Byte.MIN_VALUE) throw new IllegalStateException("Value ["+value+"] out of Byte[-128,127] range");
		return (byte)value;
	}
	
	/**
	 * Internal function to cast a Integer to a Short
	 * @param value that should be turned into a short
	 * @return the value as a short
	 * @throws IllegalStateException if the value does not fit within a short
	 */	
	public static short castToShort(int value) {
		if(value > Short.MAX_VALUE || value < Short.MIN_VALUE) throw new IllegalStateException("Value ["+value+"] out of Short[-32768,32767] range");
		return (short)value;
	}
	
	/**
	 * Internal function to cast a Integer to a Character
	 * @param value that should be turned into a char
	 * @return the value as a char
	 * @throws IllegalStateException if the value does not fit within a char
	 */
	public static char castToChar(int value) {
		if(value > Character.MAX_VALUE || value < Character.MIN_VALUE) throw new IllegalStateException("Value ["+value+"] out of Character[0,65535] range");
		return (char)value;
	}
	
	/**
	 * Internal function to cast a Double to a Double
	 * @param value that should be turned into a float
	 * @return the value as a float
	 * @throws IllegalStateException if the value does not fit within a float
	 */
	public static float castToFloat(double value) {
		if(Double.isNaN(value)) return Float.NaN;
		if(Double.isInfinite(value)) return value > 0 ? Float.POSITIVE_INFINITY : Float.NEGATIVE_INFINITY;
		if(value < -Float.MAX_VALUE || value > Float.MAX_VALUE) throw new IllegalStateException("Value ["+value+"] out of Float range");
		return (float)value;
	}
	
	/**
	 * Internal function that checks if the given array-size is big enough for the access.
	 * @param arraySize the size of the Array
	 * @param offset the offset of the access
	 * @param accessSize the length of the access
	 * @throws IllegalStateException if offset or accessSize is negative or the range goes out of the array-size
	 */
	public static void checkArrayCapacity(int arraySize, int offset, int accessSize) {
		if(offset < 0) throw new IllegalStateException("Offset is negative ("+offset+")");
		else if(accessSize < 0) throw new IllegalStateException("Size is negative ("+accessSize+")");
		else if(arraySize < offset + accessSize) throw new IndexOutOfBoundsException("Index (" + (offset + accessSize) + ") is not in size (" + arraySize + ")");
	}
	
	/**
	 * Returns if the current thread-pool can handle Multi-threading tasks
	 * @return true if the thread-count is bigger the 1
	 */
	public static boolean canParallelTask() {
		return getPool().getParallelism() > 1 || FORCE_IGNORE_PARALLELISM;
	}
	
	/**
	 * Helper method to start a ForkJoinTask. This method will await the finalization of said task
	 * @param task the Task to invoke
	 * @param <T> the type of the task
	 */
	public static <T> void invokeTask(@NotNull ForkJoinTask<T> task) {
		if(FORCE_ASYNC.get()) invokeAsyncTask(task);
		else getPool().invoke(task);
	}
	
	/**
	 * Helper method to start a ForkJoinTask. This method will not await the finalization of said task
	 * @param task the Task to invoke
	 * @param <T> the type of the task
	 */
	public static <T> void invokeAsyncTask(@NotNull ForkJoinTask<T> task) {
		getPool().execute(task);
	}
	
	/**
	 * Helper method to control what ForkJoinPool is being used for any given task.
	 * @note this method is not thread-save. It is only there to provide control over how Library specific Threaded tasks are handled.
	 * @param pool The ForkJoinPool that should receive the tasks. If null {@link ForkJoinPool#commonPool()} is set instead
	 */
	public static void setWorkPool(@Nullable ForkJoinPool pool) {
		WORK_POOL = pool == null ? ForkJoinPool.commonPool() : pool;
	}
	
	private static @NotNull ForkJoinPool getPool() {
		if(FORCE_TASK_POOL.get()) {
			ForkJoinPool pool = ForkJoinTask.getPool();
			if(pool != null) return pool;
		}
		return WORK_POOL;
	}
	
	/**
	 * Helper method to detect if the Current Thread forces not to await task completion.
	 * @return if the Current Thread has not to await task completion.
	 */
	public static boolean isForcedAsync() {
		return FORCE_ASYNC.get();
	}
	
	/**
	 * Helper method to detect if the current thread forces to execute tasks in the current Thread-pool if it is a ForkJoinPool.
	 * @return if the task checks the current pool to be executed in if it is valid.
	 */
	public static boolean isForcedTaskPool() {
		return FORCE_TASK_POOL.get();
	}
	
	/**
	 * Helper method to decide if the current thread should forcefully not wait on tasks to be completed.
	 * @param value it tasks should not be awaited for
	 */
	public static void setForcedAsync(boolean value) {
		FORCE_ASYNC.set(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.
	 * @param value if the current thread should check if it is a ThreadPoolWorker.
	 */
	public static void setForcedTaskPool(boolean value) {
		FORCE_TASK_POOL.set(value);
	}
	
	/**
	 * Helper method to decide if Parallelism should be checked or not.
	 * @param value if the Parallelism should be ignored
	 */
	public static void setForceIgnoreParallelism(boolean value) {
		FORCE_IGNORE_PARALLELISM = value;
	}
	
	/**
	 * @return Thread Specific Random needed for internal functions in this library.
	 */
	public static @NotNull Random getRandom() {
		return RANDOM.get();
	}
}