org.protempa.proposition.value

Class DateValue

java.lang.Object

org.protempa.proposition.value.DateValue

All Implemented Interfaces:

Serializable, Comparable<DateValue>, OrderedValue, Value, ValueVisitable

public class DateValue
extends Object
implements OrderedValue, Comparable<DateValue>, Serializable

Represents dates and datetimes.

Author:

Andrew Post

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DateValue() Constructs a new date value object representing the current time.
DateValue(Date date) Constructs a new date value from a Java date object.

Method Summary

Modifier and Type	Method and Description
void	accept(ValueVisitor valueVisitor) Performs some processing on a value.
DateValueBuilder	asBuilder()
ValueComparator	compare(Value o) Compares this date value and another date value according to their natural order, or checks this date value for membership in a value list.
int	compareTo(DateValue other)
boolean	equals(Object obj)
String	format(Format format) Formats this date value with a custom Format.
Date	getDate() Gets the date represented by this object as a Java Date.
String	getFormatted() Returns a string representing this value for display purposes.
static DateValue	getInstance() Constructs a new date value representing the current time.
static DateValue	getInstance(Date date) Constructs a new date value from a Java date object.
ValueType	getType() Returns this object's type, guaranteed not null.
int	hashCode()
static DateValue	parse(String str) Parses a date from a string.
Value	replace() Returns a value from a cache that is equal to this one, if such a value exists.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DateValue

public DateValue()

Constructs a new date value object representing the current time. Use getInstance() instead to leverage a cache of frequently used date values.

DateValue

public DateValue(Date date)

Constructs a new date value from a Java date object. Use getInstance(Date) instead to leverage a cache of frequently used date values.

Method Detail

parse

public static DateValue parse(String str)

Parses a date from a string. Expects the format used by AbsoluteTimeGranularity.DAY's getShortFormat().

Parameters:

str - a string representing a date.

Returns:

a date value, or null if no date could be parsed.

getInstance

public static DateValue getInstance(Date date)

Constructs a new date value from a Java date object. Uses a cache to reuse date value objects.

Parameters:

date - a Date. If null a new date value is created using the current time.

Returns:

a DateValue.

getInstance

public static DateValue getInstance()

Constructs a new date value representing the current time.

Returns:

a DateValue.

getDate

public Date getDate()

Gets the date represented by this object as a Java Date.

Returns:

a Date.

getFormatted

public String getFormatted()

Description copied from interface: Value

Returns a string representing this value for display purposes.

Specified by:

getFormatted in interface Value

Returns:

a String. Guaranteed not null.

format

public String format(Format format)

Formats this date value with a custom Format. This method passes the format a Date object.

Specified by:

format in interface Value

Parameters:

format - the custom format.

Returns:

a formatted date string.

getType

public ValueType getType()

Description copied from interface: Value

Returns this object's type, guaranteed not null.

Specified by:

getType in interface Value

Returns:

a ValueType.

compare

public ValueComparator compare(Value o)

Compares this date value and another date value according to their natural order, or checks this date value for membership in a value list.

Specified by:

compare in interface Value

Parameters:

o - a Value.

Returns:

ValueComparator.GREATER_THAN, ValueComparator.LESS_THAN or ValueComparator.EQUAL_TO depending on whether this value is greater than, less than or equal to the value provided as argument. If the provided value is a value list, returns ValueComparator.IN if this date value is in the list, or ValueComparator.NOT_IN if this date value is not in the list. Otherwise, returns ValueComparator.UNKNOWN.

replace

public Value replace()

Description copied from interface: Value

Returns a value from a cache that is equal to this one, if such a value exists. Otherwise, it returns itself.

Specified by:

replace in interface Value

Returns:

a Value for which #equals(Value) is true.

accept

public void accept(ValueVisitor valueVisitor)

Description copied from interface: ValueVisitable

Performs some processing on a value.

Specified by:

accept in interface ValueVisitable

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(DateValue other)

Specified by:

compareTo in interface Comparable<DateValue>

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

asBuilder

public DateValueBuilder asBuilder()

Specified by:

asBuilder in interface OrderedValue

Specified by:

asBuilder in interface Value