com.github.javafaker

Class Lorem

java.lang.Object

com.github.javafaker.Lorem

public class Lorem
extends Object

Method Summary

Methods

Modifier and Type	Method and Description
char	character()
char	character(boolean includeUppercase)
String	characters()
String	characters(boolean includeUppercase)
String	characters(int fixedNumberOfCharacters)
String	characters(int fixedNumberOfCharacters, boolean includeUppercase)
String	characters(int minimumLength, int maximumLength)
String	characters(int minimumLength, int maximumLength, boolean includeUppercase)
String	fixedString(int numberOfLetters) Create a string with a fixed size.
String	paragraph()
String	paragraph(int sentenceCount)
List<String>	paragraphs(int paragraphCount)
String	sentence() Create a sentence with a random number of words within the range 4..10.
String	sentence(int wordCount) Create a sentence with a random number of words within the range (wordCount+1)..(wordCount+6).
String	sentence(int wordCount, int randomWordsToAdd) Create a sentence with a random number of words within the range (wordCount+1)..(wordCount+randomWordsToAdd).
List<String>	sentences(int sentenceCount)
String	word()
List<String>	words()
List<String>	words(int num)

Methods inherited from class java.lang.Object

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

Method Detail

character

public char character()

character

public char character(boolean includeUppercase)

characters

public String characters()

characters

public String characters(boolean includeUppercase)

characters

public String characters(int minimumLength,
                int maximumLength)

characters

public String characters(int minimumLength,
                int maximumLength,
                boolean includeUppercase)

characters

public String characters(int fixedNumberOfCharacters)

characters

public String characters(int fixedNumberOfCharacters,
                boolean includeUppercase)

words

public List<String> words(int num)

words

public List<String> words()

word

public String word()

sentence

public String sentence()

Create a sentence with a random number of words within the range 4..10.

Returns:

a random sentence

sentence

public String sentence(int wordCount)

Create a sentence with a random number of words within the range (wordCount+1)..(wordCount+6).

Parameters:

wordCount -

Returns:

a random sentence

sentence

public String sentence(int wordCount,
              int randomWordsToAdd)

Create a sentence with a random number of words within the range (wordCount+1)..(wordCount+randomWordsToAdd).

Set randomWordsToAdd to 0 to generate sentences with a fixed number of words.

Parameters:

wordCount -

randomWordsToAdd -

Returns:

a random sentence

sentences

public List<String> sentences(int sentenceCount)

paragraph

public String paragraph(int sentenceCount)

paragraph

public String paragraph()

paragraphs

public List<String> paragraphs(int paragraphCount)

fixedString

public String fixedString(int numberOfLetters)

Create a string with a fixed size. Can be useful for testing validator based on length string for example

Parameters:

numberOfLetters - size of the expected String

Returns:

a string with a fixed size