Java Doc for LocalTime.java in  » Development » Joda-Time » org » joda » time » Java Source Code / Java DocumentationJava Source Code and Java Documentation

LocalTime implements the ReadablePartial interface. To do this, the interface methods focus on the key fields - HourOfDay, MinuteOfHour, SecondOfMinute and MillisOfSecond. However, all time fields may in fact be queried.

Calculations on LocalTime are performed using a Chronology . This chronology will be set internally to be in the UTC time zone for all calculations.

Each individual field can be queried in two ways:

• getHourOfDay()
• hourOfDay().get()

• numeric value
• text value
• short text value
• maximum/minimum values
• add/subtract
• set
• rounding

LocalTime is thread-safe and immutable, provided that the Chronology is as well. All standard Chronology classes supplied are thread-safe and immutable.
author:
   Stephen Colebourne
since:
   1.3

Each field is queried from the Calendar and assigned to the LocalTime. This is useful if you have been using the Calendar as a local time, ignoing the zone.

This factory method ignores the type of the calendar and always creates a LocalTime with ISO chronology.

This method is required to support the ReadablePartial interface.

If the addition is zero or the field is null, then this is returned.

If the addition causes the maximum value of the field to be exceeded, then the value will wrap.

If the addition is zero, then this is returned.

This method is typically used to add multiple copies of complex period instances.

Once the constructor is completed, the zone is no longer used.

If the specified time zone is null, the default zone is used. Once the constructor is completed, the zone is no longer used.
Parameters:
  zone - the time zone, null means default zone

If the chronology is null, ISO chronology in the default time zone is used. Once the constructor is completed, the zone is no longer used.
Parameters:
  chronology - the chronology, null means ISOChronology in default zone

Once the constructor is completed, the zone is no longer used.
Parameters:
  instant - the milliseconds from 1970-01-01T00:00:00Z

If the specified time zone is null, the default zone is used. Once the constructor is completed, the zone is no longer used.
Parameters:
  instant - the milliseconds from 1970-01-01T00:00:00Z
Parameters:
  zone - the time zone, null means default zone

If the chronology is null, ISO chronology in the default zone is used. Once the constructor is completed, the zone is no longer used.
Parameters:
  instant - the milliseconds from 1970-01-01T00:00:00Z
Parameters:
  chronology - the chronology, null means ISOChronology in default zone

If the object contains no chronology, ISOChronology is used. If the object contains no time zone, the default zone is used. Once the constructor is completed, the zone is no longer used.

The recognised object types are defined in org.joda.time.convert.ConverterManager ConverterManager and include ReadablePartial, ReadableInstant, String, Calendar and Date. The String formats are described by ISODateTimeFormat.localTimeParser . The default String converter ignores the zone and only parses the field values.
Parameters:
  instant - the datetime object
throws:
  IllegalArgumentException - if the instant is invalid

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

The recognised object types are defined in org.joda.time.convert.ConverterManager ConverterManager and include ReadablePartial, ReadableInstant, String, Calendar and Date. The String formats are described by ISODateTimeFormat.localTimeParser . The default String converter ignores the zone and only parses the field values.
Parameters:
  instant - the datetime object
Parameters:
  zone - the time zone
throws:
  IllegalArgumentException - if the instant is invalid

If the chronology is null, ISO in the default time zone is used. Once the constructor is completed, the zone is no longer used.

The recognised object types are defined in org.joda.time.convert.ConverterManager ConverterManager and include ReadablePartial, ReadableInstant, String, Calendar and Date. The String formats are described by ISODateTimeFormat.localTimeParser . The default String converter ignores the zone and only parses the field values.
Parameters:
  instant - the datetime object
Parameters:
  chronology - the chronology
throws:
  IllegalArgumentException - if the instant is invalid

If the chronology is null, ISOChronology is used.
Parameters:
  hourOfDay - the hour of the day
Parameters:
  minuteOfHour - the minute of the hour
Parameters:
  secondOfMinute - the second of the minute
Parameters:
  millisOfSecond - the millisecond of the second
Parameters:
  chronology - the chronology, null means ISOChronology in default zone

The fields are compared in order, from largest to smallest. The first field that is non-equal is used to determine the result.

The specified object must be a partial instance whose field types match those of this partial.

NOTE: This implementation violates the Comparable contract. This method will accept any instance of ReadablePartial as input. However, it is possible that some implementations of ReadablePartial exist that do not extend AbstractPartial, and thus will throw a ClassCastException if compared in the opposite direction. The cause of this problem is that ReadablePartial doesn't define the compareTo() method, however we can't change that until v2.0.
Parameters:
  partial - an object to check against negative if this is less, zero if equal, positive if greater
throws:
  ClassCastException - if the partial is the wrong classor if it has field types that don't match
throws:
  NullPointerException - if the partial is null

Each field is queried from the Calendar and assigned to the LocalTime. This is useful if you have been using the Calendar as a local time, ignoing the zone.

This factory method ignores the type of the calendar and always creates a LocalTime with ISO chronology. It is expected that you will only pass in instances of GregorianCalendar however this is not validated.
Parameters:
  calendar - the Calendar to extract fields from the created LocalTime
throws:
  IllegalArgumentException - if the calendar is null
throws:
  IllegalArgumentException - if the date is invalid for the ISO chronology

Each field is queried from the Date and assigned to the LocalTime. This is useful if you have been using the Date as a local time, ignoing the zone.

This factory method always creates a LocalTime with ISO chronology.
Parameters:
  date - the Date to extract fields from the created LocalTime
throws:
  IllegalArgumentException - if the calendar is null
throws:
  IllegalArgumentException - if the date is invalid for the ISO chronology

The millisOfDay value may exceed the number of millis in one day, but additional days will be ignored. This method uses the UTC time zone internally.
Parameters:
  millisOfDay - the number of milliseconds into a day to convert

The millisOfDay value may exceed the number of millis in one day, but additional days will be ignored. This method uses the UTC time zone internally.
Parameters:
  millisOfDay - the number of milliseconds into a day to convert
Parameters:
  chrono - the chronology, null means ISO chronology

This method gets the value of the specified field. For example:

 DateTime dt = new DateTime();
 int hourOfDay = dt.get(DateTimeFieldType.hourOfDay());
 

This method must not use any instance variables.
Parameters:
  index - the index to retrieve
Parameters:
  chrono - the chronology to use the field

This method is required to support the ReadablePartial interface. The supported fields are HourOfDay, MinuteOfHour, SecondOfMinute and MillisOfSecond.
Parameters:
  index - the index, zero to three the value
throws:
  IndexOutOfBoundsException - if the index is invalid

If the amount is zero or null, then this is returned.

This method is typically used to subtract complex period instances. Subtracting one field is best achieved using methods like LocalTime.minusHours(int) .
Parameters:
  period - the period to reduce this instant by a copy of this time with the period taken away
throws:
  ArithmeticException - if the result exceeds the internal capacity

This LocalTime instance is immutable and unaffected by this method call.

The following three lines are identical in effect:

 LocalTime subtracted = dt.minusHours(6);
 LocalTime subtracted = dt.minus(Period.hours(6));
 LocalTime subtracted = dt.withFieldAdded(DurationFieldType.hours(), -6);
 

This LocalTime instance is immutable and unaffected by this method call.

The following three lines are identical in effect:

 LocalTime subtracted = dt.minusMillis(6);
 LocalTime subtracted = dt.minus(Period.millis(6));
 LocalTime subtracted = dt.withFieldAdded(DurationFieldType.millis(), -6);
 

This LocalTime instance is immutable and unaffected by this method call.

The following three lines are identical in effect:

 LocalTime subtracted = dt.minusMinutes(6);
 LocalTime subtracted = dt.minus(Period.minutes(6));
 LocalTime subtracted = dt.withFieldAdded(DurationFieldType.minutes(), -6);
 

This LocalTime instance is immutable and unaffected by this method call.

The following three lines are identical in effect:

 LocalTime subtracted = dt.minusSeconds(6);
 LocalTime subtracted = dt.minus(Period.seconds(6));
 LocalTime subtracted = dt.withFieldAdded(DurationFieldType.seconds(), -6);
 

If the amount is zero or null, then this is returned.

This method is typically used to add complex period instances. Adding one field is best achieved using methods like LocalTime.plusHours(int) .
Parameters:
  period - the period to add to this one, null means zero a copy of this time with the period added
throws:
  ArithmeticException - if the result exceeds the internal capacity

This LocalTime instance is immutable and unaffected by this method call.

The following three lines are identical in effect:

 LocalTime added = dt.plusHours(6);
 LocalTime added = dt.plus(Period.hours(6));
 LocalTime added = dt.withFieldAdded(DurationFieldType.hours(), 6);
 

This LocalTime instance is immutable and unaffected by this method call.

The following three lines are identical in effect:

 LocalTime added = dt.plusMillis(6);
 LocalTime added = dt.plus(Period.millis(6));
 LocalTime added = dt.withFieldAdded(DurationFieldType.millis(), 6);
 

This LocalTime instance is immutable and unaffected by this method call.

The following three lines are identical in effect:

 LocalTime added = dt.plusMinutes(6);
 LocalTime added = dt.plus(Period.minutes(6));
 LocalTime added = dt.withFieldAdded(DurationFieldType.minutes(), 6);
 

This LocalTime instance is immutable and unaffected by this method call.

The following three lines are identical in effect:

 LocalTime added = dt.plusSeconds(6);
 LocalTime added = dt.plus(Period.seconds(6));
 LocalTime added = dt.withFieldAdded(DurationFieldType.seconds(), 6);
 

This method uses the chronology from this instance plus the time zone specified.
Parameters:
  zone - the zone to use, null means default this time as a datetime using todays date

For example, if the field type is hourOfDay then the hour of day field would be changed in the returned instance. If the field type is null, then this is returned.

These lines are equivalent:

 LocalTime updated = dt.withHourOfDay(6);
 LocalTime updated = dt.withField(DateTimeFieldType.hourOfDay(), 6);
 

If the addition is zero or the field is null, then this is returned.

If the addition causes the maximum value of the field to be exceeded, then the value will wrap. Thus 23:59 plus two minutes yields 00:01.

These lines are equivalent:

 LocalTime added = dt.plusHours(6);
 LocalTime added = dt.withFieldAdded(DurationFieldType.hours(), 6);
 

For example, if the partial contains an hour and minute then those two fields will be changed in the returned instance. Unsupported fields are ignored. If the partial is null, then this is returned.
Parameters:
  partial - the partial set of fields to apply to this time, null ignored a copy of this time with a different set of fields
throws:
  IllegalArgumentException - if any value is invalid

LocalTime is immutable, so there are no set methods. Instead, this method returns a new instance with the value of hour of day changed.
Parameters:
  hour - the hour of day to set a copy of this object with the field set
throws:
  IllegalArgumentException - if the value is invalid

The returned object will be a new instance of the same type. Only the millis will change, the chronology is kept. The returned object will be either be a new instance or this.
Parameters:
  newMillis - the new millis, from 1970-01-01T00:00:00 a copy of this time with different millis

LocalTime is immutable, so there are no set methods. Instead, this method returns a new instance with the value of millis of day changed.
Parameters:
  millis - the millis of day to set a copy of this object with the field set
throws:
  IllegalArgumentException - if the value is invalid

LocalTime is immutable, so there are no set methods. Instead, this method returns a new instance with the value of millis of second changed.
Parameters:
  millis - the millis of second to set a copy of this object with the field set
throws:
  IllegalArgumentException - if the value is invalid

LocalTime is immutable, so there are no set methods. Instead, this method returns a new instance with the value of minute of hour changed.
Parameters:
  minute - the minute of hour to set a copy of this object with the field set
throws:
  IllegalArgumentException - if the value is invalid

If the addition is zero, then this is returned.

This method is typically used to add multiple copies of complex period instances. Adding one field is best achieved using methods like LocalTime.withFieldAdded(DurationFieldType,int) or LocalTime.plusHours(int) .
Parameters:
  period - the period to add to this one, null means zero
Parameters:
  scalar - the amount of times to add, such as -1 to subtract once a copy of this time with the period added
throws:
  ArithmeticException - if the result exceeds the internal capacity

LocalTime is immutable, so there are no set methods. Instead, this method returns a new instance with the value of second of minute changed.
Parameters:
  second - the second of minute to set a copy of this object with the field set
throws:
  IllegalArgumentException - if the value is invalid