public final class

LimitChronology

extends AssembledChronology
java.lang.Object
   ↳ org.joda.time.Chronology
     ↳ org.joda.time.chrono.BaseChronology
       ↳ org.joda.time.chrono.AssembledChronology
         ↳ org.joda.time.chrono.LimitChronology

Class Overview

Wraps another Chronology to impose limits on the range of instants that the fields within a Chronology may support. The limits are applied to both DateTimeFields and DurationFields.

Methods in DateTimeField and DurationField throw an IllegalArgumentException whenever given an input instant that is outside the limits or when an attempt is made to move an instant outside the limits.

LimitChronology is thread-safe and immutable.

Summary

Public Methods
boolean equals(Object obj)
A limit chronology is only equal to a limit chronology with the same base chronology and limits.
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.
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(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.
static LimitChronology getInstance(Chronology base, ReadableDateTime lowerLimit, ReadableDateTime upperLimit)
Wraps another chronology, with datetime limits.
DateTime getLowerLimit()
Returns the inclusive lower limit instant.
DateTime getUpperLimit()
Returns the inclusive upper limit instant.
int hashCode()
A suitable hashcode for the chronology.
String toString()
A debugging string for the chronology.
Chronology withUTC()
If this LimitChronology is already UTC, then this is returned.
Chronology withZone(DateTimeZone zone)
If this LimitChronology has the same time zone as the one given, then this is returned.
Protected Methods
void assemble(AssembledChronology.Fields fields)
Invoked by the constructor and after deserialization to allow subclasses to define all of its supported fields.
[Expand]
Inherited Methods
From class org.joda.time.chrono.AssembledChronology
From class org.joda.time.chrono.BaseChronology
From class org.joda.time.Chronology
From class java.lang.Object

Public Methods

public boolean equals (Object obj)

A limit chronology is only equal to a limit chronology with the same base chronology and limits.

Parameters
obj the object to compare to
Returns
  • true if equal

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
Throws
IllegalArgumentException

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
Throws
IllegalArgumentException

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
Throws
IllegalArgumentException

public static LimitChronology getInstance (Chronology base, ReadableDateTime lowerLimit, ReadableDateTime upperLimit)

Wraps another chronology, with datetime limits. When withUTC or withZone is called, the returned LimitChronology instance has the same limits, except they are time zone adjusted.

Parameters
base base chronology to wrap
lowerLimit inclusive lower limit, or null if none
upperLimit exclusive upper limit, or null if none
Throws
IllegalArgumentException if chronology is null or limits are invalid

public DateTime getLowerLimit ()

Returns the inclusive lower limit instant.

Returns
  • lower limit

public DateTime getUpperLimit ()

Returns the inclusive upper limit instant.

Returns
  • upper limit

public int hashCode ()

A suitable hashcode for the chronology.

Returns
  • the hashcode

public String toString ()

A debugging string for the chronology.

Returns
  • the debugging string

public Chronology withUTC ()

If this LimitChronology is already UTC, then this is returned. Otherwise, a new instance is returned, with the limits adjusted to the new time zone.

Returns
  • a version of this chronology that ignores time zones

public Chronology withZone (DateTimeZone zone)

If this LimitChronology has the same time zone as the one given, then this is returned. Otherwise, a new instance is returned, with the limits adjusted to the new time zone.

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

Protected Methods

protected void assemble (AssembledChronology.Fields fields)

Invoked by the constructor and after deserialization to allow subclasses to define all of its supported fields. All unset fields default to unsupported instances.

Parameters
fields container of fields