org.apache.jcs.engine.behavior
Interface IElementAttributes

All Known Implementing Classes:
ElementAttributes

public interface IElementAttributes

Inteface for cache element attributes classes.

Author:
asmuts

Method Summary
 void addElementEventHandler(IElementEventHandler eventHandler)
          Adds a ElementEventHandler.
 IElementAttributes copy()
          Returns a copy of the object.
 long getCreateTime()
          Gets the createTime attribute of the IAttributes object
 java.util.ArrayList getElementEventHandlers()
          Gets the elementEventHandlers.
 long getIdleTime()
          Gets the idleTime attribute of the IAttributes object
 boolean getIsDistribute()
          Gets the {3} attribute of the IElementAttributes object
 boolean getIsEternal()
          can turn off expiration
 boolean getIsLateral()
          Is this item laterally distributable
 boolean getIsRemote()
          Can this item be sent to the remote cache
 boolean getIsSpool()
          can this item be flushed to disk
 long getLastAccessTime()
          Gets the LastAccess attribute of the IAttributes object
 long getMaxLifeSeconds()
          Sets the maxLife attribute of the IAttributes object
 int getSize()
          Gets the size attribute of the IAttributes object
 long getTimeToLiveSeconds()
          Gets the time left to live of the IAttributes object
 long getVersion()
          Gets the version attribute of the IAttributes object
 void setIdleTime(long idle)
          Sets the idleTime attribute of the IAttributes object
 void setIsDistribute(boolean val)
          Sets the isDistribute attribute of the IElementAttributes object
 void setIsEternal(boolean val)
          Sets the isEternal attribute of the IElementAttributes object
 void setIsLateral(boolean val)
          Sets the isLateral attribute of the IElementAttributes object
 void setIsRemote(boolean val)
          Sets the isRemote attribute of the IElementAttributes object
 void setIsSpool(boolean val)
          Sets the isSpool attribute of the IElementAttributes object
 void setLastAccessTimeNow()
          Sets the LastAccessTime as now of the IElementAttributes object
 void setMaxLifeSeconds(long mls)
          Sets the maxLife attribute of the IAttributes object
 void setSize(int size)
          Size in bytes.
 void setVersion(long version)
          Sets the version attribute of the IAttributes object
 

Method Detail

setVersion

public void setVersion(long version)
Sets the version attribute of the IAttributes object

Parameters:
version - The new version value

setMaxLifeSeconds

public void setMaxLifeSeconds(long mls)
Sets the maxLife attribute of the IAttributes object

Parameters:
mls - The new {3} value

getMaxLifeSeconds

public long getMaxLifeSeconds()
Sets the maxLife attribute of the IAttributes object

Returns:
The {3} value

setIdleTime

public void setIdleTime(long idle)
Sets the idleTime attribute of the IAttributes object

Parameters:
idle - The new idleTime value

setSize

public void setSize(int size)
Size in bytes.

Parameters:
size - The new size value

getSize

public int getSize()
Gets the size attribute of the IAttributes object

Returns:
The size value

getCreateTime

public long getCreateTime()
Gets the createTime attribute of the IAttributes object

Returns:
The createTime value

getLastAccessTime

public long getLastAccessTime()
Gets the LastAccess attribute of the IAttributes object

Returns:
The LastAccess value

setLastAccessTimeNow

public void setLastAccessTimeNow()
Sets the LastAccessTime as now of the IElementAttributes object


getVersion

public long getVersion()
Gets the version attribute of the IAttributes object

Returns:
The version value

getIdleTime

public long getIdleTime()
Gets the idleTime attribute of the IAttributes object

Returns:
The idleTime value

getTimeToLiveSeconds

public long getTimeToLiveSeconds()
Gets the time left to live of the IAttributes object

Returns:
The t value

copy

public IElementAttributes copy()
Returns a copy of the object.

Returns:
IElementAttributes

getIsDistribute

public boolean getIsDistribute()
Gets the {3} attribute of the IElementAttributes object

Returns:
The {3} value

setIsDistribute

public void setIsDistribute(boolean val)
Sets the isDistribute attribute of the IElementAttributes object

Parameters:
val - The new isDistribute value

getIsSpool

public boolean getIsSpool()
can this item be flushed to disk

Returns:
The {3} value

setIsSpool

public void setIsSpool(boolean val)
Sets the isSpool attribute of the IElementAttributes object

Parameters:
val - The new isSpool value

getIsLateral

public boolean getIsLateral()
Is this item laterally distributable

Returns:
The {3} value

setIsLateral

public void setIsLateral(boolean val)
Sets the isLateral attribute of the IElementAttributes object

Parameters:
val - The new isLateral value

getIsRemote

public boolean getIsRemote()
Can this item be sent to the remote cache

Returns:
The {3} value

setIsRemote

public void setIsRemote(boolean val)
Sets the isRemote attribute of the IElementAttributes object

Parameters:
val - The new isRemote value

getIsEternal

public boolean getIsEternal()
can turn off expiration

Returns:
The {3} value

setIsEternal

public void setIsEternal(boolean val)
Sets the isEternal attribute of the IElementAttributes object

Parameters:
val - The new isEternal value

addElementEventHandler

public void addElementEventHandler(IElementEventHandler eventHandler)
Adds a ElementEventHandler. Handler's can be registered for multiple events. A registered handler will be called at every recognized event.

Parameters:
eventHandler - The feature to be added to the ElementEventHandler

getElementEventHandlers

public java.util.ArrayList getElementEventHandlers()
Gets the elementEventHandlers.

Returns:
The elementEventHandlers value