Modifier and Type	Class and Description
public static enum	TimeoutBehaviorConfiguration.TimeoutBehaviorType Enum encapsulating type of TimeoutBehavior

Modifier and Type	Field and Description
public static final String	CUSTOM_TYPE_FACTORY_PROPERTY_NAME Property name used to configure the class name of the factory class used by `TimeoutBehaviorType#CUSTOM`
public static final String	CUSTOM_TYPE_NAME Type name for `TimeoutBehaviorType#CUSTOM`
public static final String	DEFAULT_PROPERTIES Default value for properties.
public static final String	DEFAULT_PROPERTY_SEPARATOR Default value for property separator
public static final TimeoutBehaviorConfiguration.TimeoutBehaviorType	DEFAULT_TIMEOUT_BEHAVIOR_TYPE Default value for timeout behavior
public static final String	DEFAULT_VALUE Default value for timeout behavior
public static final String	EXCEPTION_TYPE_NAME Type name for `TimeoutBehaviorType#EXCEPTION`
public static final String	LOCAL_READS_AND_EXCEPTION_ON_WRITES_TYPE_NAME Type name for `TimeoutBehaviorType#LOCAL_READS_AND_EXCEPTION_ON_WRITES`
public static final String	LOCAL_READS_TYPE_NAME Type name for `TimeoutBehaviorType#LOCAL_READS`
public static final String	NOOP_TYPE_NAME Type name for `TimeoutBehaviorType#NOOP`
private volatile String	properties
private volatile String	propertySeparator
private volatile TimeoutBehaviorConfiguration.TimeoutBehaviorType	type

Access	Constructor and Description
public	TimeoutBehaviorConfiguration() Default constructor
public	TimeoutBehaviorConfiguration(TimeoutBehaviorConfiguration the reference to copy ref) Copy constructor

Method Summary

Modifier and Type	Method and Description
public Object	clone() Overrides java.lang.Object.clone. Creates and returns a copy of this object.
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.
private Properties	extractProperties()
public String	Returns: properties getProperties() Get the properties
public String	Returns: the propery separator getPropertySeparator() Get the property separator
public TimeoutBehaviorConfiguration.TimeoutBehaviorType	Returns: the configured type getTimeoutBehaviorType() Returns the type of timeout behavior configured
public String	Returns: the configured type getType() Returns the type of timeout behavior configured
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.
public TimeoutBehaviorConfiguration	Returns: this instance properties(String value) Set the properties
public TimeoutBehaviorConfiguration	Returns: this instance propertySeparator(String value) Set the property separator
public void	setProperties(String properties) Set the properties
public void	setPropertySeparator(String propertySeparator) Set the property separator
public void	setType(String type) Set the type of timeout behavior
public TimeoutBehaviorConfiguration	Returns: this instance type(String type) Set the type of timeout behavior

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

Field Detail

CUSTOM_TYPE_FACTORY_PROPERTY_NAME	back to summary
public static final String CUSTOM_TYPE_FACTORY_PROPERTY_NAME Property name used to configure the class name of the factory class used by `TimeoutBehaviorType#CUSTOM`

CUSTOM_TYPE_NAME	back to summary
public static final String CUSTOM_TYPE_NAME Type name for `TimeoutBehaviorType#CUSTOM`

DEFAULT_PROPERTIES	back to summary
public static final String DEFAULT_PROPERTIES Default value for properties.

DEFAULT_PROPERTY_SEPARATOR	back to summary
public static final String DEFAULT_PROPERTY_SEPARATOR Default value for property separator

DEFAULT_TIMEOUT_BEHAVIOR_TYPE	back to summary
public static final TimeoutBehaviorConfiguration.TimeoutBehaviorType DEFAULT_TIMEOUT_BEHAVIOR_TYPE Default value for timeout behavior

DEFAULT_VALUE	back to summary
public static final String DEFAULT_VALUE Default value for timeout behavior

EXCEPTION_TYPE_NAME	back to summary
public static final String EXCEPTION_TYPE_NAME Type name for `TimeoutBehaviorType#EXCEPTION`

LOCAL_READS_AND_EXCEPTION_ON_WRITES_TYPE_NAME	back to summary
public static final String LOCAL_READS_AND_EXCEPTION_ON_WRITES_TYPE_NAME Type name for `TimeoutBehaviorType#LOCAL_READS_AND_EXCEPTION_ON_WRITES`

LOCAL_READS_TYPE_NAME	back to summary
public static final String LOCAL_READS_TYPE_NAME Type name for `TimeoutBehaviorType#LOCAL_READS`

NOOP_TYPE_NAME	back to summary
public static final String NOOP_TYPE_NAME Type name for `TimeoutBehaviorType#NOOP`

properties	back to summary
private volatile String properties

propertySeparator	back to summary
private volatile String propertySeparator

type	back to summary
private volatile TimeoutBehaviorConfiguration.TimeoutBehaviorType type

Constructor Detail

TimeoutBehaviorConfiguration	back to summary
public TimeoutBehaviorConfiguration() Default constructor

TimeoutBehaviorConfiguration	back to summary
public TimeoutBehaviorConfiguration(TimeoutBehaviorConfiguration ref) Copy constructor Parameters ref:TimeoutBehaviorConfiguration the reference to copy

TimeoutBehaviorConfiguration

back to summary

public TimeoutBehaviorConfiguration(TimeoutBehaviorConfiguration ref)

Copy constructor

Parameters

ref:TimeoutBehaviorConfiguration: the reference to copy

Method Detail

clone back to summary

clone	back to summary
public Object clone() throws CloneNotSupportedException Overrides java.lang.Object.clone. Doc from java.lang.Object.clone. Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object `x`, the expression: x.clone() != x will be true, and that the expression: x.clone().getClass() == x.getClass() will be `true`, but these are not absolute requirements. While it is typically the case that: x.clone().equals(x) will be `true`, this is not an absolute requirement. By convention, the returned object should be obtained by calling `super.clone`. If a class and all of its superclasses (except `Object`) obey this convention, it will be the case that `x.clone().getClass() == x.getClass()`. By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by `super.clone` before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by `super.clone` need to be modified. Returns:Object a clone of this instance. Annotations @Override Exceptions CloneNotSupportedException: if the object's class does not support the `Cloneable` interface. Subclasses that override the `clone` method can also throw this exception to indicate that an instance cannot be cloned.

public Object clone() throws CloneNotSupportedException

Overrides java.lang.Object.clone.

Doc from java.lang.Object.clone.

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

x.clone() != x

will be true, and that the expression:

x.clone().getClass() == x.getClass()

will be true, but these are not absolute requirements. While it is typically the case that:

x.clone().equals(x)

will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

Returns:Object

a clone of this instance.

Annotations

@Override

Exceptions

CloneNotSupportedException:: if the object's class does not support the Cloneable interface. Subclasses that override the clone method can also throw this exception to indicate that an instance cannot be cloned.

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

extractProperties	back to summary
private Properties extractProperties()

getProperties	back to summary
public String getProperties() Get the properties Returns:String properties

getProperties

back to summary

public String getProperties()

Get the properties

Returns:String: properties

getPropertySeparator	back to summary
public String getPropertySeparator() Get the property separator Returns:String the propery separator

getPropertySeparator

back to summary

public String getPropertySeparator()

Get the property separator

Returns:String: the propery separator

getTimeoutBehaviorType	back to summary
public TimeoutBehaviorConfiguration.TimeoutBehaviorType getTimeoutBehaviorType() Returns the type of timeout behavior configured Returns:TimeoutBehaviorConfiguration.TimeoutBehaviorType the configured type

getTimeoutBehaviorType

back to summary

public TimeoutBehaviorConfiguration.TimeoutBehaviorType getTimeoutBehaviorType()

Returns the type of timeout behavior configured

Returns:TimeoutBehaviorConfiguration.TimeoutBehaviorType: the configured type

getType	back to summary
public String getType() Returns the type of timeout behavior configured Returns:String the configured type

getType

back to summary

public String getType()

Returns the type of timeout behavior configured

Returns:String: the configured type

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

properties	back to summary
public TimeoutBehaviorConfiguration properties(String value) Set the properties Returns:TimeoutBehaviorConfiguration this instance

properties

back to summary

public TimeoutBehaviorConfiguration properties(String value)

Set the properties

Returns:TimeoutBehaviorConfiguration: this instance

propertySeparator	back to summary
public TimeoutBehaviorConfiguration propertySeparator(String value) Set the property separator Returns:TimeoutBehaviorConfiguration this instance

propertySeparator

back to summary

public TimeoutBehaviorConfiguration propertySeparator(String value)

Set the property separator

Returns:TimeoutBehaviorConfiguration: this instance

setProperties	back to summary
public void setProperties(String properties) Set the properties

setPropertySeparator	back to summary
public void setPropertySeparator(String propertySeparator) Set the property separator

setType	back to summary
public void setType(String type) Set the type of timeout behavior

type	back to summary
public TimeoutBehaviorConfiguration type(String type) Set the type of timeout behavior Returns:TimeoutBehaviorConfiguration this instance

type

back to summary

public TimeoutBehaviorConfiguration type(String type)

Set the type of timeout behavior

Returns:TimeoutBehaviorConfiguration: this instance

net.sf.ehcache.config back to summary

public sealed Enum TimeoutBehaviorConfiguration.TimeoutBehaviorType

Class Inheritance

extends Enum<TimeoutBehaviorConfiguration.TimeoutBehaviorType>

java.lang.Object
java.lang.Enum
net.sf.ehcache.config.TimeoutBehaviorConfiguration.TimeoutBehaviorType

Enum encapsulating type of TimeoutBehavior

Author: Abhishek Sanoujam

Field Summary

Modifier and Type	Field and Description
public static final TimeoutBehaviorConfiguration.TimeoutBehaviorType	CUSTOM Timeout behavior type that uses a custom factory to create the actual timeout behavior on timeout.
public static final TimeoutBehaviorConfiguration.TimeoutBehaviorType	EXCEPTION Timeout behavior type that throws exception on timeout
public static final TimeoutBehaviorConfiguration.TimeoutBehaviorType	LOCAL_READS Timeout behavior type that returns local values present in the VM or otherwise null on timeout
public static final TimeoutBehaviorConfiguration.TimeoutBehaviorType	LOCAL_READS_AND_EXCEPTION_ON_WRITES Timeout behavior type that returns local values present in the VM or otherwise null on timeout for read operations.
public static final TimeoutBehaviorConfiguration.TimeoutBehaviorType	NOOP Timeout behavior type that returns null and does nothing on timeout
private static final Map<String, TimeoutBehaviorConfiguration.TimeoutBehaviorType>	TYPE_MAP

Constructor Summary

Access	Constructor and Description
private	TimeoutBehaviorType()

Method Summary

Modifier and Type	Method and Description
public static TimeoutBehaviorConfiguration.TimeoutBehaviorType	Returns: the `TimeoutBehaviorType` getTimeoutBehaviorTypeFromName(String the type name typeName) Get the `TimeoutBehaviorType` corresponding to a name
public abstract String	Returns: the string name for this type getTypeName() Returns a String signifying this type
public static boolean	Returns: true if its valid, otherwise false isValidTimeoutBehaviorType(String the string name type) Find out if a string is a valid timeoutBehavior type or not
public static TimeoutBehaviorConfiguration.TimeoutBehaviorType	valueOf(String name)
public static TimeoutBehaviorConfiguration.TimeoutBehaviorType[]	values()

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

Field Detail

CUSTOM	back to summary
public static final TimeoutBehaviorConfiguration.TimeoutBehaviorType CUSTOM Timeout behavior type that uses a custom factory to create the actual timeout behavior on timeout. The custom factory has to be configured using properties otherwise an exception will be thrown. There must be a property named `TimeoutBehaviorConfiguration#CUSTOM_TYPE_FACTORY_PROPERTY_NAME`.

EXCEPTION	back to summary
public static final TimeoutBehaviorConfiguration.TimeoutBehaviorType EXCEPTION Timeout behavior type that throws exception on timeout

LOCAL_READS	back to summary
public static final TimeoutBehaviorConfiguration.TimeoutBehaviorType LOCAL_READS Timeout behavior type that returns local values present in the VM or otherwise null on timeout

LOCAL_READS_AND_EXCEPTION_ON_WRITES	back to summary
public static final TimeoutBehaviorConfiguration.TimeoutBehaviorType LOCAL_READS_AND_EXCEPTION_ON_WRITES Timeout behavior type that returns local values present in the VM or otherwise null on timeout for read operations. For write operations, it throws an exception on timeout.

NOOP	back to summary
public static final TimeoutBehaviorConfiguration.TimeoutBehaviorType NOOP Timeout behavior type that returns null and does nothing on timeout

TYPE_MAP	back to summary
private static final Map<String, TimeoutBehaviorConfiguration.TimeoutBehaviorType> TYPE_MAP

Constructor Detail

TimeoutBehaviorType	back to summary
private TimeoutBehaviorType()

Method Detail

getTimeoutBehaviorTypeFromName back to summary

getTimeoutBehaviorTypeFromName	back to summary
public static TimeoutBehaviorConfiguration.TimeoutBehaviorType getTimeoutBehaviorTypeFromName(String typeName) Get the `TimeoutBehaviorType` corresponding to a name Parameters typeName:String the type name Returns:TimeoutBehaviorConfiguration.TimeoutBehaviorType the `TimeoutBehaviorType`

public static TimeoutBehaviorConfiguration.TimeoutBehaviorType getTimeoutBehaviorTypeFromName(String typeName)

Get the TimeoutBehaviorType corresponding to a name

Parameters

typeName:String: the type name

Returns:TimeoutBehaviorConfiguration.TimeoutBehaviorType

the TimeoutBehaviorType

getTypeName	back to summary
public abstract String getTypeName() Returns a String signifying this type Returns:String the string name for this type

getTypeName

back to summary

public abstract String getTypeName()

Returns a String signifying this type

Returns:String: the string name for this type

isValidTimeoutBehaviorType	back to summary
public static boolean isValidTimeoutBehaviorType(String type) Find out if a string is a valid timeoutBehavior type or not Parameters type:String the string name Returns:boolean true if its valid, otherwise false

isValidTimeoutBehaviorType

back to summary

public static boolean isValidTimeoutBehaviorType(String type)

Find out if a string is a valid timeoutBehavior type or not

Parameters

type:String: the string name

Returns:boolean

true if its valid, otherwise false

valueOf	back to summary
public static TimeoutBehaviorConfiguration.TimeoutBehaviorType valueOf(String name)

values	back to summary
public static TimeoutBehaviorConfiguration.TimeoutBehaviorType[] values()

public Class TimeoutBehaviorConfiguration

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public sealed Enum TimeoutBehaviorConfiguration.TimeoutBehaviorType

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail