io.sarl.sre.services.executor

Class SreExecutable

java.lang.Object

io.sarl.sre.services.executor.SreExecutable

public abstract class SreExecutable
extends Object

Abstract implementation of a task that could be run on the JRE executor service. See Runnables for creating an instance.

Since:

0.6

Version:

io.janusproject.plugin 0.12.0 20210527-171007

Author:

Stéphane Galland

See Also:

Runnables

Maven Group Id:

io.janusproject.sre

Maven Artifact Id:

io.janusproject.plugin

Field Summary

Fields

Modifier and Type	Field and Description
protected Throwable	exception

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SreExecutable(logger : Logger) Constructor.

Method Summary

Modifier and Type	Method and Description
protected static String	exceptionMessage(ex : Throwable) Replies a not-empty message for the given exception.
Throwable	getException() Replies the exception that has stopped the task.
Logger	getLogger() Replies the logger.
protected static Throwable	getRootCause(ex : Throwable) Replies the root cause of the given exception.
boolean	isSuccess() Replies if the task was finished on a success.
protected boolean	onError(error : Throwable) Invoked when an error occurs into the task and after this error is logged out.
protected void	onFinished() Invoked when the task is finished whatever it is successful or failing.

Methods inherited from class java.lang.Object

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

Field Detail

exception

protected volatile var exception : Throwable

Constructor Detail

SreExecutable

protected new(logger : Logger)

Constructor. See Runnables for creating an instance.

Parameters:

logger - the logger to use.

Method Detail

getLogger

@Pure
public def getLogger() : Logger 

Description copied from class: SreExecutable

Replies the logger.

Returns:

the logger, or null if the platform logger should be used.

exceptionMessage

@Pure
protected static def exceptionMessage(ex : Throwable) : String 

Description copied from class: SreExecutable

Replies a not-empty message for the given exception.

Parameters:

ex - the exception.

Returns:

the error message.

getRootCause

@Pure
protected static def getRootCause(ex : Throwable) : Throwable 

Description copied from class: SreExecutable

Replies the root cause of the given exception.

Parameters:

ex - the exception for which the root cause msut be determined.

Returns:

the root cause, never null.

isSuccess

@Pure
public def isSuccess() : boolean 

Description copied from class: SreExecutable

Replies if the task was finished on a success.

Returns:

true if the task if finished and successful. false if the task is not not finished or successful.

getException

@Pure
public def getException() : Throwable 

Description copied from class: SreExecutable

Replies the exception that has stopped the task.

Returns:

the exception or null if the task was successfully finished.

Since:

0.11

onError

@Pure
protected def onError(error : Throwable) : boolean 

Description copied from class: SreExecutable

Invoked when an error occurs into the task and after this error is logged out. The default implementation does nothing.

Parameters:

error - the error.

Returns:

true if the error should be thrown in the current thread. false if the exception is not thrown.

Since:

0.11

onFinished

protected def onFinished() : void 

Description copied from class: SreExecutable

Invoked when the task is finished whatever it is successful or failing. The default implementation does nothing.

Parameters:

error - the error.

Since:

0.11