org.javasimon

Class IncrementalSimonsPurger

java.lang.Object

org.javasimon.IncrementalSimonsPurger

public final class IncrementalSimonsPurger
extends Object

This class implements periodical removing of old incremental Simons for specified Manager. Unused incremental samples can cause memory leaks and performance degradation and should be purged regularly. Purger can be in one of two states: stopped or started. When an instance of the class is create it is in the stopped stated. Method start(long, java.util.concurrent.TimeUnit) changes state of the class to started. In this state periodical Simons purging is performed. To stop purging one need to call cancel(). This method will change current state of the object to stopped. All other state transitions except from stopped to started or from started to stopped are forbidden. This class is thread safe. Here is a code example of how to configure IncrementalSimonsPurger to clean all outdated incremental Simons once a day for default manager:

 Manager manager = SimonManager.manager();
 IncrementalSimonsPurger incrementalSimonsPurger = new IncrementalSimonsPurger(manager);
 incrementalSimonsPurger.start(1, TimeUnit.DAYS);
 
 

Author:

Ivan Mushketyk

Constructor Summary

Constructors

Constructor and Description
IncrementalSimonsPurger(Manager manager) Create Simons purger for the specified Manager.

Method Summary

Methods

Modifier and Type	Method and Description
void	cancel() Cancel periodical Simons purging if it was started.
void	start(long period, TimeUnit timeUnit) Start periodical Simons purging with the specified period.

Methods inherited from class java.lang.Object

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

Constructor Detail

IncrementalSimonsPurger

public IncrementalSimonsPurger(Manager manager)

Create Simons purger for the specified Manager.

Parameters:

manager - manager for which old incremental Simons will be purged

Method Detail

start

public void start(long period,
         TimeUnit timeUnit)

Start periodical Simons purging with the specified period.

Parameters:

period - duration of purging period

timeUnit - time unit of period duration

cancel

public void cancel()

Cancel periodical Simons purging if it was started.