TryCache - Javadocs [I2P+ 0.9.50]

java.lang.Object

net.i2p.util.TryCache<T>

Type Parameters:: T -

Direct Known Subclasses:: ByteCache

public class TryCache<T>
extends Object

An object cache which is safe to use by multiple threads without blocking.

Since:: 0.9.36
Author:: zab

Nested Class Summary

Nested Classes

Modifier and Type Class Description

static interface TryCache.ObjectFactory<T>
Something that creates objects of the type cached by this cache
Field Summary

Fields

Modifier and Type Field Description

protected long _lastUnderflow

protected int capacity

protected List<T> items

protected Lock lock
Constructor Summary

Constructors

Constructor Description

TryCache(TryCache.ObjectFactory<T> factory, int capacity)

Method Summary

Modifier and Type	Method	Description
`T`	`acquire()`
`void`	`clear()`	Clears all cached items.
`void`	`release(T item)`	Tries to return this item to the cache but it may fail if the cache has reached capacity or it's lock is held by another thread.

Methods inherited from class java.lang.Object

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

Field Details
- capacity
  
  protected final int capacity
- items
  
  protected final List<T> items
- lock
  
  protected final Lock lock
- _lastUnderflow
  
  protected long _lastUnderflow
Constructor Details
- TryCache
  
  public TryCache(TryCache.ObjectFactory<T> factory, int capacity)
  
  Parameters:
  
  factory - to be used for creating new instances
  
  capacity - cache up to this many items
Method Details
- acquire
  
  public T acquire()
  
  Returns:
  
  a cached or newly created item from this cache
- release
  
  public void release(T item)
  
  Tries to return this item to the cache but it may fail if the cache has reached capacity or it's lock is held by another thread.
- clear
  
  public void clear()
  
  Clears all cached items. This is the only method that blocks until it acquires the lock.