org.ojai.types

Class ODate

java.lang.Object

org.ojai.types.ODate

All Implemented Interfaces:

Serializable, Comparable<ODate>

@API.Public
public final class ODate
extends Object
implements Comparable<ODate>, Serializable

An immutable class which encapsulates an OJAI DATE type.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ODate(Date date) Constructs an ODate instance from a java.util.Date using exactly the same field values.
ODate(int year, int month, int dayOfMonth) Constructs an ODate instance set to the specified year, month and day of the month.
ODate(long epoh) Constructs an ODate instance from the milliseconds value since the Unix epoch.

Method Summary

Modifier and Type	Method and Description
int	compareTo(ODate o)
boolean	equals(Object obj)
static ODate	fromDaysSinceEpoch(int daysSinceEpoch) Return an ODate instance from the specified number of days since epoch.
int	getDayOfMonth()
int	getMonth()
int	getYear()
int	hashCode()
static ODate	parse(String dateStr) Parses and return an instance of ODate from the specified string.
Date	toDate() Get this DATE as a Date in the default timezone.
String	toDateStr() Returns a string representation of this date in ISO8601 format (yyyy-MM-dd).
int	toDaysSinceEpoch()
String	toString()
String	toString(String pattern) Returns a string representation of this date using the specified format pattern.

Methods inherited from class java.lang.Object

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

Constructor Detail

ODate

public ODate(int year,
             int month,
             int dayOfMonth)

Constructs an ODate instance set to the specified year, month and day of the month.

Parameters:

year - the year

month - the month of the year, from 1 to 12

dayOfMonth - the day of the month, from 1 to 31

ODate

public ODate(long epoh)

Constructs an ODate instance from the milliseconds value since the Unix epoch. The DATE value is set to the calendar date in the default time zone.

Parameters:

epoh - the milliseconds from 1970-01-01T00:00:00.000 UTC

ODate

public ODate(Date date)

Constructs an ODate instance from a java.util.Date using exactly the same field values. The DATE value is set to the calendar date in the default time zone.

Parameters:

date - the Date to extract fields from

Method Detail

parse

public static ODate parse(String dateStr)

Parses and return an instance of ODate from the specified string.

Parameters:

dateStr - the string to parse

Throws:

ParseException - if the beginning of the specified string cannot be parsed.

fromDaysSinceEpoch

public static ODate fromDaysSinceEpoch(int daysSinceEpoch)

Return an ODate instance from the specified number of days since epoch.

Parameters:

daysSinceEpoch - the number of days since epoch

getYear

public int getYear()

Returns:

The years value of this Date as an int.

getMonth

public int getMonth()

Returns:

The months value of this Date as an int.

getDayOfMonth

public int getDayOfMonth()

Returns:

The date of month value of this Date as an int.

toDaysSinceEpoch

public int toDaysSinceEpoch()

Returns:

The total number of days since the Unix epoch.

toDate

public Date toDate()

Get this DATE as a Date in the default timezone. The time fields of the Date object is set to Unix 0.

Returns:

a Date initialized with this DATE

toDateStr

public String toDateStr()

Returns a string representation of this date in ISO8601 format (yyyy-MM-dd).

toString

public String toString(String pattern)

Returns a string representation of this date using the specified format pattern.

Parameters:

pattern - the pattern specification

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

compareTo

public int compareTo(ODate o)

Specified by:

compareTo in interface Comparable<ODate>