com.atlassian.instrumentation.operations

Class CachedExternalOpValue

java.lang.Object

com.atlassian.instrumentation.operations.CachedExternalOpValue

All Implemented Interfaces:

ExternalOpValue

public abstract class CachedExternalOpValue
extends Object
implements ExternalOpValue

This class allows ExternalOpValues to be computed on as as needed basis and also cache the values for a certain length of time.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CachedExternalOpValue() By default 1 minute is the cache time out value
protected	CachedExternalOpValue(long cacheTimeout, TimeUnit cacheTimeoutUnits) Creates a CachedExternalOpValue where the cache time is the values specified.

Method Summary

Modifier and Type	Method and Description
protected abstract OpSnapshot	computeValue() This method is called to compute the value of the CachedExternalOpValue
OpSnapshot	getSnapshot()

Methods inherited from class java.lang.Object

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

Constructor Detail

CachedExternalOpValue

protected CachedExternalOpValue()

By default 1 minute is the cache time out value

CachedExternalOpValue

protected CachedExternalOpValue(long cacheTimeout,
                                TimeUnit cacheTimeoutUnits)

Creates a CachedExternalOpValue where the cache time is the values specified.

Parameters:

cacheTimeout - the cache time out value

cacheTimeoutUnits - the units of the cache time our value

Method Detail

computeValue

protected abstract OpSnapshot computeValue()

This method is called to compute the value of the CachedExternalOpValue

This will be done because the cached value has expired and has since been requested via a call to getSnapshot()

Returns:

the computed value

getSnapshot

public OpSnapshot getSnapshot()

Specified by:

getSnapshot in interface ExternalOpValue

Returns:

the external snapshot value