org.jahia.services.cache

Class CacheEntry<V>

java.lang.Object

org.jahia.services.cache.CacheEntry<V>

All Implemented Interfaces:

Serializable

public class CacheEntry<V>
extends Object
implements Serializable

This class represents an entry in a class.

Each entry holds an object and some statistics on that object, like its expiration date, last accessed date and the amount of times it has been request from the cache.

Since:

Jahia 4.0

Version:

1.0

Author:

Fulco Houkes, Copyright (c) 2003 by Jahia Ltd.

See Also:

Cache, Serialized Form

Constructor Summary

Constructors

Constructor and Description
CacheEntry() Default constructor, creates a new CacheEntry instance.
CacheEntry(V entryObj) Creates a new CacheEntry object instance.

Method Summary

Modifier and Type	Method and Description
boolean	containsKey(String key) Returns true if this entry contains the mapping for the specified property name key.
Date	getExpirationDate() Deprecated.
Map<String,Serializable>	getExtendedProperties() Retrieves the properties Map instance.
int	getHits() Deprecated.
long	getLastAccessedTimeMillis() Deprecated.
V	getObject() Retrieves the object associated with this cache entry.
Object	getProperty(String key) Retrieve the property value associated with the key key.
void	incrementHits() Deprecated.
void	resetHits() Deprecated.
void	setExpirationDate(Date expirationDate) Deprecated.
void	setExtendedProperties(Map<String,Serializable> newProperties) Sets the new properties Map instance.
void	setLastAccessedTimeNow() Deprecated.
void	setObject(V object) Sets/Updates the object associated to this cache entry.
void	setProperty(String key, Serializable value) Set the property of name key with the specified value value.

Methods inherited from class java.lang.Object

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

Constructor Detail

CacheEntry

public CacheEntry()

Default constructor, creates a new CacheEntry instance.

CacheEntry

public CacheEntry(V entryObj)

Creates a new CacheEntry object instance.

Parameters:

entryObj - the object instance to associate with the cache entry

Method Detail

getObject

public V getObject()

Retrieves the object associated with this cache entry.

Returns:

the stored object

setObject

public void setObject(V object)

Sets/Updates the object associated to this cache entry.

Parameters:

object - the new object to store in this cache entry.

setProperty

public void setProperty(String key,
                        Serializable value)

Set the property of name key with the specified value value.

Properties can have a null value, but key names do not. When a property already exists in the cache entry, the property's value is updated. When the name is null, the set operation is canceled.

Parameters:

key - the property's key

value - the property's value

getProperty

public Object getProperty(String key)

Retrieve the property value associated with the key key.

Properties can have a null value, but key names must be not null. When value of null is returned, it does mean the key is not found in the entry or the associated property has a null value. The two cases can be distinguished with the containsKey() method.

Parameters:

key - the property key

Returns:

return the property value.

containsKey

public boolean containsKey(String key)

Returns true if this entry contains the mapping for the specified property name key.

Parameters:

key - the property name

Returns:

true if this entry contains the mapping for the specified property name key.

getExtendedProperties

public Map<String,Serializable> getExtendedProperties()

Retrieves the properties Map instance.

Returns:

the properties Map instance

setExtendedProperties

public void setExtendedProperties(Map<String,Serializable> newProperties)

Sets the new properties Map instance. The operation is ignored if the newProperties is null.

Parameters:

newProperties - the new properties

getHits

@Deprecated
public final int getHits()

Deprecated.

Retrieves the number of hits of the entry (the number of times the entry was requested).

Returns:

the entry's hits

resetHits

@Deprecated
public final void resetHits()

Deprecated.

Resets the number of times the entry was requested.

incrementHits

@Deprecated
public final void incrementHits()

Deprecated.

Increments the number of hits by one.

getExpirationDate

@Deprecated
public final Date getExpirationDate()

Deprecated.

Retrieves the entry's expiration date.

Returns:

the expiration date

setExpirationDate

@Deprecated
public final void setExpirationDate(Date expirationDate)

Deprecated.

Sets the entry's expiration date.

Parameters:

expirationDate - the expiration date

setLastAccessedTimeNow

@Deprecated
public final void setLastAccessedTimeNow()

Deprecated.

Set the last accessed date to the current time.

getLastAccessedTimeMillis

@Deprecated
public long getLastAccessedTimeMillis()

Deprecated.