ehcache-core 2.10.9.2 · net.sf.ehcache.pool.impl.AbstractPoolAccessor

Modifier and Type	Field and Description
private volatile boolean	abortedSizeOf
private final Pool	pool
private final PoolParticipant	poolParticipant
protected final SizeOfEngine	sizeOfEngine `SizeOfEngine` used by the accessor.
private final AtomicBoolean	unlinked

Access	Constructor and Description
public	AbstractPoolAccessor(Pool pool to be accessed pool, PoolParticipant accessing participant participant, SizeOfEngine sizeOfEngine) Creates an accessor for the specified participant to access the specified pool.

Method Summary

Modifier and Type	Method and Description
public final 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.
protected abstract long	Returns: how many bytes have been added to the pool or -1 if add failed. add(long number of bytes to add sizeOf, boolean true if the pool should accept adding the element, even if it's out of resources force) Add a specific number of bytes to the pool.
public final 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
protected abstract boolean	Returns: true if there is enough room left canAddWithoutEvicting(long number of bytes to test against sizeOf) Check if there is enough room in the pool to add a specific number of bytes without provoking any eviction
protected final void	checkLinked() Throws `IllegalStateException` if this accessor is not linked to it's pool.
public final void	clear() Implements net.sf.ehcache.pool.PoolAccessor.clear. Free resources used by this accessor.
protected abstract void	doClear() Free resources used by this accessor.
public final PoolParticipant	getParticipant() Implements net.sf.ehcache.pool.PoolAccessor.getParticipant. Return the store that uses this accessor
protected final Pool	Returns: associated pool getPool() Return the pool this accessor is associated with.
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 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 final 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 final 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

abortedSizeOf	back to summary
private volatile boolean abortedSizeOf

pool	back to summary
private final Pool pool

poolParticipant	back to summary
private final PoolParticipant poolParticipant

sizeOfEngine	back to summary
protected final SizeOfEngine sizeOfEngine `SizeOfEngine` used by the accessor.

unlinked	back to summary
private final AtomicBoolean unlinked

AbstractPoolAccessor	back to summary
public AbstractPoolAccessor(Pool pool, PoolParticipant participant, SizeOfEngine sizeOfEngine) Creates an accessor for the specified participant to access the specified pool. Parameters pool:Pool pool to be accessed participant:PoolParticipant accessing participant

Method Detail

add	back to summary
public final 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 final 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
protected abstract long add(long sizeOf, boolean force) throws IllegalArgumentException Add a specific number of bytes to the pool. Parameters sizeOf:long number of bytes to add 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. Exceptions IllegalArgumentException: when sizeOf is negative

add

back to summary

protected abstract long add(long sizeOf, boolean force) throws IllegalArgumentException

Add a specific number of bytes to the pool.

Parameters

sizeOf:long: number of bytes to add
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.

Exceptions

IllegalArgumentException:: when sizeOf is negative

canAddWithoutEvicting	back to summary
public final 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 final 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
protected abstract boolean canAddWithoutEvicting(long sizeOf) Check if there is enough room in the pool to add a specific number of bytes without provoking any eviction Parameters sizeOf:long number of bytes to test against Returns:boolean true if there is enough room left

canAddWithoutEvicting

back to summary

protected abstract boolean canAddWithoutEvicting(long sizeOf)

Check if there is enough room in the pool to add a specific number of bytes without provoking any eviction

Parameters

sizeOf:long: number of bytes to test against

Returns:boolean

true if there is enough room left

checkLinked back to summary

checkLinked	back to summary
protected final void checkLinked() throws IllegalStateException Throws `IllegalStateException` if this accessor is not linked to it's pool. Exceptions IllegalStateException: if not linked

protected final void checkLinked() throws IllegalStateException

Throws IllegalStateException if this accessor is not linked to it's pool.

Exceptions

IllegalStateException:: if not linked

clear	back to summary
public final 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 final void clear()

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

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

Free resources used by this accessor.

doClear	back to summary
protected abstract void doClear() Free resources used by this accessor. This method is called by `clear()`.

getParticipant	back to summary
public final 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 final 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

getPool	back to summary
protected final Pool getPool() Return the pool this accessor is associated with. Returns:Pool associated pool

getPool

back to summary

protected final Pool getPool()

Return the pool this accessor is associated with.

Returns:Pool: associated pool

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

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 final 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 final 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 final 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 final void unlink()

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

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

unlink this PoolAccessor from its pool.

public abstract Class AbstractPoolAccessor

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail