com.mattunderscore.filter.contentnegotiation.variantsource

Class CachedVariantSource

java.lang.Object

com.mattunderscore.filter.contentnegotiation.variantsource.CachedVariantSource

All Implemented Interfaces:

VariantSource

public final class CachedVariantSource
extends Object
implements VariantSource

Supports caching variant sources by providing a wrapper around them. This will only call the underlying variant source when isCacheEmpty() returns true. The cache starts empty and can be cleared. The variant list this returns is unmodifiable.

Since:

0.2.0

Author:

Matt Champion

Constructor Summary

Constructors

Constructor and Description
CachedVariantSource(VariantSource source) Constructs a cached version of the variant source.

Method Summary

Modifier and Type	Method and Description
void	clearCache() Clears the cache of any variants.
List<Variant>	getVariants() Get the variants from the variant source.
boolean	isCacheEmpty() Returns true when there are no cached variants.

Methods inherited from class java.lang.Object

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

Constructor Detail

CachedVariantSource

public CachedVariantSource(VariantSource source)

Constructs a cached version of the variant source.

Parameters:

source - Underlying variant source

Since:

0.2.0

Method Detail

getVariants

public List<Variant> getVariants()
                          throws VariantSourceException

Description copied from interface: VariantSource

Get the variants from the variant source. The variants are returned a list.

Specified by:

getVariants in interface VariantSource

Returns:

A list of the variants defined by the variant source

Throws:

VariantSourceException - Thrown when unable to return the variants

VariantSourceConfigurationException - Thrown when the variant source is not configured

isCacheEmpty

public boolean isCacheEmpty()

Returns true when there are no cached variants.

Returns:

True when there are no cached variants.

Since:

0.2.0

clearCache

public void clearCache()

Clears the cache of any variants. The next call to getVariants() will cause the underlying source to provide a new list.

Since:

0.2.0