org.jasig.jpa

Class CacheKey

java.lang.Object

org.jasig.jpa.CacheKey

All Implemented Interfaces:

Serializable

public final class CacheKey
extends Object
implements Serializable

A object designed for use as a cache key. It assumes that all key values are immutable and pre-computes the hashCode.
Tags can be added to a key which are used with the TaggedCacheEntry facilities. These tags ARE NOT included in CacheKey comparison.

Author:

Eric Dalquist

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CacheKey.CacheKeyBuilder<K extends Serializable,V extends Serializable> Utility for building more complex cache keys

Method Summary

Methods

Modifier and Type	Method and Description
static CacheKey	build(String source, Collection<? extends Serializable> key)
static CacheKey	build(String source, Map<? extends Serializable,? extends Serializable> keyData)
static CacheKey	build(String source, Serializable... key)
static <K extends Serializable,V extends Serializable> CacheKey.CacheKeyBuilder<K,V>	builder(String source)
boolean	equals(Object obj)
Serializable	getKey()
String	getSource()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static <K extends Serializable,V extends Serializable> CacheKey.CacheKeyBuilder<K,V> builder(String source)

build

public static CacheKey build(String source,
             Serializable... key)

build

public static CacheKey build(String source,
             Collection<? extends Serializable> key)

build

public static CacheKey build(String source,
             Map<? extends Serializable,? extends Serializable> keyData)

getKey

public Serializable getKey()

getSource

public String getSource()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object