Package net.datafaker.providers.base

Class Twitter

java.lang.Object

net.datafaker.providers.base.AbstractProvider<BaseProviders>

net.datafaker.providers.base.Twitter

public class Twitter
extends AbstractProvider<BaseProviders>

Creates fake Twitter messages.

Since:

0.9.0

Field Summary

Fields inherited from class net.datafaker.providers.base.AbstractProvider

faker

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Twitter(BaseProviders faker)

Method Summary

Modifier and Type	Method	Description
Date	createdTime(boolean forward, Date base, Date constraints)	Deprecated, for removal: This API element is subject to removal in a future version. better to use TimeAndDate for more flexibility
String	getLink(String username, int extraLength)	return a fake link to a Twitter message.
String	text(String[] keywords, int sentenceMaxLength, int wordMaxLength)	To fake a new text context for the Twitter.
String	twitterId(int expectedLength)	Used to fake a new Twitter ID without collision using both current time and uuid as seeds.
String	userId()
String	userName()

Methods inherited from class net.datafaker.providers.base.AbstractProvider

equals, getFaker, hashCode, loadGenerators, resolve, resolve, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Twitter

protected Twitter(BaseProviders faker)

Parameters:

faker - used as constructor

Method Details

createdTime

@Deprecated(since="2.3.0",
            forRemoval=true)
public Date createdTime(boolean forward,
 Date base,
 Date constraints)

Deprecated, for removal: This API element is subject to removal in a future version.

better to use TimeAndDate for more flexibility

Used to fake a new Twitter Date.

Parameters:

forward - to determined if the returned date is later (or before) the given date.

base - the base date given as a start point.

constraints - used to constrain the returned date range.

Returns:

a new date later (or before) the base date with respect to the constraint (no later/earlier than the constraint).

twitterId

public String twitterId(int expectedLength)

Used to fake a new Twitter ID without collision using both current time and uuid as seeds.

Parameters:

expectedLength - the expected length of the twitter id. Should be greater or equals to 6 and less than or equals to 25.

Returns:

a new Twitter ID consists of purely numbers.

text

public String text(String[] keywords,
 int sentenceMaxLength,
 int wordMaxLength)

To fake a new text context for the Twitter.

Parameters:

keywords - the keywords that you wish to appear in the text.

sentenceMaxLength - the text should be in range of the sentence max length.

wordMaxLength - each word should be in range of the word max length.

Returns:

a new fake text for the Twitter.

userName

public String userName()

Returns:

Return a user name using the twitter.user_name.

userId

public String userId()

Returns:

Return a user id using the twitter.user_name.

getLink

public String getLink(String username,
 int extraLength)

return a fake link to a Twitter message. The extra length is expected to be larger than 4.

Parameters:

username - the username will be used in the link.

extraLength - the expected length of the extra link part.

Returns:

return a fake link to a Twitter message.