org.fastnate.generator

Class RelativeDate

java.lang.Object

java.util.Date

org.fastnate.generator.RelativeDate

All Implemented Interfaces:

Serializable, Cloneable, Comparable<Date>

public class RelativeDate
extends Date

Used for date calculation when writing entities. Examples:

Write "now" as property of a bean:

bean.setDate(RelativeDate.NOW)

Write "today" as property of a bean:

bean.setDate(RelativeDate.TODAY)

Write "yesterday" as property of a bean:

bean.setDate(new RelativeDate(RelativeDate.TODAY, - DateUtils.MILLIS_PER_DAY))

Author:

Tobias Liefke

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RelativeDate.Precision The precision of a difference between a reference date and a date property.
static class	RelativeDate.ReferenceDate Marker for NOW and TODAY.

Field Summary

Fields

Modifier and Type	Field and Description
static RelativeDate.Precision	DAYS Used for adding days to a reference date.
static RelativeDate.Precision	HOURS Used for adding hours to a reference date.
static RelativeDate.Precision	MILLISECONDS Used for adding milliseconds to a reference date.
static RelativeDate.Precision	MINUTES Used for adding minutes to a reference date.
static RelativeDate.ReferenceDate	NOW Represents the constant for writing the "now" function to SQL.
private static RelativeDate.Precision[]	PRECISIONS All known precisions, from the smallest to the biggest.
private RelativeDate.ReferenceDate	referenceDate The date that is the base for this date.
static RelativeDate.Precision	SECONDS Used for adding seconds to a reference date.
private static long	serialVersionUID
static RelativeDate.ReferenceDate	TODAY Represents the constant for writing the "today" function to SQL.
static RelativeDate.Precision	WEEKS Used for adding weeks to a reference date.
static RelativeDate.Precision	YEARS Used for adding years to a reference date.

Constructor Summary

Constructors

Constructor and Description
RelativeDate(long timeInMillis) Creates a new instance with the given millis as time.
RelativeDate(RelativeDate.ReferenceDate referenceDate, long deltaInMillis) Creates a new instance with the given millis as time and the given reference date.
RelativeDate(RelativeDate.ReferenceDate referenceDate, long delta, RelativeDate.Precision precision) Creates a new difference to a given reference date.

Method Summary

Modifier and Type	Method and Description
long	getDifference() The difference of the time to the referenceDate.
RelativeDate.Precision	getPrecision() Finds the highest possible unit of the difference between the reference date and this date.
RelativeDate.ReferenceDate	getReferenceDate() The date that is the base for this date.

Methods inherited from class java.util.Date

after, before, clone, compareTo, equals, from, getDate, getDay, getHours, getMinutes, getMonth, getSeconds, getTime, getTimezoneOffset, getYear, hashCode, parse, setDate, setHours, setMinutes, setMonth, setSeconds, setTime, setYear, toGMTString, toInstant, toLocaleString, toString, UTC

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

TODAY

public static final RelativeDate.ReferenceDate TODAY

Represents the constant for writing the "today" function to SQL.

NOW

public static final RelativeDate.ReferenceDate NOW

Represents the constant for writing the "now" function to SQL.

MILLISECONDS

public static final RelativeDate.Precision MILLISECONDS

Used for adding milliseconds to a reference date.

SECONDS

public static final RelativeDate.Precision SECONDS

Used for adding seconds to a reference date.

MINUTES

public static final RelativeDate.Precision MINUTES

Used for adding minutes to a reference date.

HOURS

public static final RelativeDate.Precision HOURS

Used for adding hours to a reference date.

DAYS

public static final RelativeDate.Precision DAYS

Used for adding days to a reference date.

WEEKS

public static final RelativeDate.Precision WEEKS

Used for adding weeks to a reference date.

YEARS

public static final RelativeDate.Precision YEARS

Used for adding years to a reference date.

PRECISIONS

private static final RelativeDate.Precision[] PRECISIONS

All known precisions, from the smallest to the biggest.

referenceDate

private final RelativeDate.ReferenceDate referenceDate

The date that is the base for this date. Only the difference to this date is written to the SQL file.

Constructor Detail

RelativeDate

public RelativeDate(long timeInMillis)

Creates a new instance with the given millis as time. Uses NOW as reference date.

Parameters:

timeInMillis - the time in milliseconds. Only the difference to NOW is written to SQL

RelativeDate

public RelativeDate(RelativeDate.ReferenceDate referenceDate,
                    long deltaInMillis)

Creates a new instance with the given millis as time and the given reference date.

Parameters:

referenceDate - the reference date

deltaInMillis - the difference to the reference date in milliseconds

RelativeDate

public RelativeDate(RelativeDate.ReferenceDate referenceDate,
                    long delta,
                    RelativeDate.Precision precision)

Creates a new difference to a given reference date.

Parameters:

referenceDate - the reference date

delta - the difference to the reference date

precision - the unit of the delta, one of the constants defined above

Method Detail

getDifference

public long getDifference()

The difference of the time to the referenceDate.

Returns:

the difference in milliseconds

getPrecision

public RelativeDate.Precision getPrecision()

Finds the highest possible unit of the difference between the reference date and this date.

Returns:

the highest possible unit to use without loosing information

getReferenceDate

@Generated(value="lombok")
public RelativeDate.ReferenceDate getReferenceDate()

The date that is the base for this date. Only the difference to this date is written to the SQL file.