org.hobbit.controller.queue

Class InMemoryQueue

java.lang.Object

org.hobbit.controller.queue.InMemoryQueue

All Implemented Interfaces:

ExperimentQueue

public class InMemoryQueue
extends Object
implements ExperimentQueue

A simple in-memory implementation of the ExperimentQueue interface that can be used for JUnit tests.

Author:

Michael Röder (roeder@informatik.uni-leipzig.de)

Field Summary

Fields

Modifier and Type	Field and Description
private Deque<ExperimentConfiguration>	queue

Constructor Summary

Constructors

Constructor and Description
InMemoryQueue()

Method Summary

Modifier and Type	Method and Description
void	add(ExperimentConfiguration experiment) Adds the given experiment to the queue.
ExperimentConfiguration	getExperiment(String experimentId) Retrieves the experiment configuration with the given experiment id.
ExperimentConfiguration	getNextExperiment() Returns the experiment that should be executed next.
List<ExperimentConfiguration>	listAll() Returns the list of all experiments waiting in this queue.
boolean	remove(ExperimentConfiguration experiment) Removes the experiment from the queue.

Methods inherited from class java.lang.Object

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

Field Detail

queue

private Deque<ExperimentConfiguration> queue

Constructor Detail

InMemoryQueue

public InMemoryQueue()

Method Detail

getNextExperiment

public ExperimentConfiguration getNextExperiment()

Description copied from interface: ExperimentQueue

Returns the experiment that should be executed next.

Specified by:

getNextExperiment in interface ExperimentQueue

Returns:

the experiment that should be executed next

add

public void add(ExperimentConfiguration experiment)

Description copied from interface: ExperimentQueue

Adds the given experiment to the queue.

Specified by:

add in interface ExperimentQueue

Parameters:

experiment - the experiment that should be added

remove

public boolean remove(ExperimentConfiguration experiment)

Description copied from interface: ExperimentQueue

Removes the experiment from the queue.

Specified by:

remove in interface ExperimentQueue

Parameters:

experiment - the experiment that should be removed from the queue

Returns:

true if the given experiment has been removed

listAll

public List<ExperimentConfiguration> listAll()

Description copied from interface: ExperimentQueue

Returns the list of all experiments waiting in this queue.

Specified by:

listAll in interface ExperimentQueue

Returns:

the list of all experiments waiting in this queue

getExperiment

public ExperimentConfiguration getExperiment(String experimentId)

Description copied from interface: ExperimentQueue

Retrieves the experiment configuration with the given experiment id.

Specified by:

getExperiment in interface ExperimentQueue

Parameters:

experimentId - the id of the experiment that should be retrieved

Returns:

the experiment configuration or null if such an experiment can not be found