com.austinv11.collectiveframework.multithreading

Class SimpleRunnable

java.lang.Object

com.austinv11.collectiveframework.multithreading.SimpleRunnable

All Implemented Interfaces:

java.lang.Runnable

Direct Known Subclasses:

DependencyManager.DownloadFuture.DownloadRunnable

public abstract class SimpleRunnable
extends java.lang.Object
implements java.lang.Runnable

Runnable class to ease the management of threads

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	RESTRICT_THREAD_USAGE

Constructor Summary

Constructors

Constructor and Description
SimpleRunnable()

Method Summary

Methods

Modifier and Type	Method and Description
void	delay(int delay) Delays the given thread from running
void	disable(boolean clean) Disables this thread from running
void	enable() Attempts to reenable this thread
boolean	equals(java.lang.Object other)
java.lang.String	getName() Gets the name of the thread
boolean	isCleaned() Gets whether is runnable is cleaned
boolean	isEnabled() Gets whether the runnable is running
abstract void	run() Called by the thread to run this runnable
void	setTicking(long delay) Makes the thread loop every x milliseconds
void	start() Runs a thread with this runnable
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

RESTRICT_THREAD_USAGE

public static volatile boolean RESTRICT_THREAD_USAGE

Constructor Detail

SimpleRunnable

public SimpleRunnable()

Method Detail

disable

public final void disable(boolean clean)
                   throws java.lang.IllegalThreadStateException

Disables this thread from running

Parameters:

clean - Whether to clean the thread running - This will prevent this runnable from being able to run, only cleans if enabled in the config

Throws:

java.lang.IllegalThreadStateException

enable

public final void enable()
                  throws java.lang.IllegalThreadStateException

Attempts to reenable this thread

Throws:

java.lang.IllegalThreadStateException

start

public final void start()

Runs a thread with this runnable

run

public abstract void run()

Called by the thread to run this runnable

Specified by:

run in interface java.lang.Runnable

getName

public java.lang.String getName()

Gets the name of the thread

Returns:

The name

delay

public final void delay(int delay)
                 throws java.lang.InterruptedException

Delays the given thread from running

Parameters:

delay - The length of the delay (in milliseconds)

Throws:

java.lang.InterruptedException

isCleaned

public boolean isCleaned()

Gets whether is runnable is cleaned

Returns:

IsCleaned

isEnabled

public boolean isEnabled()

Gets whether the runnable is running

Returns:

IsEnabled

setTicking

public void setTicking(long delay)

Makes the thread loop every x milliseconds

Parameters:

delay - The delay for each loop, in milliseconds

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object