com.austinv11.collectiveframework.multithreading

Class HeavyCalculations

java.lang.Object

com.austinv11.collectiveframework.multithreading.HeavyCalculations

public class HeavyCalculations
extends java.lang.Object

This class is used to simplify multithreading for performance by delegating multiple concurrent calculations across a variable amount of threads

Constructor Summary

Constructors

Constructor and Description
HeavyCalculations(int numberOfThreads) Constructor for HeavyCalculations

Method Summary

Methods

Modifier and Type	Method and Description
java.util.concurrent.Future<ICalculations>	addCalculation(java.lang.Class calculationClass, java.lang.String methodToCalculate, java.lang.Object... params) Adds a calculation to the queues by wrapping a class to implement ICalculations, used for static methods when the class can't be instantiated This method is discouraged! It is meant for objects where it isn't possible to implement ICalculations
<T> java.util.concurrent.Future<T>	addCalculation(T calculation) Adds a calculation to the queues
<T> java.util.concurrent.Future<T>	addCalculation(T calculation, java.lang.String methodToCalculate, java.lang.Object... params) Adds a calculation to the queues by wrapping an object to implement ICalculations This method is discouraged! It is meant for objects where it isn't possible to implement ICalculations
boolean	isDead() Use this to check if you could add calculations
void	kill() Stops further calculations from occurring You can no longer add calculations after this!

Methods inherited from class java.lang.Object

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

Constructor Detail

HeavyCalculations

public HeavyCalculations(int numberOfThreads)

Constructor for HeavyCalculations

Parameters:

numberOfThreads - The number of threads to delegate calculations to

Method Detail

addCalculation

public <T> java.util.concurrent.Future<T> addCalculation(T calculation)

Adds a calculation to the queues

Parameters:

calculation - The calculation it MUST implement ICalculations

Returns:

A future representing the eventual calculation Future.get() returns the object passed, although after the calculations finished

addCalculation

public <T> java.util.concurrent.Future<T> addCalculation(T calculation,
                                                java.lang.String methodToCalculate,
                                                java.lang.Object... params)

Adds a calculation to the queues by wrapping an object to implement ICalculations This method is discouraged! It is meant for objects where it isn't possible to implement ICalculations

Parameters:

calculation - The object representing the calculations

methodToCalculate - The method to call for calculations

params - The parameters for the method

Returns:

A future representing the eventual calculation Future.get() returns the object passed, although after the calculations finished

addCalculation

public java.util.concurrent.Future<ICalculations> addCalculation(java.lang.Class calculationClass,
                                                        java.lang.String methodToCalculate,
                                                        java.lang.Object... params)

Adds a calculation to the queues by wrapping a class to implement ICalculations, used for static methods when the class can't be instantiated This method is discouraged! It is meant for objects where it isn't possible to implement ICalculations

Parameters:

calculationClass - The class representing the calculations

methodToCalculate - The method to call for calculations

params - The parameters for the method

Returns:

A future representing the eventual calculation Future.get() returns null

kill

public void kill()

Stops further calculations from occurring You can no longer add calculations after this!

isDead

public boolean isDead()

Use this to check if you could add calculations

Returns:

True if this is dead