Package com.oracle.coherence.concurrent.executor.tasks

Class CronTask<T>

java.lang.Object

com.oracle.coherence.concurrent.executor.tasks.CronTask<T>

Type Parameters:

T - the type of the Task

All Implemented Interfaces:

Task<T>, TaskExecutorService.Registration.Option, com.tangosol.io.ExternalizableLite, com.tangosol.io.pof.PortableObject, Serializable

public class CronTask<T>
extends Object
implements Task<T>, com.tangosol.io.pof.PortableObject, TaskExecutorService.Registration.Option

A Task that can run repeatedly at scheduled time, like a crontab job.

Since:

21.12

Author:

lh, bo

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.oracle.coherence.concurrent.executor.Task

Task.Collectable<T,R>, Task.Collector<T,A,R>, Task.Completable<T,R>, Task.CompletionRunnable<T>, Task.Context<T>, Task.Coordinator<T>, Task.Option, Task.Orchestration<T>, Task.Properties, Task.SubscribedOrchestration<T>, Task.Subscriber<T>, Task.Subscription<T>, Task.Yield

Field Summary

Fields

Modifier and Type	Field	Description
protected long	m_ldtNextExecutionMillis	The next execution time.
protected Task<T>	m_origTask	The original Task.
protected String	m_sCronPattern	The crontab scheduling pattern for the Task.
protected Task<T>	m_task	The actual Task.

Constructor Summary

Constructors

Constructor	Description
CronTask()	Constructs a CronTask (required for serialization).
CronTask(Task<T> task, String sPattern)	Constructs a CronTask.

Method Summary

Modifier and Type	Method	Description
static Object	clone(Object object)	Creates a clone of the given object.
boolean	equals(Object o)
T	execute(Task.Context<T> context)	Executes the Task.
String	getCronPattern()	Returns the crontab schedule pattern.
long	getNextExecutionMillis(long cMillis)	Returns the next execution time in milliseconds.
Task<T>	getTask()	Obtains the CronTask.
int	hashCode()
static <T> CronTask<T>	of(Task<T> task, String sCronPattern)	Obtains a CronTask.
void	readExternal(com.tangosol.io.pof.PofReader in)
void	readExternal(DataInput in)
String	toString()
void	writeExternal(com.tangosol.io.pof.PofWriter out)
void	writeExternal(DataOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

m_origTask

protected Task<T> m_origTask

The original Task.

m_task

protected Task<T> m_task

The actual Task.

m_sCronPattern

protected String m_sCronPattern

The crontab scheduling pattern for the Task.

m_ldtNextExecutionMillis

protected long m_ldtNextExecutionMillis

The next execution time.

Constructor Detail

CronTask

public CronTask()

Constructs a CronTask (required for serialization).

CronTask

public CronTask(Task<T> task,
                String sPattern)

Constructs a CronTask.

Parameters:

task - the task

sPattern - the crontab scheduling pattern

Method Detail

getTask

public Task<T> getTask()

Obtains the CronTask.

Returns:

the CronTask

getCronPattern

public String getCronPattern()

Returns the crontab schedule pattern.

Returns:

the crontab schedule pattern

getNextExecutionMillis

public long getNextExecutionMillis(long cMillis)

Returns the next execution time in milliseconds.

Parameters:

cMillis - The timestamp, as a UNIX-era millis value.

Returns:

the next execution time in milliseconds

execute

public T execute(Task.Context<T> context)
          throws Exception

Description copied from interface: Task

Executes the Task.

Specified by:

execute in interface Task<T>

Parameters:

context - the Task.Context

Returns:

the result of executing the Task

Throws:

Task.Yield - which indicates the Task execution should yield execution until some later point in time

Exception

readExternal

public void readExternal(DataInput in)
                  throws IOException

Specified by:

readExternal in interface com.tangosol.io.ExternalizableLite

Throws:

IOException

writeExternal

public void writeExternal(DataOutput out)
                   throws IOException

Specified by:

writeExternal in interface com.tangosol.io.ExternalizableLite

Throws:

IOException

readExternal

public void readExternal(com.tangosol.io.pof.PofReader in)
                  throws IOException

Specified by:

readExternal in interface com.tangosol.io.pof.PortableObject

Throws:

IOException

writeExternal

public void writeExternal(com.tangosol.io.pof.PofWriter out)
                   throws IOException

Specified by:

writeExternal in interface com.tangosol.io.pof.PortableObject

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

clone

public static Object clone(Object object)

Creates a clone of the given object.

Parameters:

object - the object to clone

Returns:

the cloned object

of

public static <T> CronTask<T> of(Task<T> task,
                                 String sCronPattern)

Obtains a CronTask.

Type Parameters:

T - the type of the Task

Parameters:

task - the task to be scheduled

sCronPattern - the task schedule pattern

Returns:

a CronTask