net.datafaker.providers.base

Class DateAndTime

java.lang.Object

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

net.datafaker.providers.base.DateAndTime

public class DateAndTime
extends AbstractProvider<BaseProviders>

A generator of random dates.

Since:

0.8.0

Author:

pmiklos

Field Summary

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

faker

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DateAndTime(BaseProviders faker)

Method Summary

Modifier and Type	Method and Description
<T extends java.util.Date> T	between(T from, T to) Generates a random date between two dates.
<T extends java.util.Date> java.lang.String	between(T from, T to, java.lang.String pattern) Generates a string representation of a random date between two dates.
java.sql.Timestamp	birthday() Generates a random birthday between 65 and 18 years ago from now.
java.sql.Timestamp	birthday(int minAge, int maxAge) Generates a random birthday between two ages from now.
java.lang.String	birthday(int minAge, int maxAge, java.lang.String pattern) Generates and converts to string representation a random birthday between two ages from now.
java.lang.String	birthday(java.lang.String pattern) Generates a string representation of a random birthday between 65 and 18 years ago from now.
java.time.Duration	duration(long max, java.time.temporal.ChronoUnit unit) Generates a random Duration lower than max.
java.time.Duration	duration(long min, long max, java.time.temporal.ChronoUnit unit) Generates a random Duration between min and max.
java.time.Duration	duration(long min, long max, java.lang.String unit) Generates a random Duration between min and max.
java.time.Duration	duration(long max, java.lang.String unit) Generates a random Duration lower than max.
java.sql.Timestamp	future(int atMost, int minimum, java.util.concurrent.TimeUnit unit) Generates a future date from now, with a minimum time.
java.lang.String	future(int atMost, int minimum, java.util.concurrent.TimeUnit unit, java.lang.String pattern) Generates and converts to string representation of a future date from now, with a minimum time.
java.sql.Timestamp	future(int atMost, java.util.concurrent.TimeUnit unit) Generates a future date from now.
java.lang.String	future(int atMost, java.util.concurrent.TimeUnit unit, java.lang.String pattern) Generates and converts to string representation a future date from now.
<T extends java.util.Date> T	future(int atMost, java.util.concurrent.TimeUnit unit, T referenceDate) Generates a future date relative to the referenceDate.
<T extends java.util.Date> java.lang.String	future(int atMost, java.util.concurrent.TimeUnit unit, T referenceDate, java.lang.String pattern) Generates and converts to string representation a future date relative to the referenceDate.
java.sql.Timestamp	past(int atMost, int minimum, java.util.concurrent.TimeUnit unit) Generates a past date from now, with a minimum time.
java.lang.String	past(int atMost, int minimum, java.util.concurrent.TimeUnit unit, java.lang.String pattern) Generates and converts to string representation a past date from now, with a minimum time.
java.sql.Timestamp	past(int atMost, java.util.concurrent.TimeUnit unit) Generates a past date from now.
java.lang.String	past(int atMost, java.util.concurrent.TimeUnit unit, java.util.Date referenceDate, java.lang.String pattern) Generates a string representation of a past date relative to the referenceDate.
java.lang.String	past(int atMost, java.util.concurrent.TimeUnit unit, java.lang.String pattern) Generates a string representation of a past date from now.
<T extends java.util.Date> T	past(int atMost, java.util.concurrent.TimeUnit unit, T referenceDate) Generates a past date relative to the referenceDate.
java.time.Period	period(java.time.Period min, java.time.Period max) Generates a random Period between min and max.

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

getFaker, resolve, resolve

Methods inherited from class java.lang.Object

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

Constructor Detail

DateAndTime

protected DateAndTime(BaseProviders faker)

Method Detail

future

public java.sql.Timestamp future(int atMost,
                                 java.util.concurrent.TimeUnit unit)

Generates a future date from now.

Parameters:

atMost - at most this amount of time ahead from now exclusive.

unit - the time unit.

Returns:

a future date from now.

future

public java.lang.String future(int atMost,
                               java.util.concurrent.TimeUnit unit,
                               java.lang.String pattern)

Generates and converts to string representation a future date from now.

Parameters:

atMost - at most this amount of time ahead from now exclusive.

unit - the time unit.

pattern - date time pattern to convert to string.

Returns:

a string representation of a future date from now.

future

public java.sql.Timestamp future(int atMost,
                                 int minimum,
                                 java.util.concurrent.TimeUnit unit)

Generates a future date from now, with a minimum time.

Parameters:

atMost - at most this amount of time ahead from now exclusive.

minimum - the minimum amount of time in the future from now.

unit - the time unit.

Returns:

a future date from now, with a minimum time.

future

public java.lang.String future(int atMost,
                               int minimum,
                               java.util.concurrent.TimeUnit unit,
                               java.lang.String pattern)

Generates and converts to string representation of a future date from now, with a minimum time.

Parameters:

atMost - at most this amount of time ahead from now exclusive.

minimum - the minimum amount of time in the future from now.

unit - the time unit.

pattern - date time pattern to convert to string.

Returns:

a string representation of a future date from now, with a minimum time.

future

public <T extends java.util.Date> T future(int atMost,
                                           java.util.concurrent.TimeUnit unit,
                                           T referenceDate)

Generates a future date relative to the referenceDate.

Parameters:

atMost - at most this amount of time ahead to the referenceDate exclusive.

unit - the time unit.

referenceDate - the future date relative to this date.

Returns:

a future date relative to referenceDate.

future

public <T extends java.util.Date> java.lang.String future(int atMost,
                                                          java.util.concurrent.TimeUnit unit,
                                                          T referenceDate,
                                                          java.lang.String pattern)

Generates and converts to string representation a future date relative to the referenceDate.

Parameters:

atMost - at most this amount of time ahead to the referenceDate exclusive.

unit - the time unit.

referenceDate - the future date relative to this date.

pattern - date time pattern to convert to string.

Returns:

a string representation of a future date relative to referenceDate.

past

public java.sql.Timestamp past(int atMost,
                               java.util.concurrent.TimeUnit unit)

Generates a past date from now.

Parameters:

atMost - at most this amount of time earlier from now exclusive.

unit - the time unit.

Returns:

a past date from now.

past

public java.lang.String past(int atMost,
                             java.util.concurrent.TimeUnit unit,
                             java.lang.String pattern)

Generates a string representation of a past date from now.

Parameters:

atMost - at most this amount of time earlier from now exclusive.

unit - the time unit.

pattern - date time pattern to convert to string.

Returns:

a string representation of a past date from now.

past

public java.sql.Timestamp past(int atMost,
                               int minimum,
                               java.util.concurrent.TimeUnit unit)

Generates a past date from now, with a minimum time.

Parameters:

atMost - at most this amount of time earlier from now exclusive.

minimum - the minimum amount of time in the past from now.

unit - the time unit.

Returns:

a past date from now.

past

public java.lang.String past(int atMost,
                             int minimum,
                             java.util.concurrent.TimeUnit unit,
                             java.lang.String pattern)

Generates and converts to string representation a past date from now, with a minimum time.

Parameters:

atMost - at most this amount of time earlier from now exclusive.

minimum - the minimum amount of time in the past from now.

unit - the time unit.

pattern - date time pattern to convert to string.

Returns:

a string representation of a past date from now, with a minimum time.

past

public <T extends java.util.Date> T past(int atMost,
                                         java.util.concurrent.TimeUnit unit,
                                         T referenceDate)

Generates a past date relative to the referenceDate.

Parameters:

atMost - at most this amount of time past to the referenceDate exclusive.

unit - the time unit.

referenceDate - the past date relative to this date.

Returns:

a past date relative to referenceDate.

past

public java.lang.String past(int atMost,
                             java.util.concurrent.TimeUnit unit,
                             java.util.Date referenceDate,
                             java.lang.String pattern)

Generates a string representation of a past date relative to the referenceDate.

Parameters:

atMost - at most this amount of time past to the referenceDate exclusive.

unit - the time unit.

referenceDate - the past date relative to this date.

pattern - date time pattern to convert to string.

Returns:

a string representation of a past date relative to referenceDate.

between

public <T extends java.util.Date> T between(T from,
                                            T to)
                                     throws java.lang.IllegalArgumentException

Generates a random date between two dates.

Parameters:

from - the lower bound inclusive

to - the upper bound exclusive

Returns:

a random date between from and to.

Throws:

java.lang.IllegalArgumentException - if the to date represents an earlier date than from date.

between

public <T extends java.util.Date> java.lang.String between(T from,
                                                           T to,
                                                           java.lang.String pattern)
                                                    throws java.lang.IllegalArgumentException

Generates a string representation of a random date between two dates.

Parameters:

from - the lower bound inclusive

to - the upper bound exclusive

pattern - date time pattern to convert to string.

Returns:

a string representation of a random date between from and to.

Throws:

java.lang.IllegalArgumentException - if the to date represents an earlier date than from date.

birthday

public java.sql.Timestamp birthday()

Generates a random birthday between 65 and 18 years ago from now.

Returns:

a random birthday between 65 and 18 years ago from now.

birthday

public java.lang.String birthday(java.lang.String pattern)

Generates a string representation of a random birthday between 65 and 18 years ago from now.

Parameters:

pattern - date time pattern to convert to string.

Returns:

a string representation of a random birthday between 65 and 18 years ago from now.

birthday

public java.sql.Timestamp birthday(int minAge,
                                   int maxAge)

Generates a random birthday between two ages from now.

Parameters:

minAge - the minimal age

maxAge - the maximal age

Returns:

a random birthday between minAge and maxAge years ago from now.

Throws:

java.lang.IllegalArgumentException - if the maxAge is lower than minAge.

birthday

public java.lang.String birthday(int minAge,
                                 int maxAge,
                                 java.lang.String pattern)

Generates and converts to string representation a random birthday between two ages from now.

Parameters:

minAge - the minimal age

maxAge - the maximal age

pattern - date time pattern to convert to string.

Returns:

a string representation of a random birthday between minAge and maxAge years ago from now.

Throws:

java.lang.IllegalArgumentException - if the maxAge is lower than minAge.

duration

public java.time.Duration duration(long max,
                                   java.time.temporal.ChronoUnit unit)

Generates a random Duration lower than max.

Parameters:

max - the maximum value

unit - the temporal unit (day or shorter than a day)

Returns:

a random Duration lower than max.

Throws:

java.lang.IllegalArgumentException - if the unit is invalid.

duration

public java.time.Duration duration(long min,
                                   long max,
                                   java.time.temporal.ChronoUnit unit)

Generates a random Duration between min and max.

Parameters:

min - the maximum value

max - the minimal value

unit - the temporal unit (day or shorter than a day)

Returns:

a random Duration between min inclusive and max exclusive if max greater min.

Throws:

java.lang.IllegalArgumentException - if the unit is invalid.

duration

public java.time.Duration duration(long max,
                                   java.lang.String unit)

Generates a random Duration lower than max.

Parameters:

max - the maximum value

unit - the temporal unit (day or shorter than a day)

Returns:

a random Duration lower than max.

Throws:

java.lang.IllegalArgumentException - if the unit is invalid.

duration

public java.time.Duration duration(long min,
                                   long max,
                                   java.lang.String unit)

Generates a random Duration between min and max.

Parameters:

min - the minimal value

max - the maximum value

unit - the temporal unit (day or shorter than a day)

Returns:

a random Duration between min inclusive and max exclusive if max greater min.

Throws:

java.lang.IllegalArgumentException - if the unit is invalid.

period

public java.time.Period period(java.time.Period min,
                               java.time.Period max)

Generates a random Period between min and max.

Parameters:

min - the minimal value

max - the maximum value

Returns:

a random Period between min inclusive and max inclusive if max greater min.

Throws:

java.lang.IllegalArgumentException - if the min is greater than max.