org.javers.core

Class Javers

java.lang.Object

org.javers.core.Javers

public class Javers
extends Object

Facade to JaVers instance.
Should be constructed by JaversBuilder provided with your domain specific configuration.

See MappingDocumentation to find out how to map your domain model

Author:

bartosz walacik

Constructor Summary

Constructors

Constructor and Description
Javers(DiffFactory diffFactory, TypeMapper typeMapper, JsonConverter jsonConverter, CommitFactory commitFactory, JaversExtendedRepository repository, SnapshotDiffer snapshotDiffer) JaVers instance should be constructed by JaversBuilder

Method Summary

Modifier and Type	Method and Description
Commit	commit(String author, Object currentVersion) Persists current version of given domain objects graph in JaVers repository.
Diff	compare(Object oldVersion, Object currentVersion) Easiest way to calculate diff, just provide two versions of the same object graph.
Diff	compare(String author, Object oldVersion, Object currentVersion) Deprecated. use compare(Object, Object)
List<Change>	getChangeHistory(GlobalIdDTO globalCdoId, int limit) Changes (diff sequence) of given managed class instance (entity or value object), in reverse chronological order
List<Change>	getChangeHistory(Object localId, Class entityClass, int limit) Changes (diff sequence) of given entity instance, in reverse chronological order
JsonConverter	getJsonConverter()
Optional<CdoSnapshot>	getLatestSnapshot(GlobalIdDTO globalCdoId) Latest snapshot of given object or Optional#EMPTY if object is not versioned
List<CdoSnapshot>	getStateHistory(Object localId, Class entityClass, int limit) Snapshots (historical states) of given entity instance, in reverse chronological order
IdBuilder	idBuilder()
Diff	initial(Object newDomainObject) Initial diff is a kind of snapshot of given domain objects graph.
Diff	initial(String author, Object newDomainObject) Deprecated. use initial(Object)
String	toJson(Diff diff) Use it alongside with compare(Object, Object)

Methods inherited from class java.lang.Object

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

Constructor Detail

Javers

public Javers(DiffFactory diffFactory,
              TypeMapper typeMapper,
              JsonConverter jsonConverter,
              CommitFactory commitFactory,
              JaversExtendedRepository repository,
              SnapshotDiffer snapshotDiffer)

JaVers instance should be constructed by JaversBuilder

Method Detail

commit

public Commit commit(String author,
                     Object currentVersion)

Persists current version of given domain objects graph in JaVers repository. All changes made on versioned objects are recorded, new objects become versioned and its initial state is recorded.

Parameters:

currentVersion - domain object, instance of Entity or ValueObject. It should be root of an aggregate, tree root or any node in objects graph from where all other nodes are navigable. (Javadoc source: ObjectGraphBuilder.buildGraph(Object))

compare

public Diff compare(Object oldVersion,
                    Object currentVersion)

Easiest way to calculate diff, just provide two versions of the same object graph. Use it if you don't want to store domain objects history in JaVers repository.

Diffs can be converted to JSON with toJson(Diff) and stored in custom repository

initial

public Diff initial(Object newDomainObject)

Initial diff is a kind of snapshot of given domain objects graph. Use it alongside with compare(Object, Object)

toJson

public String toJson(Diff diff)

Use it alongside with compare(Object, Object)

idBuilder

public IdBuilder idBuilder()

getStateHistory

public List<CdoSnapshot> getStateHistory(Object localId,
                                         Class entityClass,
                                         int limit)

Snapshots (historical states) of given entity instance, in reverse chronological order

Parameters:

localId - id of required instance

entityClass - class of required instance

limit - choose reasonable limit

Returns:

empty List if object is not versioned

Throws:

JaversException - ENTITY_EXPECTED if given javaClass is NOT mapped to Entity

getLatestSnapshot

public Optional<CdoSnapshot> getLatestSnapshot(GlobalIdDTO globalCdoId)

Latest snapshot of given object or Optional#EMPTY if object is not versioned

getChangeHistory

public List<Change> getChangeHistory(Object localId,
                                     Class entityClass,
                                     int limit)

Changes (diff sequence) of given entity instance, in reverse chronological order

Parameters:

localId - id of required instance

entityClass - class of required instance

limit - choose reasonable limit

Returns:

empty List if object is not versioned or was committed only once

Throws:

JaversException - ENTITY_EXPECTED if given javaClass is NOT mapped to Entity

getChangeHistory

public List<Change> getChangeHistory(GlobalIdDTO globalCdoId,
                                     int limit)

Changes (diff sequence) of given managed class instance (entity or value object), in reverse chronological order

initial

@Deprecated
public Diff initial(String author,
                                 Object newDomainObject)

Deprecated. use initial(Object)

Parameters:

author - ignored

compare

@Deprecated
public Diff compare(String author,
                                 Object oldVersion,
                                 Object currentVersion)

Deprecated. use compare(Object, Object)

Parameters:

author - ignored

getJsonConverter

public JsonConverter getJsonConverter()