com.elasticpath.xpf.connectivity.cache

Class XPFCacheResult<T>

java.lang.Object

com.elasticpath.xpf.connectivity.cache.XPFCacheResult<T>

Type Parameters:

T - the class implemented by the cache values

public final class XPFCacheResult<T>
extends Object

A container object for a cache result which can distinguish between a cache value that is present or not present. A present value can contain null. If a value is present, isPresent() will return true and get() will return the value.

Method Summary

Modifier and Type	Method and Description
static <T> XPFCacheResult<T>	create(T value) Creates wrapper for given value.
boolean	equals(Object obj)
T	get() If a value is present in this CacheResult, returns the value, otherwise throws NoSuchElementException.
int	hashCode()
boolean	isPresent() Return true if there is a value present, otherwise false.
static <T> XPFCacheResult<T>	notPresent() Creates empty wrapper for absent result in the cache.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static <T> XPFCacheResult<T> create(T value)

Creates wrapper for given value.

Type Parameters:

T - the class implemented by the cache values

Parameters:

value - given value to create wrapper

Returns:

created wrapper

notPresent

public static <T> XPFCacheResult<T> notPresent()

Creates empty wrapper for absent result in the cache.

Type Parameters:

T - the class implemented by the cache values

Returns:

empty wrapper

get

public T get()

If a value is present in this CacheResult, returns the value, otherwise throws NoSuchElementException.

Returns:

the value held by this CacheResult

Throws:

NoSuchElementException - if there is no value present

isPresent

public boolean isPresent()

Return true if there is a value present, otherwise false.

Returns:

true if there is a value present, otherwise false

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object