Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	ConfigurationSource.DefaultConfigurationSource Default `ConfigurationSource` based on default ehcache.xml in classpath (if one is present) or the ehcache-failsafe.xml provided with the kit
private static class	ConfigurationSource.FileNameSource `ConfigurationSource` based on file name
private static class	ConfigurationSource.InputStreamConfigurationSource `ConfigurationSource` based on `InputStream`
private static class	ConfigurationSource.URLConfigurationSource `ConfigurationSource` based on URL

Access	Constructor and Description
protected	ConfigurationSource() protected constructor

Method Summary

Modifier and Type	Method and Description
public abstract Configuration	Returns: `Configuration` based on the source createConfiguration() Abstract method used for creating a `Configuration` based on the source
public static ConfigurationSource	Returns: ConfigurationSource for the input file getConfigurationSource(File file) Utility factory method for creating a `ConfigurationSource` based on a file.
public static ConfigurationSource	Returns: ConfigurationSource for the input URL getConfigurationSource(URL configFileURL) Utility factory method for creating a `ConfigurationSource` based on `URL`
public static ConfigurationSource	Returns: ConfigurationSource for the input InputStream getConfigurationSource(InputStream configFileStream) Utility factory method for creating a `ConfigurationSource` based on InputStream
public static ConfigurationSource	Returns: Default ConfigurationSource getConfigurationSource() Utility factory method for creating a `ConfigurationSource` based on default settings (default ehcache.xml in classpath if one is present or an ehcache-failsafe provided with the kit

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

ConfigurationSource	back to summary
protected ConfigurationSource() protected constructor

Method Detail

createConfiguration back to summary

createConfiguration	back to summary
public abstract Configuration createConfiguration() Abstract method used for creating a `Configuration` based on the source Returns:Configuration `Configuration` based on the source

public abstract Configuration createConfiguration()

Abstract method used for creating a Configuration based on the source

Returns:Configuration: Configuration based on the source

getConfigurationSource back to summary

getConfigurationSource	back to summary
public static ConfigurationSource getConfigurationSource(File file) Utility factory method for creating a `ConfigurationSource` based on a file. Returns:ConfigurationSource ConfigurationSource for the input file

public static ConfigurationSource getConfigurationSource(File file)

Utility factory method for creating a ConfigurationSource based on a file.

Returns:ConfigurationSource: ConfigurationSource for the input file

getConfigurationSource back to summary

getConfigurationSource	back to summary
public static ConfigurationSource getConfigurationSource(URL configFileURL) Utility factory method for creating a `ConfigurationSource` based on `URL` Returns:ConfigurationSource ConfigurationSource for the input URL

public static ConfigurationSource getConfigurationSource(URL configFileURL)

Utility factory method for creating a ConfigurationSource based on URL

Returns:ConfigurationSource: ConfigurationSource for the input URL

getConfigurationSource back to summary

getConfigurationSource	back to summary
public static ConfigurationSource getConfigurationSource(InputStream configFileStream) Utility factory method for creating a `ConfigurationSource` based on InputStream Returns:ConfigurationSource ConfigurationSource for the input InputStream

public static ConfigurationSource getConfigurationSource(InputStream configFileStream)

Utility factory method for creating a ConfigurationSource based on InputStream

Returns:ConfigurationSource: ConfigurationSource for the input InputStream

getConfigurationSource back to summary

getConfigurationSource	back to summary
public static ConfigurationSource getConfigurationSource() Utility factory method for creating a `ConfigurationSource` based on default settings (default ehcache.xml in classpath if one is present or an ehcache-failsafe provided with the kit Returns:ConfigurationSource Default ConfigurationSource

public static ConfigurationSource getConfigurationSource()

Utility factory method for creating a ConfigurationSource based on default settings (default ehcache.xml in classpath if one is present or an ehcache-failsafe provided with the kit

Returns:ConfigurationSource: Default ConfigurationSource

net.sf.ehcache.config.generator back to summary

private Class ConfigurationSource.DefaultConfigurationSource

Class Inheritance

extends ConfigurationSource

java.lang.Object
net.sf.ehcache.config.generator.ConfigurationSource
net.sf.ehcache.config.generator.ConfigurationSource.DefaultConfigurationSource

Default ConfigurationSource based on default ehcache.xml in classpath (if one is present) or the ehcache-failsafe.xml provided with the kit

Field Summary

Modifier and Type	Field and Description
public static final ConfigurationSource.DefaultConfigurationSource	INSTANCE Singleton instance of `DefaultConfigurationSource`

Constructor Summary

Access	Constructor and Description
public	DefaultConfigurationSource() private constructor

Method Summary

Modifier and Type	Method and Description
public Configuration	createConfiguration() Implements abstract net.sf.ehcache.config.generator.ConfigurationSource.createConfiguration. Abstract method used for creating a `Configuration` based on the source
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from net.sf.ehcache.config.generator.ConfigurationSource:: getConfigurationSource getConfigurationSource getConfigurationSource getConfigurationSource

Field Detail

INSTANCE	back to summary
public static final ConfigurationSource.DefaultConfigurationSource INSTANCE Singleton instance of `DefaultConfigurationSource`

Constructor Detail

DefaultConfigurationSource	back to summary
public DefaultConfigurationSource() private constructor

Method Detail

createConfiguration back to summary

createConfiguration	back to summary
public Configuration createConfiguration() Implements abstract net.sf.ehcache.config.generator.ConfigurationSource.createConfiguration. Doc from net.sf.ehcache.config.generator.ConfigurationSource.createConfiguration. Abstract method used for creating a `Configuration` based on the source Returns:Configuration `Configuration` based on the source Annotations @Override See Also `net.sf.ehcache.config.generator.ConfigurationSource#createConfiguration()`

public Configuration createConfiguration()

Implements abstract net.sf.ehcache.config.generator.ConfigurationSource.createConfiguration.

Doc from net.sf.ehcache.config.generator.ConfigurationSource.createConfiguration.

Abstract method used for creating a Configuration based on the source

Returns:Configuration

Configuration based on the source

Annotations

@Override

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

net.sf.ehcache.config.generator back to summary

private Class ConfigurationSource.FileNameSource

Class Inheritance

extends ConfigurationSource

java.lang.Object
net.sf.ehcache.config.generator.ConfigurationSource
net.sf.ehcache.config.generator.ConfigurationSource.FileNameSource

ConfigurationSource based on file name

Field Summary

Modifier and Type	Field and Description
private final File	file

Constructor Summary

Access	Constructor and Description
public	FileNameSource(File file) Constructor accepting the file name

Method Summary

Modifier and Type	Method and Description
public Configuration	createConfiguration() Implements abstract net.sf.ehcache.config.generator.ConfigurationSource.createConfiguration. Abstract method used for creating a `Configuration` based on the source
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from net.sf.ehcache.config.generator.ConfigurationSource:: getConfigurationSource getConfigurationSource getConfigurationSource getConfigurationSource

Field Detail

file	back to summary
private final File file

Constructor Detail

FileNameSource	back to summary
public FileNameSource(File file) Constructor accepting the file name

Method Detail

createConfiguration back to summary

createConfiguration	back to summary
public Configuration createConfiguration() Implements abstract net.sf.ehcache.config.generator.ConfigurationSource.createConfiguration. Doc from net.sf.ehcache.config.generator.ConfigurationSource.createConfiguration. Abstract method used for creating a `Configuration` based on the source Returns:Configuration `Configuration` based on the source Annotations @Override See Also `net.sf.ehcache.config.generator.ConfigurationSource#getConfiguration()`

public Configuration createConfiguration()

Implements abstract net.sf.ehcache.config.generator.ConfigurationSource.createConfiguration.

Doc from net.sf.ehcache.config.generator.ConfigurationSource.createConfiguration.

Abstract method used for creating a Configuration based on the source

Returns:Configuration

Configuration based on the source

Annotations

@Override

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

net.sf.ehcache.config.generator back to summary

private Class ConfigurationSource.InputStreamConfigurationSource

Class Inheritance

extends ConfigurationSource

java.lang.Object
net.sf.ehcache.config.generator.ConfigurationSource
net.sf.ehcache.config.generator.ConfigurationSource.InputStreamConfigurationSource

ConfigurationSource based on InputStream

Field Summary

Modifier and Type	Field and Description
private final InputStream	stream

Constructor Summary

Access	Constructor and Description
public	InputStreamConfigurationSource(InputStream stream) Constructor accepting `InputStream`

Method Summary

Modifier and Type	Method and Description
public Configuration	createConfiguration() Implements abstract net.sf.ehcache.config.generator.ConfigurationSource.createConfiguration. Abstract method used for creating a `Configuration` based on the source
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from net.sf.ehcache.config.generator.ConfigurationSource:: getConfigurationSource getConfigurationSource getConfigurationSource getConfigurationSource

Field Detail

stream	back to summary
private final InputStream stream

Constructor Detail

InputStreamConfigurationSource	back to summary
public InputStreamConfigurationSource(InputStream stream) Constructor accepting `InputStream`

Method Detail

createConfiguration back to summary

createConfiguration	back to summary
public Configuration createConfiguration() Implements abstract net.sf.ehcache.config.generator.ConfigurationSource.createConfiguration. Doc from net.sf.ehcache.config.generator.ConfigurationSource.createConfiguration. Abstract method used for creating a `Configuration` based on the source Returns:Configuration `Configuration` based on the source Annotations @Override See Also `net.sf.ehcache.config.generator.ConfigurationSource#createConfiguration()`

public Configuration createConfiguration()

Implements abstract net.sf.ehcache.config.generator.ConfigurationSource.createConfiguration.

Doc from net.sf.ehcache.config.generator.ConfigurationSource.createConfiguration.

Abstract method used for creating a Configuration based on the source

Returns:Configuration

Configuration based on the source

Annotations

@Override

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

net.sf.ehcache.config.generator back to summary

private Class ConfigurationSource.URLConfigurationSource

Class Inheritance

extends ConfigurationSource

java.lang.Object
net.sf.ehcache.config.generator.ConfigurationSource
net.sf.ehcache.config.generator.ConfigurationSource.URLConfigurationSource

ConfigurationSource based on URL

Field Summary

Modifier and Type	Field and Description
private final URL	url

Constructor Summary

Access	Constructor and Description
public	URLConfigurationSource(URL url) Constructor accepting a URL

Method Summary

Modifier and Type	Method and Description
public Configuration	createConfiguration() Implements abstract net.sf.ehcache.config.generator.ConfigurationSource.createConfiguration. Abstract method used for creating a `Configuration` based on the source
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from net.sf.ehcache.config.generator.ConfigurationSource:: getConfigurationSource getConfigurationSource getConfigurationSource getConfigurationSource

Field Detail

url	back to summary
private final URL url

Constructor Detail

URLConfigurationSource	back to summary
public URLConfigurationSource(URL url) Constructor accepting a URL

Method Detail

createConfiguration back to summary

createConfiguration	back to summary
public Configuration createConfiguration() Implements abstract net.sf.ehcache.config.generator.ConfigurationSource.createConfiguration. Doc from net.sf.ehcache.config.generator.ConfigurationSource.createConfiguration. Abstract method used for creating a `Configuration` based on the source Returns:Configuration `Configuration` based on the source Annotations @Override See Also `net.sf.ehcache.config.generator.ConfigurationSource#createConfiguration()`

public Configuration createConfiguration()

Implements abstract net.sf.ehcache.config.generator.ConfigurationSource.createConfiguration.

Doc from net.sf.ehcache.config.generator.ConfigurationSource.createConfiguration.

Abstract method used for creating a Configuration based on the source

Returns:Configuration

Configuration based on the source

Annotations

@Override

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

public abstract Class ConfigurationSource

Nested and Inner Type Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private Class ConfigurationSource.DefaultConfigurationSource

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class ConfigurationSource.FileNameSource

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class ConfigurationSource.InputStreamConfigurationSource

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class ConfigurationSource.URLConfigurationSource

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail