org.uma.jmetal.util.measure.impl

Class ListenerTimeMeasure

java.lang.Object

org.uma.jmetal.util.naming.impl.SimpleDescribedEntity

org.uma.jmetal.util.measure.impl.SimpleMeasure<Value>

org.uma.jmetal.util.measure.impl.SimplePullMeasure<Long>

org.uma.jmetal.util.measure.impl.ListenerTimeMeasure

All Implemented Interfaces:

Serializable, Measure<Long>, PullMeasure<Long>, DescribedEntity

public class ListenerTimeMeasure
extends SimplePullMeasure<Long>
implements PullMeasure<Long>

This measure is a facility to evaluate the time spent in MeasureListeners registered in PushMeasures. In order to measure the time spent in a MeasureListener, you should wrap it by calling wrapListener(MeasureListener). The wrapper returned should be used instead of the original MeasureListener to allow the ListenerTimeMeasure to account for its execution time. If you want to wrap automatically all the MeasureListeners registered to a given PushMeasure, you can wrap the PushMeasure through wrapMeasure(PushMeasure): all the MeasureListeners registered to the wrapper will be wrapped too. You can restart the evaluation by calling reset().

Notice that the time accounted is not the physical time but the processing time: if several listeners run in parallel, their execution time is summed as if they were running sequentially, thus you can have a measured time which is superior to the physical time spent. If you want to measure the physical time spent in the execution of parallel runs, you should use another way.

Author:

Matthieu Vergne

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ListenerTimeMeasure()

Method Summary

Modifier and Type	Method and Description
Long	get()
void	reset() This method reset the time measured to zero.
<Value> MeasureListener<Value>	wrapListener(MeasureListener<Value> wrapped) This method wrap a MeasureListener (the wrapped) into another one (the wrapper).
<Value> MeasureManager	wrapManager(MeasureManager wrapped, Object measureKey) This method wrap a MeasureManager (the wrapped) into another one (the wrapper) which provides the same measures, excepted that any PushMeasure returned by the wrapper will be automatically wrapped via wrapMeasure(PushMeasure).
<Value> PushMeasure<Value>	wrapMeasure(PushMeasure<Value> wrapped) This method wrap a PushMeasure (the wrapped) into another one (the wrapper).

Methods inherited from class org.uma.jmetal.util.naming.impl.SimpleDescribedEntity

getDescription, getName, setDescription, setName, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.uma.jmetal.util.naming.DescribedEntity

getDescription, getName

Constructor Detail

ListenerTimeMeasure

public ListenerTimeMeasure()

Method Detail

wrapListener

public <Value> MeasureListener<Value> wrapListener(MeasureListener<Value> wrapped)

This method wrap a MeasureListener (the wrapped) into another one (the wrapper). Any notification made via the wrapper will allow to measure how much time has been spent by the wrapped to treat this notification.

The wrapped listener is not changed, thus it can be reused in other PushMeasures that we don't want to consider. If a wrapper has already been made for the given wrapped, it will be returned and no new one will be instantiated (weak references are used to not keep in memory the unused wrappers).

Parameters:

wrapped - the MeasureListener to wrap

Returns:

the MeasureListener wrapper

wrapMeasure

public <Value> PushMeasure<Value> wrapMeasure(PushMeasure<Value> wrapped)

This method wrap a PushMeasure (the wrapped) into another one (the wrapper). Any MeasureListener registered to the wrapper will be automatically wrapped via wrapListener(MeasureListener). This allows to ensure that any MeasureListener registered will be considered, independently of who registers it or when it is registered.

The wrapped measure is not changed, thus it can be reused to register MeasureListeners that we don't want to consider. If a wrapper has already been made for the given wrapped, it will be returned and no new one will be instantiated (weak references are used to not keep in memory the unused wrappers).

Parameters:

wrapped - the PushMeasure to wrap

Returns:

the PushMeasure wrapper

wrapManager

public <Value> MeasureManager wrapManager(MeasureManager wrapped,
                                          Object measureKey)

This method wrap a MeasureManager (the wrapped) into another one (the wrapper) which provides the same measures, excepted that any PushMeasure returned by the wrapper will be automatically wrapped via wrapMeasure(PushMeasure). This allows to ensure that any MeasureListener registered to the PushMeasures provided by the wrapper will be considered, independently of who registers it or when it is registered. You can also provide an additional key to add this ListenerTimeMeasure to the wrapper.

The wrapped manager is not changed, thus it can be reused to register MeasureListeners that we don't want to consider.

Parameters:

wrapped - the MeasureManager to wrap

measureKey - the key that the wrapper should use for this ListenerTimeMeasure, null if it should not use it

Returns:

the MeasureManager wrapper

get

public Long get()

Specified by:

get in interface PullMeasure<Long>

Returns:

the time spent in the wrapped MeasureListeners

reset

public void reset()

This method reset the time measured to zero. Notice that MeasureListeners which are still running will be affected consequently: their execution time will be measured from the reset time, not from their own starting time.