jhelp.util.thread

Class ThreadElement<PARAMETER,RESULT,PROGRESS>

java.lang.Object

jhelp.util.thread.ThreadElement<PARAMETER,RESULT,PROGRESS>

Type Parameters:

PARAMETER - Parameter type

RESULT - Result type

PROGRESS - Progress type

All Implemented Interfaces:

java.lang.Comparable<ThreadElement<PARAMETER,RESULT,PROGRESS>>

final class ThreadElement<PARAMETER,RESULT,PROGRESS>
extends java.lang.Object
implements java.lang.Comparable<ThreadElement<PARAMETER,RESULT,PROGRESS>>

Describes a thread element.
For ThreadManager internal use only

Author:

JHelp

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	alive Indicates if the element is alive
private int	id Thread element ID
private static int	nextId Next thread element ID
private PARAMETER	parameter Parameter to give to the thread
private java.util.concurrent.locks.ReentrantLock	reentrantLock For synchronize
private long	repeatTime Repeat time
private ThreadedTask<PARAMETER,RESULT,PROGRESS>	threadedTask Task to do
private long	timeToAct Time when do the action

Constructor Summary

Constructors

Constructor and Description
ThreadElement(ThreadedTask<PARAMETER,RESULT,PROGRESS> threadedTask, PARAMETER parameter, long timeToAct) Create a new instance of ThreadElement
ThreadElement(ThreadedTask<PARAMETER,RESULT,PROGRESS> threadedTask, PARAMETER parameter, long timeToAct, long repeatTime) Create a new instance of ThreadElement

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(ThreadElement<PARAMETER,RESULT,PROGRESS> threadElement) Compare the element to an other.
(package private) void	destroy() Destroy properly the element to free some memory
(package private) boolean	doRepeat() Apply the repeat time, if need
(package private) int	getID() Thread element ID
(package private) long	getTimeToAct() Time when do the task
(package private) boolean	isAlive() Indicates if the element still alive
void	run() Do the action

Methods inherited from class java.lang.Object

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

Field Detail

nextId

private static int nextId

Next thread element ID

alive

private boolean alive

Indicates if the element is alive

id

private int id

Thread element ID

parameter

private PARAMETER parameter

Parameter to give to the thread

reentrantLock

private final java.util.concurrent.locks.ReentrantLock reentrantLock

For synchronize

repeatTime

private long repeatTime

Repeat time

threadedTask

private ThreadedTask<PARAMETER,RESULT,PROGRESS> threadedTask

Task to do

timeToAct

private long timeToAct

Time when do the action

Constructor Detail

ThreadElement

ThreadElement(ThreadedTask<PARAMETER,RESULT,PROGRESS> threadedTask,
             PARAMETER parameter,
             long timeToAct)

Create a new instance of ThreadElement

Parameters:

threadedTask - Task to do

parameter - Parameter to give to the task

timeToAct - Time when do the task

ThreadElement

ThreadElement(ThreadedTask<PARAMETER,RESULT,PROGRESS> threadedTask,
             PARAMETER parameter,
             long timeToAct,
             long repeatTime)

Create a new instance of ThreadElement

Parameters:

threadedTask - Task to do

parameter - Parameter to give to the task

timeToAct - Time when do the task

repeatTime - Repeat time

Method Detail

destroy

void destroy()

Destroy properly the element to free some memory

doRepeat

boolean doRepeat()

Apply the repeat time, if need

Returns:

true if the task need to be repeat. false if the task is just do once

getID

int getID()

Thread element ID

Returns:

Thread element ID

getTimeToAct

long getTimeToAct()

Time when do the task

Returns:

Time when do the task

isAlive

boolean isAlive()

Indicates if the element still alive

Returns:

true if the element still alive

compareTo

public int compareTo(ThreadElement<PARAMETER,RESULT,PROGRESS> threadElement)

Compare the element to an other.
It returns :

-1	If is is before the compared task
0	If It is on same time as compared task
1	If it is after the compared task

Parent documentation:

Specified by:

compareTo in interface java.lang.Comparable<ThreadElement<PARAMETER,RESULT,PROGRESS>>

Parameters:

threadElement - Element to compare

Returns:

Comparison result

See Also:

Comparable.compareTo(java.lang.Object)

run

public void run()

Do the action