ehcache-core 2.10.9.2 · net.sf.ehcache.pool.Pool

Method Summary

Modifier and Type	Method and Description
public PoolAccessor<T extends PoolParticipant>	Returns: a PoolAccessor whose consumption is tracked by this pool. 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) Return a PoolAccessor whose consumption is tracked by this pool, using a default SizeOf engine.
public PoolAccessor<T extends PoolParticipant>	Returns: a PoolAccessor whose consumption is tracked by this pool. 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) Return a PoolAccessor whose consumption is tracked by this pool, using a specific SizeOf engine.
public PoolEvictor<T extends PoolParticipant>	Returns: the pool evictor getEvictor() Return the pool evictor used by this pool.
public long	Returns: the maximum size of the pool. getMaxSize() Return the maximum size of the pool.
public Collection<PoolAccessor<T extends PoolParticipant>>	Returns: participants using this pool getPoolAccessors() Return the participants accessing this pool.
public long	Returns: used size of the pool. getSize() Return the used size of the pool.
public void	registerPoolAccessor(PoolAccessor<T extends PoolParticipant> accessor to be registered accessor) Register an accessor implementation with this pool.
public void	removePoolAccessor(PoolAccessor<T extends PoolParticipant> accessor to be removed accessor) Remove the supplied accessor from this pool.
public void	setMaxSize(long the new pool size. newSize) Change the maximum size of the pool.

Method Detail

createPoolAccessor	back to summary
public PoolAccessor<T extends PoolParticipant> createPoolAccessor(PoolParticipant participant, int maxDepth, boolean abortWhenMaxDepthExceeded) 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)

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) 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)

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() 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()

Return the pool evictor used by this pool.

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

getMaxSize	back to summary
public long getMaxSize() Return the maximum size of the pool. Returns:long the maximum size of the pool.

getMaxSize

back to summary

public long 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() 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()

Return the participants accessing this pool.

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

getSize	back to summary
public long getSize() Return the used size of the pool. Returns:long used size of the pool.

getSize

back to summary

public long 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) 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)

Parameters

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

removePoolAccessor	back to summary
public void removePoolAccessor(PoolAccessor<T extends PoolParticipant> accessor) 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)

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) Change the maximum size of the pool. Parameters newSize:long the new pool size.

setMaxSize

back to summary

public void setMaxSize(long newSize)

Change the maximum size of the pool.

Parameters

newSize:long: the new pool size.

public Interface Pool

Method Summary

Method Detail