public abstract class

BaseChronology

extends Chronology
implements Serializable
java.lang.Object
   ↳ org.joda.time.Chronology
     ↳ org.joda.time.chrono.BaseChronology
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

BaseChronology provides a skeleton implementation for chronology classes. Many utility methods are defined, but all fields are unsupported.

BaseChronology is thread-safe and immutable, and all subclasses must be as well.

Summary

Protected Constructors
BaseChronology()
Restricted constructor.
Public Methods
long add(ReadablePeriod period, long instant, int scalar)
Adds the period to the instant, specifying the number of times to add.
long add(long instant, long duration, int scalar)
Adds the duration to the instant, specifying the number of times to add.
DurationField centuries()
Get the centuries duration field for this chronology.
DateTimeField centuryOfEra()
Get the century of era field for this chronology.
DateTimeField clockhourOfDay()
Get the hour of day (offset to 1-24) field for this chronology.
DateTimeField clockhourOfHalfday()
Get the hour of am/pm (offset to 1-12) field for this chronology.
DateTimeField dayOfMonth()
Get the day of month field for this chronology.
DateTimeField dayOfWeek()
Get the day of week field for this chronology.
DateTimeField dayOfYear()
Get the day of year field for this chronology.
DurationField days()
Get the days duration field for this chronology.
DateTimeField era()
Get the era field for this chronology.
DurationField eras()
Get the eras duration field for this chronology.
int[] get(ReadablePeriod period, long startInstant, long endInstant)
Gets the values of a period from an interval.
int[] get(ReadablePartial partial, long instant)
Gets the values of a partial from an instant.
int[] get(ReadablePeriod period, long duration)
Gets the values of a period from an interval.
long getDateTimeMillis(long instant, int hourOfDay, int minuteOfHour, int secondOfMinute, int millisOfSecond)
Returns a datetime millisecond instant, from from the given instant, hour, minute, second, and millisecond values.
long getDateTimeMillis(int year, int monthOfYear, int dayOfMonth, int millisOfDay)
Returns a datetime millisecond instant, formed from the given year, month, day, and millisecond values.
long getDateTimeMillis(int year, int monthOfYear, int dayOfMonth, int hourOfDay, int minuteOfHour, int secondOfMinute, int millisOfSecond)
Returns a datetime millisecond instant, formed from the given year, month, day, hour, minute, second, and millisecond values.
abstract DateTimeZone getZone()
Returns the DateTimeZone that this Chronology operates in, or null if unspecified.
DateTimeField halfdayOfDay()
Get the AM(0) PM(1) field for this chronology.
DurationField halfdays()
Get the halfdays duration field for this chronology.
DateTimeField hourOfDay()
Get the hour of day (0-23) field for this chronology.
DateTimeField hourOfHalfday()
Get the hour of am/pm (0-11) field for this chronology.
DurationField hours()
Get the hours duration field for this chronology.
DurationField millis()
Get the millis duration field for this chronology.
DateTimeField millisOfDay()
Get the millis of day field for this chronology.
DateTimeField millisOfSecond()
Get the millis of second field for this chronology.
DateTimeField minuteOfDay()
Get the minute of day field for this chronology.
DateTimeField minuteOfHour()
Get the minute of hour field for this chronology.
DurationField minutes()
Get the minutes duration field for this chronology.
DateTimeField monthOfYear()
Get the month of year field for this chronology.
DurationField months()
Get the months duration field for this chronology.
DateTimeField secondOfDay()
Get the second of day field for this chronology.
DateTimeField secondOfMinute()
Get the second of minute field for this chronology.
DurationField seconds()
Get the seconds duration field for this chronology.
long set(ReadablePartial partial, long instant)
Sets the partial into the instant.
abstract String toString()
Gets a debugging toString.
void validate(ReadablePartial partial, int[] values)
Validates whether the fields stored in a partial instant are valid.
DateTimeField weekOfWeekyear()
Get the week of a week based year field for this chronology.
DurationField weeks()
Get the weeks duration field for this chronology.
DateTimeField weekyear()
Get the year of a week based year field for this chronology.
DateTimeField weekyearOfCentury()
Get the year of a week based year in a century field for this chronology.
DurationField weekyears()
Get the weekyears duration field for this chronology.
abstract Chronology withUTC()
Returns an instance of this Chronology that operates in the UTC time zone.
abstract Chronology withZone(DateTimeZone zone)
Returns an instance of this Chronology that operates in any time zone.
DateTimeField year()
Get the year field for this chronology.
DateTimeField yearOfCentury()
Get the year of century field for this chronology.
DateTimeField yearOfEra()
Get the year of era field for this chronology.
DurationField years()
Get the years duration field for this chronology.
[Expand]
Inherited Methods
From class org.joda.time.Chronology
From class java.lang.Object

Protected Constructors

protected BaseChronology ()

Restricted constructor.

Public Methods

public long add (ReadablePeriod period, long instant, int scalar)

Adds the period to the instant, specifying the number of times to add.

Parameters
period the period to add, null means add nothing
instant the instant to add to
scalar the number of times to add
Returns
  • the updated instant

public long add (long instant, long duration, int scalar)

Adds the duration to the instant, specifying the number of times to add.

Parameters
instant the instant to add to
duration the duration to add
scalar the number of times to add
Returns
  • the updated instant

public DurationField centuries ()

Get the centuries duration field for this chronology.

Returns
  • DurationField or UnsupportedDurationField if unsupported

public DateTimeField centuryOfEra ()

Get the century of era field for this chronology.

Returns
  • DateTimeField or UnsupportedDateTimeField if unsupported

public DateTimeField clockhourOfDay ()

Get the hour of day (offset to 1-24) field for this chronology.

Returns
  • DateTimeField or UnsupportedDateTimeField if unsupported

public DateTimeField clockhourOfHalfday ()

Get the hour of am/pm (offset to 1-12) field for this chronology.

Returns
  • DateTimeField or UnsupportedDateTimeField if unsupported

public DateTimeField dayOfMonth ()

Get the day of month field for this chronology.

Returns
  • DateTimeField or UnsupportedDateTimeField if unsupported

public DateTimeField dayOfWeek ()

Get the day of week field for this chronology.

DayOfWeek values are defined in DateTimeConstants. They use the ISO definitions, where 1 is Monday and 7 is Sunday.

Returns
  • DateTimeField or UnsupportedDateTimeField if unsupported

public DateTimeField dayOfYear ()

Get the day of year field for this chronology.

Returns
  • DateTimeField or UnsupportedDateTimeField if unsupported

public DurationField days ()

Get the days duration field for this chronology.

Returns
  • DurationField or UnsupportedDurationField if unsupported

public DateTimeField era ()

Get the era field for this chronology.

Returns
  • DateTimeField or UnsupportedDateTimeField if unsupported

public DurationField eras ()

Get the eras duration field for this chronology.

Returns
  • DurationField or UnsupportedDurationField if unsupported

public int[] get (ReadablePeriod period, long startInstant, long endInstant)

Gets the values of a period from an interval.

Parameters
period the period instant to use
startInstant the start instant of an interval to query
endInstant the start instant of an interval to query
Returns
  • the values of the period extracted from the interval

public int[] get (ReadablePartial partial, long instant)

Gets the values of a partial from an instant.

Parameters
partial the partial instant to use
instant the instant to query
Returns
  • the values of the partial extracted from the instant

public int[] get (ReadablePeriod period, long duration)

Gets the values of a period from an interval.

Parameters
period the period instant to use
duration the duration to query
Returns
  • the values of the period extracted from the duration

public long getDateTimeMillis (long instant, int hourOfDay, int minuteOfHour, int secondOfMinute, int millisOfSecond)

Returns a datetime millisecond instant, from from the given instant, hour, minute, second, and millisecond values. The set of given values must refer to a valid datetime, or else an IllegalArgumentException is thrown.

The default implementation calls upon separate DateTimeFields to determine the result. Subclasses are encouraged to provide a more efficient implementation.

Parameters
instant instant to start from
hourOfDay hour to use
minuteOfHour minute to use
secondOfMinute second to use
millisOfSecond millisecond to use
Returns
  • millisecond instant from 1970-01-01T00:00:00Z

public long getDateTimeMillis (int year, int monthOfYear, int dayOfMonth, int millisOfDay)

Returns a datetime millisecond instant, formed from the given year, month, day, and millisecond values. The set of given values must refer to a valid datetime, or else an IllegalArgumentException is thrown.

The default implementation calls upon separate DateTimeFields to determine the result. Subclasses are encouraged to provide a more efficient implementation.

Parameters
year year to use
monthOfYear month to use
dayOfMonth day of month to use
millisOfDay millisecond to use
Returns
  • millisecond instant from 1970-01-01T00:00:00Z

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

Returns a datetime millisecond instant, formed from the given year, month, day, hour, minute, second, and millisecond values. The set of given values must refer to a valid datetime, or else an IllegalArgumentException is thrown.

The default implementation calls upon separate DateTimeFields to determine the result. Subclasses are encouraged to provide a more efficient implementation.

Parameters
year year to use
monthOfYear month to use
dayOfMonth day of month to use
hourOfDay hour to use
minuteOfHour minute to use
secondOfMinute second to use
millisOfSecond millisecond to use
Returns
  • millisecond instant from 1970-01-01T00:00:00Z

public abstract DateTimeZone getZone ()

Returns the DateTimeZone that this Chronology operates in, or null if unspecified.

Returns
  • DateTimeZone null if unspecified

public DateTimeField halfdayOfDay ()

Get the AM(0) PM(1) field for this chronology.

Returns
  • DateTimeField or UnsupportedDateTimeField if unsupported

public DurationField halfdays ()

Get the halfdays duration field for this chronology.

Returns
  • DurationField or UnsupportedDurationField if unsupported

public DateTimeField hourOfDay ()

Get the hour of day (0-23) field for this chronology.

Returns
  • DateTimeField or UnsupportedDateTimeField if unsupported

public DateTimeField hourOfHalfday ()

Get the hour of am/pm (0-11) field for this chronology.

Returns
  • DateTimeField or UnsupportedDateTimeField if unsupported

public DurationField hours ()

Get the hours duration field for this chronology.

Returns
  • DurationField or UnsupportedDurationField if unsupported

public DurationField millis ()

Get the millis duration field for this chronology.

Returns
  • DurationField or UnsupportedDurationField if unsupported

public DateTimeField millisOfDay ()

Get the millis of day field for this chronology.

Returns
  • DateTimeField or UnsupportedDateTimeField if unsupported

public DateTimeField millisOfSecond ()

Get the millis of second field for this chronology.

Returns
  • DateTimeField or UnsupportedDateTimeField if unsupported

public DateTimeField minuteOfDay ()

Get the minute of day field for this chronology.

Returns
  • DateTimeField or UnsupportedDateTimeField if unsupported

public DateTimeField minuteOfHour ()

Get the minute of hour field for this chronology.

Returns
  • DateTimeField or UnsupportedDateTimeField if unsupported

public DurationField minutes ()

Get the minutes duration field for this chronology.

Returns
  • DurationField or UnsupportedDurationField if unsupported

public DateTimeField monthOfYear ()

Get the month of year field for this chronology.

Returns
  • DateTimeField or UnsupportedDateTimeField if unsupported

public DurationField months ()

Get the months duration field for this chronology.

Returns
  • DurationField or UnsupportedDurationField if unsupported

public DateTimeField secondOfDay ()

Get the second of day field for this chronology.

Returns
  • DateTimeField or UnsupportedDateTimeField if unsupported

public DateTimeField secondOfMinute ()

Get the second of minute field for this chronology.

Returns
  • DateTimeField or UnsupportedDateTimeField if unsupported

public DurationField seconds ()

Get the seconds duration field for this chronology.

Returns
  • DurationField or UnsupportedDurationField if unsupported

public long set (ReadablePartial partial, long instant)

Sets the partial into the instant.

Parameters
partial the partial instant to use
instant the instant to update
Returns
  • the updated instant

public abstract String toString ()

Gets a debugging toString.

Returns
  • a debugging string

public void validate (ReadablePartial partial, int[] values)

Validates whether the fields stored in a partial instant are valid.

This implementation uses getMinimumValue(ReadablePartial, int[]) and getMaximumValue(ReadablePartial, int[]).

Parameters
partial the partial instant to validate
values the values to validate, not null
Throws
IllegalArgumentException if the instant is invalid

public DateTimeField weekOfWeekyear ()

Get the week of a week based year field for this chronology.

Returns
  • DateTimeField or UnsupportedDateTimeField if unsupported

public DurationField weeks ()

Get the weeks duration field for this chronology.

Returns
  • DurationField or UnsupportedDurationField if unsupported

public DateTimeField weekyear ()

Get the year of a week based year field for this chronology.

Returns
  • DateTimeField or UnsupportedDateTimeField if unsupported

public DateTimeField weekyearOfCentury ()

Get the year of a week based year in a century field for this chronology.

Returns
  • DateTimeField or UnsupportedDateTimeField if unsupported

public DurationField weekyears ()

Get the weekyears duration field for this chronology.

Returns
  • DurationField or UnsupportedDurationField if unsupported

public abstract Chronology withUTC ()

Returns an instance of this Chronology that operates in the UTC time zone. Chronologies that do not operate in a time zone or are already UTC must return themself.

Returns
  • a version of this chronology that ignores time zones

public abstract Chronology withZone (DateTimeZone zone)

Returns an instance of this Chronology that operates in any time zone.

Parameters
zone to use, or default if null
Returns
  • a version of this chronology with a specific time zone
See Also

public DateTimeField year ()

Get the year field for this chronology.

Returns
  • DateTimeField or UnsupportedDateTimeField if unsupported

public DateTimeField yearOfCentury ()

Get the year of century field for this chronology.

Returns
  • DateTimeField or UnsupportedDateTimeField if unsupported

public DateTimeField yearOfEra ()

Get the year of era field for this chronology.

Returns
  • DateTimeField or UnsupportedDateTimeField if unsupported

public DurationField years ()

Get the years duration field for this chronology.

Returns
  • DurationField or UnsupportedDurationField if unsupported