JaversBuilder (javers-core 1.4.6 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
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 a given Value type (type of a property owned by Entity or ValueObject).
`JaversBuilder`	`registerEntities(java.lang.Class<?>... entityClasses)`
`JaversBuilder`	`registerEntity(java.lang.Class<?> entityClass)` Registers an `EntityType`.
`JaversBuilder`	`registerEntity(EntityDefinition entityDefinition)` Registers an `EntityType`.
`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`	`scanTypeName(java.lang.Class userType)` Register your class with @`TypeName` annotation in order to use them in all kinds of JQL queries (without getting TYPE_NAME_NOT_FOUND exception).
`JaversBuilder`	`scanTypeNames(java.lang.String packageToScan)` Not implemented! If implemented, allows you to register all your classes with @`TypeName` annotation (within given package) in order to use them in all kinds of JQL queries (without getting TYPE_NAME_NOT_FOUND exception).
`JaversBuilder`	`withDateTimeProvider(DateProvider dateProvider)` DateProvider providers current date for `Commit.getCommitDate()`.
`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)` When enabled, `Javers.compare(Object oldVersion, Object currentVersion)` generates additional 'Snapshots' of new objects (objects added in currentVersion graph).
`JaversBuilder`	`withObjectAccessHook(ObjectAccessHook objectAccessHook)`
`JaversBuilder`	`withPrettyPrint(boolean prettyPrint)` choose between JSON pretty or concise printing style, i.e.
`JaversBuilder`	`withTypeSafeValues(boolean typeSafeValues)` Switch on when you need a type safe serialization for heterogeneous collections like List, List<Object>.

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 EntityType.
    Use @Id annotation to mark exactly one Id-property.
    
    Optionally, use @Transient or @DiffIgnore annotations to mark ignored properties.
    
    For example, Entities are: Person, Document
    
    See Also:
    
    registerEntity(EntityDefinition), http://javers.org/documentation/domain-configuration/#domain-model-mapping
  - registerValueObject
```
public JaversBuilder registerValueObject(java.lang.Class<?> valueObjectClass)
```
    Registers a ValueObjectType.
    Optionally, use @Transient or @DiffIgnore annotations to mark ignored properties.
    
    For example, ValueObjects are: Address, Point
    
    See Also:
    
    registerValueObject(ValueObjectDefinition), http://javers.org/documentation/domain-configuration/#domain-model-mapping
  - registerEntity
```
public JaversBuilder registerEntity(EntityDefinition entityDefinition)
```
    Registers an EntityType.
    Use this method if you are not willing to use annotations.
    
    Recommended way to create EntityDefinition is EntityDefinitionBuilder, for example:
```
 javersBuilder.registerEntity(
     EntityDefinitionBuilder.entityDefinition(Person.class)
     .withIdPropertyName("id")
     .withTypeName("Person")
     .withIgnoredProperties("notImportantProperty","transientProperty")
     .build());
 
```
    For simple cases, you can use EntityDefinition constructors, for example:
```
 javersBuilder.registerEntity( new EntityDefinition(Person.class, "login") );
 
```
    See Also:
    
    EntityDefinitionBuilder.entityDefinition(Class), 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.
    
    Recommended way to create ValueObjectDefinition is ValueObjectDefinitionBuilder. For example:
```
 javersBuilder.registerValueObject(ValueObjectDefinitionBuilder.valueObjectDefinition(Address.class)
     .withIgnoredProperties(ignoredProperties)
     .withTypeName(typeName)
     .build();
 
```
    For simple cases, you can use ValueObjectDefinition constructors, for example:
```
 javersBuilder.registerValueObject( new ValueObjectDefinition(Address.class, "ignored") );
 
```
    See Also:
    
    ValueObjectDefinitionBuilder.valueObjectDefinition(Class), http://javers.org/documentation/domain-configuration/#domain-model-mapping
  - scanTypeNames
```
public JaversBuilder scanTypeNames(java.lang.String packageToScan)
```
    Not implemented!
    
    If implemented, allows you to register all your classes with @TypeName annotation (within given package) in order to use them in all kinds of JQL queries
    (without getting TYPE_NAME_NOT_FOUND exception).
    
    If you think that this method should be implemented, vote here: issue/263
  - scanTypeName
```
public JaversBuilder scanTypeName(java.lang.Class userType)
```
    Register your class with @TypeName annotation in order to use them in all kinds of JQL queries
    (without getting TYPE_NAME_NOT_FOUND exception).
    
    If you think that JaVers should be able to scan all your classes in given package, vote for this feature: issue/263
    
    Alias for Javers.getTypeMapping(Type)
    
    Since:
    
    1.4
  - 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
  - withTypeSafeValues
```
public JaversBuilder withTypeSafeValues(boolean 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>.
    
    Parameters:
    
    typeSafeValues - default false
    
    See Also:
    
    JsonConverterBuilder.typeSafeValues(boolean)
  - withPrettyPrint
```
public JaversBuilder withPrettyPrint(boolean prettyPrint)
```
    choose between JSON pretty or concise printing style, i.e. :
    - pretty:
      { "value": 5 }
    - concise:
      {"value":5}
    Parameters:
    
    prettyPrint - default true
  - 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.
    
    See Also:
    
    http://javers.org/documentation/domain-configuration/#property-mapping-style
  - withNewObjectsSnapshot
```
public JaversBuilder withNewObjectsSnapshot(boolean newObjectsSnapshot)
```
    When enabled, Javers.compare(Object oldVersion, Object currentVersion) generates additional 'Snapshots' of new objects (objects added in currentVersion graph).
    For each new object, state of its properties is captured and returned as a Set of PropertyChanges. These Changes have null at the left side and a current property value at the right side.
    
    Disabled by default.
  - withObjectAccessHook
```
public JaversBuilder withObjectAccessHook(ObjectAccessHook objectAccessHook)
```
  - registerCustomComparator
```
public <T> JaversBuilder registerCustomComparator(CustomPropertyComparator<T,?> comparator,
                                                  java.lang.Class<T> customType)
```
    Registers a custom comparator for a given Value type (type of a property owned by Entity or ValueObject).
    
    Custom comparators are used by diff algorithm to calculate property-to-property diff.
    
    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 http://javers.org/documentation/diff-configuration/#list-algorithms for description of both algorithms
    
    Parameters:
    
    algorithm - ListCompareAlgorithm.SIMPLE is used by default
  - withDateTimeProvider
```
public JaversBuilder withDateTimeProvider(DateProvider dateProvider)
```
    DateProvider providers current date for Commit.getCommitDate().
    By default, now() is used.
    Overriding default dateProvider probably makes sense only in test environment.

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

registerValueObject

registerEntity

registerValueObject

scanTypeNames

scanTypeName

registerValue

registerValueTypeAdapter

registerValueGsonTypeAdapter

withTypeSafeValues

withPrettyPrint

registerEntities

registerValueObjects

withMappingStyle

withNewObjectsSnapshot

withObjectAccessHook

registerCustomComparator

withListCompareAlgorithm

withDateTimeProvider