org.javers.core

Class JaversBuilder

java.lang.Object

org.javers.core.AbstractJaversBuilder

org.javers.core.JaversBuilder

public final class JaversBuilder
extends AbstractJaversBuilder

Creates JaVers instance based on your domain model metadata and custom configuration.
Supports two configuring methods:

• by properties file, see {TBA ...}
• programmatically using builder style methods

Method Summary

Modifier and Type	Method and Description
Javers	build()
static JaversBuilder	javers()
JaversBuilder	registerEntities(java.lang.Class<?>... entityClasses)
JaversBuilder	registerEntity(java.lang.Class<?> entityClass) registers Entity with id-property pointed by @Id annotation
JaversBuilder	registerEntity(java.lang.Class<?> entityClass, java.lang.String idPropertyName) registers Entity with id-property selected explicitly by name
JaversBuilder	registerJaversRepository(JaversRepository repository)
JaversBuilder	registerValue(java.lang.Class<?> valueClass) registers 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 ValueObject
JaversBuilder	registerValueObjects(java.lang.Class<?>... valueObjectClasses)
JaversBuilder	registerValueTypeAdapter(JsonTypeAdapter typeAdapter) Registers ValueType and its custom JSON adapter.
JaversBuilder	typeSafeValues() Switch on when you need type safe Atomics serialization stored in polymorfic collections like List, List<Object>, Map<Object,Object>, etc.
JaversBuilder	withMappingStyle(MappingStyle mappingStyle) MappingStyle.FIELD by default
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)

registerEntity

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

registers Entity with id-property pointed by @Id annotation

registerEntity

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

registers Entity with id-property selected explicitly by name

registerValueObject

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

registers ValueObject

registerValueObjects

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

registerValue

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

registers ValueType

registerValueTypeAdapter

public JaversBuilder registerValueTypeAdapter(JsonTypeAdapter typeAdapter)

Registers ValueType and its custom JSON adapter.

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

See Also:

JsonTypeAdapter, JsonTypeAdapter.getValueTypes()

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 type safe Atomics serialization stored in polymorfic collections like List, List<Object>, Map<Object,Object>, etc.

See Also:

JsonConverterBuilder.typeSafeValues(boolean)

registerEntities

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

withMappingStyle

public JaversBuilder withMappingStyle(MappingStyle mappingStyle)

MappingStyle.FIELD by default

withNewObjectsSnapshot

public JaversBuilder withNewObjectsSnapshot(boolean newObjectsSnapshot)