org.ehcache.xml.multi

Class XmlMultiConfiguration

java.lang.Object

org.ehcache.xml.multi.XmlMultiConfiguration

public class XmlMultiConfiguration
extends java.lang.Object

A collection of multiple Ehcache configurations.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	XmlMultiConfiguration.Builder An XmlMultiConfiguration builder.
static interface	XmlMultiConfiguration.Variant A variant configuration builder.

Method Summary

Modifier and Type	Method and Description
org.w3c.dom.Document	asDocument() Return this configuration as an XML Document.
java.lang.String	asRenderedDocument() Return this configuration as a rendered XML string.
Configuration	configuration(java.lang.String identity) Retrieve the singular configuration for identity.
Configuration	configuration(java.lang.String identity, java.lang.String variant) Retrieve the singular configuration for identity and variant.
static XmlMultiConfiguration.Builder	from(java.net.URL xml) Create a builder seeded from an XML configuration.
static XmlMultiConfiguration.Builder	from(java.net.URL xml, java.lang.ClassLoader classLoader) Create a builder seeded from an XML configuration using the supplier class loader.
static XmlMultiConfiguration.Builder	from(XmlMultiConfiguration config) Create a builder seeded from an existing XmlMultiConfiguration.
static XmlMultiConfiguration.Builder	fromNothing() Create an initially empty builder.
java.util.Set<java.lang.String>	identities() Return the set of identities defined in this multi-configuration.
java.lang.String	toString()
java.util.Set<java.lang.String>	variants(java.lang.String identity) Return the set of variants defined for the given configuration.

Methods inherited from class java.lang.Object

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

Method Detail

configuration

public Configuration configuration(java.lang.String identity)
                            throws java.lang.IllegalArgumentException

Retrieve the singular configuration for identity.

If the given identity is associated with multiple variant configurations then an IllegalStateException will be thrown. In this case the configuration(String, String) method must be used to select a specific variant.

Parameters:

identity - identity to retrieve

Returns:

the configuration for the given identity; null if the identity is not in this configuration

Throws:

java.lang.IllegalArgumentException - if the identity is associated with multiple variant configurations

configuration

public Configuration configuration(java.lang.String identity,
                                   java.lang.String variant)

Retrieve the singular configuration for identity and variant.

If the given identity is associated only with a singular configuration then that configuration will be returned for all variants.

Parameters:

identity - identity to retrieve

variant - variant to retrieve

Returns:

the configuration for the given identity; null if the identity is not in this configuration

Throws:

java.lang.IllegalArgumentException - if the given variant does not exist

variants

public java.util.Set<java.lang.String> variants(java.lang.String identity)
                                         throws java.lang.IllegalArgumentException

Return the set of variants defined for the given configuration.

If the given identity does not exist then an IllegalArgumentException is thrown. If the given identity is not variant-ed then an empty set is returned.

Returns:

the set of variants; possibly empty.

Throws:

java.lang.IllegalArgumentException - if the identity does not exist

identities

public java.util.Set<java.lang.String> identities()

Return the set of identities defined in this multi-configuration.

Returns:

the defined identity set

asDocument

public org.w3c.dom.Document asDocument()

Return this configuration as an XML Document.

Returns:

configuration XML DOM.

asRenderedDocument

public java.lang.String asRenderedDocument()

Return this configuration as a rendered XML string.

Returns:

configuration XML string

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

from

public static XmlMultiConfiguration.Builder from(java.net.URL xml)

Create a builder seeded from an XML configuration.

Enclosed configurations will parsed using XmlConfiguration.XmlConfiguration(Document).

Parameters:

xml - xml seed resource

Returns:

a builder seeded with the xml configuration

See Also:

XmlConfiguration.XmlConfiguration(Document)

from

public static XmlMultiConfiguration.Builder from(java.net.URL xml,
                                                 java.lang.ClassLoader classLoader)

Create a builder seeded from an XML configuration using the supplier class loader.

Enclosed configurations will parsed using XmlConfiguration.XmlConfiguration(Document, ClassLoader), which will be passed the classloader provided to this method.

Parameters:

xml - xml seed resource

classLoader - loader for the cache managers

Returns:

a builder seeded with the xml configuration

See Also:

XmlConfiguration.XmlConfiguration(Document, ClassLoader)

from

public static XmlMultiConfiguration.Builder from(XmlMultiConfiguration config)

Create a builder seeded from an existing XmlMultiConfiguration.

Parameters:

config - existing configuration seed

Returns:

a builder seeded with the xml configuration

fromNothing

public static XmlMultiConfiguration.Builder fromNothing()

Create an initially empty builder.

Returns:

an empty builder