Package eu.cloudnetservice.driver.module

Class DefaultModuleTaskEntry

java.lang.Object

eu.cloudnetservice.driver.module.DefaultModuleTaskEntry

All Implemented Interfaces:

ModuleTaskEntry

public class DefaultModuleTaskEntry
extends Object
implements ModuleTaskEntry

Represents the default implementation of the module task entry.

Since:

4.0

See Also:

• ModuleTaskEntry

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	fullMethodSignatureCached
protected final InjectionLayer<?>	injectionLayer
protected static final String	METHOD_SIGNATURE_FORMAT	A simple format which allows unique method identifiers.
protected final dev.derklaro.reflexion.MethodAccessor<?>	methodAccessor
protected final ModuleTask	moduleTask
protected final ModuleWrapper	moduleWrapper
protected final dev.derklaro.aerogel.Element[]	paramTypes

Constructor Summary

Constructors

Constructor	Description
DefaultModuleTaskEntry(@NonNull ModuleWrapper wrapper, @NonNull ModuleTask task, @NonNull Method method)	Constructs a new instance of this class.

Method Summary

Modifier and Type	Method	Description
void	fire()	Fires this module task.
@NonNull String	fullMethodSignature()	Get the full method signature of the detected method.
@NonNull Module	module()	The module (or module main class) this task was detected in.
@NonNull ModuleWrapper	moduleWrapper()	The associated module wrapper this task was detected by.
@NonNull ModuleTask	taskInfo()	The annotation holding the information about this task.

Methods inherited from class java.lang.Object

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

Field Details

METHOD_SIGNATURE_FORMAT

protected static final String METHOD_SIGNATURE_FORMAT

A simple format which allows unique method identifiers. Format: declaring class@method name()

See Also:

• Constant Field Values

methodAccessor

protected final dev.derklaro.reflexion.MethodAccessor<?> methodAccessor

paramTypes

protected final dev.derklaro.aerogel.Element[] paramTypes

injectionLayer

protected final InjectionLayer<?> injectionLayer

moduleTask

protected final ModuleTask moduleTask

moduleWrapper

protected final ModuleWrapper moduleWrapper

fullMethodSignatureCached

protected final String fullMethodSignatureCached

Constructor Details

DefaultModuleTaskEntry

public DefaultModuleTaskEntry(@NonNull
 @NonNull ModuleWrapper wrapper,
 @NonNull
 @NonNull ModuleTask task,
 @NonNull
 @NonNull Method method)
                       throws IllegalAccessException

Constructs a new instance of this class.

Parameters:

wrapper - the module wrapper associated with this task entry.

task - the module task annotation based on which this entry was created.

method - the method which was annotated with ModuleTask.

Throws:

IllegalAccessException - if access checking for the provided method fails.

NullPointerException - if wrapper, task or method is null.

Method Details

module

@NonNull
public @NonNull Module module()

The module (or module main class) this task was detected in.

Specified by:

module in interface ModuleTaskEntry

Returns:

the associated module to this task.

moduleWrapper

@NonNull
public @NonNull ModuleWrapper moduleWrapper()

The associated module wrapper this task was detected by.

Specified by:

moduleWrapper in interface ModuleTaskEntry

Returns:

the associated module wrapper to this task.

See Also:

• DefaultModuleWrapper.resolveModuleTasks(Module)

taskInfo

@NonNull
public @NonNull ModuleTask taskInfo()

The annotation holding the information about this task.

Specified by:

taskInfo in interface ModuleTaskEntry

Returns:

the task information.

fullMethodSignature

@NonNull
public @NonNull String fullMethodSignature()

Get the full method signature of the detected method. This must not be in the standard java signature declaration format. However, this descriptor must be unique for debug reasons.

Specified by:

fullMethodSignature in interface ModuleTaskEntry

Returns:

a unique descriptor of the method in the main module class.

fire

public void fire()
          throws Throwable

Fires this module task.

Specified by:

fire in interface ModuleTaskEntry

Throws:

Throwable - anything thrown by the underlying method.