com.goldencode.p2j.directory

Class DateValue

java.lang.Object

com.goldencode.p2j.directory.DateValue

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable

public class DateValue
extends java.lang.Object
implements java.lang.Comparable, java.io.Serializable

The main purpose of this class is to hold date value for storing/saving it in the Directory. Also it allows to distinguish types during processing (this is not so simple for java.util.Date and derivatives). For the convenience it can be easily converted to/from java.util.Date class.

Version:

1.0

Author:

SIY

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Calendar	calendar Internal instance of the Calendar
private static java.lang.ThreadLocal<java.text.SimpleDateFormat>	format Format used for DateValue <-> String conversion.

Constructor Summary

Constructors

Constructor and Description
DateValue() Construct an instance for the current date.
DateValue(java.util.Date other) Construct new instance from the instance of the Date.
DateValue(DateValue other) Construct new instance from the other instance of the DateValue.
DateValue(int year, int month, int day) Construct an instance for specified date.

Method Summary

Modifier and Type	Method and Description
int	compareTo(java.util.Date other) Compares this instance with instance of Date for ordering.
int	compareTo(DateValue other) Compares two instances for ordering.
int	compareTo(java.lang.Object other) Compare this instance with other object.
private void	enforceTime(java.util.Date input) This method performs all necessary steps to enforce DateValue instance to contain only date, without time part.
boolean	equals(java.lang.Object o) Compares two objects for equality.
java.util.Date	getDate() Return current value represented as an instance of Date.
int	hashCode() Return a hash code for the instance.
void	setDate(java.util.Date date) Set current value using instance of Date as a source.
java.lang.String	toString() Convert DateValue instance into String.
static DateValue	valueOf(java.lang.String str) Parse String like YYYYMMDD and create an instance of DateValue.

Methods inherited from class java.lang.Object

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

Field Detail

format

private static final java.lang.ThreadLocal<java.text.SimpleDateFormat> format

Format used for DateValue <-> String conversion.

calendar

private java.util.Calendar calendar

Internal instance of the Calendar

Constructor Detail

DateValue

public DateValue()

Construct an instance for the current date.

DateValue

public DateValue(java.util.Date other)

Construct new instance from the instance of the Date.

Parameters:

other - An instance which is used as a source of the information.

DateValue

public DateValue(DateValue other)

Construct new instance from the other instance of the DateValue.

Parameters:

other - An instance which is used as a source of the information.

DateValue

public DateValue(int year,
                 int month,
                 int day)

Construct an instance for specified date.

Parameters:

year - Year value for the new instance.

month - Month value for the new instance.

day - Day of the month value for the new instance.

Method Detail

valueOf

public static DateValue valueOf(java.lang.String str)

Parse String like YYYYMMDD and create an instance of DateValue.

Parameters:

str - Source string.

Returns:

new DateValue instance or null if source string does not contain properly formatted date.

compareTo

public int compareTo(java.util.Date other)

Compares this instance with instance of Date for ordering.

Parameters:

other - The instance of Date to be compared.

Returns:

0 if dates are equal; a value less than 0 if this instance date is before date of the passed parameter; a value greater than 0 if this instance date is after date of the parameter.

compareTo

public int compareTo(DateValue other)

Compares two instances for ordering.

Parameters:

other - The instance to be compared.

Returns:

0 if instances are equal; a value less than 0 if this instance date is before date of the instance passed as a parameter; a value greater than 0 if this instance date is after date of the instance passed as a parameter.

compareTo

public int compareTo(java.lang.Object other)

Compare this instance with other object.

Specified by:

compareTo in interface java.lang.Comparable

Parameters:

other - The instance of Date to be compared.

Returns:

0 if dates are equal; a value less than 0 if this instance date is before date of the passed parameter; a value greater than 0 if this instance date is after date of the parameter.

Throws:

java.lang.ClassCastException - if argument is not instance of Date or DateValue.

equals

public boolean equals(java.lang.Object o)

Compares two objects for equality. Calls Calendar.equals() or Date.equals() if possible. Otherwise return false.

Overrides:

equals in class java.lang.Object

Parameters:

o - Object to compare with.

Returns:

true if instances are equal and false otherwise.

getDate

public java.util.Date getDate()

Return current value represented as an instance of Date.

Returns:

an instance of java.util.Date.

hashCode

public int hashCode()

Return a hash code for the instance. Use Date.hashCode() for real computation.

Overrides:

hashCode in class java.lang.Object

Returns:

hash code for the instance.

setDate

public void setDate(java.util.Date date)

Set current value using instance of Date as a source.

Parameters:

date - Source instance of Date to get values from.

toString

public java.lang.String toString()

Convert DateValue instance into String.

Overrides:

toString in class java.lang.Object

Returns:

string in format YYYYMMMDD.

enforceTime

private void enforceTime(java.util.Date input)

This method performs all necessary steps to enforce DateValue instance to contain only date, without time part.

Parameters:

input - Date instance to set information from.