Modifier and Type	Class and Description
public static enum	SizeOfPolicyConfiguration.MaxDepthExceededBehavior Enum of the possible behaviors of the SizeOf engine when the max depth is exceeded

Modifier and Type	Field and Description
public static final SizeOfPolicyConfiguration.MaxDepthExceededBehavior	DEFAULT_MAX_DEPTH_EXCEEDED_BEHAVIOR Default max traversal depth exceeded behavior
public static final int	DEFAULT_MAX_SIZEOF_DEPTH Default max traversal depth
private volatile int	maxDepth
private volatile SizeOfPolicyConfiguration.MaxDepthExceededBehavior	maxDepthExceededBehavior

Access	Constructor and Description
public	SizeOfPolicyConfiguration()

Method Summary

Modifier and Type	Method and Description
public boolean	equals(Object the reference object with which to compare. obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public int	Returns: the maximum depth the SizeOf engine can normally traverse getMaxDepth() Gets the maximum depth the SizeOf engine can normally traverse
public SizeOfPolicyConfiguration.MaxDepthExceededBehavior	Returns: the behavior of the SizeOf engine when the max depth is reached getMaxDepthExceededBehavior() Gets the behavior of the SizeOf engine when the max depth is reached
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.
public SizeOfPolicyConfiguration	Returns: this SizeOfPolicyConfiguration object maxDepth(int the maximum depth the SizeOf engine can normally traverse maxDepth) Builder method to set the maximum depth the SizeOf engine can normally traverse
public SizeOfPolicyConfiguration	Returns: this SizeOfPolicyConfiguration object maxDepthExceededBehavior(SizeOfPolicyConfiguration.MaxDepthExceededBehavior the behavior of the SizeOf engine when the max depth is reached maxDepthExceededBehavior) Builder method to set the behavior of the SizeOf engine when the max depth is reached
public SizeOfPolicyConfiguration	Returns: this SizeOfPolicyConfiguration object maxDepthExceededBehavior(String the behavior of the SizeOf engine when the max depth is reached maxDepthExceededBehavior) Builder method to set the behavior of the SizeOf engine when the max depth is reached using a String object
public static SizeOfPolicyConfiguration.MaxDepthExceededBehavior	Returns: the resolved MaxDepthExceededBehavior resolveBehavior(Ehcache the cache from which to resolve the MaxDepthExceededBehavior cache) Helper method which resolves the MaxDepthExceededBehavior of a cache, using the cache manager's one if none was configured on the cache itself.
public static int	Returns: the resolved max depth resolveMaxDepth(Ehcache the cache from which to resolve the max depth cache) Helper method which resolves the max depth of a cache, using the cache manager's one if none was configured on the cache itself.
private static SizeOfPolicyConfiguration	resolvePolicy(Configuration configuration, CacheConfiguration cacheConfiguration)
public void	setMaxDepth(int the maximum depth the SizeOf engine can normally traverse maxDepth) Sets the maximum depth the SizeOf engine can normally traverse
public void	setMaxDepthExceededBehavior(String the behavior of the SizeOf engine when the max depth is reached maxDepthExceededBehavior) Sets the behavior of the SizeOf engine when the max depth is reached

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

Field Detail

DEFAULT_MAX_DEPTH_EXCEEDED_BEHAVIOR	back to summary
public static final SizeOfPolicyConfiguration.MaxDepthExceededBehavior DEFAULT_MAX_DEPTH_EXCEEDED_BEHAVIOR Default max traversal depth exceeded behavior

DEFAULT_MAX_SIZEOF_DEPTH	back to summary
public static final int DEFAULT_MAX_SIZEOF_DEPTH Default max traversal depth

maxDepth	back to summary
private volatile int maxDepth

maxDepthExceededBehavior	back to summary
private volatile SizeOfPolicyConfiguration.MaxDepthExceededBehavior maxDepthExceededBehavior

Constructor Detail

SizeOfPolicyConfiguration	back to summary
public SizeOfPolicyConfiguration()

Method Detail

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters obj:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

obj:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getMaxDepth	back to summary
public int getMaxDepth() Gets the maximum depth the SizeOf engine can normally traverse Returns:int the maximum depth the SizeOf engine can normally traverse

getMaxDepth

back to summary

public int getMaxDepth()

Gets the maximum depth the SizeOf engine can normally traverse

Returns:int: the maximum depth the SizeOf engine can normally traverse

getMaxDepthExceededBehavior	back to summary
public SizeOfPolicyConfiguration.MaxDepthExceededBehavior getMaxDepthExceededBehavior() Gets the behavior of the SizeOf engine when the max depth is reached Returns:SizeOfPolicyConfiguration.MaxDepthExceededBehavior the behavior of the SizeOf engine when the max depth is reached

getMaxDepthExceededBehavior

back to summary

public SizeOfPolicyConfiguration.MaxDepthExceededBehavior getMaxDepthExceededBehavior()

Gets the behavior of the SizeOf engine when the max depth is reached

Returns:SizeOfPolicyConfiguration.MaxDepthExceededBehavior: the behavior of the SizeOf engine when the max depth is reached

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object. Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object.

Annotations

@Override

maxDepth	back to summary
public SizeOfPolicyConfiguration maxDepth(int maxDepth) Builder method to set the maximum depth the SizeOf engine can normally traverse Parameters maxDepth:int the maximum depth the SizeOf engine can normally traverse Returns:SizeOfPolicyConfiguration this SizeOfPolicyConfiguration object

maxDepth

back to summary

public SizeOfPolicyConfiguration maxDepth(int maxDepth)

Builder method to set the maximum depth the SizeOf engine can normally traverse

Parameters

maxDepth:int: the maximum depth the SizeOf engine can normally traverse

Returns:SizeOfPolicyConfiguration

this SizeOfPolicyConfiguration object

maxDepthExceededBehavior	back to summary
public SizeOfPolicyConfiguration maxDepthExceededBehavior(SizeOfPolicyConfiguration.MaxDepthExceededBehavior maxDepthExceededBehavior) Builder method to set the behavior of the SizeOf engine when the max depth is reached Parameters maxDepthExceededBehavior:SizeOfPolicyConfiguration.MaxDepthExceededBehavior the behavior of the SizeOf engine when the max depth is reached Returns:SizeOfPolicyConfiguration this SizeOfPolicyConfiguration object

maxDepthExceededBehavior

back to summary

public SizeOfPolicyConfiguration maxDepthExceededBehavior(SizeOfPolicyConfiguration.MaxDepthExceededBehavior maxDepthExceededBehavior)

Builder method to set the behavior of the SizeOf engine when the max depth is reached

Parameters

maxDepthExceededBehavior:SizeOfPolicyConfiguration.MaxDepthExceededBehavior: the behavior of the SizeOf engine when the max depth is reached

Returns:SizeOfPolicyConfiguration

this SizeOfPolicyConfiguration object

maxDepthExceededBehavior	back to summary
public SizeOfPolicyConfiguration maxDepthExceededBehavior(String maxDepthExceededBehavior) Builder method to set the behavior of the SizeOf engine when the max depth is reached using a String object Parameters maxDepthExceededBehavior:String the behavior of the SizeOf engine when the max depth is reached Returns:SizeOfPolicyConfiguration this SizeOfPolicyConfiguration object

maxDepthExceededBehavior

back to summary

public SizeOfPolicyConfiguration maxDepthExceededBehavior(String maxDepthExceededBehavior)

Builder method to set the behavior of the SizeOf engine when the max depth is reached using a String object

Parameters

maxDepthExceededBehavior:String: the behavior of the SizeOf engine when the max depth is reached

Returns:SizeOfPolicyConfiguration

this SizeOfPolicyConfiguration object

resolveBehavior	back to summary
public static SizeOfPolicyConfiguration.MaxDepthExceededBehavior resolveBehavior(Ehcache cache) Helper method which resolves the MaxDepthExceededBehavior of a cache, using the cache manager's one if none was configured on the cache itself. Parameters cache:Ehcache the cache from which to resolve the MaxDepthExceededBehavior Returns:SizeOfPolicyConfiguration.MaxDepthExceededBehavior the resolved MaxDepthExceededBehavior

resolveBehavior

back to summary

public static SizeOfPolicyConfiguration.MaxDepthExceededBehavior resolveBehavior(Ehcache cache)

Helper method which resolves the MaxDepthExceededBehavior of a cache, using the cache manager's one if none was configured on the cache itself.

Parameters

cache:Ehcache: the cache from which to resolve the MaxDepthExceededBehavior

Returns:SizeOfPolicyConfiguration.MaxDepthExceededBehavior

the resolved MaxDepthExceededBehavior

resolveMaxDepth	back to summary
public static int resolveMaxDepth(Ehcache cache) Helper method which resolves the max depth of a cache, using the cache manager's one if none was configured on the cache itself. Parameters cache:Ehcache the cache from which to resolve the max depth Returns:int the resolved max depth

resolveMaxDepth

back to summary

public static int resolveMaxDepth(Ehcache cache)

Helper method which resolves the max depth of a cache, using the cache manager's one if none was configured on the cache itself.

Parameters

cache:Ehcache: the cache from which to resolve the max depth

Returns:int

the resolved max depth

resolvePolicy	back to summary
private static SizeOfPolicyConfiguration resolvePolicy(Configuration configuration, CacheConfiguration cacheConfiguration)

setMaxDepth	back to summary
public void setMaxDepth(int maxDepth) Sets the maximum depth the SizeOf engine can normally traverse Parameters maxDepth:int the maximum depth the SizeOf engine can normally traverse

setMaxDepth

back to summary

public void setMaxDepth(int maxDepth)

Sets the maximum depth the SizeOf engine can normally traverse

Parameters

maxDepth:int: the maximum depth the SizeOf engine can normally traverse

setMaxDepthExceededBehavior	back to summary
public void setMaxDepthExceededBehavior(String maxDepthExceededBehavior) Sets the behavior of the SizeOf engine when the max depth is reached Parameters maxDepthExceededBehavior:String the behavior of the SizeOf engine when the max depth is reached

setMaxDepthExceededBehavior

back to summary

public void setMaxDepthExceededBehavior(String maxDepthExceededBehavior)

Sets the behavior of the SizeOf engine when the max depth is reached

Parameters

maxDepthExceededBehavior:String: the behavior of the SizeOf engine when the max depth is reached

net.sf.ehcache.config back to summary

public final Enum SizeOfPolicyConfiguration.MaxDepthExceededBehavior

Class Inheritance

extends Enum<SizeOfPolicyConfiguration.MaxDepthExceededBehavior>

java.lang.Object
java.lang.Enum
net.sf.ehcache.config.SizeOfPolicyConfiguration.MaxDepthExceededBehavior

Enum of the possible behaviors of the SizeOf engine when the max depth is exceeded

Field Summary

Modifier and Type	Field and Description
public static final SizeOfPolicyConfiguration.MaxDepthExceededBehavior	ABORT Abort the SizeOf engine's traversal and immediately return the partially calculated size
public static final SizeOfPolicyConfiguration.MaxDepthExceededBehavior	CONTINUE Warn about the exceeded max depth but continue traversal of the sized element

Constructor Summary

Access	Constructor and Description
private	MaxDepthExceededBehavior()

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: true if this behavior is equal to ABORT isAbort() Returns true if this behavior is equal to ABORT
public boolean	Returns: true if this behavior is equal to CONTINUE isContinue() Returns true if this behavior is equal to CONTINUE
public static SizeOfPolicyConfiguration.MaxDepthExceededBehavior	valueOf(String name)
public static SizeOfPolicyConfiguration.MaxDepthExceededBehavior[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

ABORT	back to summary
public static final SizeOfPolicyConfiguration.MaxDepthExceededBehavior ABORT Abort the SizeOf engine's traversal and immediately return the partially calculated size

CONTINUE	back to summary
public static final SizeOfPolicyConfiguration.MaxDepthExceededBehavior CONTINUE Warn about the exceeded max depth but continue traversal of the sized element

Constructor Detail

MaxDepthExceededBehavior	back to summary
private MaxDepthExceededBehavior()

Method Detail

isAbort	back to summary
public boolean isAbort() Returns true if this behavior is equal to ABORT Returns:boolean true if this behavior is equal to ABORT

isAbort

back to summary

public boolean isAbort()

Returns true if this behavior is equal to ABORT

Returns:boolean: true if this behavior is equal to ABORT

isContinue	back to summary
public boolean isContinue() Returns true if this behavior is equal to CONTINUE Returns:boolean true if this behavior is equal to CONTINUE

isContinue

back to summary

public boolean isContinue()

Returns true if this behavior is equal to CONTINUE

Returns:boolean: true if this behavior is equal to CONTINUE

valueOf	back to summary
public static SizeOfPolicyConfiguration.MaxDepthExceededBehavior valueOf(String name)

values	back to summary
public static SizeOfPolicyConfiguration.MaxDepthExceededBehavior[] values()

public Class SizeOfPolicyConfiguration

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum SizeOfPolicyConfiguration.MaxDepthExceededBehavior

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail