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

public abstract class

BaseDateTime

extends AbstractDateTime
implements Serializable ReadableDateTime

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

Known Direct Subclasses

DateMidnight, DateTime, MutableDateTime

Class Overview

BaseDateTime is an abstract implementation of ReadableDateTime that stores data in long and Chronology fields.

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.

BaseDateTime subclasses may be mutable and not thread-safe.

Summary

Public Constructors
	BaseDateTime() Constructs an instance set to the current system millisecond time using `ISOChronology` in the default time zone.
	BaseDateTime(DateTimeZone zone) Constructs an instance set to the current system millisecond time using `ISOChronology` in the specified time zone.
	BaseDateTime(Chronology chronology) Constructs an instance set to the current system millisecond time using the specified chronology.
	BaseDateTime(long instant) Constructs an instance set to the milliseconds from 1970-01-01T00:00:00Z using `ISOChronology` in the default time zone.
	BaseDateTime(long instant, DateTimeZone zone) Constructs an instance set to the milliseconds from 1970-01-01T00:00:00Z using `ISOChronology` in the specified time zone.
	BaseDateTime(long instant, Chronology chronology) Constructs an instance set to the milliseconds from 1970-01-01T00:00:00Z using the specified chronology.
	BaseDateTime(Object instant, DateTimeZone zone) Constructs an instance from an Object that represents a datetime, forcing the time zone to that specified.
	BaseDateTime(Object instant, Chronology chronology) Constructs an instance from an Object that represents a datetime, using the specified chronology.
	BaseDateTime(int year, int monthOfYear, int dayOfMonth, int hourOfDay, int minuteOfHour, int secondOfMinute, int millisOfSecond) Constructs an instance from datetime field values using `ISOChronology` in the default time zone.
	BaseDateTime(int year, int monthOfYear, int dayOfMonth, int hourOfDay, int minuteOfHour, int secondOfMinute, int millisOfSecond, DateTimeZone zone) Constructs an instance from datetime field values using `ISOChronology` in the specified time zone.
	BaseDateTime(int year, int monthOfYear, int dayOfMonth, int hourOfDay, int minuteOfHour, int secondOfMinute, int millisOfSecond, Chronology chronology) Constructs an instance from datetime field values using the specified chronology.

Public Methods
Chronology	getChronology() Gets the chronology of the datetime.
long	getMillis() Gets the milliseconds of the datetime instant from the Java epoch of 1970-01-01T00:00:00Z.

Protected Methods
Chronology	checkChronology(Chronology chronology) Checks the specified chronology before storing it, potentially altering it.
long	checkInstant(long instant, Chronology chronology) Checks the specified instant before storing it, potentially altering it.
void	setChronology(Chronology chronology) Sets the chronology of the datetime.
void	setMillis(long instant) Sets the milliseconds of the datetime.

[Expand]

Inherited Methods

From class org.joda.time.base.AbstractDateTime

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.

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.

Public Constructors

public BaseDateTime ()

Constructs an instance set to the current system millisecond time using ISOChronology in the default time zone.

public BaseDateTime (DateTimeZone zone)

Constructs an instance set to the current system millisecond time using ISOChronology in the specified time zone.

If the specified time zone is null, the default zone is used.

Parameters

zone	the time zone, null means default zone

public BaseDateTime (Chronology chronology)

Constructs an instance set to the current system millisecond time using the specified chronology.

If the chronology is null, ISOChronology in the default time zone is used.

Parameters

chronology	the chronology, null means ISOChronology in default zone

public BaseDateTime (long instant)

Constructs an instance set to the milliseconds from 1970-01-01T00:00:00Z using ISOChronology in the default time zone.

Parameters

instant	the milliseconds from 1970-01-01T00:00:00Z

public BaseDateTime (long instant, DateTimeZone zone)

Constructs an instance set to the milliseconds from 1970-01-01T00:00:00Z using ISOChronology in the specified time zone.

If the specified time zone is null, the default zone is used.

Parameters

instant	the milliseconds from 1970-01-01T00:00:00Z
zone	the time zone, null means default zone

public BaseDateTime (long instant, Chronology chronology)

Constructs an instance set to the milliseconds from 1970-01-01T00:00:00Z using the specified chronology.

If the chronology is null, ISOChronology in the default time zone is used.

Parameters

instant	the milliseconds from 1970-01-01T00:00:00Z
chronology	the chronology, null means ISOChronology in default zone

public BaseDateTime (Object instant, DateTimeZone zone)

Constructs an instance from an Object that represents a datetime, forcing the time zone to that specified.

If the object contains no chronology, ISOChronology is used. If the specified time zone is null, the default zone is used.

The recognised object types are defined in ConverterManager and include ReadableInstant, String, Calendar and Date.

Parameters

instant	the datetime object
zone	the time zone

Throws

IllegalArgumentException	if the instant is invalid

public BaseDateTime (Object instant, Chronology chronology)

Constructs an instance from an Object that represents a datetime, using the specified chronology.

If the chronology is null, ISO in the default time zone is used.

The recognised object types are defined in ConverterManager and include ReadableInstant, String, Calendar and Date.

Parameters

instant	the datetime object
chronology	the chronology

Throws

IllegalArgumentException	if the instant is invalid

public BaseDateTime (int year, int monthOfYear, int dayOfMonth, int hourOfDay, int minuteOfHour, int secondOfMinute, int millisOfSecond)

Constructs an instance from datetime field values using ISOChronology in the default time zone.

Parameters

year	the year
monthOfYear	the month of the year
dayOfMonth	the day of the month
hourOfDay	the hour of the day
minuteOfHour	the minute of the hour
secondOfMinute	the second of the minute
millisOfSecond	the millisecond of the second

public BaseDateTime (int year, int monthOfYear, int dayOfMonth, int hourOfDay, int minuteOfHour, int secondOfMinute, int millisOfSecond, DateTimeZone zone)

Constructs an instance from datetime field values using ISOChronology in the specified time zone.

If the specified time zone is null, the default zone is used.

Parameters

year	the year
monthOfYear	the month of the year
dayOfMonth	the day of the month
hourOfDay	the hour of the day
minuteOfHour	the minute of the hour
secondOfMinute	the second of the minute
millisOfSecond	the millisecond of the second
zone	the time zone, null means default time zone

public BaseDateTime (int year, int monthOfYear, int dayOfMonth, int hourOfDay, int minuteOfHour, int secondOfMinute, int millisOfSecond, Chronology chronology)

Constructs an instance from datetime field values using the specified chronology.

If the chronology is null, ISOChronology in the default time zone is used.

Parameters

year	the year
monthOfYear	the month of the year
dayOfMonth	the day of the month
hourOfDay	the hour of the day
minuteOfHour	the minute of the hour
secondOfMinute	the second of the minute
millisOfSecond	the millisecond of the second
chronology	the chronology, null means ISOChronology in default zone

Public Methods

public Chronology getChronology ()

Gets the chronology of the datetime.

Returns

the Chronology that the datetime is using

public long getMillis ()

Gets the milliseconds of the datetime instant from the Java epoch of 1970-01-01T00:00:00Z.

Returns

the number of milliseconds since 1970-01-01T00:00:00Z

Protected Methods

protected Chronology checkChronology (Chronology chronology)

Checks the specified chronology before storing it, potentially altering it. This method must not access any instance variables.

This implementation converts nulls to ISOChronology in the default zone.

Parameters

chronology	the chronology to use, may be null

Returns

the chronology to store in this datetime, not null

protected long checkInstant (long instant, Chronology chronology)

Checks the specified instant before storing it, potentially altering it. This method must not access any instance variables.

This implementation simply returns the instant.

Parameters

instant	the milliseconds from 1970-01-01T00:00:00Z to round
chronology	the chronology to use, not null

Returns

the instant to store in this datetime

protected void setChronology (Chronology chronology)

Sets the chronology of the datetime.

All changes to the chronology field occurs via this method. Override and block this method to make a subclass immutable.

Parameters

chronology	the chronology to set

protected void setMillis (long instant)

Sets the milliseconds of the datetime.

All changes to the millisecond field occurs via this method. Override and block this method to make a subclass immutable.

Parameters

instant	the milliseconds since 1970-01-01T00:00:00Z to set the datetime to

Classes

BaseDateTime

Class Overview

Summary

Public Constructors

public BaseDateTime ()

public BaseDateTime (DateTimeZone zone)

Parameters

public BaseDateTime (Chronology chronology)

Parameters

public BaseDateTime (long instant)

Parameters

public BaseDateTime (long instant, DateTimeZone zone)

Parameters

public BaseDateTime (long instant, Chronology chronology)

Parameters

public BaseDateTime (Object instant, DateTimeZone zone)

Parameters

Throws

public BaseDateTime (Object instant, Chronology chronology)

Parameters

Throws

public BaseDateTime (int year, int monthOfYear, int dayOfMonth, int hourOfDay, int minuteOfHour, int secondOfMinute, int millisOfSecond)

Parameters

public BaseDateTime (int year, int monthOfYear, int dayOfMonth, int hourOfDay, int minuteOfHour, int secondOfMinute, int millisOfSecond, DateTimeZone zone)

Parameters

public BaseDateTime (int year, int monthOfYear, int dayOfMonth, int hourOfDay, int minuteOfHour, int secondOfMinute, int millisOfSecond, Chronology chronology)

Parameters

Public Methods

public Chronology getChronology ()

Returns

public long getMillis ()

Returns

Protected Methods

protected Chronology checkChronology (Chronology chronology)

Parameters

Returns

protected long checkInstant (long instant, Chronology chronology)

Parameters

Returns

protected void setChronology (Chronology chronology)

Parameters

protected void setMillis (long instant)

Parameters