com.explodingbacon.bcnlib.utils

Class CodeThread

java.lang.Object

com.explodingbacon.bcnlib.utils.CodeThread

All Implemented Interfaces:

java.lang.Runnable

Direct Known Subclasses:

AbstractOI

public class CodeThread
extends java.lang.Object
implements java.lang.Runnable

A class that allows us to easily write code that will run in its own separate thread.

Constructor Summary

Constructors

Constructor and Description
CodeThread() Creates a CodeThread.
CodeThread(boolean l) Creates a CodeThread.
CodeThread(boolean l, java.lang.Runnable r) Creates a CodeThread that will run r (possibly repeatedly).
CodeThread(java.lang.Runnable r) Creates a CodeThread that will repeatedly run r.

Method Summary

Modifier and Type	Method and Description
void	code() Override this with what code you want to run in the thread.
boolean	isRunning() Returns whether or not this CodeThread is currently running.
void	run() Don't touch this, we take care of it.
CodeThread	setName(java.lang.String name) Sets the name of this CodeThread.
void	start() Start this CodeThread
void	stop() Stop execution of this CodeThread

Methods inherited from class java.lang.Object

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

Constructor Detail

CodeThread

public CodeThread()

Creates a CodeThread.

CodeThread

public CodeThread(java.lang.Runnable r)

Creates a CodeThread that will repeatedly run r.

Parameters:

r - The code to be repeatedly.

CodeThread

public CodeThread(boolean l)

Creates a CodeThread.

Parameters:

l - If the CodeThread will loop.

CodeThread

public CodeThread(boolean l,
                  java.lang.Runnable r)

Creates a CodeThread that will run r (possibly repeatedly).

Parameters:

r - The code to be run.

Method Detail

start

public void start()

Start this CodeThread

run

public void run()

Don't touch this, we take care of it.

Specified by:

run in interface java.lang.Runnable

code

public void code()

Override this with what code you want to run in the thread.

stop

public void stop()

Stop execution of this CodeThread

isRunning

public boolean isRunning()

Returns whether or not this CodeThread is currently running.

Returns:

Whether or not this CodeThread is currently running.

setName

public CodeThread setName(java.lang.String name)

Sets the name of this CodeThread.

Parameters:

name - The name.

Returns:

This CodeThread.