FakeValuesService (Java Faker 0.13 API)

java.lang.Object
- com.github.javafaker.service.FakeValuesService

public class FakeValuesService
extends Object

Constructor Summary

Constructors
Constructor and Description
`FakeValuesService(Locale locale, RandomService randomService)` Resolves YAML file using the most specific path first based on language and country code.

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`bothify(String string)` Applies both a `numerify(String)` and a `letterify(String)` over the incoming string.
`String`	`bothify(String string, boolean isUpper)` Applies both a `numerify(String)` and a `letterify(String,boolean)` over the incoming string.
`String`	`expression(String expression, Faker faker)` resolves an expression using the current faker.
`protected Map`	`fakerFromStream(InputStream stream, String localeName)`
`Object`	`fetch(String key)` Fetch a random value from an array item specified by the key
`Object`	`fetchObject(String key)` Return the object selected by the key from yaml file.
`String`	`fetchString(String key)` Same as `fetch(String)` except this casts the result into a String.
`String`	`letterify(String letterString)` Returns a string with the '?' characters in the parameter replaced with random alphabetic characters.
`String`	`letterify(String letterString, boolean isUpper)` Returns a string with the '?' characters in the parameter replaced with random alphabetic characters.
`protected List<Locale>`	`localeChain(Locale from)` Convert the specified locale into a chain of locales used for message resolution.
`String`	`numerify(String numberString)` Returns a string with the '#' characters in the parameter replaced with random digits between 0-9 inclusive.
`String`	`regexify(String regex)` Generates a String that matches the given regular expression.
`String`	`resolve(String key, Object current, Faker root)` Resolves a key to a method on an object.
`protected String`	`resolveExpression(String expression, Object current, Faker root)` processes a expression in the style #{X.y} using the current objects as the 'current' location within the yml file (or the `Faker` object hierarchy as it were).
`String`	`safeFetch(String key, String defaultIfNull)` Safely fetches a key.

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

- Constructor Detail
  - FakeValuesService
```
public FakeValuesService(Locale locale,
                 RandomService randomService)
```
    Resolves YAML file using the most specific path first based on language and country code. 'en_US' would resolve in the following order:
    1. /en-US.yml
    2. /en.yml
    The search is case-insensitive, so the following will all resolve correctly. Also, either a hyphen or an underscore can be used when constructing a Locale instance. This is legacy behavior and not condoned, but it will work.
    - EN_US
    - En-Us
    - eN_uS
    Parameters:
    locale -
    randomService -
- Method Detail
  - fakerFromStream
```
protected Map fakerFromStream(InputStream stream,
                  String localeName)
```
    Returns:
    the embedded faker: clause from the loaded Yml by the localeName, so .yml > en-us: > faker:
  - localeChain
```
protected List<Locale> localeChain(Locale from)
```
    Convert the specified locale into a chain of locales used for message resolution. For example: Locale.FRANCE (fr_FR) -> [ fr_FR, fr, en ]
    
    Returns:
    a list of Locale instances
  - fetch
```
public Object fetch(String key)
```
    Fetch a random value from an array item specified by the key
    
    Parameters:
    key -
    
    Returns:
  - fetchString
```
public String fetchString(String key)
```
    Same as fetch(String) except this casts the result into a String.
    
    Parameters:
    key -
    
    Returns:
  - safeFetch
```
public String safeFetch(String key,
               String defaultIfNull)
```
    Safely fetches a key.
    If the value is null, it will return an empty string.
    If it is a list, it will assume it is a list of strings and select a random value from it.
    If the retrieved value is an slash encoded regular expression such as /[a-b]/ then the regex will be converted to a regexify expression and returned (ex. #regexify '[a-b]')
    Otherwise it will just return the value as a string.
    
    Parameters:
    key - the key to fetch from the YML structure.
    defaultIfNull - the value to return if the fetched value is null
    
    Returns:
    see above
  - fetchObject
```
public Object fetchObject(String key)
```
    Return the object selected by the key from yaml file.
    
    Parameters:
    key - key contains path to an object. Path segment is separated by dot. E.g. name.first_name
    
    Returns:
  - numerify
```
public String numerify(String numberString)
```
    Returns a string with the '#' characters in the parameter replaced with random digits between 0-9 inclusive.
    For example, the string "ABC##EFG" could be replaced with a string like "ABC99EFG".
    
    Parameters:
    numberString -
    
    Returns:
  - bothify
```
public String bothify(String string)
```
    Applies both a numerify(String) and a letterify(String) over the incoming string.
    
    Parameters:
    string -
    
    Returns:
  - bothify
```
public String bothify(String string,
             boolean isUpper)
```
    Applies both a numerify(String) and a letterify(String,boolean) over the incoming string.
    
    Parameters:
    string -
    isUpper -
    
    Returns:
  - regexify
```
public String regexify(String regex)
```
    Generates a String that matches the given regular expression.
  - letterify
```
public String letterify(String letterString)
```
    Returns a string with the '?' characters in the parameter replaced with random alphabetic characters.
    For example, the string "12??34" could be replaced with a string like "12AB34".
    
    Parameters:
    letterString -
    
    Returns:
  - letterify
```
public String letterify(String letterString,
               boolean isUpper)
```
    Returns a string with the '?' characters in the parameter replaced with random alphabetic characters.
    For example, the string "12??34" could be replaced with a string like "12AB34".
    
    Parameters:
    letterString -
    isUpper - specifies whether or not letters should be upper case
    
    Returns:
  - resolve
```
public String resolve(String key,
             Object current,
             Faker root)
```
    Resolves a key to a method on an object. #{hello} with result in a method call to current.hello(); #{Person.hello_someone} will result in a method call to person.helloSomeone();
  - expression
```
public String expression(String expression,
                Faker faker)
```
    resolves an expression using the current faker.
    
    Parameters:
    expression -
    faker -
    
    Returns:
  - resolveExpression
```
protected String resolveExpression(String expression,
                       Object current,
                       Faker root)
```
    processes a expression in the style #{X.y} using the current objects as the 'current' location within the yml file (or the Faker object hierarchy as it were).
    
    #{Address.streetName} would get resolved to Faker.address()'s Address.streetName()
    
    #{address.street} would get resolved to the YAML > locale: faker: address: street:
    
    Combinations are supported as well: "#{x} #{y}"
    
    Recursive templates are supported. if "#{x}" resolves to "#{Address.streetName}" then "#{x}" resolves to Faker.address()'s Address.streetName().

Class FakeValuesService

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FakeValuesService

Method Detail

fakerFromStream

localeChain

fetch

fetchString

safeFetch

fetchObject

numerify

bothify

bothify

regexify

letterify

letterify

resolve

expression

resolveExpression