UniqueValues (Dummy4j 0.7.3 API)

All Known Implementing Classes:

DefaultUniqueValues
```
public interface UniqueValues
```
Produces unique values

Since:

SNAPSHOT

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`<T,E> E`	`of(Supplier<T> supplier, Function<Supplier<T>,E> collector)` Allows for the creation of collections of unique values.
`void`	`setMaxRetries(int maxRetries)`
`<T> T`	`value(String uniquenessGroup, Supplier<T> supplier)` Invokes supplier until it returns a value unique within `uniquenessGroup` or the max retry limit is reached.
`<T> void`	`within(Supplier<T> supplier, Consumer<Supplier<T>> within)` Guarantees supplied values to be unique within the context of the consumer's code.

- Method Detail
  - setMaxRetries
```
void setMaxRetries(int maxRetries)
```
    Parameters:
    
    maxRetries - how many times a random value may be generated during one invocation
  - value
```
<T> T value(String uniquenessGroup,
            Supplier<T> supplier)
```
    Invokes supplier until it returns a value unique within uniquenessGroup or the max retry limit is reached.
    The unique values will be referenced in memory for the lifetime of Dummy4j.
    E.g. the following code:
```
 String color1 = dummy4j.unique().value("colors", () -> dummy4j.color().basicName());
 String color2 = dummy4j.unique().value("colors", () -> dummy4j.color().basicName());
 
```
    will guarantee that the values of color1 and color2 will always be different from each other.
    Type Parameters:
    
    T - the type of value to return
    
    Parameters:
    
    uniquenessGroup - id of the group within which the generated value should be unique
    
    supplier - the value supplier
    
    Returns:
    
    a unique value
    
    Throws:
    
    UniqueValueRetryLimitExceededException - if retry limit is exceeded
  - within
```
<T> void within(Supplier<T> supplier,
                Consumer<Supplier<T>> within)
```
    Guarantees supplied values to be unique within the context of the consumer's code.
    The unique values will be referenced in memory only until the execution of within is completed.
    E.g. the following code:
```
 dummy.unique().within(() -> dummy.color().basicName(), color -> {
             String color1 = color.get();
             String color2 = color.get();
         });
 
```
    will guarantee that the values of color1 and color2 will always be different from each other.
    Type Parameters:
    
    T - the type of value to return
    
    Parameters:
    
    supplier - the value supplier
    
    within - the code within which the supplied values will be unique
    
    Throws:
    
    UniqueValueRetryLimitExceededException - if retry limit is exceeded
  - of
```
<T,E> E of(Supplier<T> supplier,
           Function<Supplier<T>,E> collector)
```
    Allows for the creation of collections of unique values.
    Values supplied within the collector function are guaranteed to be unique.
    The unique values will be referenced in memory only until the execution of collector is completed.
    E.g. the following code:
```
 List<String> colors = dummy.unique().of(() -> dummy.color().basicName(), color -> dummy.listOf(2, color));
 
```
    will guarantee that the values of color will always be unique within the context of their list.
    Type Parameters:
    
    T - the type of value to return
    
    Parameters:
    
    supplier - the value supplier
    
    collector - the collector within which the supplied values will be unique
    
    Throws:
    
    UniqueValueRetryLimitExceededException - if retry limit is exceeded

Interface UniqueValues

Method Summary

Method Detail

setMaxRetries

value

within

of