com.emc.vipr.client.core.util

Class CachedResources<T extends DataObjectRestRep>

java.lang.Object

com.emc.vipr.client.core.util.CachedResources<T>

Type Parameters:

T - the resource type.

public class CachedResources<T extends DataObjectRestRep>
extends java.lang.Object

Wrapper around resources that can cache the results. This can be quite useful when looking up related resources from another type.

Constructor Summary

Constructors

Constructor and Description
CachedResources(Resources<T> resources)

Method Summary

Modifier and Type	Method and Description
void	clear() Clears the cached values.
T	get(RelatedResourceRep ref) Gets a list resource by reference, first checking if it is already in the cache.
T	get(java.net.URI id) Gets a resource by ID, first checking if it is already in the cache.
java.util.List<T>	getByIds(java.util.Collection<java.net.URI> ids) Gets a list of resources by IDs, checking the cache for each.
java.util.List<T>	getByIds(java.util.Collection<java.net.URI> ids, ResourceFilter<T> filter) Gets a list of resources by IDs, checking the cache for each.
java.util.List<T>	getByRefs(java.util.Collection<? extends RelatedResourceRep> refs) Gets a list of resources by reference, checking the cache for each.
java.util.List<T>	getByRefs(java.util.Collection<? extends RelatedResourceRep> refs, ResourceFilter<T> filter) Gets a list of resources by reference, checking the cache for each.
T	getCached(java.net.URI id) Gets the resource from the cache only.
boolean	isCached(java.net.URI id) Determines if the cache contains the given resource by ID
T	remove(RelatedResourceRep ref) Removes a resource from the cache.
T	remove(java.net.URI id) Removes a resource from the cache.

Methods inherited from class java.lang.Object

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

Constructor Detail

CachedResources

public CachedResources(Resources<T> resources)

Method Detail

get

public T get(java.net.URI id)

Gets a resource by ID, first checking if it is already in the cache. This will handle an HTTP 404 error by caching and returning a null value.

Parameters:

id - the resource ID.

Returns:

the resource.

get

public T get(RelatedResourceRep ref)

Gets a list resource by reference, first checking if it is already in the cache.

Parameters:

ref - the resource reference.

Returns:

the resource.

getByRefs

public java.util.List<T> getByRefs(java.util.Collection<? extends RelatedResourceRep> refs)

Gets a list of resources by reference, checking the cache for each. This is a convenience method for getByRefs(refs, null).

Parameters:

refs - the resource references.

Returns:

the list of resources.

See Also:

getByRefs(Collection, ResourceFilter)

getByRefs

public java.util.List<T> getByRefs(java.util.Collection<? extends RelatedResourceRep> refs,
                                   ResourceFilter<T> filter)

Gets a list of resources by reference, checking the cache for each. If a filter is provided the values are filtered as they are retrieved.

Parameters:

refs - the resource references.

filter - the filter to apply (may be null).

Returns:

the list of resources.

getByIds

public java.util.List<T> getByIds(java.util.Collection<java.net.URI> ids)

Gets a list of resources by IDs, checking the cache for each. This is a convenience method for getByIds(ids, null).

Parameters:

ids - the resource IDs.

Returns:

the resources.

See Also:

getByIds(Collection, ResourceFilter)

getByIds

public java.util.List<T> getByIds(java.util.Collection<java.net.URI> ids,
                                  ResourceFilter<T> filter)

Gets a list of resources by IDs, checking the cache for each. If a filter is provided, the resources are filtered as they are retrieved.

Parameters:

ids - the resource IDs.

filter - the filter to apply (may be null).

Returns:

the resources.

isCached

public boolean isCached(java.net.URI id)

Determines if the cache contains the given resource by ID

Parameters:

id - resource ID.

Returns:

true if the cache contains the resource.

getCached

public T getCached(java.net.URI id)

Gets the resource from the cache only.

Parameters:

id - the resource ID.

Returns:

the cached resource.

clear

public void clear()

Clears the cached values.

remove

public T remove(java.net.URI id)

Removes a resource from the cache.

Parameters:

id - the resource ID.

Returns:

the previously cached value.

remove

public T remove(RelatedResourceRep ref)

Removes a resource from the cache.

Parameters:

ref - the resource reference.

Returns:

the previously cached value.