JaversBuilder (javers-core 1.3.4 API)

java.lang.Object
- org.javers.core.AbstractJaversBuilder
- - org.javers.core.JaversBuilder

```
public 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/domain-configuration

Constructor Summary

Constructors
Modifier Constructor and Description

protected JaversBuilder()
use static factory method javers()

Constructors
Modifier	Constructor and Description
`protected`	`JaversBuilder()` use static factory method `javers()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected Javers`	`assembleJaversInstance()`
`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`.
`JaversBuilder`	`registerEntity(java.lang.Class<?> entityClass, java.lang.String idPropertyName)` Deprecated.
`JaversBuilder`	`registerEntity(EntityDefinition entityDefinition)` Registers an `Entity`.
`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 `ValueObjectType`.
`JaversBuilder`	`registerValueObject(ValueObjectDefinition valueObjectDefinition)` Registers a `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`	`withListCompareAlgorithm(ListCompareAlgorithm algorithm)` Choose between two algorithms for comparing list: ListCompareAlgorithm.SIMPLE or ListCompareAlgorithm.LEVENSHTEIN_DISTANCE.
`JaversBuilder`	`withMappingStyle(MappingStyle mappingStyle)` Default style is `MappingStyle.FIELD`.
`JaversBuilder`	`withNewObjectsSnapshot(boolean newObjectsSnapshot)`
`JaversBuilder`	`withObjectAccessHook(ObjectAccessHook objectAccessHook)`

Methods inherited from class org.javers.core.AbstractJaversBuilder
addComponent, addModule, addModule, bindComponent, bootContainer, getComponents, getContainer, getContainerComponent, removeComponent

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - JaversBuilder
```
protected JaversBuilder()
```
    use static factory method javers()
- Method Detail
  - javers
```
public static JaversBuilder javers()
```
  - build
```
public Javers build()
```
  - assembleJaversInstance
```
protected Javers assembleJaversInstance()
```
  - registerJaversRepository
```
public JaversBuilder registerJaversRepository(JaversRepository repository)
```
    See Also:
    
    http://javers.org/documentation/repository-configuration
  - registerEntity
```
public JaversBuilder registerEntity(java.lang.Class<?> entityClass)
```
    Registers an Entity. Use @Id annotation to mark exactly one Id-property.
    
    Optionally, use @Transient or @DiffIgnore to mark ignored properties.
    
    See Also:
    
    http://javers.org/documentation/domain-configuration/#domain-model-mapping
  - registerEntity
```
public JaversBuilder registerEntity(EntityDefinition entityDefinition)
```
    Registers an Entity.
    Use this method if you are not willing to use annotations to mark Id-property and ignored properties.
    
    See Also:
    
    http://javers.org/documentation/domain-configuration/#domain-model-mapping
  - registerEntity
```
@Deprecated
public JaversBuilder registerEntity(java.lang.Class<?> entityClass,
                                                 java.lang.String idPropertyName)
```
    Deprecated.
    
    Deprecated since 1.0.6, use registerEntity(Class) or registerEntity(EntityDefinition)
  - registerValueObject
```
public JaversBuilder registerValueObject(java.lang.Class<?> valueObjectClass)
```
    Registers a ValueObjectType.
    Use @Transient or @DiffIgnore to mark ignored properties.
    
    For example, ValueObjects are: Address, Point
    
    See Also:
    
    http://javers.org/documentation/domain-configuration/#domain-model-mapping
  - registerValueObject
```
public JaversBuilder registerValueObject(ValueObjectDefinition valueObjectDefinition)
```
    Registers a ValueObjectType.
    Use this method if you are not willing to use annotations to mark ignored properties.
    
    See Also:
    
    http://javers.org/documentation/domain-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/domain-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/repository-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)
```
  - withObjectAccessHook
```
public JaversBuilder withObjectAccessHook(ObjectAccessHook objectAccessHook)
```
  - 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
  - withListCompareAlgorithm
```
public JaversBuilder withListCompareAlgorithm(ListCompareAlgorithm algorithm)
```
    Choose between two algorithms for comparing list: ListCompareAlgorithm.SIMPLE or ListCompareAlgorithm.LEVENSHTEIN_DISTANCE.
    
    Generally, we recommend using LEVENSHTEIN_DISTANCE, because it’s smarter. Hoverer, it can be slow for long lists, so SIMPLE is enabled by default.
    
    Refer to javers.org/documentation/diff-configuration/#list-algorithms for description of both algorithms
    
    Parameters:
    
    algorithm - ListCompareAlgorithm.SIMPLE is used by default

Class JaversBuilder

Constructor Summary

Method Summary

Methods inherited from class org.javers.core.AbstractJaversBuilder

Methods inherited from class java.lang.Object

Constructor Detail

JaversBuilder

Method Detail

javers

build

assembleJaversInstance

registerJaversRepository

registerEntity

registerEntity

registerEntity

registerValueObject

registerValueObject

registerValue

registerValueTypeAdapter

registerValueGsonTypeAdapter

typeSafeValues

registerEntities

registerValueObjects

withMappingStyle

withNewObjectsSnapshot

withObjectAccessHook

registerCustomComparator

withListCompareAlgorithm