eve.data

Class PlainDate

java.lang.Object

eve.data.DataObject

eve.data.PlainDate

All Implemented Interfaces:

DataUnit, IDate, Value, Copyable, Intable, LocaleFormatted, Stringable, Comparable

public class PlainDate
extends DataObject
implements IDate, Intable, Value, LocaleFormatted

A PlainDate holds a day in year value with guaranteed no regard for timezone information. The Date, DayInYear and DayOfYear classes all take timezones into account which raises the possibility of values changing when data is moved from one timezone into another.

Author:

Mike

Field Summary

Fields

Modifier and Type	Field and Description
int	day The day in the month value, starting from 1.
int	month The month in the year value, starting from 1.
int	year The full four-digit year, e.g. 2008

Constructor Summary

Constructors

Constructor and Description
PlainDate() Constructs a PlainDate object set to the current date.
PlainDate(int day, int month, int year)

Method Summary

Modifier and Type	Method and Description
int	compareTo(Object other) Compare this object with another.
boolean	dateIsValid() Checks if month and day are both greater than 0.
void	format(LocaleFormat locale, CharArray dest)
String	format(String format) Format the PlainDate using the LocaleFormat.format() method.
CharArray	format(String format, Locale locale, CharArray dest)
void	fromString(char[] src, int offset, int length)
void	fromString(String s)
PlainDate	getDate(PlainDate dest)
int	getInt() Convert this PlainDate into a platform independent int value.
int	hashCode() Returns a hashCode for the object.
void	makeDateInvalid() Set both the month and day to zero.
void	parse(LocaleFormat localeFormat, char[] chars, int offset, int length)
void	parse(String toParse, String format) Parse the PlainDate using the LocaleFormat.parse() method.
void	setDate(int day, int month, int year)
void	setInt(int value) Retrieve this PlainDate from a platform independent int value.
PlainDate	setToCurrent() Set the PlainDate to the current date.
String	toString() Return a String representation of this object.
CharArray	toString(CharArray dest)

Methods inherited from class eve.data.DataObject

_getFieldType, _getSetField, cache, copied, copyFrom, equals, getCopy, getDeclaredField, getDeclaredFieldValue, getMyFieldList, getNew

Methods inherited from class java.lang.Object

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

Field Detail

year

public int year

The full four-digit year, e.g. 2008

month

public int month

The month in the year value, starting from 1.

day

public int day

The day in the month value, starting from 1.

Constructor Detail

PlainDate

public PlainDate()

Constructs a PlainDate object set to the current date.

PlainDate

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

Method Detail

format

public String format(String format)

Format the PlainDate using the LocaleFormat.format() method.

Returns:

a String that is the formatted PlainDate.

parse

public void parse(String toParse,
                  String format)
           throws ParseException

Parse the PlainDate using the LocaleFormat.parse() method.

Parameters:

toParse - the String to parse.

format - the expected format.

Throws:

ParseException - if the format is wrong.

setToCurrent

public PlainDate setToCurrent()

Set the PlainDate to the current date.

Returns:

this PlainDate.

dateIsValid

public boolean dateIsValid()

Checks if month and day are both greater than 0.

Specified by:

dateIsValid in interface IDate

makeDateInvalid

public void makeDateInvalid()

Set both the month and day to zero.

Specified by:

makeDateInvalid in interface IDate

getInt

public int getInt()

Convert this PlainDate into a platform independent int value.

Specified by:

getInt in interface Intable

setInt

public void setInt(int value)

Retrieve this PlainDate from a platform independent int value.

Specified by:

setInt in interface Intable

compareTo

public int compareTo(Object other)

Description copied from interface: Comparable

Compare this object with another. It should return: less than 0 if this object is considered LESS than the "other" object; greater than 0 if this object is considered GREATER than the "other" object; 0 if this object is considered EQUAL to the "other" object. (i.e. it is an implicit subtraction).

Specified by:

compareTo in interface Comparable

Overrides:

compareTo in class DataObject

hashCode

public int hashCode()

Description copied from class: Object

Returns a hashCode for the object. The general contract of hashCode is:

An object must return the same hash code for its entire existence. If two objects are considered equal by the equals() method, they should return the same hash code. Not all Objects will do this and you should only use hashCode() from Objects which declare an overrided version of hashCode(). The only Objects which provide consistent and correct hash codes under Ewe are Object, String and Class.

Overrides:

hashCode in class Object

getDate

public PlainDate getDate(PlainDate dest)

Specified by:

getDate in interface IDate

setDate

public void setDate(int day,
                    int month,
                    int year)

Specified by:

setDate in interface IDate

toString

public String toString()

Description copied from class: Object

Return a String representation of this object.

Specified by:

toString in interface Stringable

Overrides:

toString in class Object

Returns:

a String representing this object.

fromString

public void fromString(String s)

Specified by:

fromString in interface Stringable

fromString

public void fromString(char[] src,
                       int offset,
                       int length)

Specified by:

fromString in interface Stringable

toString

public CharArray toString(CharArray dest)

Specified by:

toString in interface Stringable

format

public CharArray format(String format,
                        Locale locale,
                        CharArray dest)

format

public void format(LocaleFormat locale,
                   CharArray dest)

Specified by:

format in interface LocaleFormatted

parse

public void parse(LocaleFormat localeFormat,
                  char[] chars,
                  int offset,
                  int length)
           throws ParseException

Specified by:

parse in interface LocaleFormatted

Throws:

ParseException