org.javers.core

Class JaversBuilder

java.lang.Object

org.javers.core.AbstractJaversBuilder

org.javers.core.JaversBuilder

public final class JaversBuilder
extends AbstractJaversBuilder

Creates a JaVers instance based on your domain model metadata and custom configuration.

For example, to build a JaVers instance configured with reasonable defaults:

 Javers javers = JaversBuilder.javers().build();
 

To build a JaVers instance with Entity type registered:

 Javers javers = JaversBuilder.javers()
                              .registerEntity(MyEntity.class)
                              .build();
 

See Also:

http://javers.org/documentation/configuration

Method Summary

Modifier and Type	Method and Description
Javers	build()
static JaversBuilder	javers()
<T> JaversBuilder	registerCustomComparator(CustomPropertyComparator<T,?> comparator, java.lang.Class<T> customType) Registers a custom comparator for given custom type.
JaversBuilder	registerEntities(java.lang.Class<?>... entityClasses)
JaversBuilder	registerEntity(java.lang.Class<?> entityClass) registers an Entity with id-property pointed by @Id annotation
JaversBuilder	registerEntity(java.lang.Class<?> entityClass, java.lang.String idPropertyName) registers an Entity with id-property selected explicitly by name
JaversBuilder	registerJaversRepository(JaversRepository repository)
JaversBuilder	registerValue(java.lang.Class<?> valueClass) Registers a simple value type (see ValueType).
JaversBuilder	registerValueGsonTypeAdapter(java.lang.Class valueType, com.google.gson.TypeAdapter nativeAdapter) Registers ValueType and its custom native Gson adapter.
JaversBuilder	registerValueObject(java.lang.Class<?> valueObjectClass) Registers a ValueObject type (see ValueObjectType).
JaversBuilder	registerValueObjects(java.lang.Class<?>... valueObjectClasses)
JaversBuilder	registerValueTypeAdapter(JsonTypeAdapter typeAdapter) Registers a ValueType and its custom JSON adapter.
JaversBuilder	typeSafeValues() Switch on when you need a type safe serialization for heterogeneous collections like List, List<Object>.
JaversBuilder	withMappingStyle(MappingStyle mappingStyle) Default style is MappingStyle.FIELD.
JaversBuilder	withNewObjectsSnapshot(boolean newObjectsSnapshot)

Methods inherited from class org.javers.core.AbstractJaversBuilder

addComponent, addModule, addModule, bindComponent, bootContainer, getComponents, getContainer, getContainerComponent

Methods inherited from class java.lang.Object

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

Method Detail

javers

public static JaversBuilder javers()

build

public Javers build()

registerJaversRepository

public JaversBuilder registerJaversRepository(JaversRepository repository)

See Also:

http://javers.org/documentation/configuration/#repository-setup

registerEntity

public JaversBuilder registerEntity(java.lang.Class<?> entityClass)

registers an Entity with id-property pointed by @Id annotation

See Also:

http://javers.org/documentation/configuration/#domain-model-mapping

registerEntity

public JaversBuilder registerEntity(java.lang.Class<?> entityClass,
                                    java.lang.String idPropertyName)

registers an Entity with id-property selected explicitly by name

See Also:

http://javers.org/documentation/configuration/#domain-model-mapping

registerValueObject

public JaversBuilder registerValueObject(java.lang.Class<?> valueObjectClass)

Registers a ValueObject type (see ValueObjectType).
For example, ValueObjects are: Address, Point

See Also:

http://javers.org/documentation/configuration/#domain-model-mapping

registerValue

public JaversBuilder registerValue(java.lang.Class<?> valueClass)

Registers a simple value type (see ValueType).
For example, values are: BigDecimal, LocalDateTime

See Also:

http://javers.org/documentation/configuration/#domain-model-mapping

registerValueTypeAdapter

public JaversBuilder registerValueTypeAdapter(JsonTypeAdapter typeAdapter)

Registers a ValueType and its custom JSON adapter.

Useful for not trivial ValueTypes when Gson's default representation isn't appropriate

See Also:

http://javers.org/documentation/configuration/#json-type-adapters, JsonTypeAdapter

registerValueGsonTypeAdapter

public JaversBuilder registerValueGsonTypeAdapter(java.lang.Class valueType,
                                                  com.google.gson.TypeAdapter nativeAdapter)

Registers ValueType and its custom native Gson adapter.

Useful when you already have Gson TypeAdapters implemented.

See Also:

TypeAdapter

typeSafeValues

public JaversBuilder typeSafeValues()

Switch on when you need a type safe serialization for heterogeneous collections like List, List<Object>.

Heterogeneous collections are collections which contains items of different types (or types unknown at compile time).

This approach is generally discouraged, prefer statically typed collections with exactly one type of items like List<String>.

See Also:

JsonConverterBuilder.typeSafeValues(boolean)

registerEntities

public JaversBuilder registerEntities(java.lang.Class<?>... entityClasses)

registerValueObjects

public JaversBuilder registerValueObjects(java.lang.Class<?>... valueObjectClasses)

withMappingStyle

public JaversBuilder withMappingStyle(MappingStyle mappingStyle)

Default style is MappingStyle.FIELD.

withNewObjectsSnapshot

public JaversBuilder withNewObjectsSnapshot(boolean newObjectsSnapshot)

registerCustomComparator

public <T> JaversBuilder registerCustomComparator(CustomPropertyComparator<T,?> comparator,
                                                  java.lang.Class<T> customType)

Registers a custom comparator for given custom type.

Comparator has to calculate and return a subtype of PropertyChange.

Internally, given type is mapped as CustomType.

Custom types are serialized to JSON using Gson defaults.

Type Parameters:

T - custom type

Parameters:

customType - class literal to define a custom type

See Also:

CustomPropertyComparator