com.jparams.object.builder

Class Configuration

java.lang.Object

com.jparams.object.builder.Configuration

public final class Configuration
extends java.lang.Object

Provides configuration used by ObjectBuilder. Create an instance of Configuration with default settings by calling defaultConfiguration() and apply overrides.

Method Summary

Modifier and Type	Method and Description
static Configuration	defaultConfiguration() Create a new instance of Configuration by default settings pre-configured.
Configuration	withBuildStrategy(Type<?> type, BuildStrategy buildStrategy) This will override the default build strategy set for a specific type.
Configuration	withCacheAll() Enable caching of all objects.
Configuration	withCaching(java.util.function.Predicate<Type<?>> predicate) Enable caching only on all types matching this predicate.
Configuration	withCachingAllExcluding(java.util.Collection<Type<?>> types) Enable caching on all types excluding these.
Configuration	withCachingAllExcluding(Type<?>... types) Enable caching on all types excluding these.
Configuration	withCachingOnly(java.util.Collection<Type<?>> types) Enable caching only on the given types.
Configuration	withCachingOnly(Type<?>... types) Enable caching only on the given types.
Configuration	withDefaultBuildStrategy(BuildStrategy defaultBuildStrategy) The default build strategy described how objects should be instantiated.
Configuration	withFailOnError(boolean failOnError) If set to true, the builder will throw an exception on the first occurrence of an error level issue.
Configuration	withFailOnWarning(boolean failOnWarning) If set to true, the builder will throw an exception on the first occurrence of an warning level issue.
Configuration	withMaxDepth(int maxDepth) Define the max depth to which ObjectBuilder should build to.
<T extends AnyValueTypeProvider> Configuration	withNullProvider(T nullProvider) Configure the provider that will be used to generate null values.
Configuration	withPathFilter(PathFilter pathFilter) Filter out paths that should not be built.
Configuration	withPrefabValue(Type<?> type, java.lang.Object value) Define a prefabricated for a given type.
Configuration	withProvider(Provider provider) Add a custom provider.

Methods inherited from class java.lang.Object

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

Method Detail

withMaxDepth

public Configuration withMaxDepth(int maxDepth)

Define the max depth to which ObjectBuilder should build to. Once the max depth is breached, all subsequent values will be built as null. This is to avoid infinite recursion. This defaults to 15 if not set.

Parameters:

maxDepth - max depth

Returns:

this

withPathFilter

public Configuration withPathFilter(PathFilter pathFilter)

Filter out paths that should not be built. All paths filtered will be built as null.

Parameters:

pathFilter - path filter

Returns:

this

withNullProvider

public <T extends AnyValueTypeProvider> Configuration withNullProvider(T nullProvider)

Configure the provider that will be used to generate null values. This defaults to NullProvider, which returns null for all class types and null equivalent values for primitives, such as 0 for int.

Type Parameters:

T - provider type

Parameters:

nullProvider - null provided

Returns:

this

withFailOnError

public Configuration withFailOnError(boolean failOnError)

If set to true, the builder will throw an exception on the first occurrence of an error level issue. If set to false, the issue will be logged and a recovery strategy applied. This is set to false by default.

Parameters:

failOnError - fail on error

Returns:

this

withFailOnWarning

public Configuration withFailOnWarning(boolean failOnWarning)

If set to true, the builder will throw an exception on the first occurrence of an warning level issue. If set to false, the issue will be logged and a recovery strategy applied. This is set to false by default.

Parameters:

failOnWarning - fail on warning

Returns:

this

withProvider

public Configuration withProvider(Provider provider)

Add a custom provider. Providers are prioritised in the order added. User added providers take precedence over the default providers.

Parameters:

provider - provider

Returns:

this

withCacheAll

public Configuration withCacheAll()

Enable caching of all objects. Once an object of a certain type is built, it will be cached and returned each time that type is requested. The cache exists for each instance of ObjectBuilder and not shared across multiple instances. Note, calling one of the other caching methods such as withCachingAllExcluding(Type...), withCachingOnly(Type...), or withCaching(Predicate), will unset any settings defined by this method call.

Returns:

this

withCachingOnly

public Configuration withCachingOnly(Type<?>... types)

Enable caching only on the given types. Once an object of a certain type is built, it will be cached and returned each time that type is requested. The cache exists for each instance of ObjectBuilder and not shared across multiple instances. Note, calling one of the other caching methods such as withCachingAllExcluding(Type...), withCacheAll(), or withCaching(Predicate), will unset any settings defined by this method call.

Parameters:

types - types to cache

Returns:

this

withCachingOnly

public Configuration withCachingOnly(java.util.Collection<Type<?>> types)

Enable caching only on the given types. Once an object of a certain type is built, it will be cached and returned each time that type is requested. The cache exists for each instance of ObjectBuilder and not shared across multiple instances. Note, calling one of the other caching methods such as withCachingAllExcluding(Type...), withCacheAll(), or withCaching(Predicate), will unset any settings defined by this method call.

Parameters:

types - types to cache

Returns:

this

withCachingAllExcluding

public Configuration withCachingAllExcluding(Type<?>... types)

Enable caching on all types excluding these. Once an object of this type is built, it will not be cached, instead the Provider will be called each time an object of this type is required. Note, calling one of the other caching methods such as withCachingOnly(Type...), withCacheAll(), or withCaching(Predicate), will unset any settings defined by this method call.

Parameters:

types - types not to cache

Returns:

this

withCachingAllExcluding

public Configuration withCachingAllExcluding(java.util.Collection<Type<?>> types)

Enable caching on all types excluding these. Once an object of this type is built, it will not be cached, instead the Provider will be called each time an object of this type is required. Note, calling one of the other caching methods such as withCachingOnly(Type...), withCacheAll(), or withCaching(Predicate), will unset any settings defined by this method call.

Parameters:

types - types not to cache

Returns:

this

withCaching

public Configuration withCaching(java.util.function.Predicate<Type<?>> predicate)

Enable caching only on all types matching this predicate. Once an object of a matching type is built, it will be cached and returned each time that type is requested. The cache exists for each instance of ObjectBuilder and not shared across multiple instances. Note, calling one of the other caching methods such as withCachingAllExcluding(Type...), withCacheAll(), or withCachingOnly(Collection), will unset any settings defined by this method call.

Parameters:

predicate - predicate to decide if a type should be cached

Returns:

this

withPrefabValue

public Configuration withPrefabValue(Type<?> type,
                                     java.lang.Object value)

Define a prefabricated for a given type. If a value of this type is required, the prefabricated value will be returned, avoid a call to a suitable Provider.

Parameters:

type - type

value - value

Returns:

this

withDefaultBuildStrategy

public Configuration withDefaultBuildStrategy(BuildStrategy defaultBuildStrategy)

The default build strategy described how objects should be instantiated. These are objects that have not been prefabricated and are not supported by a specific Provider. The default build strategy will be used for all types unless a specific build strategy has been configured at type level by calling withBuildStrategy(Type, BuildStrategy). If unspecified, the defaultBuildStrategy of BuildStrategy.AUTO will be used.

Parameters:

defaultBuildStrategy - default build strategy

Returns:

this

withBuildStrategy

public Configuration withBuildStrategy(Type<?> type,
                                       BuildStrategy buildStrategy)

This will override the default build strategy set for a specific type.

Parameters:

type - type

buildStrategy - build strategy

Returns:

this

defaultConfiguration

public static Configuration defaultConfiguration()

Create a new instance of Configuration by default settings pre-configured. You can then override the defaults as required.

Returns:

configuration