eu.cqse.check.framework.core

Class CheckInstance

java.lang.Object

eu.cqse.check.framework.core.CheckInstance

public class CheckInstance
extends java.lang.Object

A instance of a custom check. Multiple CheckInstances of one CheckImplementationBase subtype can exist in order to be executed in parallel by multiple worker threads (each CheckInstance is backed by a separate instance of the CheckImplementationBase subtype).

Constructor Summary

Constructors

Constructor and Description
CheckInstance(CheckInfo checkInfo) Creates a new check instance with the given check info.

Method Summary

Modifier and Type	Method and Description
void	execute() Executes this check with the given context.
CheckImplementationBase	getCheckImplementation()
CheckInfo	getCheckInfo()
void	initialize() Initializes the check.
void	initializeAndSetContext(ICheckContext context) Initializes the underlying check implementation (calls CheckImplementationBase.initialize()) and then sets the check context of the underlying check implementation to the given one.
<T> void	setOption(java.lang.String name, T value) Sets the option with the given name to the given value.

Methods inherited from class java.lang.Object

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

Constructor Detail

CheckInstance

public CheckInstance(CheckInfo checkInfo)
              throws CheckException

Creates a new check instance with the given check info. This given check info must not be null.

Throws:

CheckException

Method Detail

initialize

public void initialize()
                throws CheckException

Initializes the check.

Throws:

CheckException

execute

public void execute()
             throws CheckException

Executes this check with the given context.

Throws:

CheckException

getCheckImplementation

public CheckImplementationBase getCheckImplementation()

See Also:

checkImplementation

getCheckInfo

public CheckInfo getCheckInfo()

See Also:

checkInfo

initializeAndSetContext

public void initializeAndSetContext(ICheckContext context)
                             throws CheckException

Initializes the underlying check implementation (calls CheckImplementationBase.initialize()) and then sets the check context of the underlying check implementation to the given one.

Throws:

CheckException

setOption

public <T> void setOption(java.lang.String name,
                          T value)

Sets the option with the given name to the given value.