net.sf.ehcache.config
Class DiskStoreConfiguration

java.lang.Object
  net.sf.ehcache.config.DiskStoreConfiguration

public final class DiskStoreConfiguration
extends Object

A class to represent DiskStore configuration e.g.

Version:

$Id: DiskStoreConfiguration.java 2522 2010-06-25 14:40:22Z gbevin $

Author:

Greg Luck

Constructor Summary

DiskStoreConfiguration()

Method Summary

static String	getDefaultPath() The diskStore default path, which is the system environment variable availablen on all Java virtual machines java.io.tmpdir
String	getOriginalPath()
String	getPath() The diskStore path
DiskStoreConfiguration	path(String path) Builder method to set the disk store path, see setPath(String)
static String	replaceToken(String token, String replacement, String source) Replaces a token with replacement text.
void	setPath(String path) Translates and sets the path.

Methods inherited from class java.lang.Object

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

Constructor Detail

DiskStoreConfiguration

public DiskStoreConfiguration()

Method Detail

getPath

public final String getPath()

The diskStore path

getDefaultPath

public static String getDefaultPath()

The diskStore default path, which is the system environment variable availablen on all Java virtual machines java.io.tmpdir

path

public final DiskStoreConfiguration path(String path)

Builder method to set the disk store path, see setPath(String)

Returns:

this configuration instance

setPath

public final void setPath(String path)

Translates and sets the path.

Parameters:

path - If the path contains a Java System Property token it is replaced by its value in the running VM. Subdirectories can be specified below the property e.g. java.io.tmpdir/one. The following properties are translated:

• user.home - User's home directory
• user.dir - User's current working directory
• java.io.tmpdir - Default temp file path
• ehcache.disk.store.di?r - A system property you would normally specify on the command linecan specify with -DDefault temp file path e.g. java -Dehcache.disk.store.dir=/u01/myapp/diskdir ...

Additional strings can be placed before and after tokens? e.g. java.io/tmpdir/caches might become /tmp/caches

getOriginalPath

public String getOriginalPath()

Returns:

the originalPath

replaceToken

public static String replaceToken(String token,
                                  String replacement,
                                  String source)

Replaces a token with replacement text.

Parameters:

token -

replacement -

source -

Returns:

the String with replacement text applied