org.eth.cyril.model.advanced

Class ObjectFactory

java.lang.Object

org.eth.cyril.model.advanced.ObjectFactory

public class ObjectFactory
extends java.lang.Object

An object factory can be used to generate objects based on a type and a set of arguments. For an object factory to generate objects of a certain type, that type needs to be known to the factory, and must have a constructor annotated with a ConstructorParameters annotation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ObjectFactory.ObjectArguments

Method Summary

Modifier and Type	Method and Description
ObjectFactory.ObjectArguments	createObjectArguments(Configuration configuration) Creates an ObjectFactory.ObjectArguments instance from the given configuration, which can then be used to generate an object of some type.
java.util.Optional<java.lang.Object>	generate(ObjectFactory.ObjectArguments arguments) Generates a new object for the given arguments.
<T> java.util.Optional<T>	generate(ObjectFactory.ObjectArguments arguments, java.lang.Class<T> type) Generates a new object of the given type for the given arguments.
java.util.Optional<java.lang.Class<?>>	getClassForName(java.lang.String name) Get the class for the given name.
static ObjectFactory	getFactory() Gets the factory which can be used to generate objects.
void	registerGeneratableType(java.lang.Class<?> type) Register the given generatable type with this factory.
static void	setFactory(ObjectFactory factory) Sets the factory which can be used to generate objects.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getFactory

public static ObjectFactory getFactory()

Gets the factory which can be used to generate objects.

setFactory

public static void setFactory(ObjectFactory factory)

Sets the factory which can be used to generate objects.

createObjectArguments

public final ObjectFactory.ObjectArguments createObjectArguments(Configuration configuration)

Creates an ObjectFactory.ObjectArguments instance from the given configuration, which can then be used to generate an object of some type. This method will always return an ObjectArguments instance, however it is not certain that an object can be generated from it.

Parameters:

configuration - The configuration to create an ObjectFactory.ObjectArguments instance from. This configuration must have two keys: Properties.TYPE specifies the fully-qualified name of the type to generate, and Properties.ARGS specifies the arguments for the constructor. Note that this value may have one of three different types: A comma-separated String of the arguments in order, a ConfigurationArray containing the arguments in order, or a Configuration with named arguments. In the last case, the constructor must have a ConstructorParameters annotation with named parameters. Note that for each argument, only Strings, doubles, integers or booleans are supported.

Returns:

An ObjectArguments instance created from the given configuration.

generate

public final <T> java.util.Optional<T> generate(ObjectFactory.ObjectArguments arguments,
                                                java.lang.Class<T> type)

Generates a new object of the given type for the given arguments. If any error occurs during creation, an empty optional is returned instead of an exception being thrown.

Type Parameters:

T - The generic type of the new object.

Parameters:

arguments - The arguments given to generate the new object.

type - The desired type of the new object.

Returns:

A new object generated of the given type for the given arguments, or an empty optional if any error occurs.

generate

public java.util.Optional<java.lang.Object> generate(ObjectFactory.ObjectArguments arguments)

Generates a new object for the given arguments. If any error occurs during creation, an empty optional is returned instead of an exception being thrown.

Parameters:

arguments - The arguments given to generate the new object.

Returns:

A new object generated for the given arguments, or an empty optional if any error occurs.

getClassForName

public java.util.Optional<java.lang.Class<?>> getClassForName(java.lang.String name)

Get the class for the given name. If the class can not be found, then instead return an empty optional.

Parameters:

name - The fully qualified class name.

Returns:

An optional containing the class, or an empty optional if the class can not be found.

registerGeneratableType

public void registerGeneratableType(java.lang.Class<?> type)

Register the given generatable type with this factory. It is then ensured that objects of the given type can be generated by the factory, given that it has a correctly annotated constructor. Generally, any classes which can be referenced with Class.forName(String) don't need to be specifically registered.

Parameters:

type - The type of objects newly generatable by this factory.