Package dev.zemco.codegame.evaluation

Class TimeoutSolutionEvaluatorDecorator

java.lang.Object

dev.zemco.codegame.evaluation.TimeoutSolutionEvaluatorDecorator

All Implemented Interfaces:

ISolutionEvaluator

public class TimeoutSolutionEvaluatorDecorator
extends Object
implements ISolutionEvaluator

Enforces maximum step count for a given evaluation. If maximum number of steps is surpassed, the evaluation is considered finished unsuccessfully and TimeoutException is thrown.

Author:

Erik Zemčík

Constructor Summary

Constructors

Constructor	Description
TimeoutSolutionEvaluatorDecorator(ISolutionEvaluator wrappedEvaluator, int maxStepCount)	Creates an instance of TimeoutSolutionEvaluatorDecorator which wraps an existing evaluator.

Method Summary

Modifier and Type	Method	Description
IExecutionContext	getExecutionContext()	Returns the execution context that is being evaluated by the evaluator.
boolean	hasFinished()	Checks if the evaluator has finished its evaluation.
boolean	isSuccessful()	Checks if the evaluation of the execution context is successful.
void	step()	Steps the decorated evaluator if the maximum allowed number of steps was not reached.

Methods inherited from class java.lang.Object

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

Constructor Details

TimeoutSolutionEvaluatorDecorator

public TimeoutSolutionEvaluatorDecorator(ISolutionEvaluator wrappedEvaluator,
 int maxStepCount)

Creates an instance of TimeoutSolutionEvaluatorDecorator which wraps an existing evaluator.

Parameters:

wrappedEvaluator - evaluator to decorate

maxStepCount - maximum allowed number of steps to be enforced

Throws:

IllegalArgumentException - if wrappedEvaluator is null or if maxStepCount is a negative integer

Method Details

hasFinished

public boolean hasFinished()

Description copied from interface: ISolutionEvaluator

Checks if the evaluator has finished its evaluation.

Specified by:

hasFinished in interface ISolutionEvaluator

Returns:

true if evaluator has finished, else false

isSuccessful

public boolean isSuccessful()

Description copied from interface: ISolutionEvaluator

Checks if the evaluation of the execution context is successful. Result of this method should only be considered if the evaluator has finished its evaluation.

Specified by:

isSuccessful in interface ISolutionEvaluator

Returns:

true if the evaluation has ended and is successful, else false

getExecutionContext

public IExecutionContext getExecutionContext()

Description copied from interface: ISolutionEvaluator

Returns the execution context that is being evaluated by the evaluator.

Specified by:

getExecutionContext in interface ISolutionEvaluator

Returns:

evaluated execution context

step

public void step()

Steps the decorated evaluator if the maximum allowed number of steps was not reached. If the maximum number of steps was reached, the evaluation is considered finished as a failure and the TimeoutException is thrown with the details of the failure.

Specified by:

step in interface ISolutionEvaluator

Throws:

TimeoutException - if maximum allowed number of steps was reached

StepEvaluationException - if underlying execution threw an exception during the step

IllegalStateException - if step was attempted when evaluation has already finished

See Also:

• ISolutionEvaluator.step()