net.sf.ehcache.writer.writebehind

Class NonStopWriteBehind

java.lang.Object

net.sf.ehcache.writer.writebehind.NonStopWriteBehind

All Implemented Interfaces:

WriteBehind

public class NonStopWriteBehind
extends Object
implements WriteBehind

Non stop class for write behind

Author:

npurwar

Constructor Summary

Constructors

Constructor and Description
NonStopWriteBehind()

Method Summary

Modifier and Type	Method and Description
void	delete(CacheEntry entry) Add a delete operation for the given cache entry
long	getQueueSize() Gets the best estimate for items in the queue still awaiting processing.
void	init(WriteBehind writeBehind)
void	setOperationsFilter(OperationsFilter filter) Set the operations filter that should be used.
void	start(CacheWriter writerParam) Start the write behind queue with a cache writer
void	stop() Stop the coordinator and all the internal data structures.
void	write(Element element) Add a write operation for a given element.

Methods inherited from class java.lang.Object

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

Constructor Detail

NonStopWriteBehind

public NonStopWriteBehind()

Method Detail

init

public void init(WriteBehind writeBehind)

Parameters:

writeBehind -

start

public void start(CacheWriter writerParam)
           throws CacheException

Description copied from interface: WriteBehind

Start the write behind queue with a cache writer

Specified by:

start in interface WriteBehind

Parameters:

writerParam - the cache writer that should be used to process the operations

Throws:

CacheException

See Also:

WriteBehind.stop()

write

public void write(Element element)

Description copied from interface: WriteBehind

Add a write operation for a given element.

Specified by:

write in interface WriteBehind

Parameters:

element - the element for which a write operation will be added to the write behind queue

delete

public void delete(CacheEntry entry)

Description copied from interface: WriteBehind

Add a delete operation for the given cache entry

Specified by:

delete in interface WriteBehind

Parameters:

entry - the cache entry for which a delete operation will be added to the write behind queue

setOperationsFilter

public void setOperationsFilter(OperationsFilter filter)

Description copied from interface: WriteBehind

Set the operations filter that should be used.

Specified by:

setOperationsFilter in interface WriteBehind

Parameters:

filter - the filter that will be used as of now

stop

public void stop()
          throws CacheException

Description copied from interface: WriteBehind

Stop the coordinator and all the internal data structures.

This stops as quickly as possible without losing any previously added items. However, no guarantees are made towards the processing of these items. It's highly likely that items are still inside the internal data structures and not processed.

Specified by:

stop in interface WriteBehind

Throws:

CacheException

See Also:

WriteBehind.start(net.sf.ehcache.writer.CacheWriter)

getQueueSize

public long getQueueSize()

Description copied from interface: WriteBehind

Gets the best estimate for items in the queue still awaiting processing. Not including elements currently processed

Specified by:

getQueueSize in interface WriteBehind

Returns:

the amount of elements still awaiting processing.