Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	CacheWriterConfiguration.CacheWriterFactoryConfiguration Configuration for the CacheWriterFactoryConfiguration.
public static enum	CacheWriterConfiguration.WriteMode Represents how elements are written to the `net.sf.ehcache.writer.CacheWriter`

Field Summary

Modifier and Type	Field and Description
private CacheWriterConfiguration.CacheWriterFactoryConfiguration	cacheWriterFactoryConfiguration
public static final int	DEFAULT_MAX_WRITE_DELAY Default maximum write delay
public static final int	DEFAULT_MIN_WRITE_DELAY Default minimum write delay
public static final boolean	DEFAULT_NOTIFY_LISTENERS_ON_EXCEPTION Default notifyListenersOnException behavior
public static final int	DEFAULT_RATE_LIMIT_PER_SECOND Default rate limit per second
public static final int	DEFAULT_RETRY_ATTEMPT_DELAY_SECONDS Default retry attempt delay
public static final int	DEFAULT_RETRY_ATTEMPTS Default retry attempts
public static final int	DEFAULT_WRITE_BATCH_SIZE Default write batch size
public static final boolean	DEFAULT_WRITE_BATCHING Default writeBatching behavior
public static final int	DEFAULT_WRITE_BEHIND_CONCURRENCY Default concurrency level for write behind
public static final int	DEFAULT_WRITE_BEHIND_MAX_QUEUE_SIZE Default max queue size for write behind
public static final boolean	DEFAULT_WRITE_COALESCING Default write coalescing behavior
public static final CacheWriterConfiguration.WriteMode	DEFAULT_WRITE_MODE Default writeMode
private int	maxWriteDelay
private int	minWriteDelay
private boolean	notifyListenersOnException
private int	rateLimitPerSecond
private int	retryAttemptDelaySeconds
private int	retryAttempts
private boolean	writeBatching
private int	writeBatchSize
private int	writeBehindConcurrency
private int	writeBehindMaxQueueSize
private boolean	writeCoalescing
private CacheWriterConfiguration.WriteMode	writeMode

Constructor Summary

Access	Constructor and Description
public	CacheWriterConfiguration()

Method Summary

Modifier and Type	Method and Description
public final void	addCacheWriterFactory(CacheWriterConfiguration.CacheWriterFactoryConfiguration cacheWriterFactoryConfiguration) Allows BeanHandler to add the CacheWriterFactory to the configuration.
public CacheWriterConfiguration	Returns: this configuration instance cacheWriterFactory(CacheWriterConfiguration.CacheWriterFactoryConfiguration cacheWriterFactory)
public CacheWriterConfiguration	Returns: a copy, which independent other than configurations than cannot change. clone() Overrides java.lang.Object.clone. Clones this object, following the usual contract.
public boolean	equals(Object the reference object with which to compare. obj) Overrides java.lang.Object.equals. Overrided equals()
public CacheWriterConfiguration.CacheWriterFactoryConfiguration	Returns: the configuration getCacheWriterFactoryConfiguration() Accessor
public int	getMaxWriteDelay() Get the maximum number of seconds to wait before writing behind
public int	getMinWriteDelay() Get the minimum number of seconds to wait before writing behind
public boolean	getNotifyListenersOnException() Check whether listeners should be notified when an exception occurs on a writer operation
public int	getRateLimitPerSecond() Get the maximum number of write operations to allow per second.
public int	getRetryAttemptDelaySeconds() Retrieves the number of seconds to wait before retrying an failed operation.
public int	getRetryAttempts() Retrieves the number of times the write of element is retried.
public boolean	getWriteBatching() Check whether write operations should be batched
public int	getWriteBatchSize() Retrieves the size of the batch operation.
public int	Returns: the amount of bucket/thread pairs configured for this cache's write behind getWriteBehindConcurrency() Accessor
public int	Returns: the maximum amount of operations allowed on the write behind queue getWriteBehindMaxQueueSize() Accessor
public boolean	Returns: this configuration instance getWriteCoalescing()
public CacheWriterConfiguration.WriteMode	getWriteMode() Get the write mode in terms of the mode enum
public int	hashCode() Overrides java.lang.Object.hashCode. Overrided hashCode()
public CacheWriterConfiguration	Returns: this configuration instance maxWriteDelay(int maxWriteDelay)
public CacheWriterConfiguration	Returns: this configuration instance minWriteDelay(int minWriteDelay)
public CacheWriterConfiguration	Returns: this configuration instance notifyListenersOnException(boolean notifyListenersOnException)
public CacheWriterConfiguration	Returns: this configuration instance rateLimitPerSecond(int rateLimitPerSecond)
public CacheWriterConfiguration	Returns: this configuration instance retryAttemptDelaySeconds(int retryAttemptDelaySeconds)
public CacheWriterConfiguration	Returns: this configuration instance retryAttempts(int retryAttempts)
public void	setMaxWriteDelay(int the maximum number of seconds to wait before writing behind maxWriteDelay) Set the maximum number of seconds to wait before writing behind.
public void	setMinWriteDelay(int the minimum number of seconds to wait before writing behind minWriteDelay) Set the minimum number of seconds to wait before writing behind.
public void	setNotifyListenersOnException(boolean `true` if listeners should be notified when an exception occurs on a writer operation; `false` otherwise notifyListenersOnException) Sets whether to notify listeners when an exception occurs on a writer operation.
public void	setRateLimitPerSecond(int the number of write operations to allow; use a number `<=0` to disable rate limiting. rateLimitPerSecond) Sets the maximum number of write operations to allow per second when `writeBatching` is enabled.
public void	setRetryAttemptDelaySeconds(int the number of seconds to wait before retrying an operation retryAttemptDelaySeconds) Sets the number of seconds to wait before retrying an failed operation.
public void	setRetryAttempts(int the number of retries for a particular element retryAttempts) Sets the number of times the operation is retried in the `CacheWriter`, this happens after the original operation.
public void	setWriteBatching(boolean `true` if write operations should be batched; `false` otherwise writeBatching) Sets whether to batch write operations.
public void	setWriteBatchSize(int the number of operations to include in each batch; numbers smaller than `1` will cause the default batch size to be used writeBatchSize) Sets the number of operations to include in each batch when `writeBatching` is enabled.
public void	setWriteBehindConcurrency(int Amount of thread/bucket pairs, has to be at least 1 concurrency) Configures the amount of thread/bucket pairs WriteBehind should use
public void	setWriteBehindMaxQueueSize(final int maximum amount of operations allowed on the waiting queue writeBehindMaxQueueSize) Configures the maximum amount of operations to be on the waiting queue, before it blocks
public void	setWriteCoalescing(boolean `true` to enable write coalescing; or `false` to disable it writeCoalescing) Sets whether to use write coalescing.
public void	setWriteMode(String writeMode) Converts the `writeMode` string argument to uppercase and looks up enum constant in WriteMode.
public void	validate(Collection<ConfigError> collection to add errors to. errors) Check for errors/inconsistencies in this configuration.
public CacheWriterConfiguration	Returns: this configuration instance writeBatching(boolean writeBatching)
public CacheWriterConfiguration	Returns: this configuration instance writeBatchSize(int writeBatchSize)
public CacheWriterConfiguration	Returns: this configuration instance writeBehindConcurrency(int Amount of thread/bucket pairs, has to be at least 1 concurrency)
public CacheWriterConfiguration	Returns: this configuration instance writeBehindMaxQueueSize(int maximum amount of operations allowed on the waiting queue writeBehindMaxQueueSize)
public CacheWriterConfiguration	Returns: this configuration instance writeCoalescing(boolean writeCoalescing)
public CacheWriterConfiguration	Returns: this configuration instance writeMode(String writeMode)
public CacheWriterConfiguration	Returns: this configuration instance writeMode(CacheWriterConfiguration.WriteMode writeMode)

Inherited from java.lang.Object:: finalize getClass notify notifyAll toString wait wait wait

Field Detail

cacheWriterFactoryConfiguration	back to summary
private CacheWriterConfiguration.CacheWriterFactoryConfiguration cacheWriterFactoryConfiguration

DEFAULT_MAX_WRITE_DELAY	back to summary
public static final int DEFAULT_MAX_WRITE_DELAY Default maximum write delay

DEFAULT_MIN_WRITE_DELAY	back to summary
public static final int DEFAULT_MIN_WRITE_DELAY Default minimum write delay

DEFAULT_NOTIFY_LISTENERS_ON_EXCEPTION	back to summary
public static final boolean DEFAULT_NOTIFY_LISTENERS_ON_EXCEPTION Default notifyListenersOnException behavior

DEFAULT_RATE_LIMIT_PER_SECOND	back to summary
public static final int DEFAULT_RATE_LIMIT_PER_SECOND Default rate limit per second

DEFAULT_RETRY_ATTEMPT_DELAY_SECONDS	back to summary
public static final int DEFAULT_RETRY_ATTEMPT_DELAY_SECONDS Default retry attempt delay

DEFAULT_RETRY_ATTEMPTS	back to summary
public static final int DEFAULT_RETRY_ATTEMPTS Default retry attempts

DEFAULT_WRITE_BATCH_SIZE	back to summary
public static final int DEFAULT_WRITE_BATCH_SIZE Default write batch size

DEFAULT_WRITE_BATCHING	back to summary
public static final boolean DEFAULT_WRITE_BATCHING Default writeBatching behavior

DEFAULT_WRITE_BEHIND_CONCURRENCY	back to summary
public static final int DEFAULT_WRITE_BEHIND_CONCURRENCY Default concurrency level for write behind

DEFAULT_WRITE_BEHIND_MAX_QUEUE_SIZE	back to summary
public static final int DEFAULT_WRITE_BEHIND_MAX_QUEUE_SIZE Default max queue size for write behind

DEFAULT_WRITE_COALESCING	back to summary
public static final boolean DEFAULT_WRITE_COALESCING Default write coalescing behavior

DEFAULT_WRITE_MODE	back to summary
public static final CacheWriterConfiguration.WriteMode DEFAULT_WRITE_MODE Default writeMode

maxWriteDelay	back to summary
private int maxWriteDelay

minWriteDelay	back to summary
private int minWriteDelay

notifyListenersOnException	back to summary
private boolean notifyListenersOnException

rateLimitPerSecond	back to summary
private int rateLimitPerSecond

retryAttemptDelaySeconds	back to summary
private int retryAttemptDelaySeconds

retryAttempts	back to summary
private int retryAttempts

writeBatching	back to summary
private boolean writeBatching

writeBatchSize	back to summary
private int writeBatchSize

writeBehindConcurrency	back to summary
private int writeBehindConcurrency

writeBehindMaxQueueSize	back to summary
private int writeBehindMaxQueueSize

writeCoalescing	back to summary
private boolean writeCoalescing

writeMode	back to summary
private CacheWriterConfiguration.WriteMode writeMode

Constructor Detail

CacheWriterConfiguration	back to summary
public CacheWriterConfiguration()

Method Detail

addCacheWriterFactory	back to summary
public final void addCacheWriterFactory(CacheWriterConfiguration.CacheWriterFactoryConfiguration cacheWriterFactoryConfiguration) Allows BeanHandler to add the CacheWriterFactory to the configuration.

cacheWriterFactory	back to summary
public CacheWriterConfiguration cacheWriterFactory(CacheWriterConfiguration.CacheWriterFactoryConfiguration cacheWriterFactory) Returns:CacheWriterConfiguration this configuration instance See Also `addCacheWriterFactory(CacheWriterFactoryConfiguration)`

clone	back to summary
public CacheWriterConfiguration clone() Overrides java.lang.Object.clone. Clones this object, following the usual contract. Returns:CacheWriterConfiguration a copy, which independent other than configurations than cannot change. Annotations @Override

clone

back to summary

public CacheWriterConfiguration clone()

Overrides java.lang.Object.clone.

Clones this object, following the usual contract.

Returns:CacheWriterConfiguration

a copy, which independent other than configurations than cannot change.

Annotations

@Override

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Overrided equals() Parameters obj:Object Doc from java.lang.Object.equals. the reference object with which to compare. Returns:boolean Doc from java.lang.Object.equals. `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Overrided equals()

Parameters

obj:Object

Doc from java.lang.Object.equals.

the reference object with which to compare.

Returns:boolean

Doc from java.lang.Object.equals.

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getCacheWriterFactoryConfiguration	back to summary
public CacheWriterConfiguration.CacheWriterFactoryConfiguration getCacheWriterFactoryConfiguration() Accessor Returns:CacheWriterConfiguration.CacheWriterFactoryConfiguration the configuration

getCacheWriterFactoryConfiguration

back to summary

public CacheWriterConfiguration.CacheWriterFactoryConfiguration getCacheWriterFactoryConfiguration()

Accessor

Returns:CacheWriterConfiguration.CacheWriterFactoryConfiguration: the configuration

getMaxWriteDelay	back to summary
public int getMaxWriteDelay() Get the maximum number of seconds to wait before writing behind

getMinWriteDelay	back to summary
public int getMinWriteDelay() Get the minimum number of seconds to wait before writing behind

getNotifyListenersOnException	back to summary
public boolean getNotifyListenersOnException() Check whether listeners should be notified when an exception occurs on a writer operation

getRateLimitPerSecond	back to summary
public int getRateLimitPerSecond() Get the maximum number of write operations to allow per second.

getRetryAttemptDelaySeconds	back to summary
public int getRetryAttemptDelaySeconds() Retrieves the number of seconds to wait before retrying an failed operation.

getRetryAttempts	back to summary
public int getRetryAttempts() Retrieves the number of times the write of element is retried.

getWriteBatching	back to summary
public boolean getWriteBatching() Check whether write operations should be batched

getWriteBatchSize	back to summary
public int getWriteBatchSize() Retrieves the size of the batch operation.

getWriteBehindConcurrency	back to summary
public int getWriteBehindConcurrency() Accessor Returns:int the amount of bucket/thread pairs configured for this cache's write behind

getWriteBehindConcurrency

back to summary

public int getWriteBehindConcurrency()

Accessor

Returns:int: the amount of bucket/thread pairs configured for this cache's write behind

getWriteBehindMaxQueueSize	back to summary
public int getWriteBehindMaxQueueSize() Accessor Returns:int the maximum amount of operations allowed on the write behind queue

getWriteBehindMaxQueueSize

back to summary

public int getWriteBehindMaxQueueSize()

Accessor

Returns:int: the maximum amount of operations allowed on the write behind queue

getWriteCoalescing	back to summary
public boolean getWriteCoalescing() Returns:boolean this configuration instance See Also `setWriteCoalescing(boolean)`

getWriteMode	back to summary
public CacheWriterConfiguration.WriteMode getWriteMode() Get the write mode in terms of the mode enum

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Overrided hashCode() Returns:int Doc from java.lang.Object.hashCode. a hash code value for this object. Annotations @Override

hashCode

back to summary

public int hashCode()

Overrides java.lang.Object.hashCode.

Overrided hashCode()

Returns:int

Doc from java.lang.Object.hashCode.

a hash code value for this object.

Annotations

@Override

maxWriteDelay	back to summary
public CacheWriterConfiguration maxWriteDelay(int maxWriteDelay) Returns:CacheWriterConfiguration this configuration instance See Also `setMaxWriteDelay(int)`

minWriteDelay	back to summary
public CacheWriterConfiguration minWriteDelay(int minWriteDelay) Returns:CacheWriterConfiguration this configuration instance See Also `setMinWriteDelay(int)`

notifyListenersOnException	back to summary
public CacheWriterConfiguration notifyListenersOnException(boolean notifyListenersOnException) Returns:CacheWriterConfiguration this configuration instance See Also `setNotifyListenersOnException(boolean)`

rateLimitPerSecond	back to summary
public CacheWriterConfiguration rateLimitPerSecond(int rateLimitPerSecond) Returns:CacheWriterConfiguration this configuration instance See Also `setRateLimitPerSecond(int rateLimitPerSecond)`

retryAttemptDelaySeconds	back to summary
public CacheWriterConfiguration retryAttemptDelaySeconds(int retryAttemptDelaySeconds) Returns:CacheWriterConfiguration this configuration instance See Also `setRetryAttemptDelaySeconds(int)`

retryAttempts	back to summary
public CacheWriterConfiguration retryAttempts(int retryAttempts) Returns:CacheWriterConfiguration this configuration instance See Also `setRetryAttempts(int)`

setMaxWriteDelay

back to summary

public void setMaxWriteDelay(int maxWriteDelay)

Set the maximum number of seconds to wait before writing behind. If set to a value greater than 0, it permits operations to build up in the queue to enable effective coalescing and batching optimisations.

This is only applicable to write behind mode.

Defaults to 1).

Parameters

maxWriteDelay:int: the maximum number of seconds to wait before writing behind

setMinWriteDelay back to summary

public void setMinWriteDelay(int minWriteDelay)

Set the minimum number of seconds to wait before writing behind. If set to a value greater than 0, it permits operations to build up in the queue. This is different from the maximum write delay in that by waiting a minimum amount of time, work is always being built up. If the minimum write delay is set to zero and the CacheWriter performs its work very quickly, the overhead of processing the write behind queue items becomes very noticeable in a cluster since all the operations might be done for individual items instead of for a collection of them.

This is only applicable to write behind mode.

Defaults to 1).

Parameters

minWriteDelay:int: the minimum number of seconds to wait before writing behind

setNotifyListenersOnException back to summary

public void setNotifyListenersOnException(boolean notifyListenersOnException)

Sets whether to notify listeners when an exception occurs on a writer operation.

This is only applicable to write through mode.

Defaults to false.

Parameters

notifyListenersOnException:boolean: true if listeners should be notified when an exception occurs on a writer operation; false otherwise

setRateLimitPerSecond back to summary

public void setRateLimitPerSecond(int rateLimitPerSecond)

Sets the maximum number of write operations to allow per second when writeBatching is enabled.

This is only applicable to write behind mode.

Defaults to 0.

Parameters

rateLimitPerSecond:int: the number of write operations to allow; use a number <=0 to disable rate limiting.

setRetryAttemptDelaySeconds

back to summary

public void setRetryAttemptDelaySeconds(int retryAttemptDelaySeconds)

Sets the number of seconds to wait before retrying an failed operation.

This is only applicable to write behind mode.

Defaults to 1.

Parameters

retryAttemptDelaySeconds:int: the number of seconds to wait before retrying an operation

setRetryAttempts back to summary

public void setRetryAttempts(int retryAttempts)

Sets the number of times the operation is retried in the CacheWriter, this happens after the original operation.

This is only applicable to write behind mode.

Defaults to 0.

Parameters

retryAttempts:int: the number of retries for a particular element

setWriteBatching back to summary

public void setWriteBatching(boolean writeBatching)

Sets whether to batch write operations. If set to true, net.sf.ehcache.writer.CacheWriter#writeAll and CacheWriter#deleteAll will be called rather than net.sf.ehcache.writer.CacheWriter#write and net.sf.ehcache.writer.CacheWriter#delete being called for each key. Resources such as databases can perform more efficiently if updates are batched, thus reducing load.

This is only applicable to write behind mode.

Defaults to false.

Parameters

writeBatching:boolean: true if write operations should be batched; false otherwise

setWriteBatchSize back to summary

public void setWriteBatchSize(int writeBatchSize)

Sets the number of operations to include in each batch when writeBatching is enabled. If there are less entries in the write-behind queue than the batch size, the queue length size is used.

This is only applicable to write behind mode.

Defaults to 1.

Parameters

writeBatchSize:int: the number of operations to include in each batch; numbers smaller than 1 will cause the default batch size to be used

setWriteBehindConcurrency

back to summary

public void setWriteBehindConcurrency(int concurrency)

Configures the amount of thread/bucket pairs WriteBehind should use

Parameters

concurrency:int: Amount of thread/bucket pairs, has to be at least 1

setWriteBehindMaxQueueSize

back to summary

public void setWriteBehindMaxQueueSize(final int writeBehindMaxQueueSize)

Configures the maximum amount of operations to be on the waiting queue, before it blocks

Parameters

writeBehindMaxQueueSize:int: maximum amount of operations allowed on the waiting queue

setWriteCoalescing back to summary

public void setWriteCoalescing(boolean writeCoalescing)

Sets whether to use write coalescing. If set to true and multiple operations on the same key are present in the write-behind queue, only the latest write is done, as the others are redundant. This can dramatically reduce load on the underlying resource.

This is only applicable to write behind mode.

Defaults to false.

Parameters

writeCoalescing:boolean: true to enable write coalescing; or false to disable it

setWriteMode	back to summary
public void setWriteMode(String writeMode) Converts the `writeMode` string argument to uppercase and looks up enum constant in WriteMode.

validate back to summary

public void validate(Collection<ConfigError> errors)

Check for errors/inconsistencies in this configuration. Add any erros found as ConfigError in the errors collection.

Parameters

errors:Collection<ConfigError>: collection to add errors to.

writeBatching	back to summary
public CacheWriterConfiguration writeBatching(boolean writeBatching) Returns:CacheWriterConfiguration this configuration instance See Also `setWriteBatching(boolean)`

writeBatchSize	back to summary
public CacheWriterConfiguration writeBatchSize(int writeBatchSize) Returns:CacheWriterConfiguration this configuration instance See Also `setWriteBatchSize(int)`

writeBehindConcurrency	back to summary
public CacheWriterConfiguration writeBehindConcurrency(int concurrency) Parameters concurrency:int Amount of thread/bucket pairs, has to be at least 1 Returns:CacheWriterConfiguration this configuration instance See Also `setWriteBehindConcurrency(int)`

writeBehindMaxQueueSize	back to summary
public CacheWriterConfiguration writeBehindMaxQueueSize(int writeBehindMaxQueueSize) Parameters writeBehindMaxQueueSize:int maximum amount of operations allowed on the waiting queue Returns:CacheWriterConfiguration this configuration instance See Also `setWriteBehindMaxQueueSize(int)`

writeCoalescing	back to summary
public CacheWriterConfiguration writeCoalescing(boolean writeCoalescing) Returns:CacheWriterConfiguration this configuration instance See Also `setWriteCoalescing(boolean)`

writeMode	back to summary
public CacheWriterConfiguration writeMode(String writeMode) Returns:CacheWriterConfiguration this configuration instance See Also `setWriteMode(String)`

writeMode	back to summary
public CacheWriterConfiguration writeMode(CacheWriterConfiguration.WriteMode writeMode) Returns:CacheWriterConfiguration this configuration instance See Also `setWriteMode(String)`

net.sf.ehcache.config back to summary

public final Class CacheWriterConfiguration.CacheWriterFactoryConfiguration

Class Inheritance

extends FactoryConfiguration<CacheWriterConfiguration.CacheWriterFactoryConfiguration>

java.lang.Object
net.sf.ehcache.config.FactoryConfiguration
net.sf.ehcache.config.CacheWriterConfiguration.CacheWriterFactoryConfiguration

Configuration for the CacheWriterFactoryConfiguration.

Field Summary

Inherited from net.sf.ehcache.config.FactoryConfiguration:: fullyQualifiedClassPath properties propertySeparator

Constructor Summary

Access	Constructor and Description
public	CacheWriterFactoryConfiguration()

Method Summary

Modifier and Type	Method and Description
public boolean	equals(Object the reference object with which to compare. obj) Overrides net.sf.ehcache.config.FactoryConfiguration.equals. Overrided equals
public int	hashCode() Overrides net.sf.ehcache.config.FactoryConfiguration.hashCode. Overrided hashCode()

Inherited from net.sf.ehcache.config.FactoryConfiguration:: className clone getFullyQualifiedClassPath getProperties getPropertySeparator properties propertySeparator setClass setProperties setPropertySeparator

Constructor Detail

CacheWriterFactoryConfiguration	back to summary
public CacheWriterFactoryConfiguration()

Method Detail

equals back to summary

public boolean equals(Object obj)

Overrides net.sf.ehcache.config.FactoryConfiguration.equals.

Overrided equals

Parameters

obj:Object

Doc from java.lang.Object.equals.

the reference object with which to compare.

Returns:boolean

Doc from java.lang.Object.equals.

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

hashCode

back to summary

public int hashCode()

Overrides net.sf.ehcache.config.FactoryConfiguration.hashCode.

Overrided hashCode()

Returns:int

Doc from java.lang.Object.hashCode.

a hash code value for this object.

Annotations

@Override

net.sf.ehcache.config back to summary

public sealed Enum CacheWriterConfiguration.WriteMode

Class Inheritance

extends Enum<CacheWriterConfiguration.WriteMode>

java.lang.Object
java.lang.Enum
net.sf.ehcache.config.CacheWriterConfiguration.WriteMode

Represents how elements are written to the net.sf.ehcache.writer.CacheWriter

Field Summary

Modifier and Type	Field and Description
public static final CacheWriterConfiguration.WriteMode	WRITE_BEHIND Write mode enum constant that can be used to configure a cache writer to use write behind
public static final CacheWriterConfiguration.WriteMode	WRITE_THROUGH Write mode enum constant that can be used to configure a cache writer to use write through

Constructor Summary

Access	Constructor and Description
private	WriteMode()

Method Summary

Modifier and Type	Method and Description
public abstract CacheWriterManager	Returns: the newly created `WriterManager` createWriterManager(Cache the cache instance for which the `WriterManager` should be created cache, Store store) Create a new `WriterManager` for a particular cache instance
public static CacheWriterConfiguration.WriteMode	valueOf(String name)
public static CacheWriterConfiguration.WriteMode[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

WRITE_BEHIND	back to summary
public static final CacheWriterConfiguration.WriteMode WRITE_BEHIND Write mode enum constant that can be used to configure a cache writer to use write behind

WRITE_THROUGH	back to summary
public static final CacheWriterConfiguration.WriteMode WRITE_THROUGH Write mode enum constant that can be used to configure a cache writer to use write through

Constructor Detail

WriteMode	back to summary
private WriteMode()

Method Detail

createWriterManager back to summary

public abstract CacheWriterManager createWriterManager(Cache cache, Store store)

Create a new WriterManager for a particular cache instance

Parameters

cache:Cache: the cache instance for which the WriterManager should be created

Returns:CacheWriterManager

the newly created WriterManager

valueOf	back to summary
public static CacheWriterConfiguration.WriteMode valueOf(String name)

values	back to summary
public static CacheWriterConfiguration.WriteMode[] values()

public Class CacheWriterConfiguration

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Class CacheWriterConfiguration.CacheWriterFactoryConfiguration

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail

public sealed Enum CacheWriterConfiguration.WriteMode

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail