org.kitteh.irc.client.library.util

Class QueueProcessingThread<Type>

java.lang.Object

java.lang.Thread

org.kitteh.irc.client.library.util.QueueProcessingThread<Type>

Type Parameters:

Type - type of items queued

All Implemented Interfaces:

Runnable

Direct Known Subclasses:

QueueProcessingThreadSender

public abstract class QueueProcessingThread<Type>
extends Thread

Self starting processor of queued items on its own thread.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

Thread.State, Thread.UncaughtExceptionHandler

Field Summary

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	QueueProcessingThread(@NonNull String name) Creates a thread and starts itself.

Method Summary

Modifier and Type	Method and Description
protected void	cleanup(@NonNull Queue<Type> remainingQueue) This method is called after the thread has been interrupted.
boolean	contains(Type item) Gets if the queue contains a specified item.
@NonNull Queue<Type>	getQueue() Gets a copy of the queue in its current state.
protected abstract void	processElement(Type element) Processes an element from the queue.
void	queue(Type item) Queues an item.
void	run()

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

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

Constructor Detail

QueueProcessingThread

protected QueueProcessingThread(@NonNull String name)

Creates a thread and starts itself.

Parameters:

name - name of the thread

Method Detail

run

public void run()

Specified by:

run in interface Runnable

Overrides:

run in class Thread

cleanup

protected void cleanup(@NonNull Queue<Type> remainingQueue)

This method is called after the thread has been interrupted.

Parameters:

remainingQueue - the queue

processElement

protected abstract void processElement(Type element)

Processes an element from the queue.

Parameters:

element - next element from the queue

contains

public boolean contains(Type item)

Gets if the queue contains a specified item.

Parameters:

item - the item

Returns:

true if the item is in the queue

getQueue

public @NonNull Queue<Type> getQueue()

Gets a copy of the queue in its current state.

Returns:

a queue copy

queue

public void queue(Type item)

Queues an item.

Parameters:

item - item to queue