MongoSherlockBuilder (mongo-sync 0.4.0 API)

java.lang.Object
- com.coditory.sherlock.MongoSherlockBuilder

public final class MongoSherlockBuilder
extends java.lang.Object

Builds Sherlock that uses MongoDB for locking mechanism.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`com.coditory.sherlock.Sherlock`	`build()`
`static MongoSherlockBuilder`	`mongoSherlock()`
`static com.coditory.sherlock.Sherlock`	`mongoSherlock(com.mongodb.client.MongoCollection<org.bson.Document> collection)`
`MongoSherlockBuilder`	`withClock(java.time.Clock clock)`
`T`	`withLockDuration(java.time.Duration arg0)`
`MongoSherlockBuilder`	`withLocksCollection(com.mongodb.client.MongoCollection<org.bson.Document> collection)`
`T`	`withOwnerId(java.lang.String arg0)`
`T`	`withStaticUniqueOwnerId()`
`T`	`withUniqueOwnerId()`

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

- Method Detail
  - mongoSherlock
```
public static MongoSherlockBuilder mongoSherlock()
```
    Returns:
    
    new instance of the builder
  - mongoSherlock
```
public static com.coditory.sherlock.Sherlock mongoSherlock(com.mongodb.client.MongoCollection<org.bson.Document> collection)
```
    Parameters:
    
    collection - mongo collection to be used for locking
    
    Returns:
    
    new instance of mongo sherlock with default configuration
  - withLocksCollection
```
public MongoSherlockBuilder withLocksCollection(com.mongodb.client.MongoCollection<org.bson.Document> collection)
```
    Parameters:
    
    collection - mongo collection to be used for locking
    
    Returns:
    
    the instance
  - withClock
```
public MongoSherlockBuilder withClock(java.time.Clock clock)
```
    Parameters:
    
    clock - time provider used in locking mechanism. Default: SherlockDefaults.DEFAULT_CLOCK
    
    Returns:
    
    the instance
  - build
```
public com.coditory.sherlock.Sherlock build()
```
    Returns:
    
    sherlock instance
    
    Throws:
    
    java.lang.IllegalArgumentException - when some required values are missing
  - withLockDuration
```
public T withLockDuration(java.time.Duration arg0)
```
  - withOwnerId
```
public T withOwnerId(java.lang.String arg0)
```
  - withUniqueOwnerId
```
public T withUniqueOwnerId()
```
  - withStaticUniqueOwnerId
```
public T withStaticUniqueOwnerId()
```