Summary: Protected Ctors | Methods | Inherited Methods | [Expand All]

public abstract class

AbstractDateTime

extends AbstractInstant
implements ReadableDateTime

java.lang.Object
↳	org.joda.time.base.AbstractInstant
	↳	org.joda.time.base.AbstractDateTime

Known Direct Subclasses

BaseDateTime

Known Indirect Subclasses

DateMidnight, DateTime, MutableDateTime

Class Overview

AbstractDateTime provides the common behaviour for datetime classes.

This class should generally not be used directly by API users. The ReadableDateTime interface should be used when different kinds of date/time objects are to be referenced.

Whenever you want to implement ReadableDateTime you should extend this class.

AbstractDateTime subclasses may be mutable and not thread-safe.

Summary

Protected Constructors
	AbstractDateTime() Constructor.

Public Methods
int	get(DateTimeFieldType type) Get the value of one of the fields of a datetime.
int	getCenturyOfEra() Get the year of era field value.
int	getDayOfMonth() Get the day of month field value.
int	getDayOfWeek() Get the day of week field value.
int	getDayOfYear() Get the day of year field value.
int	getEra() Get the era field value.
int	getHourOfDay() Get the hour of day field value.
int	getMillisOfDay() Get the millis of day field value.
int	getMillisOfSecond() Get the millis of second field value.
int	getMinuteOfDay() Get the minute of day field value.
int	getMinuteOfHour() Get the minute of hour field value.
int	getMonthOfYear() Get the month of year field value.
int	getSecondOfDay() Get the second of day field value.
int	getSecondOfMinute() Get the second of minute field value.
int	getWeekOfWeekyear() Get the week of weekyear field value.
int	getWeekyear() Get the weekyear field value.
int	getYear() Get the year field value.
int	getYearOfCentury() Get the year of century field value.
int	getYearOfEra() Get the year of era field value.
Calendar	toCalendar(Locale locale) Get the date time as a `java.util.Calendar`, assigning exactly the same millisecond instant.
GregorianCalendar	toGregorianCalendar() Get the date time as a `java.util.GregorianCalendar`, assigning exactly the same millisecond instant.
String	toString(String pattern, Locale locale) Output the instant using the specified format pattern.
String	toString(String pattern) Output the instant using the specified format pattern.

[Expand]

Inherited Methods

From class org.joda.time.base.AbstractInstant

int	compareTo(Object instant) Compares this object with the specified object for ascending millisecond instant order.
boolean	equals(Object readableInstant) Compares this object with the specified object for equality based on the millisecond instant, chronology and time zone.
int	get(DateTimeFieldType type) Get the value of one of the fields of a datetime using the chronology of the instant.
int	get(DateTimeField field) Get the value of one of the fields of a datetime.
DateTimeZone	getZone() Gets the time zone of the instant from the chronology.
int	hashCode() Gets a hash code for the instant as defined in `ReadableInstant`.
boolean	isAfter(long instant) Is this instant after the millisecond instant passed in comparing solely by millisecond.
boolean	isAfter(ReadableInstant instant) Is this instant after the instant passed in comparing solely by millisecond.
boolean	isAfterNow() Is this instant after the current instant comparing solely by millisecond.
boolean	isBefore(long instant) Is this instant before the millisecond instant passed in comparing solely by millisecond.
boolean	isBefore(ReadableInstant instant) Is this instant before the instant passed in comparing solely by millisecond.
boolean	isBeforeNow() Is this instant before the current instant comparing solely by millisecond.
boolean	isEqual(ReadableInstant instant) Is this instant equal to the instant passed in comparing solely by millisecond.
boolean	isEqual(long instant) Is this instant equal to the millisecond instant passed in comparing solely by millisecond.
boolean	isEqualNow() Is this instant equal to the current instant comparing solely by millisecond.
boolean	isSupported(DateTimeFieldType type) Checks if the field type specified is supported by this instant and chronology.
Date	toDate() Get the date time as a `java.util.Date`.
DateTime	toDateTime(Chronology chronology) Get this object as a DateTime using the given chronology and its zone.
DateTime	toDateTime(DateTimeZone zone) Get this object as a DateTime using the same chronology but a different zone.
DateTime	toDateTime() Get this object as a DateTime in the same zone.
DateTime	toDateTimeISO() Get this object as a DateTime using ISOChronology in the same zone.
Instant	toInstant() Get this object as an Instant.
MutableDateTime	toMutableDateTime() Get this object as a MutableDateTime in the same zone.
MutableDateTime	toMutableDateTime(Chronology chronology) Get this object as a MutableDateTime using the given chronology and its zone.
MutableDateTime	toMutableDateTime(DateTimeZone zone) Get this object as a MutableDateTime using the same chronology but a different zone.
MutableDateTime	toMutableDateTimeISO() Get this object as a MutableDateTime using ISOChronology in the same zone.
String	toString() Output the date time in ISO8601 format (yyyy-MM-ddTHH:mm:ss.SSSZZ).
String	toString(DateTimeFormatter formatter) Uses the specified formatter to convert this partial to a String.

From class java.lang.Object

From interface java.lang.Comparable

From interface org.joda.time.ReadableDateTime

abstract int	getCenturyOfEra() Get the year of era field value.
abstract int	getDayOfMonth() Get the day of month field value.
abstract int	getDayOfWeek() Get the day of week field value.
abstract int	getDayOfYear() Get the day of year field value.
abstract int	getEra() Get the era field value.
abstract int	getHourOfDay() Get the hour of day field value.
abstract int	getMillisOfDay() Get the millis of day field value.
abstract int	getMillisOfSecond() Get the millis of second field value.
abstract int	getMinuteOfDay() Get the minute of day field value.
abstract int	getMinuteOfHour() Get the minute of hour field value.
abstract int	getMonthOfYear() Get the month of year field value.
abstract int	getSecondOfDay() Get the second of day field value.
abstract int	getSecondOfMinute() Get the second of minute field value.
abstract int	getWeekOfWeekyear() Get the week of weekyear field value.
abstract int	getWeekyear() Get the weekyear field value.
abstract int	getYear() Get the year field value.
abstract int	getYearOfCentury() Get the year of century field value.
abstract int	getYearOfEra() Get the year of era field value.
abstract DateTime	toDateTime() Get this object as a DateTime.
abstract MutableDateTime	toMutableDateTime() Get this object as a MutableDateTime, always returning a new instance.
abstract String	toString(String pattern, Locale locale) Output the instant using the specified format pattern.
abstract String	toString(String pattern) Output the instant using the specified format pattern.

From interface org.joda.time.ReadableInstant

abstract int	compareTo(Object readableInstant) Compares this object with the specified object for ascending millisecond instant order.
abstract boolean	equals(Object readableInstant) Compares this object with the specified object for equality based on the millisecond instant and the Chronology.
abstract int	get(DateTimeFieldType type) Get the value of one of the fields of a datetime.
abstract Chronology	getChronology() Gets the chronology of the instant.
abstract long	getMillis() Get the value as the number of milliseconds since the epoch, 1970-01-01T00:00:00Z.
abstract DateTimeZone	getZone() Gets the time zone of the instant from the chronology.
abstract int	hashCode() Gets a hash code for the instant that is compatible with the equals method.
abstract boolean	isAfter(ReadableInstant instant) Is this instant after the instant passed in comparing solely by millisecond.
abstract boolean	isBefore(ReadableInstant instant) Is this instant before the instant passed in comparing solely by millisecond.
abstract boolean	isEqual(ReadableInstant instant) Is this instant equal to the instant passed in comparing solely by millisecond.
abstract boolean	isSupported(DateTimeFieldType field) Checks whether the field type specified is supported by this implementation.
abstract Instant	toInstant() Get the value as a simple immutable `Instant` object.
abstract String	toString() Get the value as a String in a recognisable ISO8601 format.

Protected Constructors

protected AbstractDateTime ()

Constructor.

Public Methods

public int get (DateTimeFieldType type)

Get the value of one of the fields of a datetime.

This method uses the chronology of the datetime to obtain the value. It is essentially a generic way of calling one of the get methods.

Parameters

type	a field type, usually obtained from DateTimeFieldType

Returns

the value of that field

Throws

IllegalArgumentException	if the field type is null

public int getCenturyOfEra ()

Get the year of era field value.

Returns

the year of era

public int getDayOfMonth ()

Get the day of month field value.

The values for the day of month are defined in DateTimeConstants.

Returns

the day of month

public int getDayOfWeek ()

Get the day of week field value.

The values for the day of week are defined in DateTimeConstants.

Returns

the day of week

public int getDayOfYear ()

Get the day of year field value.

Returns

the day of year

public int getEra ()

Get the era field value.

Returns

the era

public int getHourOfDay ()

Get the hour of day field value.

Returns

the hour of day

public int getMillisOfDay ()

Get the millis of day field value.

Returns

the millis of day

public int getMillisOfSecond ()

Get the millis of second field value.

Returns

the millis of second

public int getMinuteOfDay ()

Get the minute of day field value.

Returns

the minute of day

public int getMinuteOfHour ()

Get the minute of hour field value.

Returns

the minute of hour

public int getMonthOfYear ()

Get the month of year field value.

Returns

the month of year

public int getSecondOfDay ()

Get the second of day field value.

Returns

the second of day

public int getSecondOfMinute ()

Get the second of minute field value.

Returns

the second of minute

public int getWeekOfWeekyear ()

Get the week of weekyear field value.

Returns

the week of a week based year

public int getWeekyear ()

Get the weekyear field value.

Returns

the year of a week based year

public int getYear ()

Get the year field value.

Returns

the year

public int getYearOfCentury ()

Get the year of century field value.

Returns

the year of century

public int getYearOfEra ()

Get the year of era field value.

Returns

the year of era

public Calendar toCalendar (Locale locale)

Get the date time as a java.util.Calendar, assigning exactly the same millisecond instant. The locale is passed in, enabling Calendar to select the correct localized subclass.

The JDK and Joda-Time both have time zone implementations and these differ in accuracy. Joda-Time's implementation is generally more up to date and thus more accurate - for example JDK1.3 has no historical data. The effect of this is that the field values of the Calendar may differ from those of this object, even though the milliseond value is the same. Most of the time this just means that the JDK field values are wrong, as our time zone information is more up to date.

Parameters

locale	the locale to get the Calendar for, or default if null

Returns

a localized Calendar initialised with this datetime

public GregorianCalendar toGregorianCalendar ()

Get the date time as a java.util.GregorianCalendar, assigning exactly the same millisecond instant.

The JDK and Joda-Time both have time zone implementations and these differ in accuracy. Joda-Time's implementation is generally more up to date and thus more accurate - for example JDK1.3 has no historical data. The effect of this is that the field values of the Calendar may differ from those of this object, even though the milliseond value is the same. Most of the time this just means that the JDK field values are wrong, as our time zone information is more up to date.

Returns

a GregorianCalendar initialised with this datetime

public String toString (String pattern, Locale locale)

Output the instant using the specified format pattern.

Parameters

pattern	the pattern specification, null means use `toString`
locale	Locale to use, null means default

Throws

IllegalArgumentException

public String toString (String pattern)

Output the instant using the specified format pattern.

Parameters

pattern	the pattern specification, null means use `toString`

Classes

AbstractDateTime

Class Overview

Summary

Protected Constructors

protected AbstractDateTime ()

Public Methods

public int get (DateTimeFieldType type)

Parameters

Returns

Throws

public int getCenturyOfEra ()

Returns

public int getDayOfMonth ()

Returns

public int getDayOfWeek ()

Returns

public int getDayOfYear ()

Returns

public int getEra ()

Returns

public int getHourOfDay ()

Returns

public int getMillisOfDay ()

Returns

public int getMillisOfSecond ()

Returns

public int getMinuteOfDay ()

Returns

public int getMinuteOfHour ()

Returns

public int getMonthOfYear ()

Returns

public int getSecondOfDay ()

Returns

public int getSecondOfMinute ()

Returns

public int getWeekOfWeekyear ()

Returns

public int getWeekyear ()

Returns

public int getYear ()

Returns

public int getYearOfCentury ()

Returns

public int getYearOfEra ()

Returns

public Calendar toCalendar (Locale locale)

Parameters

Returns

public GregorianCalendar toGregorianCalendar ()

Returns

public String toString (String pattern, Locale locale)

Parameters

Throws

See Also

public String toString (String pattern)

Parameters

See Also