com.helger.commons.xml.schema

Class DefaultSchemaCache

java.lang.Object

com.helger.commons.cache.AbstractCache<KEYTYPE,VALUETYPE>

com.helger.commons.cache.AbstractNotifyingCache<List<? extends IReadableResource>,Schema>

com.helger.commons.xml.schema.DefaultSchemaCache

All Implemented Interfaces:

ISimpleCache<List<? extends IReadableResource>,Schema>, SimpleCacheMBean, IHasSize, IHasName

Direct Known Subclasses:

XMLSchemaCache

@ThreadSafe
public abstract class DefaultSchemaCache
extends AbstractNotifyingCache<List<? extends IReadableResource>,Schema>

Abstract base class for caching abstract Schema objects. A Schema is immutable and can therefore safely be used in multi-threaded environments.

Author:

Philip Helger

Field Summary

Fields inherited from class com.helger.commons.cache.AbstractCache

DEFAULT_JMX_ENABLED, m_aCacheAccessStats, m_aRWLock, STATISTICS_PREFIX

Constructor Summary

Constructors

Constructor and Description
DefaultSchemaCache(String sSchemaTypeName, SchemaFactory aSchemaFactory, ErrorHandler aErrorHandler, LSResourceResolver aResourceResolver)

Method Summary

Methods

Modifier and Type	Method and Description
ErrorHandler	getErrorHandler()
Schema	getSchema(Collection<? extends IReadableResource> aResources) Get a cached Schema that consists of multiple resources.
Schema	getSchema(IReadableResource... aResources) Get a cached Schema that consists of multiple resources.
Schema	getSchema(IReadableResource aResource) Get a cached Schema from a single resource.
SchemaFactory	getSchemaFactory()
String	getSchemaTypeName()
Validator	getValidator(Collection<? extends IReadableResource> aResources) Get a new validator based on the Schema that consists of multiple resources.
Validator	getValidator(IReadableResource... aResources) Get a new validator based on the Schema that consists of multiple resources.
Validator	getValidator(IReadableResource aResource) Get a new validator based on the Schema that consists of a single resource.
Validator	getValidatorFromSchema(Schema aSchema) Utility method to get the validator for a given schema using the error handler provided in the constructor.
protected Schema	getValueToCache(List<? extends IReadableResource> aKey) This abstract method is invoked, once a new value needs to be put into the cache.
EChange	removeFromCache(IReadableResource aKey) Utility method to remove a single resource from the schema cache.
String	toString()

Methods inherited from class com.helger.commons.cache.AbstractNotifyingCache

getFromCache

Methods inherited from class com.helger.commons.cache.AbstractCache

clearCache, createCache, getFromCacheNoStats, getFromCacheNoStatsNotLocked, getFromCacheNotLocked, getName, isEmpty, isJMXEnabled, isNotEmpty, putInCache, putInCacheNotLocked, removeFromCache, setJMXEnabled, size

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultSchemaCache

public DefaultSchemaCache(@Nonnull
                  String sSchemaTypeName,
                  @Nonnull
                  SchemaFactory aSchemaFactory,
                  @Nullable
                  ErrorHandler aErrorHandler,
                  @Nullable
                  LSResourceResolver aResourceResolver)

Method Detail

getSchemaTypeName

@Nonnull
public String getSchemaTypeName()

getSchemaFactory

@Nonnull
public SchemaFactory getSchemaFactory()

getErrorHandler

@Nullable
public ErrorHandler getErrorHandler()

getValueToCache

@Nonnull
@IsLocked(value=WRITE)
protected Schema getValueToCache(List<? extends IReadableResource> aKey)

Description copied from class: AbstractNotifyingCache

This abstract method is invoked, once a new value needs to be put into the cache. This method is invoked within a locked section.

Specified by:

getValueToCache in class AbstractNotifyingCache<List<? extends IReadableResource>,Schema>

Parameters:

aKey - The key for which the value to cache is required. May be nullable or not - depends upon the implementation.

Returns:

The value to be cached. May not be null.

getSchema

@Nonnull
public final Schema getSchema(@Nonnull
                       IReadableResource aResource)

Get a cached Schema from a single resource.

Parameters:

aResource - The resource to parse into a Schema. May not be null.

Returns:

Either the Schema from the cache or the newly compiled one.

getSchema

@Nonnull
public final Schema getSchema(@Nonnull@Nonempty
                       IReadableResource... aResources)

Get a cached Schema that consists of multiple resources.

Parameters:

aResources - The resources to parse into a single Schema. May neither null nor empty nor may it contain null elements.

Returns:

Either the Schema from the cache or the newly compiled one.

getSchema

@Nonnull
public final Schema getSchema(@Nonnull@Nonempty
                       Collection<? extends IReadableResource> aResources)

Get a cached Schema that consists of multiple resources.

Parameters:

aResources - The resources to parse into a single Schema. May neither null nor empty nor may it contain null elements.

Returns:

Either the Schema from the cache or the newly compiled one.

getValidatorFromSchema

@Nonnull
public final Validator getValidatorFromSchema(@Nonnull
                                       Schema aSchema)

Utility method to get the validator for a given schema using the error handler provided in the constructor.

Parameters:

aSchema - The schema for which the validator is to be retrieved. May not be null.

Returns:

The validator and never null.

getValidator

@Nonnull
public final Validator getValidator(@Nonnull
                             IReadableResource aResource)

Get a new validator based on the Schema that consists of a single resource.

Parameters:

aResource - The resource to parse into a single Schema. May not be null.

Returns:

A new Validator object. Never null.

See Also:

getSchema(IReadableResource)

getValidator

@Nonnull
public final Validator getValidator(@Nonnull@Nonempty
                             IReadableResource... aResources)

Get a new validator based on the Schema that consists of multiple resources.

Parameters:

aResources - The resources to parse into a single Schema. May neither null nor empty nor may it contain null elements.

Returns:

A new Validator object. Never null.

See Also:

getSchema(IReadableResource...)

getValidator

@Nonnull
public final Validator getValidator(@Nonnull@Nonempty
                             Collection<? extends IReadableResource> aResources)

Get a new validator based on the Schema that consists of multiple resources.

Parameters:

aResources - The resources to parse into a single Schema. May neither null nor empty nor may it contain null elements.

Returns:

A new Validator object. Never null.

See Also:

getSchema(Collection)

removeFromCache

@Nonnull
public EChange removeFromCache(@Nullable
                              IReadableResource aKey)

Utility method to remove a single resource from the schema cache.

Parameters:

aKey - The resource to remove

Returns:

EChange.

toString

public String toString()

Overrides:

toString in class AbstractCache<List<? extends IReadableResource>,Schema>