public final class

LocalTime

extends BaseLocal
implements Serializable ReadablePartial

java.lang.Object
↳	org.joda.time.base.AbstractPartial
	↳	org.joda.time.base.BaseLocal
		↳	org.joda.time.LocalTime

Class Overview

LocalTime is an immutable time class representing a time without a time zone.

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()

The second technique also provides access to other useful methods on the field:

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.

Summary

Nested Classes
class	LocalTime.Property	LocalTime.Property binds a LocalTime to a DateTimeField allowing powerful datetime functionality to be easily accessed.

Fields
public static final LocalTime	MIDNIGHT	Constant for midnight.

Public Constructors
	LocalTime() Constructs an instance set to the current local time evaluated using ISO chronology in the default zone.
	LocalTime(DateTimeZone zone) Constructs an instance set to the current local time evaluated using ISO chronology in the specified zone.
	LocalTime(Chronology chronology) Constructs an instance set to the current local time evaluated using specified chronology and zone.
	LocalTime(long instant) Constructs an instance set to the local time defined by the specified instant evaluated using ISO chronology in the default zone.
	LocalTime(long instant, DateTimeZone zone) Constructs an instance set to the local time defined by the specified instant evaluated using ISO chronology in the specified zone.
	LocalTime(long instant, Chronology chronology) Constructs an instance set to the local time defined by the specified instant evaluated using the specified chronology.
	LocalTime(Object instant) Constructs an instance from an Object that represents a datetime.
	LocalTime(Object instant, DateTimeZone zone) Constructs an instance from an Object that represents a datetime, forcing the time zone to that specified.
	LocalTime(Object instant, Chronology chronology) Constructs an instance from an Object that represents a datetime, using the specified chronology.
	LocalTime(int hourOfDay, int minuteOfHour) Constructs an instance set to the specified time using `ISOChronology`.
	LocalTime(int hourOfDay, int minuteOfHour, int secondOfMinute) Constructs an instance set to the specified time using `ISOChronology`.
	LocalTime(int hourOfDay, int minuteOfHour, int secondOfMinute, int millisOfSecond) Constructs an instance set to the specified time using `ISOChronology`.
	LocalTime(int hourOfDay, int minuteOfHour, int secondOfMinute, int millisOfSecond, Chronology chronology) Constructs an instance set to the specified time using the specified chronology, whose zone is ignored.

Public Methods
int	compareTo(Object partial) Compares this partial with another returning an integer indicating the order.
boolean	equals(Object partial) Compares this ReadablePartial with another returning true if the chronology, field types and values are equal.
static LocalTime	fromCalendarFields(Calendar calendar) Constructs a LocalTime from a `java.util.Calendar` using exactly the same field values.
static LocalTime	fromDateFields(Date date) Constructs a LocalTime from a `java.util.Date` using exactly the same field values.
static LocalTime	fromMillisOfDay(long millisOfDay) Constructs a LocalTime from the specified millis of day using the ISO chronology.
static LocalTime	fromMillisOfDay(long millisOfDay, Chronology chrono) Constructs a LocalTime from the specified millis of day using the specified chronology.
int	get(DateTimeFieldType fieldType) Get the value of one of the fields of time.
Chronology	getChronology() Gets the chronology of the time.
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	getMinuteOfHour() Get the minute of hour field value.
int	getSecondOfMinute() Get the second of minute field value.
int	getValue(int index) Gets the value of the field at the specifed index.
LocalTime.Property	hourOfDay() Get the hour of day field property which provides access to advanced functionality.
boolean	isSupported(DurationFieldType type) Checks if the duration type specified is supported by this local time and chronology.
boolean	isSupported(DateTimeFieldType type) Checks if the field type specified is supported by this local time and chronology.
LocalTime.Property	millisOfDay() Get the millis of day property which provides access to advanced functionality.
LocalTime.Property	millisOfSecond() Get the millis of second property which provides access to advanced functionality.
LocalTime	minus(ReadablePeriod period) Returns a copy of this time with the specified period taken away.
LocalTime	minusHours(int hours) Returns a copy of this time minus the specified number of hours.
LocalTime	minusMillis(int millis) Returns a copy of this time minus the specified number of millis.
LocalTime	minusMinutes(int minutes) Returns a copy of this time minus the specified number of minutes.
LocalTime	minusSeconds(int seconds) Returns a copy of this time minus the specified number of seconds.
LocalTime.Property	minuteOfHour() Get the minute of hour field property which provides access to advanced functionality.
LocalTime	plus(ReadablePeriod period) Returns a copy of this time with the specified period added.
LocalTime	plusHours(int hours) Returns a copy of this time plus the specified number of hours.
LocalTime	plusMillis(int millis) Returns a copy of this time plus the specified number of millis.
LocalTime	plusMinutes(int minutes) Returns a copy of this time plus the specified number of minutes.
LocalTime	plusSeconds(int seconds) Returns a copy of this time plus the specified number of seconds.
LocalTime.Property	property(DateTimeFieldType fieldType) Gets the property object for the specified type, which contains many useful methods.
LocalTime.Property	secondOfMinute() Get the second of minute field property which provides access to advanced functionality.
int	size() Gets the number of fields in this partial, which is four.
DateTime	toDateTimeToday(DateTimeZone zone) Converts this LocalTime to a full datetime using the specified time zone setting the time fields from this instance and the date fields from the current time.
DateTime	toDateTimeToday() Converts this LocalTime to a full datetime using the default time zone setting the time fields from this instance and the date fields from the current date.
String	toString(String pattern, Locale locale) Output the time using the specified format pattern.
String	toString(String pattern) Output the time using the specified format pattern.
String	toString() Output the time in ISO8601 format (HH:mm:ss.SSSZZ).
LocalTime	withField(DateTimeFieldType fieldType, int value) Returns a copy of this time with the specified field set to a new value.
LocalTime	withFieldAdded(DurationFieldType fieldType, int amount) Returns a copy of this time with the value of the specified field increased.
LocalTime	withFields(ReadablePartial partial) Returns a copy of this time with the partial set of fields replacing those from this instance.
LocalTime	withHourOfDay(int hour) Returns a copy of this time with the hour of day field updated.
LocalTime	withMillisOfDay(int millis) Returns a copy of this time with the millis of day field updated.
LocalTime	withMillisOfSecond(int millis) Returns a copy of this time with the millis of second field updated.
LocalTime	withMinuteOfHour(int minute) Returns a copy of this time with the minute of hour field updated.
LocalTime	withPeriodAdded(ReadablePeriod period, int scalar) Returns a copy of this time with the specified period added.
LocalTime	withSecondOfMinute(int second) Returns a copy of this time with the second of minute field updated.

Protected Methods
DateTimeField	getField(int index, Chronology chrono) Gets the field for a specific index in the chronology specified.
long	getLocalMillis() Gets the local milliseconds from the Java epoch of 1970-01-01T00:00:00 (not fixed to any specific time zone).

[Expand]

Inherited Methods

From class org.joda.time.base.BaseLocal

From class org.joda.time.base.AbstractPartial

int	compareTo(Object partial) Compares this partial with another returning an integer indicating the order.
boolean	equals(Object partial) Compares this ReadablePartial with another returning true if the chronology, field types and values are equal.
int	get(DateTimeFieldType type) Get the value of one of the fields of a datetime.
DateTimeField	getField(int index) Gets the field at the specifed index.
abstract DateTimeField	getField(int index, Chronology chrono) Gets the field for a specific index in the chronology specified.
DateTimeFieldType	getFieldType(int index) Gets the field type at the specifed index.
DateTimeFieldType[]	getFieldTypes() Gets an array of the field types that this partial supports.
DateTimeField[]	getFields() Gets an array of the fields that this partial supports.
int[]	getValues() Gets an array of the value of each of the fields that this partial supports.
int	hashCode() Gets a hash code for the ReadablePartial that is compatible with the equals method.
int	indexOf(DurationFieldType type) Gets the index of the first fields to have the specified duration, or -1 if the field is unsupported.
int	indexOf(DateTimeFieldType type) Gets the index of the specified field, or -1 if the field is unsupported.
int	indexOfSupported(DurationFieldType type) Gets the index of the first fields to have the specified duration, throwing an exception if the field is unsupported.
int	indexOfSupported(DateTimeFieldType type) Gets the index of the specified field, throwing an exception if the field is unsupported.
boolean	isAfter(ReadablePartial partial) Is this partial later than the specified partial.
boolean	isBefore(ReadablePartial partial) Is this partial earlier than the specified partial.
boolean	isEqual(ReadablePartial partial) Is this partial the same as the specified partial.
boolean	isSupported(DateTimeFieldType type) Checks whether the field specified is supported by this partial.
DateTime	toDateTime(ReadableInstant baseInstant) Resolves this partial against another complete instant to create a new full instant.
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.ReadablePartial

abstract boolean	equals(Object partial) Compares this partial with the specified object for equality based on the supported fields, chronology and values.
abstract int	get(DateTimeFieldType field) Gets the value of one of the fields.
abstract Chronology	getChronology() Gets the chronology of the partial which is never null.
abstract DateTimeField	getField(int index) Gets the field at the specified index.
abstract DateTimeFieldType	getFieldType(int index) Gets the field type at the specified index.
abstract int	getValue(int index) Gets the value at the specified index.
abstract int	hashCode() Gets a hash code for the partial that is compatible with the equals method.
abstract boolean	isSupported(DateTimeFieldType field) Checks whether the field type specified is supported by this partial.
abstract int	size() Gets the number of fields that this partial supports.
abstract DateTime	toDateTime(ReadableInstant baseInstant) Converts this partial to a full datetime by resolving it against another datetime.
abstract String	toString() Get the value as a String in a recognisable ISO8601 format, only displaying supported fields.

Fields

public static final LocalTime MIDNIGHT

Constant for midnight.

Public Constructors

public LocalTime ()

Constructs an instance set to the current local time evaluated using ISO chronology in the default zone.

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

public LocalTime (DateTimeZone zone)

Constructs an instance set to the current local time evaluated using ISO chronology in the specified zone.

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

public LocalTime (Chronology chronology)

Constructs an instance set to the current local time evaluated using specified chronology and 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

public LocalTime (long instant)

Constructs an instance set to the local time defined by the specified instant evaluated using ISO chronology in the default zone.

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

Parameters

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

public LocalTime (long instant, DateTimeZone zone)

Constructs an instance set to the local time defined by the specified instant evaluated using ISO chronology in the specified zone.

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
zone	the time zone, null means default zone

public LocalTime (long instant, Chronology chronology)

Constructs an instance set to the local time defined by the specified instant evaluated using the specified chronology.

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
chronology	the chronology, null means ISOChronology in default zone

public LocalTime (Object instant)

Constructs an instance from an Object that represents a datetime.

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 ConverterManager and include ReadablePartial, ReadableInstant, String, Calendar and Date. The String formats are described by 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

public LocalTime (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. Once the constructor is completed, the zone is no longer used.

The recognised object types are defined in ConverterManager and include ReadablePartial, ReadableInstant, String, Calendar and Date. The String formats are described by localTimeParser(). The default String converter ignores the zone and only parses the field values.

Parameters

instant	the datetime object
zone	the time zone

Throws

IllegalArgumentException	if the instant is invalid

public LocalTime (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. Once the constructor is completed, the zone is no longer used.

The recognised object types are defined in ConverterManager and include ReadablePartial, ReadableInstant, String, Calendar and Date. The String formats are described by localTimeParser(). The default String converter ignores the zone and only parses the field values.

Parameters

instant	the datetime object
chronology	the chronology

Throws

IllegalArgumentException	if the instant is invalid

public LocalTime (int hourOfDay, int minuteOfHour)

Constructs an instance set to the specified time using ISOChronology.

Parameters

hourOfDay	the hour of the day
minuteOfHour	the minute of the hour

public LocalTime (int hourOfDay, int minuteOfHour, int secondOfMinute)

Constructs an instance set to the specified time using ISOChronology.

Parameters

hourOfDay	the hour of the day
minuteOfHour	the minute of the hour
secondOfMinute	the second of the minute

public LocalTime (int hourOfDay, int minuteOfHour, int secondOfMinute, int millisOfSecond)

Constructs an instance set to the specified time using ISOChronology.

Parameters

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 LocalTime (int hourOfDay, int minuteOfHour, int secondOfMinute, int millisOfSecond, Chronology chronology)

Constructs an instance set to the specified time using the specified chronology, whose zone is ignored.

If the chronology is null, ISOChronology is used.

Parameters

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 int compareTo (Object partial)

Compares this partial with another returning an integer indicating the order.

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

Returns

negative if this is less, zero if equal, positive if greater

Throws

ClassCastException	if the partial is the wrong class or if it has field types that don't match
NullPointerException	if the partial is null

public boolean equals (Object partial)

Compares this ReadablePartial with another returning true if the chronology, field types and values are equal.

Parameters

partial	an object to check against

Returns

true if fields and values are equal

public static LocalTime fromCalendarFields (Calendar calendar)

Constructs a LocalTime from a java.util.Calendar using exactly the same field values.

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, ignoring the zone.

One advantage of this method is that this method is unaffected if the version of the time zone data differs between the JDK and Joda-Time. That is because the local field values are transferred, calculated using the JDK time zone data and without using the Joda-Time time zone data.

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

Returns

the created LocalTime

Throws

IllegalArgumentException	if the calendar is null
IllegalArgumentException	if the date is invalid for the ISO chronology

public static LocalTime fromDateFields (Date date)

Constructs a LocalTime from a java.util.Date using exactly the same field values.

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, ignoring the zone.

One advantage of this method is that this method is unaffected if the version of the time zone data differs between the JDK and Joda-Time. That is because the local field values are transferred, calculated using the JDK time zone data and without using the Joda-Time time zone data.

This factory method always creates a LocalTime with ISO chronology.

Parameters

date	the Date to extract fields from

Returns

the created LocalTime

Throws

IllegalArgumentException	if the calendar is null
IllegalArgumentException	if the date is invalid for the ISO chronology

public static LocalTime fromMillisOfDay (long millisOfDay)

Constructs a LocalTime from the specified millis of day using 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

public static LocalTime fromMillisOfDay (long millisOfDay, Chronology chrono)

Constructs a LocalTime from the specified millis of day using the specified 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
chrono	the chronology, null means ISO chronology

public int get (DateTimeFieldType fieldType)

Get the value of one of the fields of time.

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

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

Parameters

fieldType	a field type, usually obtained from DateTimeFieldType, not null

Returns

the value of that field

Throws

IllegalArgumentException	if the field type is null

public Chronology getChronology ()

Gets the chronology of the time.

Returns

the Chronology that the time is using

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 getMinuteOfHour ()

Get the minute of hour field value.

Returns

the minute of hour

public int getSecondOfMinute ()

Get the second of minute field value.

Returns

the second of minute

public int getValue (int index)

Gets the value of the field at the specifed index.

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

Returns

the value

Throws

IndexOutOfBoundsException	if the index is invalid

public LocalTime.Property hourOfDay ()

Get the hour of day field property which provides access to advanced functionality.

Returns

the hour of day property

public boolean isSupported (DurationFieldType type)

Checks if the duration type specified is supported by this local time and chronology.

Parameters

type	a duration type, usually obtained from DurationFieldType

Returns

true if the field type is supported

public boolean isSupported (DateTimeFieldType type)

Checks if the field type specified is supported by this local time and chronology. This can be used to avoid exceptions in get(DateTimeFieldType).

Parameters

type	a field type, usually obtained from DateTimeFieldType

Returns

true if the field type is supported

public LocalTime.Property millisOfDay ()

Get the millis of day property which provides access to advanced functionality.

Returns

the millis of day property

public LocalTime.Property millisOfSecond ()

Get the millis of second property which provides access to advanced functionality.

Returns

the millis of second property

public LocalTime minus (ReadablePeriod period)

Returns a copy of this time with the specified period taken away.

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 minusHours(int).

Parameters

period	the period to reduce this instant by

Returns

a copy of this time with the period taken away

Throws

ArithmeticException	if the result exceeds the internal capacity

public LocalTime minusHours (int hours)

Returns a copy of this time minus the specified number of hours.

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);

Parameters

hours	the amount of hours to subtract, may be negative

Returns

the new LocalTime minus the increased hours

public LocalTime minusMillis (int millis)

Returns a copy of this time minus the specified number of millis.

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);

Parameters

millis	the amount of millis to subtract, may be negative

Returns

the new LocalTime minus the increased millis

public LocalTime minusMinutes (int minutes)

Returns a copy of this time minus the specified number of minutes.

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);

Parameters

minutes	the amount of minutes to subtract, may be negative

Returns

the new LocalTime minus the increased minutes

public LocalTime minusSeconds (int seconds)

Returns a copy of this time minus the specified number of seconds.

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);

Parameters

seconds	the amount of seconds to subtract, may be negative

Returns

the new LocalTime minus the increased seconds

public LocalTime.Property minuteOfHour ()

Get the minute of hour field property which provides access to advanced functionality.

Returns

the minute of hour property

public LocalTime plus (ReadablePeriod period)

Returns a copy of this time with the specified period added.

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 plusHours(int).

Parameters

period	the period to add to this one, null means zero

Returns

a copy of this time with the period added

Throws

ArithmeticException	if the result exceeds the internal capacity

public LocalTime plusHours (int hours)

Returns a copy of this time plus the specified number of hours.

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);

Parameters

hours	the amount of hours to add, may be negative

Returns

the new LocalTime plus the increased hours

public LocalTime plusMillis (int millis)

Returns a copy of this time plus the specified number of millis.

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);

Parameters

millis	the amount of millis to add, may be negative

Returns

the new LocalTime plus the increased millis

public LocalTime plusMinutes (int minutes)

Returns a copy of this time plus the specified number of minutes.

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);

Parameters

minutes	the amount of minutes to add, may be negative

Returns

the new LocalTime plus the increased minutes

public LocalTime plusSeconds (int seconds)

Returns a copy of this time plus the specified number of seconds.

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);

Parameters

seconds	the amount of seconds to add, may be negative

Returns

the new LocalTime plus the increased seconds

public LocalTime.Property property (DateTimeFieldType fieldType)

Gets the property object for the specified type, which contains many useful methods.

Parameters

fieldType	the field type to get the chronology for

Returns

the property object

Throws

IllegalArgumentException	if the field is null or unsupported

public LocalTime.Property secondOfMinute ()

Get the second of minute field property which provides access to advanced functionality.

Returns

the second of minute property

public int size ()

Gets the number of fields in this partial, which is four. The supported fields are HourOfDay, MinuteOfHour, SecondOfMinute and MillisOfSecond.

Returns

the field count, four

public DateTime toDateTimeToday (DateTimeZone zone)

Converts this LocalTime to a full datetime using the specified time zone setting the time fields from this instance and the date fields from the current time.

This method uses the chronology from this instance plus the time zone specified.

Parameters

zone	the zone to use, null means default

Returns

this time as a datetime using todays date

public DateTime toDateTimeToday ()

Converts this LocalTime to a full datetime using the default time zone setting the time fields from this instance and the date fields from the current date.

Returns

this time as a datetime using todays date

public String toString (String pattern, Locale locale)

Output the time 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 time using the specified format pattern.

Parameters

pattern	the pattern specification, null means use `toString`

public String toString ()

Output the time in ISO8601 format (HH:mm:ss.SSSZZ).

Returns

ISO8601 time formatted string.

public LocalTime withField (DateTimeFieldType fieldType, int value)

Returns a copy of this time with the specified field set to a new value.

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);

Parameters

fieldType	the field type to set, not null
value	the value to set

Returns

a copy of this time with the field set

Throws

IllegalArgumentException	if the value is null or invalid

public LocalTime withFieldAdded (DurationFieldType fieldType, int amount)

Returns a copy of this time with the value of the specified field increased.

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);

Parameters

fieldType	the field type to add to, not null
amount	the amount to add

Returns

a copy of this time with the field updated

Throws

IllegalArgumentException	if the value is null or invalid
ArithmeticException	if the result exceeds the internal capacity

public LocalTime withFields (ReadablePartial partial)

Returns a copy of this time with the partial set of fields replacing those from this instance.

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

Returns

a copy of this time with a different set of fields

Throws

IllegalArgumentException	if any value is invalid

public LocalTime withHourOfDay (int hour)

Returns a copy of this time with the hour of day field updated.

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

Returns

a copy of this object with the field set

Throws

IllegalArgumentException	if the value is invalid

public LocalTime withMillisOfDay (int millis)

Returns a copy of this time with the millis of day field updated.

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

Returns

a copy of this object with the field set

Throws

IllegalArgumentException	if the value is invalid

public LocalTime withMillisOfSecond (int millis)

Returns a copy of this time with the millis of second field updated.

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

Returns

a copy of this object with the field set

Throws

IllegalArgumentException	if the value is invalid

public LocalTime withMinuteOfHour (int minute)

Returns a copy of this time with the minute of hour field updated.

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

Returns

a copy of this object with the field set

Throws

IllegalArgumentException	if the value is invalid

public LocalTime withPeriodAdded (ReadablePeriod period, int scalar)

Returns a copy of this time with the specified period added.

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 withFieldAdded(DurationFieldType, int) or plusHours(int).

Parameters

period	the period to add to this one, null means zero
scalar	the amount of times to add, such as -1 to subtract once

Returns

a copy of this time with the period added

Throws

ArithmeticException	if the result exceeds the internal capacity

public LocalTime withSecondOfMinute (int second)

Returns a copy of this time with the second of minute field updated.

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

Returns

a copy of this object with the field set

Throws

IllegalArgumentException	if the value is invalid

Protected Methods

protected DateTimeField getField (int index, Chronology chrono)

Gets the field for a specific index in the chronology specified.

This method must not use any instance variables.

Parameters

index	the index to retrieve
chrono	the chronology to use

Returns

the field

protected long getLocalMillis ()

Gets the local milliseconds from the Java epoch of 1970-01-01T00:00:00 (not fixed to any specific time zone).

Returns

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

Interfaces

Classes

Exceptions

LocalTime

Class Overview

Summary

Fields

public static final LocalTime MIDNIGHT

Public Constructors

public LocalTime ()

public LocalTime (DateTimeZone zone)

Parameters

public LocalTime (Chronology chronology)

Parameters

public LocalTime (long instant)

Parameters

public LocalTime (long instant, DateTimeZone zone)

Parameters

public LocalTime (long instant, Chronology chronology)

Parameters

public LocalTime (Object instant)

Parameters

Throws

public LocalTime (Object instant, DateTimeZone zone)

Parameters

Throws

public LocalTime (Object instant, Chronology chronology)

Parameters

Throws

public LocalTime (int hourOfDay, int minuteOfHour)

Parameters

public LocalTime (int hourOfDay, int minuteOfHour, int secondOfMinute)

Parameters

public LocalTime (int hourOfDay, int minuteOfHour, int secondOfMinute, int millisOfSecond)

Parameters

public LocalTime (int hourOfDay, int minuteOfHour, int secondOfMinute, int millisOfSecond, Chronology chronology)

Parameters

Public Methods

public int compareTo (Object partial)

Parameters

Returns

Throws

public boolean equals (Object partial)

Parameters

Returns

public static LocalTime fromCalendarFields (Calendar calendar)

Parameters

Returns

Throws

public static LocalTime fromDateFields (Date date)

Parameters

Returns

Throws

public static LocalTime fromMillisOfDay (long millisOfDay)

Parameters

public static LocalTime fromMillisOfDay (long millisOfDay, Chronology chrono)

Parameters

public int get (DateTimeFieldType fieldType)

Parameters

Returns

Throws

public Chronology getChronology ()

Returns

public int getHourOfDay ()

Returns

public int getMillisOfDay ()

Returns

public int getMillisOfSecond ()

Returns

public int getMinuteOfHour ()

Returns

public int getSecondOfMinute ()

Returns

public int getValue (int index)

Parameters

Returns

Throws

public LocalTime.Property hourOfDay ()

Returns

public boolean isSupported (DurationFieldType type)