Dummy4j (Dummy4j 0.7.1 API)

java.lang.Object
- dev.codesoapbox.dummy4j.Dummy4j

```
public class Dummy4j
extends Object
```
Provides methods for generating dummy data.
For best performance, a single instance of this class should be created and reused throughout the code.

Field Summary

Fields
Modifier and Type	Field and Description
`protected ConvenienceMethods`	`convenienceMethods`
`protected Dummies`	`dummies`
`protected ExpressionResolver`	`expressionResolver`
`protected RandomService`	`randomService`
`protected UniqueValues`	`uniqueValues`

Constructor Summary

Constructors
Modifier	Constructor and Description
	`Dummy4j()` Create a Dummy4j instance with a default configuration
	`Dummy4j(ExpressionResolver expressionResolver, RandomService randomService)`
`protected`	`Dummy4j(ExpressionResolver expressionResolver, RandomService randomService, Function<? super Dummy4j,Dummies> dummiesFactory, UniqueValues uniqueValues, ConvenienceMethods convenienceMethods)`
	`Dummy4j(Long seed, List<String> locales, List<String> paths)` This constructor is primarily used for Dummy4j's builder.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AddressDummy`	`address()` Provides methods for generating addresses
`BookDummy`	`book()` Provides methods for generating book-related values
`boolean`	`chance(int howMany, int in)` Has a `howMany` in `in` chance to return `true`.
`<T> T`	`chance(int howMany, int in, Supplier<T> supplier)` Has a `howMany` in `in` chance to supply a value.
`ColorDummy`	`color()` Provides methods for generating colors
`DateAndTimeDummy`	`dateAndTime()` Provides methods for generating dates and times
`EducationDummy`	`education()` Provides methods for generating values related to education
`ExpressionResolver`	`expressionResolver()`
`FinanceDummy`	`finance()` Provides methods for generating values related to finances
`Long`	`getSeed()` Returns the seed used for random number generation
`IdentifierDummy`	`identifier()` Provides methods for generating identifiers
`InternetDummy`	`internet()` Provides methods for generating values related to the internet
`<T> List<T>`	`listOf(int count, Supplier<T> supplier)` Provides a list of objects supplied by a method
`LoremDummy`	`lorem()` Provides methods for generating text
`MedicalDummy`	`medical()` Provides methods for generating medical data
`NameDummy`	`name()` Provides methods for generating names
`NationDummy`	`nation()` Provides methods for generating values related to countries, languages and nationalities
`NatoPhoneticAlphabetDummy`	`natoPhoneticAlphabet()` Provides methods for generating text in the NATO phonetic alphabet
`boolean`	`nextBoolean()`
`<T extends Enum<?>> T`	`nextEnum(Class<T> clazz)` Returns a random enum value
`NumberService`	`number()` Provides methods for generating random numbers
`NumeralsDummy`	`numerals()` Provides methods for generating numerals
`<T> T`	`of(List<T> list)` Returns a random element from a list
`<T> T`	`of(Set<T> set)` Returns a random element from a set
`<T> T`	`of(Supplier<T>... suppliers)` Returns a value from a random supplier.
`<T> T`	`of(T... array)` Returns a random element from an array
`ResearchPaperDummy`	`researchPaper()` Provides methods for generating values related to research papers
`ScifiDummy`	`scifi()` Provides methods for generating science fiction themed values
`<T> Set<T>`	`setOf(int count, Supplier<T> supplier)` Provides a set of objects supplied by a method
`@Experimental UniqueValues`	`unique()` Provides methods for generating unique values

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

- Field Detail
  - expressionResolver
```
protected final ExpressionResolver expressionResolver
```
  - randomService
```
protected final RandomService randomService
```
  - dummies
```
protected final Dummies dummies
```
  - uniqueValues
```
protected final UniqueValues uniqueValues
```
  - convenienceMethods
```
protected final ConvenienceMethods convenienceMethods
```
- Constructor Detail
  - Dummy4j
```
public Dummy4j()
```
    Create a Dummy4j instance with a default configuration
  - Dummy4j
```
public Dummy4j(Long seed,
               List<String> locales,
               List<String> paths)
```
    This constructor is primarily used for Dummy4j's builder. It is used instead of passing the entire builder instance for better extensibility.
    
    Parameters:
    
    seed - used for generating random values
    
    locales - a list of locales, ordered by priority of resolution
    
    paths - a list of paths from which to load yml files (relative to the resources directory)
    
    Since:
    
    0.3.0
  - Dummy4j
```
public Dummy4j(ExpressionResolver expressionResolver,
               RandomService randomService)
```
  - Dummy4j
```
protected Dummy4j(ExpressionResolver expressionResolver,
                  RandomService randomService,
                  Function<? super Dummy4j,Dummies> dummiesFactory,
                  UniqueValues uniqueValues,
                  ConvenienceMethods convenienceMethods)
```
- Method Detail
  - expressionResolver
```
public ExpressionResolver expressionResolver()
```
    Returns:
    
    the resolver used for resolving expressions
  - unique
```
@Experimental
public @Experimental UniqueValues unique()
```
    Provides methods for generating unique values
    
    Since:
    
    0.1.2
  - number
```
public NumberService number()
```
    Provides methods for generating random numbers
  - getSeed
```
public Long getSeed()
```
    Returns the seed used for random number generation
    
    Since:
    
    0.6.0
  - nextBoolean
```
public boolean nextBoolean()
```
    Returns:
    
    a random boolean value
  - listOf
```
public <T> List<T> listOf(int count,
                          Supplier<T> supplier)
```
    Provides a list of objects supplied by a method
    
    Type Parameters:
    
    T - the type of objects to generate
    
    Parameters:
    
    count - the number of objects to generate
    
    supplier - the method to generate an object
    
    Returns:
    
    a list of objects
    
    Since:
    
    0.4.0
  - setOf
```
public <T> Set<T> setOf(int count,
                        Supplier<T> supplier)
```
    Provides a set of objects supplied by a method
    
    Type Parameters:
    
    T - the type of objects to generate
    
    Parameters:
    
    count - the number of objects to generate
    
    supplier - the method to generate an object
    
    Returns:
    
    a list of objects
    
    Since:
    
    0.4.0
  - of
```
@SafeVarargs
public final <T> T of(T... array)
```
    Returns a random element from an array
    
    Type Parameters:
    
    T - the type of object to return
    
    Parameters:
    
    array - the array to pick from
    
    Returns:
    
    a random element
    
    Since:
    
    0.5.0
  - of
```
public <T> T of(List<T> list)
```
    Returns a random element from a list
    
    Type Parameters:
    
    T - the type of object to return
    
    Parameters:
    
    list - the list to pick from
    
    Returns:
    
    a random element
    
    Since:
    
    0.5.0
  - of
```
public <T> T of(Set<T> set)
```
    Returns a random element from a set
    
    Type Parameters:
    
    T - the type of object to return
    
    Parameters:
    
    set - the list to pick from
    
    Returns:
    
    a random element
    
    Since:
    
    0.5.0
  - of
```
@SafeVarargs
public final <T> T of(Supplier<T>... suppliers)
```
    Returns a value from a random supplier.
    
    Type Parameters:
    
    T - the type of value to return
    
    Parameters:
    
    suppliers - value suppliers to pick from
    
    Returns:
    
    a value from a random supplier
    
    Since:
    
    0.5.0
  - chance
```
public <T> T chance(int howMany,
                    int in,
                    Supplier<T> supplier)
```
    Has a howMany in in chance to supply a value. Otherwise, returns null.
    E.g. chance(1, 2, () -> "hello") has a 1-in-2 chance to supply "hello", that is it will be supplied 50% of the time when the method is invoked.
    
    Returns:
    
    supplied T or null
    
    Since:
    
    0.5.0
  - chance
```
public boolean chance(int howMany,
                      int in)
```
    Has a howMany in in chance to return true. Otherwise, returns false.
    E.g. chance(1, 2) has a 1-in-2 chance to return true, that is it will return true 50% of the time when the method is invoked.
    
    Returns:
    
    boolean
    
    Since:
    
    0.5.0
  - nextEnum
```
public <T extends Enum<?>> T nextEnum(Class<T> clazz)
```
    Returns a random enum value
    
    Since:
    
    0.5.0
  - name
```
public NameDummy name()
```
    Provides methods for generating names
  - nation
```
public NationDummy nation()
```
    Provides methods for generating values related to countries, languages and nationalities
    
    Since:
    
    0.2.0
  - address
```
public AddressDummy address()
```
    Provides methods for generating addresses
  - lorem
```
public LoremDummy lorem()
```
    Provides methods for generating text
  - dateAndTime
```
public DateAndTimeDummy dateAndTime()
```
    Provides methods for generating dates and times
    
    Since:
    
    0.4.0
  - identifier
```
public IdentifierDummy identifier()
```
    Provides methods for generating identifiers
    
    Since:
    
    0.5.0
  - education
```
public EducationDummy education()
```
    Provides methods for generating values related to education
    
    Since:
    
    0.3.0
  - book
```
public BookDummy book()
```
    Provides methods for generating book-related values
    
    Since:
    
    0.2.0
  - researchPaper
```
public ResearchPaperDummy researchPaper()
```
    Provides methods for generating values related to research papers
    
    Since:
    
    0.2.0
  - scifi
```
public ScifiDummy scifi()
```
    Provides methods for generating science fiction themed values
  - color
```
public ColorDummy color()
```
    Provides methods for generating colors
    
    Since:
    
    0.4.0
  - numerals
```
public NumeralsDummy numerals()
```
    Provides methods for generating numerals
    
    Since:
    
    0.4.0
  - medical
```
public MedicalDummy medical()
```
    Provides methods for generating medical data
    
    Since:
    
    0.4.0
  - natoPhoneticAlphabet
```
public NatoPhoneticAlphabetDummy natoPhoneticAlphabet()
```
    Provides methods for generating text in the NATO phonetic alphabet
    
    Since:
    
    0.4.0
  - internet
```
public InternetDummy internet()
```
    Provides methods for generating values related to the internet
    
    Since:
    
    0.5.0
  - finance
```
public FinanceDummy finance()
```
    Provides methods for generating values related to finances
    
    Since:
    
    0.6.0

Class Dummy4j

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

expressionResolver

randomService

dummies

uniqueValues

convenienceMethods

Constructor Detail

Dummy4j

Dummy4j

Dummy4j

Dummy4j

Method Detail

expressionResolver

unique

number

getSeed

nextBoolean

listOf

setOf

of

of

of

of

chance

chance

nextEnum

name

nation

address

lorem

dateAndTime

identifier

education

book

researchPaper

scifi

color

numerals

medical

natoPhoneticAlphabet

internet

finance