Modifier and Type	Class and Description
public static class	FactoryBuilder.ClassFactory< the type of the instance produced by the `Factory` T> A `Factory` that instantiates a specific Class.
public static class	FactoryBuilder.SingletonFactory< the type of the instance produced by the `Factory` T> A `Factory` that always returns a specific instance.

Access	Constructor and Description
private	FactoryBuilder() A private constructor to prevent instantiation.

Method Summary

Modifier and Type	Method and Description
public static < the type of the instances produced by the `Factory` T> Factory<T>	Returns: a `Factory` for the specified clazz factoryOf(Class<T> the class of instances to be produced by the returned `Factory` clazz) Constructs a `Factory` that will produce factory instances of the specified class.
public static < the type of the instances produced by the `Factory` T> Factory<T>	Returns: a `Factory` for the specified clazz factoryOf(String the class of instances to be produced by the returned `Factory` className) Constructs a `Factory` that will produce factory instances of the specified class.
public static < the type of the instances returned T extends Serializable> Factory<T>	Returns: a `Factory` for the instance factoryOf(T the Serializable instance the `Factory` will return instance) Constructs a `Factory` that will return the specified factory Serializable instance.

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

FactoryBuilder	back to summary
private FactoryBuilder() A private constructor to prevent instantiation.

Method Detail

factoryOf back to summary

factoryOf	back to summary
public static <T> Factory<T> factoryOf(Class<T> clazz) Constructs a `Factory` that will produce factory instances of the specified class. The specified class must have a no-args constructor. Parameters <T> the type of the instances produced by the `Factory` clazz:Class<T> the class of instances to be produced by the returned `Factory` Returns:Factory<T> a `Factory` for the specified clazz

public static <T> Factory<T> factoryOf(Class<T> clazz)

Constructs a Factory that will produce factory instances of the specified class.

The specified class must have a no-args constructor.

Parameters

<T>: the type of the instances produced by the Factory
clazz:Class<T>: the class of instances to be produced by the returned Factory

Returns:Factory<T>

a Factory for the specified clazz

factoryOf back to summary

factoryOf	back to summary
public static <T> Factory<T> factoryOf(String className) Constructs a `Factory` that will produce factory instances of the specified class. The specified class must have a no-args constructor. Parameters <T> the type of the instances produced by the `Factory` className:String the class of instances to be produced by the returned `Factory` Returns:Factory<T> a `Factory` for the specified clazz

public static <T> Factory<T> factoryOf(String className)

Constructs a Factory that will produce factory instances of the specified class.

The specified class must have a no-args constructor.

Parameters

<T>: the type of the instances produced by the Factory
className:String: the class of instances to be produced by the returned Factory

Returns:Factory<T>

a Factory for the specified clazz

factoryOf back to summary

factoryOf	back to summary
public static <T extends Serializable> Factory<T> factoryOf(T instance) Constructs a `Factory` that will return the specified factory Serializable instance. If T is not Serializable use `factoryOf(Class)` or `factoryOf(String)`. Parameters <T> the type of the instances returned instance:T the Serializable instance the `Factory` will return Returns:Factory<T> a `Factory` for the instance

public static <T extends Serializable> Factory<T> factoryOf(T instance)

Constructs a Factory that will return the specified factory Serializable instance.

If T is not Serializable use factoryOf(Class) or factoryOf(String).

Parameters

<T>: the type of the instances returned
instance:T: the Serializable instance the Factory will return

Returns:Factory<T>

a Factory for the instance

javax.cache.configuration back to summary

public Class FactoryBuilder.ClassFactory<T>

Class Inheritance

extends Object
implements Factory<T>, Serializable

java.lang.Object
javax.cache.configuration.FactoryBuilder.ClassFactory

All Implemented Interfaces

java.io.Serializable, javax.cache.configuration.Factory

Type Parameters

<T>: the type of the instance produced by the Factory

A Factory that instantiates a specific Class.

Field Summary

Modifier and Type	Field and Description
private String	className The name of the Class.
public static final long	serialVersionUID The serialVersionUID required for `Serializable`.

Constructor Summary

Access	Constructor and Description
public	ClassFactory(Class<T> the Class to instantiate clazz) Constructor for the `ClassFactory`.
public	ClassFactory(String the name of the Class to instantiate className) Constructor for the `ClassFactory`.

Method Summary

Modifier and Type	Method and Description
public T	create() Implements javax.cache.configuration.Factory.create. Constructs and returns a fully configured instance of T.
public boolean	equals(Object the reference object with which to compare. other) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.

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

Field Detail

className	back to summary
private String className The name of the Class.

serialVersionUID	back to summary
public static final long serialVersionUID The serialVersionUID required for `Serializable`.

Constructor Detail

ClassFactory back to summary

ClassFactory	back to summary
public ClassFactory(Class<T> clazz) Constructor for the `ClassFactory`. Parameters clazz:Class<T> the Class to instantiate

public ClassFactory(Class<T> clazz)

Constructor for the ClassFactory.

Parameters

clazz:Class<T>: the Class to instantiate

ClassFactory back to summary

ClassFactory	back to summary
public ClassFactory(String className) Constructor for the `ClassFactory`. Parameters className:String the name of the Class to instantiate

public ClassFactory(String className)

Constructor for the ClassFactory.

Parameters

className:String: the name of the Class to instantiate

Method Detail

create	back to summary
public T create() Implements javax.cache.configuration.Factory.create. Doc from javax.cache.configuration.Factory.create. Constructs and returns a fully configured instance of T. Returns:T an instance of T. Annotations @Override

create

back to summary

public T create()

Implements javax.cache.configuration.Factory.create.

Doc from javax.cache.configuration.Factory.create.

Constructs and returns a fully configured instance of T.

Returns:T

an instance of T.

Annotations

@Override

equals back to summary

equals	back to summary
public boolean equals(Object other) 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 other: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 other)

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

other: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

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

javax.cache.configuration back to summary

public Class FactoryBuilder.SingletonFactory<T>

Class Inheritance

extends Object
implements Factory<T>, Serializable

java.lang.Object
javax.cache.configuration.FactoryBuilder.SingletonFactory

All Implemented Interfaces

java.io.Serializable, javax.cache.configuration.Factory

Type Parameters

<T>: the type of the instance produced by the Factory

A Factory that always returns a specific instance. ie: the factory returns a singleton, regardless of the number of times Factory#create() is called.

Field Summary

Modifier and Type	Field and Description
private T	instance The singleton instance.
public static final long	serialVersionUID The serialVersionUID required for `java.io.Serializable`.

Constructor Summary

Access	Constructor and Description
public	SingletonFactory(T the instance to return instance) Constructor for the `SingletonFactory`.

Method Summary

Modifier and Type	Method and Description
public T	create() Implements javax.cache.configuration.Factory.create. Constructs and returns a fully configured instance of T.
public boolean	equals(Object the reference object with which to compare. other) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.

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

Field Detail

instance	back to summary
private T instance The singleton instance.

serialVersionUID	back to summary
public static final long serialVersionUID The serialVersionUID required for `java.io.Serializable`.

Constructor Detail

SingletonFactory back to summary

SingletonFactory	back to summary
public SingletonFactory(T instance) Constructor for the `SingletonFactory`. Parameters instance:T the instance to return

public SingletonFactory(T instance)

Constructor for the SingletonFactory.

Parameters

instance:T: the instance to return

Method Detail

create	back to summary
public T create() Implements javax.cache.configuration.Factory.create. Doc from javax.cache.configuration.Factory.create. Constructs and returns a fully configured instance of T. Returns:T an instance of T. Annotations @Override

create

back to summary

public T create()

Implements javax.cache.configuration.Factory.create.

Doc from javax.cache.configuration.Factory.create.

Constructs and returns a fully configured instance of T.

Returns:T

an instance of T.

Annotations

@Override

equals back to summary

equals	back to summary
public boolean equals(Object other) 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 other: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 other)

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.

Parameters

other: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

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

public final Class FactoryBuilder

Nested and Inner Type Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail

public Class FactoryBuilder.ClassFactory<T>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class FactoryBuilder.SingletonFactory<T>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail