org.eth.cyril.bugfixer

Class PermutationGroups

java.lang.Object

org.eth.cyril.bugfixer.PermutationGroups

public class PermutationGroups
extends java.lang.Object

A class which handles the grouping of the permutation tester. This class is thread-safe and can be accessed by both a reader reading results and a writer adding results at the same time. Methods for readers may be non thread-safe. Methods which are not thread-safe are declared as such.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PermutationGroups.PermutationGroup A single permutation group, which contains a collection of argument permutations which all lead to the same result.

Constructor Summary

Constructors

Constructor and Description
PermutationGroups()

Method Summary

Modifier and Type	Method and Description
void	addFinalizeListener(Executor listener) Adds a new listener to be notified when the finalize() method is called.
void	addNewGroupListener(java.util.function.Consumer<PermutationGroups.PermutationGroup> listener) Adds a new listener to be notified when new permutation groups are added.
void	addStartListener(Executor listener) Adds a new listener to be notified when the start() method is called.
void	finalize() Mark that there are no more results to be submitted.
PermutationGroups.PermutationGroup	getPermutationGroup(JavaResult result, java.util.List<?> input, TestAllPermutations.JavaResultComparer comparer) Gets the permutation group for the given result and comparer.
java.util.Collection<PermutationGroups.PermutationGroup>	getPermutationGroups() Gets the current view of the existing permutation groups.
boolean	isFinalized() Check whether finalize() has been called.
boolean	isStarted() Returns whether calculation should have already started.
boolean	isStopped() Returns whether calculation should be stopped.
void	removeFinalizeListener(Executor listener) Removes a listener to be notified when the finalize method is called.
void	removeNewGroupListener(java.util.function.Consumer<PermutationGroups.PermutationGroup> listener) Removes a listener to be notified when new permutation groups are added.
void	removeStartListener(Executor listener) Removes a listener to be notified when the start method is called.
void	start() Allow to start the actual calculation.
void	stop() Allow to stop the actual calculation.

Methods inherited from class java.lang.Object

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

Constructor Detail

PermutationGroups

public PermutationGroups()

Method Detail

start

public void start()

Allow to start the actual calculation. Any client performing work on this instance must ensure that isStarted() is true, before any work is performed. The startListeners will be notified the first time this method is called.

isStarted

public boolean isStarted()

Returns whether calculation should have already started.

stop

public void stop()

Allow to stop the actual calculation. Any client performing work on this instance should not perform any additional work after they notice that the stop flag is set. Note however, that clients MAY still perform work after stop - only after finalize is called they are not allowed to anymore.

isStopped

public boolean isStopped()

Returns whether calculation should be stopped.

getPermutationGroup

public PermutationGroups.PermutationGroup getPermutationGroup(JavaResult result,
                                                              java.util.List<?> input,
                                                              TestAllPermutations.JavaResultComparer comparer)

Gets the permutation group for the given result and comparer. If no group exists yet, a new permutation group is created and listeners are notified. This method may not be called after finalize has been called.

Parameters:

result - The execution result.

input - The execution input.

comparer - The result comparer.

Returns:

The permutation group for the given result and comparer.

Throws:

java.lang.IllegalStateException - If the result has been finalized.

getPermutationGroups

public java.util.Collection<PermutationGroups.PermutationGroup> getPermutationGroups()

Gets the current view of the existing permutation groups. The collection is created once per call. This means that changes to the existing groups are still recorded, however newly added groups will not become part of this collection. If the finalize() method has been called correctly previous to this method, then no permutation groups may be added afterwards.

finalize

public void finalize()

Mark that there are no more results to be submitted. All finalize listeners are then notified. This method may be called multiple times from different threads, but the finalize listeners are guaranteed to be called only once. This method must be called after all threads have terminated.

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.IllegalStateException - If a thread is still in the critical section of getting a group.

isFinalized

public boolean isFinalized()

Check whether finalize() has been called.

addNewGroupListener

public void addNewGroupListener(java.util.function.Consumer<PermutationGroups.PermutationGroup> listener)

Adds a new listener to be notified when new permutation groups are added. Note that if multiple groups are added in parallel, the order in which they are returned to the listener is not defined. However, they are certainly passed on to the listener. The notification always happens in the same thread, listeners therefore do not need to be thread-safe. This method is not thread-safe.

Parameters:

listener - The listener which is notified about the permutation groups which were added.

addFinalizeListener

public void addFinalizeListener(Executor listener)

Adds a new listener to be notified when the finalize() method is called. The listener will be called at most once per PermutationGroups instance. After this listener is called, it is guaranteed that no new permutation groups may be added. This method is not thread-safe.

Parameters:

executor - The listener which is notified about the finalize method being called.

addStartListener

public void addStartListener(Executor listener)

Adds a new listener to be notified when the start() method is called. The listener will be called at most once per PermutationGroups instance. This method is not thread-safe.

Parameters:

listener - The listener which is notified about the start method being called.

removeNewGroupListener

public void removeNewGroupListener(java.util.function.Consumer<PermutationGroups.PermutationGroup> listener)

Removes a listener to be notified when new permutation groups are added. This method is not thread-safe.

Parameters:

listener - The listener to be removed.

removeFinalizeListener

public void removeFinalizeListener(Executor listener)

Removes a listener to be notified when the finalize method is called. This method is not thread-safe.

Parameters:

listener - The listener to be removed.

removeStartListener

public void removeStartListener(Executor listener)

Removes a listener to be notified when the start method is called. This method is not thread-safe.

Parameters:

listener - The listener to be removed.