Modifier and Type	Class and Description
private static class	UnboundedPool.UnboundedPoolAccessor The PoolAccessor class of the UnboundedPool

Modifier and Type	Field and Description
public static final PoolAccessor<PoolParticipant>	UNBOUNDED_ACCESSOR An accessor that just is unbounded

Access	Constructor and Description
public	UnboundedPool() Create an UnboundedPool instance

Method Summary

Modifier and Type	Method and Description
public PoolAccessor<T extends PoolParticipant>	createPoolAccessor(PoolParticipant the participant which will use the created accessor. participant, int maximum depth of the object graph to traverse maxDepth, boolean true if the object traversal should be aborted when the max depth is exceeded abortWhenMaxDepthExceeded) Implements net.sf.ehcache.pool.Pool.createPoolAccessor. Return a PoolAccessor whose consumption is tracked by this pool, using a default SizeOf engine.
public PoolAccessor<T extends PoolParticipant>	createPoolAccessor(PoolParticipant the participant which will use the created accessor. participant, SizeOfEngine the SizeOf engine used to measure the size of objects added through the created accessor. sizeOfEngine) Implements net.sf.ehcache.pool.Pool.createPoolAccessor. Return a PoolAccessor whose consumption is tracked by this pool, using a specific SizeOf engine.
public PoolEvictor<T extends PoolParticipant>	getEvictor() Implements net.sf.ehcache.pool.Pool.getEvictor. Return the pool evictor used by this pool.
public long	getMaxSize() Implements net.sf.ehcache.pool.Pool.getMaxSize. Return the maximum size of the pool.
public Collection<PoolAccessor<T extends PoolParticipant>>	getPoolAccessors() Implements net.sf.ehcache.pool.Pool.getPoolAccessors. Return the participants accessing this pool.
public long	getSize() Implements net.sf.ehcache.pool.Pool.getSize. Return the used size of the pool.
public void	registerPoolAccessor(PoolAccessor<T extends PoolParticipant> accessor to be registered accessor) Implements net.sf.ehcache.pool.Pool.registerPoolAccessor. Register an accessor implementation with this pool.
public void	removePoolAccessor(PoolAccessor<T extends PoolParticipant> accessor to be removed accessor) Implements net.sf.ehcache.pool.Pool.removePoolAccessor. Remove the supplied accessor from this pool.
public void	setMaxSize(long the new pool size. newSize) Implements net.sf.ehcache.pool.Pool.setMaxSize. Change the maximum size of the pool.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

UNBOUNDED_ACCESSOR	back to summary
public static final PoolAccessor<PoolParticipant> UNBOUNDED_ACCESSOR An accessor that just is unbounded

UnboundedPool	back to summary
public UnboundedPool() Create an UnboundedPool instance

Method Detail

createPoolAccessor	back to summary
public PoolAccessor<T extends PoolParticipant> createPoolAccessor(PoolParticipant participant, int maxDepth, boolean abortWhenMaxDepthExceeded) Implements net.sf.ehcache.pool.Pool.createPoolAccessor. Doc from net.sf.ehcache.pool.Pool.createPoolAccessor. Return a PoolAccessor whose consumption is tracked by this pool, using a default SizeOf engine. Parameters participant:PoolParticipant the participant which will use the created accessor. maxDepth:int maximum depth of the object graph to traverse abortWhenMaxDepthExceeded:boolean true if the object traversal should be aborted when the max depth is exceeded Returns:PoolAccessor<T extends PoolParticipant> a PoolAccessor whose consumption is tracked by this pool.

createPoolAccessor

back to summary

public PoolAccessor<T extends PoolParticipant> createPoolAccessor(PoolParticipant participant, int maxDepth, boolean abortWhenMaxDepthExceeded)

Implements net.sf.ehcache.pool.Pool.createPoolAccessor.

Doc from net.sf.ehcache.pool.Pool.createPoolAccessor.

Return a PoolAccessor whose consumption is tracked by this pool, using a default SizeOf engine.

Parameters

participant:PoolParticipant: the participant which will use the created accessor.
maxDepth:int: maximum depth of the object graph to traverse
abortWhenMaxDepthExceeded:boolean: true if the object traversal should be aborted when the max depth is exceeded

Returns:PoolAccessor<T extends PoolParticipant>

a PoolAccessor whose consumption is tracked by this pool.

createPoolAccessor	back to summary
public PoolAccessor<T extends PoolParticipant> createPoolAccessor(PoolParticipant participant, SizeOfEngine sizeOfEngine) Implements net.sf.ehcache.pool.Pool.createPoolAccessor. Doc from net.sf.ehcache.pool.Pool.createPoolAccessor. Return a PoolAccessor whose consumption is tracked by this pool, using a specific SizeOf engine. Parameters participant:PoolParticipant the participant which will use the created accessor. sizeOfEngine:SizeOfEngine the SizeOf engine used to measure the size of objects added through the created accessor. Returns:PoolAccessor<T extends PoolParticipant> a PoolAccessor whose consumption is tracked by this pool.

createPoolAccessor

back to summary

public PoolAccessor<T extends PoolParticipant> createPoolAccessor(PoolParticipant participant, SizeOfEngine sizeOfEngine)

Implements net.sf.ehcache.pool.Pool.createPoolAccessor.

Doc from net.sf.ehcache.pool.Pool.createPoolAccessor.

Return a PoolAccessor whose consumption is tracked by this pool, using a specific SizeOf engine.

Parameters

participant:PoolParticipant: the participant which will use the created accessor.
sizeOfEngine:SizeOfEngine: the SizeOf engine used to measure the size of objects added through the created accessor.

Returns:PoolAccessor<T extends PoolParticipant>

a PoolAccessor whose consumption is tracked by this pool.

getEvictor	back to summary
public PoolEvictor<T extends PoolParticipant> getEvictor() Implements net.sf.ehcache.pool.Pool.getEvictor. Doc from net.sf.ehcache.pool.Pool.getEvictor. Return the pool evictor used by this pool. Returns:PoolEvictor<T extends PoolParticipant> the pool evictor

getEvictor

back to summary

public PoolEvictor<T extends PoolParticipant> getEvictor()

Implements net.sf.ehcache.pool.Pool.getEvictor.

Doc from net.sf.ehcache.pool.Pool.getEvictor.

Return the pool evictor used by this pool.

Returns:PoolEvictor<T extends PoolParticipant>: the pool evictor

getMaxSize	back to summary
public long getMaxSize() Implements net.sf.ehcache.pool.Pool.getMaxSize. Doc from net.sf.ehcache.pool.Pool.getMaxSize. Return the maximum size of the pool. Returns:long the maximum size of the pool.

getMaxSize

back to summary

public long getMaxSize()

Implements net.sf.ehcache.pool.Pool.getMaxSize.

Doc from net.sf.ehcache.pool.Pool.getMaxSize.

Return the maximum size of the pool.

Returns:long: the maximum size of the pool.

getPoolAccessors	back to summary
public Collection<PoolAccessor<T extends PoolParticipant>> getPoolAccessors() Implements net.sf.ehcache.pool.Pool.getPoolAccessors. Doc from net.sf.ehcache.pool.Pool.getPoolAccessors. Return the participants accessing this pool. Returns:Collection<PoolAccessor<T extends PoolParticipant>> participants using this pool

getPoolAccessors

back to summary

public Collection<PoolAccessor<T extends PoolParticipant>> getPoolAccessors()

Implements net.sf.ehcache.pool.Pool.getPoolAccessors.

Doc from net.sf.ehcache.pool.Pool.getPoolAccessors.

Return the participants accessing this pool.

Returns:Collection<PoolAccessor<T extends PoolParticipant>>: participants using this pool

getSize	back to summary
public long getSize() Implements net.sf.ehcache.pool.Pool.getSize. Doc from net.sf.ehcache.pool.Pool.getSize. Return the used size of the pool. Returns:long used size of the pool.

getSize

back to summary

public long getSize()

Implements net.sf.ehcache.pool.Pool.getSize.

Doc from net.sf.ehcache.pool.Pool.getSize.

Return the used size of the pool.

Returns:long: used size of the pool.

registerPoolAccessor	back to summary
public void registerPoolAccessor(PoolAccessor<T extends PoolParticipant> accessor) Implements net.sf.ehcache.pool.Pool.registerPoolAccessor. Doc from net.sf.ehcache.pool.Pool.registerPoolAccessor. Register an accessor implementation with this pool. Parameters accessor:PoolAccessor<T extends PoolParticipant> accessor to be registered

registerPoolAccessor

back to summary

public void registerPoolAccessor(PoolAccessor<T extends PoolParticipant> accessor)

Implements net.sf.ehcache.pool.Pool.registerPoolAccessor.

Doc from net.sf.ehcache.pool.Pool.registerPoolAccessor.

Parameters

accessor:PoolAccessor<T extends PoolParticipant>: accessor to be registered

removePoolAccessor	back to summary
public void removePoolAccessor(PoolAccessor<T extends PoolParticipant> accessor) Implements net.sf.ehcache.pool.Pool.removePoolAccessor. Doc from net.sf.ehcache.pool.Pool.removePoolAccessor. Remove the supplied accessor from this pool. Parameters accessor:PoolAccessor<T extends PoolParticipant> accessor to be removed

removePoolAccessor

back to summary

public void removePoolAccessor(PoolAccessor<T extends PoolParticipant> accessor)

Implements net.sf.ehcache.pool.Pool.removePoolAccessor.

Doc from net.sf.ehcache.pool.Pool.removePoolAccessor.

Remove the supplied accessor from this pool.

Parameters

accessor:PoolAccessor<T extends PoolParticipant>: accessor to be removed

setMaxSize	back to summary
public void setMaxSize(long newSize) Implements net.sf.ehcache.pool.Pool.setMaxSize. Doc from net.sf.ehcache.pool.Pool.setMaxSize. Change the maximum size of the pool. Parameters newSize:long the new pool size.

setMaxSize

back to summary

public void setMaxSize(long newSize)

Implements net.sf.ehcache.pool.Pool.setMaxSize.

Doc from net.sf.ehcache.pool.Pool.setMaxSize.

Change the maximum size of the pool.

Parameters

newSize:long: the new pool size.

net.sf.ehcache.pool.impl back to summary

private final Class UnboundedPool.UnboundedPoolAccessor

Class Inheritance

extends Object
implements PoolAccessor<PoolParticipant>

java.lang.Object
net.sf.ehcache.pool.impl.UnboundedPool.UnboundedPoolAccessor

All Implemented Interfaces

net.sf.ehcache.pool.PoolAccessor

The PoolAccessor class of the UnboundedPool

Constructor Summary

Access	Constructor and Description
private	UnboundedPoolAccessor()

Method Summary

Modifier and Type	Method and Description
public long	add(Object the key of the element key, Object the value of the element value, Object the element-container object container, boolean true if the pool should accept adding the element, even if it's out of resources force) Implements net.sf.ehcache.pool.PoolAccessor.add. Add an element to the pool.
public boolean	canAddWithoutEvicting(Object the key of the element key, Object the value of the element value, Object the element-container object container) Implements net.sf.ehcache.pool.PoolAccessor.canAddWithoutEvicting. Check if there is enough room in the pool to add an element without provoking any eviction
public void	clear() Implements net.sf.ehcache.pool.PoolAccessor.clear. Free resources used by this accessor.
public long	delete(long number of bytes sizeOf) Implements net.sf.ehcache.pool.PoolAccessor.delete. Delete a fixed number of bytes from the pool.
public PoolParticipant	getParticipant() Implements net.sf.ehcache.pool.PoolAccessor.getParticipant. Return the store that uses this accessor
public long	getPoolOccupancy() Implements net.sf.ehcache.pool.PoolAccessor.getPoolOccupancy. Returns the occupied size for this pool.
public long	getPoolSize() Implements net.sf.ehcache.pool.PoolAccessor.getPoolSize. Returns the size of this pool.
public long	getSize() Implements net.sf.ehcache.pool.PoolAccessor.getSize. Return how many bytes this accessor consumes from the pool.
public boolean	hasAbortedSizeOf() Implements net.sf.ehcache.pool.PoolAccessor.hasAbortedSizeOf. Check if the store may contain elements which the SizeOf engine could not fully size.
public long	replace(long the size of the object(s) being replaced currentSize, Object the key of the element key, Object the value of the element value, Object the element-container object container, boolean true if the pool should accept replacing the element, even if it's out of resources force) Implements net.sf.ehcache.pool.PoolAccessor.replace. Delete a fixed number of bytes from the pool with the given objects.
public void	setMaxSize(final long the value in bytes newValue) Implements net.sf.ehcache.pool.PoolAccessor.setMaxSize. Sets the max size for this pool
public void	unlink() Implements net.sf.ehcache.pool.PoolAccessor.unlink. unlink this PoolAccessor from its pool.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

UnboundedPoolAccessor	back to summary
private UnboundedPoolAccessor()

Method Detail

add	back to summary
public long add(Object key, Object value, Object container, boolean force) Implements net.sf.ehcache.pool.PoolAccessor.add. Doc from net.sf.ehcache.pool.PoolAccessor.add. Add an element to the pool. Parameters key:Object the key of the element value:Object the value of the element container:Object the element-container object force:boolean true if the pool should accept adding the element, even if it's out of resources Returns:long how many bytes have been added to the pool or -1 if add failed.

add

back to summary

public long add(Object key, Object value, Object container, boolean force)

Implements net.sf.ehcache.pool.PoolAccessor.add.

Doc from net.sf.ehcache.pool.PoolAccessor.add.

Add an element to the pool.

Parameters

key:Object: the key of the element
value:Object: the value of the element
container:Object: the element-container object
force:boolean: true if the pool should accept adding the element, even if it's out of resources

Returns:long

how many bytes have been added to the pool or -1 if add failed.

canAddWithoutEvicting	back to summary
public boolean canAddWithoutEvicting(Object key, Object value, Object container) Implements net.sf.ehcache.pool.PoolAccessor.canAddWithoutEvicting. Doc from net.sf.ehcache.pool.PoolAccessor.canAddWithoutEvicting. Check if there is enough room in the pool to add an element without provoking any eviction Parameters key:Object the key of the element value:Object the value of the element container:Object the element-container object Returns:boolean true if there is enough room left

canAddWithoutEvicting

back to summary

public boolean canAddWithoutEvicting(Object key, Object value, Object container)

Implements net.sf.ehcache.pool.PoolAccessor.canAddWithoutEvicting.

Doc from net.sf.ehcache.pool.PoolAccessor.canAddWithoutEvicting.

Check if there is enough room in the pool to add an element without provoking any eviction

Parameters

key:Object: the key of the element
value:Object: the value of the element
container:Object: the element-container object

Returns:boolean

true if there is enough room left

clear	back to summary
public void clear() Implements net.sf.ehcache.pool.PoolAccessor.clear. Doc from net.sf.ehcache.pool.PoolAccessor.clear. Free resources used by this accessor.

clear

back to summary

public void clear()

Implements net.sf.ehcache.pool.PoolAccessor.clear.

Doc from net.sf.ehcache.pool.PoolAccessor.clear.

Free resources used by this accessor.

delete	back to summary
public long delete(long sizeOf) throws IllegalArgumentException Implements net.sf.ehcache.pool.PoolAccessor.delete. Doc from net.sf.ehcache.pool.PoolAccessor.delete. Delete a fixed number of bytes from the pool. Parameters sizeOf:long number of bytes Returns:long how many bytes have been freed from the pool. Exceptions IllegalArgumentException: when sizeOf is negative

delete

back to summary

public long delete(long sizeOf) throws IllegalArgumentException

Implements net.sf.ehcache.pool.PoolAccessor.delete.

Doc from net.sf.ehcache.pool.PoolAccessor.delete.

Delete a fixed number of bytes from the pool.

Parameters

sizeOf:long: number of bytes

Returns:long

how many bytes have been freed from the pool.

Exceptions

IllegalArgumentException:: when sizeOf is negative

getParticipant	back to summary
public PoolParticipant getParticipant() Implements net.sf.ehcache.pool.PoolAccessor.getParticipant. Doc from net.sf.ehcache.pool.PoolAccessor.getParticipant. Return the store that uses this accessor Returns:PoolParticipant store using this accessor

getParticipant

back to summary

public PoolParticipant getParticipant()

Implements net.sf.ehcache.pool.PoolAccessor.getParticipant.

Doc from net.sf.ehcache.pool.PoolAccessor.getParticipant.

Return the store that uses this accessor

Returns:PoolParticipant: store using this accessor

getPoolOccupancy	back to summary
public long getPoolOccupancy() Implements net.sf.ehcache.pool.PoolAccessor.getPoolOccupancy. Doc from net.sf.ehcache.pool.PoolAccessor.getPoolOccupancy. Returns the occupied size for this pool. Returns:long occupied pool size

getPoolOccupancy

back to summary

public long getPoolOccupancy()

Implements net.sf.ehcache.pool.PoolAccessor.getPoolOccupancy.

Doc from net.sf.ehcache.pool.PoolAccessor.getPoolOccupancy.

Returns the occupied size for this pool.

Returns:long: occupied pool size

getPoolSize	back to summary
public long getPoolSize() Implements net.sf.ehcache.pool.PoolAccessor.getPoolSize. Doc from net.sf.ehcache.pool.PoolAccessor.getPoolSize. Returns the size of this pool. Returns:long pool size

getPoolSize

back to summary

public long getPoolSize()

Implements net.sf.ehcache.pool.PoolAccessor.getPoolSize.

Doc from net.sf.ehcache.pool.PoolAccessor.getPoolSize.

Returns the size of this pool.

Returns:long: pool size

getSize	back to summary
public long getSize() Implements net.sf.ehcache.pool.PoolAccessor.getSize. Doc from net.sf.ehcache.pool.PoolAccessor.getSize. Return how many bytes this accessor consumes from the pool. Returns:long how many bytes this accessor consumes from the pool.

getSize

back to summary

public long getSize()

Implements net.sf.ehcache.pool.PoolAccessor.getSize.

Doc from net.sf.ehcache.pool.PoolAccessor.getSize.

Return how many bytes this accessor consumes from the pool.

Returns:long: how many bytes this accessor consumes from the pool.

hasAbortedSizeOf	back to summary
public boolean hasAbortedSizeOf() Implements net.sf.ehcache.pool.PoolAccessor.hasAbortedSizeOf. Doc from net.sf.ehcache.pool.PoolAccessor.hasAbortedSizeOf. Check if the store may contain elements which the SizeOf engine could not fully size. Returns:boolean true if the store may contain partially sized objects

hasAbortedSizeOf

back to summary

public boolean hasAbortedSizeOf()

Implements net.sf.ehcache.pool.PoolAccessor.hasAbortedSizeOf.

Doc from net.sf.ehcache.pool.PoolAccessor.hasAbortedSizeOf.

Check if the store may contain elements which the SizeOf engine could not fully size.

Returns:boolean: true if the store may contain partially sized objects

replace back to summary

replace	back to summary
public long replace(long currentSize, Object key, Object value, Object container, boolean force) Implements net.sf.ehcache.pool.PoolAccessor.replace. Doc from net.sf.ehcache.pool.PoolAccessor.replace. Delete a fixed number of bytes from the pool with the given objects. Parameters currentSize:long the size of the object(s) being replaced key:Object the key of the element value:Object the value of the element container:Object the element-container object force:boolean true if the pool should accept replacing the element, even if it's out of resources Returns:long the change in size of the pool, or `Long#MIN_VALUE` if replace failed.

public long replace(long currentSize, Object key, Object value, Object container, boolean force)

Implements net.sf.ehcache.pool.PoolAccessor.replace.

Doc from net.sf.ehcache.pool.PoolAccessor.replace.

Delete a fixed number of bytes from the pool with the given objects.

Parameters

currentSize:long: the size of the object(s) being replaced
key:Object: the key of the element
value:Object: the value of the element
container:Object: the element-container object
force:boolean: true if the pool should accept replacing the element, even if it's out of resources

Returns:long

the change in size of the pool, or Long#MIN_VALUE if replace failed.

setMaxSize	back to summary
public void setMaxSize(final long newValue) Implements net.sf.ehcache.pool.PoolAccessor.setMaxSize. Doc from net.sf.ehcache.pool.PoolAccessor.setMaxSize. Sets the max size for this pool Parameters newValue:long the value in bytes

setMaxSize

back to summary

public void setMaxSize(final long newValue)

Implements net.sf.ehcache.pool.PoolAccessor.setMaxSize.

Doc from net.sf.ehcache.pool.PoolAccessor.setMaxSize.

Sets the max size for this pool

Parameters

newValue:long: the value in bytes

unlink	back to summary
public void unlink() Implements net.sf.ehcache.pool.PoolAccessor.unlink. Doc from net.sf.ehcache.pool.PoolAccessor.unlink. unlink this PoolAccessor from its pool.

unlink

back to summary

public void unlink()

Implements net.sf.ehcache.pool.PoolAccessor.unlink.

Doc from net.sf.ehcache.pool.PoolAccessor.unlink.

unlink this PoolAccessor from its pool.

public Class UnboundedPool

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class UnboundedPool.UnboundedPoolAccessor

Constructor Summary

Method Summary

Constructor Detail

Method Detail