org.jboss.dna.graph.cache
Interface Cacheable

All Superinterfaces:

Serializable

All Known Implementing Classes:

CacheableRequest, GetWorkspacesRequest, ReadAllChildrenRequest, ReadAllPropertiesRequest, ReadBlockOfChildrenRequest, ReadBranchRequest, ReadNextBlockOfChildrenRequest, ReadNodeRequest, ReadPropertyRequest, VerifyNodeExistsRequest

public interface Cacheable
extends Serializable

Interface defining an object that can be cached according to a CachePolicy.

Method Summary

CachePolicy	getCachePolicy() Get the caching policy to be used for this object.
DateTime	getTimeLoaded() Get the time that this node data was originally loaded.
void	setCachePolicy(CachePolicy cachePolicy) Set the caching policy for this object.

Method Detail

getTimeLoaded

DateTime getTimeLoaded()

Get the time that this node data was originally loaded.

Returns:

the system time (in milliseconds) that the node data was loaded

getCachePolicy

CachePolicy getCachePolicy()

Get the caching policy to be used for this object.

Note that the values of the policy are relative to the time the node was loaded, so the same instance can be used for many nodes.

Returns:

cachePolicy the caching policy, which may not be null

setCachePolicy

void setCachePolicy(CachePolicy cachePolicy)

Set the caching policy for this object.

Parameters:

cachePolicy - the caching policy to use for this object

Throws:

IllegalArgumentException - if the cachePolicy is null