TimeLimited (Castor JavaDoc)

java.lang.Object
- org.castor.cache.AbstractBaseCache
- - org.castor.cache.simple.TimeLimited

All Implemented Interfaces:

java.util.Map<java.lang.Object,java.lang.Object>, Cache
```
public class TimeLimited
extends AbstractBaseCache
```
TimeLimited is a time limted first-in-first-out Map. Every object being put in the Map will live until the timeout expired.
The expiration time is passed to the cache at initialization by the individual cache property ttl which defines the timeout of every object in the cache in seconds. If not specified a timeout of 30 seconds will be used.

Version:

$Revision: 8102 $ $Date: 2006-04-25 16:09:10 -0600 (Tue, 25 Apr 2006) $

Author:

Thomas Yip, Stein M. Hugubakken, Werner Guttmann, Ralf Joachim

Nested Class Summary
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K extends java.lang.Object,V extends java.lang.Object>

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`DEFAULT_TTL`	Default ttl of cache.
`static java.lang.String`	`PARAM_TTL`	Mapped initialization parameter `ttl`.
`static java.lang.String`	`TYPE`	The type of the cache.

Fields inherited from interface org.castor.cache.Cache
DEFAULT_DEBUG, DEFAULT_NAME, DEFAULT_TYPE, PARAM_DEBUG, PARAM_NAME, PARAM_TYPE

Constructor Summary

Constructors
Constructor Description

TimeLimited()

Constructors
Constructor	Description
`TimeLimited()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`clear()`
`boolean`	`containsKey(java.lang.Object key)`
`boolean`	`containsValue(java.lang.Object value)`
`java.util.Set<java.util.Map.Entry<java.lang.Object,java.lang.Object>>`	`entrySet()`
`java.lang.Object`	`get(java.lang.Object key)`
`int`	`getTTL()`	Get real ttl of this cache.
`java.lang.String`	`getType()`	Indicates the type of this cache.
`void`	`initialize(java.util.Properties params)`	Lyfe-cycle method to allow custom initialization of cache implementations.
`boolean`	`isEmpty()`
`java.util.Set<java.lang.Object>`	`keySet()`
`java.lang.Object`	`put(java.lang.Object key, java.lang.Object value)`
`void`	`putAll(java.util.Map<? extends java.lang.Object,? extends java.lang.Object> map)`
`java.lang.Object`	`remove(java.lang.Object key)`
`int`	`size()`
`java.util.Collection<java.lang.Object>`	`values()`

Methods inherited from class org.castor.cache.AbstractBaseCache
close, expire, expireAll, getName, invokeMethod, invokeStaticMethod

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- TYPE
```
public static final java.lang.String TYPE
```
  The type of the cache.
  
  See Also:
  
  Constant Field Values
- PARAM_TTL
```
public static final java.lang.String PARAM_TTL
```
  Mapped initialization parameter ttl.
  
  See Also:
  
  Constant Field Values
- DEFAULT_TTL
```
public static final int DEFAULT_TTL
```
  Default ttl of cache.
  
  See Also:
  
  Constant Field Values

Constructor Detail
- TimeLimited
```
public TimeLimited()
```

Method Detail

initialize
```
public final void initialize(java.util.Properties params)
                      throws CacheAcquireException
```
Lyfe-cycle method to allow custom initialization of cache implementations.

Specified by:

initialize in interface Cache

Overrides:

initialize in class AbstractBaseCache

Parameters:

params - Parameters to initialize the cache (e.g. name, capacity).

Throws:

CacheAcquireException - If cache can not be initialized.

getType
```
public final java.lang.String getType()
```
Indicates the type of this cache.

Returns:

The cache type.

getTTL
```
public final int getTTL()
```
Get real ttl of this cache.

Returns:

Real ttl of this cache.

size
```
public final int size()
```

isEmpty
```
public final boolean isEmpty()
```

containsKey

public final boolean containsKey(java.lang.Object key)

containsValue

public final boolean containsValue(java.lang.Object value)

get

public final java.lang.Object get(java.lang.Object key)

put

public final java.lang.Object put(java.lang.Object key,
                                  java.lang.Object value)

remove

public java.lang.Object remove(java.lang.Object key)

putAll

public final void putAll(java.util.Map<? extends java.lang.Object,? extends java.lang.Object> map)

clear
```
public final void clear()
```

keySet

public final java.util.Set<java.lang.Object> keySet()

values

public final java.util.Collection<java.lang.Object> values()

entrySet

public final java.util.Set<java.util.Map.Entry<java.lang.Object,java.lang.Object>> entrySet()

Class TimeLimited

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Field Summary

Fields inherited from interface org.castor.cache.Cache

Constructor Summary

Method Summary

Methods inherited from class org.castor.cache.AbstractBaseCache

Methods inherited from interface java.util.Map

Methods inherited from class java.lang.Object

Field Detail

TYPE

PARAM_TTL

DEFAULT_TTL

Constructor Detail

TimeLimited

Method Detail

initialize

getType

getTTL

size

isEmpty

containsKey

containsValue

get

put

remove

putAll

clear

keySet

values

entrySet