org.joda.time.TimeOfDay Maven / Gradle / Ivy
Show all versions of swagger-all Show documentation
/*
* Copyright 2001-2011 Stephen Colebourne
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.joda.time;
import java.io.Serializable;
import java.util.Calendar;
import java.util.Date;
import java.util.Locale;
import org.joda.time.base.BasePartial;
import org.joda.time.chrono.ISOChronology;
import org.joda.time.field.AbstractPartialFieldProperty;
import org.joda.time.field.FieldUtils;
import org.joda.time.format.ISODateTimeFormat;
/**
* TimeOfDay is an immutable partial supporting the hour, minute, second
* and millisecond fields.
*
* NOTE: This class only supports the four fields listed above. Thus, you
* cannot query the millisOfDay or secondOfDay fields for example.
* The new LocalTime class removes this restriction.
*
* Calculations on TimeOfDay are performed using a {@link Chronology}.
* This chronology is set 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 -
hourOfDay().get()
* - text value -
hourOfDay().getAsText()
* - short text value -
hourOfDay().getAsShortText()
* - maximum/minimum values -
hourOfDay().getMaximumValue()
* - add/subtract -
hourOfDay().addToCopy()
* - set -
hourOfDay().setCopy()
*
*
* TimeOfDay 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
* @author Brian S O'Neill
* @since 1.0
* @deprecated Use LocalTime which has a much better internal implementation and
* has been available since 1.3
*/
@Deprecated
public final class TimeOfDay
extends BasePartial
implements ReadablePartial, Serializable {
// NOTE: No toDateTime(YearMonthDay) as semantics are confusing when
// different chronologies
/** Serialization version */
private static final long serialVersionUID = 3633353405803318660L;
/** The singleton set of field types */
private static final DateTimeFieldType[] FIELD_TYPES = new DateTimeFieldType[] {
DateTimeFieldType.hourOfDay(),
DateTimeFieldType.minuteOfHour(),
DateTimeFieldType.secondOfMinute(),
DateTimeFieldType.millisOfSecond(),
};
/** Constant for midnight. */
public static final TimeOfDay MIDNIGHT = new TimeOfDay(0, 0, 0, 0);
/** The index of the hourOfDay field in the field array */
public static final int HOUR_OF_DAY = 0;
/** The index of the minuteOfHour field in the field array */
public static final int MINUTE_OF_HOUR = 1;
/** The index of the secondOfMinute field in the field array */
public static final int SECOND_OF_MINUTE = 2;
/** The index of the millisOfSecond field in the field array */
public static final int MILLIS_OF_SECOND = 3;
//-----------------------------------------------------------------------
/**
* Constructs a TimeOfDay from a java.util.Calendar
* using exactly the same field values avoiding any time zone effects.
*
* Each field is queried from the Calendar and assigned to the TimeOfDay.
* This is useful to ensure that the field values are the same in the
* created TimeOfDay no matter what the time zone is. For example, if
* the Calendar states that the time is 04:29, then the created TimeOfDay
* will always have the time 04:29 irrespective of time zone issues.
*
* This factory method ignores the type of the calendar and always
* creates a TimeOfDay with ISO chronology.
*
* @param calendar the Calendar to extract fields from
* @return the created TimeOfDay
* @throws IllegalArgumentException if the calendar is null
* @throws IllegalArgumentException if the time is invalid for the ISO chronology
* @since 1.2
*/
public static TimeOfDay fromCalendarFields(Calendar calendar) {
if (calendar == null) {
throw new IllegalArgumentException("The calendar must not be null");
}
return new TimeOfDay(
calendar.get(Calendar.HOUR_OF_DAY),
calendar.get(Calendar.MINUTE),
calendar.get(Calendar.SECOND),
calendar.get(Calendar.MILLISECOND)
);
}
/**
* Constructs a TimeOfDay from a java.util.Date
* using exactly the same field values avoiding any time zone effects.
*
* Each field is queried from the Date and assigned to the TimeOfDay.
* This is useful to ensure that the field values are the same in the
* created TimeOfDay no matter what the time zone is. For example, if
* the Calendar states that the time is 04:29, then the created TimeOfDay
* will always have the time 04:29 irrespective of time zone issues.
*
* This factory method always creates a TimeOfDay with ISO chronology.
*
* @param date the Date to extract fields from
* @return the created TimeOfDay
* @throws IllegalArgumentException if the calendar is null
* @throws IllegalArgumentException if the date is invalid for the ISO chronology
* @since 1.2
*/
public static TimeOfDay fromDateFields(Date date) {
if (date == null) {
throw new IllegalArgumentException("The date must not be null");
}
return new TimeOfDay(
date.getHours(),
date.getMinutes(),
date.getSeconds(),
(((int) (date.getTime() % 1000)) + 1000) % 1000
);
}
//-----------------------------------------------------------------------
/**
* Constructs a TimeOfDay 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.
*
* @param millisOfDay the number of milliseconds into a day to convert
*/
public static TimeOfDay fromMillisOfDay(long millisOfDay) {
return fromMillisOfDay(millisOfDay, null);
}
/**
* Constructs a TimeOfDay 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.
*
* @param millisOfDay the number of milliseconds into a day to convert
* @param chrono the chronology, null means ISO chronology
*/
public static TimeOfDay fromMillisOfDay(long millisOfDay, Chronology chrono) {
chrono = DateTimeUtils.getChronology(chrono);
chrono = chrono.withUTC();
return new TimeOfDay(millisOfDay, chrono);
}
// Constructors
//-----------------------------------------------------------------------
/**
* Constructs a TimeOfDay with the current time, using ISOChronology in
* the default zone to extract the fields.
*
* The constructor uses the default time zone, resulting in the local time
* being initialised. Once the constructor is complete, all further calculations
* are performed without reference to a timezone (by switching to UTC).
*/
public TimeOfDay() {
super();
}
/**
* Constructs a TimeOfDay with the current time, using ISOChronology in
* the specified zone to extract the fields.
*
* The constructor uses the specified time zone to obtain the current time.
* Once the constructor is complete, all further calculations
* are performed without reference to a timezone (by switching to UTC).
*
* @param zone the zone to use, null means default zone
* @since 1.1
*/
public TimeOfDay(DateTimeZone zone) {
super(ISOChronology.getInstance(zone));
}
/**
* Constructs a TimeOfDay with the current time, using the specified chronology
* and zone to extract the fields.
*
* The constructor uses the time zone of the chronology specified.
* Once the constructor is complete, all further calculations are performed
* without reference to a timezone (by switching to UTC).
*
* @param chronology the chronology, null means ISOChronology in the default zone
*/
public TimeOfDay(Chronology chronology) {
super(chronology);
}
/**
* Constructs a TimeOfDay extracting the partial fields from the specified
* milliseconds using the ISOChronology in the default zone.
*
* The constructor uses the default time zone, resulting in the local time
* being initialised. Once the constructor is complete, all further calculations
* are performed without reference to a timezone (by switching to UTC).
*
* @param instant the milliseconds from 1970-01-01T00:00:00Z
*/
public TimeOfDay(long instant) {
super(instant);
}
/**
* Constructs a TimeOfDay extracting the partial fields from the specified
* milliseconds using the chronology provided.
*
* The constructor uses the time zone of the chronology specified.
* Once the constructor is complete, all further calculations are performed
* without reference to a timezone (by switching to UTC).
*
* @param instant the milliseconds from 1970-01-01T00:00:00Z
* @param chronology the chronology, null means ISOChronology in the default zone
*/
public TimeOfDay(long instant, Chronology chronology) {
super(instant, chronology);
}
/**
* Constructs a TimeOfDay from an Object that represents a time.
*
* The recognised object types are defined in
* {@link org.joda.time.convert.ConverterManager ConverterManager} and
* include ReadableInstant, String, Calendar and Date.
* The String formats are described by {@link ISODateTimeFormat#timeParser()}.
*
* The chronology used will be derived from the object, defaulting to ISO.
*
* NOTE: Prior to v1.3 the string format was described by
* {@link ISODateTimeFormat#dateTimeParser()}. Dates are now rejected.
*
* @param instant the datetime object, null means now
* @throws IllegalArgumentException if the instant is invalid
*/
public TimeOfDay(Object instant) {
super(instant, null, ISODateTimeFormat.timeParser());
}
/**
* Constructs a TimeOfDay from an Object that represents a time, using the
* specified chronology.
*
* The recognised object types are defined in
* {@link org.joda.time.convert.ConverterManager ConverterManager} and
* include ReadableInstant, String, Calendar and Date.
* The String formats are described by {@link ISODateTimeFormat#timeParser()}.
*
* The constructor uses the time zone of the chronology specified.
* Once the constructor is complete, all further calculations are performed
* without reference to a timezone (by switching to UTC).
* The specified chronology overrides that of the object.
*
* NOTE: Prior to v1.3 the string format was described by
* {@link ISODateTimeFormat#dateTimeParser()}. Dates are now rejected.
*
* @param instant the datetime object, null means now
* @param chronology the chronology, null means ISO default
* @throws IllegalArgumentException if the instant is invalid
*/
public TimeOfDay(Object instant, Chronology chronology) {
super(instant, DateTimeUtils.getChronology(chronology), ISODateTimeFormat.timeParser());
}
/**
* Constructs a TimeOfDay with specified hour and minute and zero seconds and milliseconds
* using ISOChronology in the default zone.
*
* The constructor uses the no time zone initialising the fields as provided.
* Once the constructor is complete, all further calculations
* are performed without reference to a timezone (by switching to UTC).
*
* @param hourOfDay the hour of the day
* @param minuteOfHour the minute of the hour
*/
public TimeOfDay(int hourOfDay, int minuteOfHour) {
this(hourOfDay, minuteOfHour, 0, 0, null);
}
/**
* Constructs a TimeOfDay with specified hour and minute and zero seconds and milliseconds.
*
* The constructor uses the time zone of the chronology specified.
* Once the constructor is complete, all further calculations are performed
* without reference to a timezone (by switching to UTC).
*
* @param hourOfDay the hour of the day
* @param minuteOfHour the minute of the hour
* @param chronology the chronology, null means ISOChronology in the default zone
*/
public TimeOfDay(int hourOfDay, int minuteOfHour, Chronology chronology) {
this(hourOfDay, minuteOfHour, 0, 0, chronology);
}
/**
* Constructs a TimeOfDay with specified time field values and zero milliseconds
* using ISOChronology in the default zone.
*
* The constructor uses the no time zone initialising the fields as provided.
* Once the constructor is complete, all further calculations
* are performed without reference to a timezone (by switching to UTC).
*
* @param hourOfDay the hour of the day
* @param minuteOfHour the minute of the hour
* @param secondOfMinute the second of the minute
*/
public TimeOfDay(int hourOfDay, int minuteOfHour, int secondOfMinute) {
this(hourOfDay, minuteOfHour, secondOfMinute, 0, null);
}
/**
* Constructs a TimeOfDay with specified time field values and zero milliseconds.
*
* The constructor uses the time zone of the chronology specified.
* Once the constructor is complete, all further calculations are performed
* without reference to a timezone (by switching to UTC).
*
* @param hourOfDay the hour of the day
* @param minuteOfHour the minute of the hour
* @param secondOfMinute the second of the minute
* @param chronology the chronology, null means ISOChronology in the default zone
*/
public TimeOfDay(int hourOfDay, int minuteOfHour, int secondOfMinute, Chronology chronology) {
this(hourOfDay, minuteOfHour, secondOfMinute, 0, chronology);
}
/**
* Constructs a TimeOfDay with specified time field values using
* ISOChronology in the default zone.
*
* The constructor uses the no time zone initialising the fields as provided.
* Once the constructor is complete, all further calculations
* are performed without reference to a timezone (by switching to UTC).
*
* @param hourOfDay the hour of the day
* @param minuteOfHour the minute of the hour
* @param secondOfMinute the second of the minute
* @param millisOfSecond the millisecond of the second
*/
public TimeOfDay(int hourOfDay, int minuteOfHour, int secondOfMinute, int millisOfSecond) {
this(hourOfDay, minuteOfHour, secondOfMinute, millisOfSecond, null);
}
/**
* Constructs a TimeOfDay with specified time field values and chronology.
*
* The constructor uses the time zone of the chronology specified.
* Once the constructor is complete, all further calculations are performed
* without reference to a timezone (by switching to UTC).
*
* @param hourOfDay the hour of the day
* @param minuteOfHour the minute of the hour
* @param secondOfMinute the second of the minute
* @param millisOfSecond the millisecond of the second
* @param chronology the chronology, null means ISOChronology in the default zone
*/
public TimeOfDay(int hourOfDay, int minuteOfHour,
int secondOfMinute, int millisOfSecond, Chronology chronology) {
super(new int[] {hourOfDay, minuteOfHour, secondOfMinute, millisOfSecond}, chronology);
}
/**
* Constructs a TimeOfDay with chronology from this instance and new values.
*
* @param partial the partial to base this new instance on
* @param values the new set of values
*/
TimeOfDay(TimeOfDay partial, int[] values) {
super(partial, values);
}
/**
* Constructs a TimeOfDay with values from this instance and a new chronology.
*
* @param partial the partial to base this new instance on
* @param chrono the new chronology
*/
TimeOfDay(TimeOfDay partial, Chronology chrono) {
super(partial, chrono);
}
//-----------------------------------------------------------------------
/**
* Gets the number of fields in this partial.
*
* @return the field count
*/
public int size() {
return 4;
}
/**
* Gets the field for a specific index in the chronology specified.
*
* This method must not use any instance variables.
*
* @param index the index to retrieve
* @param chrono the chronology to use
* @return the field
*/
protected DateTimeField getField(int index, Chronology chrono) {
switch (index) {
case HOUR_OF_DAY:
return chrono.hourOfDay();
case MINUTE_OF_HOUR:
return chrono.minuteOfHour();
case SECOND_OF_MINUTE:
return chrono.secondOfMinute();
case MILLIS_OF_SECOND:
return chrono.millisOfSecond();
default:
throw new IndexOutOfBoundsException("Invalid index: " + index);
}
}
/**
* Gets the field type at the specified index.
*
* @param index the index to retrieve
* @return the field at the specified index
* @throws IndexOutOfBoundsException if the index is invalid
*/
public DateTimeFieldType getFieldType(int index) {
return FIELD_TYPES[index];
}
/**
* Gets an array of the field type of each of the fields that this partial supports.
*
* The fields are returned largest to smallest, Hour, Minute, Second, Millis.
*
* @return the array of field types (cloned), largest to smallest
*/
public DateTimeFieldType[] getFieldTypes() {
return (DateTimeFieldType[]) FIELD_TYPES.clone();
}
//-----------------------------------------------------------------------
/**
* Returns a copy of this time with the specified chronology.
* This instance is immutable and unaffected by this method call.
*
* This method retains the values of the fields, thus the result will
* typically refer to a different instant.
*
* The time zone of the specified chronology is ignored, as TimeOfDay
* operates without a time zone.
*
* @param newChronology the new chronology, null means ISO
* @return a copy of this datetime with a different chronology
* @throws IllegalArgumentException if the values are invalid for the new chronology
*/
public TimeOfDay withChronologyRetainFields(Chronology newChronology) {
newChronology = DateTimeUtils.getChronology(newChronology);
newChronology = newChronology.withUTC();
if (newChronology == getChronology()) {
return this;
} else {
TimeOfDay newTimeOfDay = new TimeOfDay(this, newChronology);
newChronology.validate(newTimeOfDay, getValues());
return newTimeOfDay;
}
}
/**
* Returns a copy of this time with the specified field set to a new value.
*
* For example, if the field type is minuteOfHour then the day
* would be changed in the returned instance.
*
* These three lines are equivalent:
*
* TimeOfDay updated = tod.withField(DateTimeFieldType.minuteOfHour(), 6);
* TimeOfDay updated = tod.minuteOfHour().setCopy(6);
* TimeOfDay updated = tod.property(DateTimeFieldType.minuteOfHour()).setCopy(6);
*
*
* @param fieldType the field type to set, not null
* @param value the value to set
* @return a copy of this instance with the field set
* @throws IllegalArgumentException if the value is null or invalid
*/
public TimeOfDay withField(DateTimeFieldType fieldType, int value) {
int index = indexOfSupported(fieldType);
if (value == getValue(index)) {
return this;
}
int[] newValues = getValues();
newValues = getField(index).set(this, index, newValues, value);
return new TimeOfDay(this, newValues);
}
/**
* Returns a copy of this time with the value of the specified field increased,
* wrapping to what would be a new day if required.
*
* If the addition is zero, then this is returned.
*
* These three lines are equivalent:
*
* TimeOfDay added = tod.withFieldAdded(DurationFieldType.minutes(), 6);
* TimeOfDay added = tod.plusMinutes(6);
* TimeOfDay added = tod.minuteOfHour().addToCopy(6);
*
*
* @param fieldType the field type to add to, not null
* @param amount the amount to add
* @return a copy of this instance with the field updated
* @throws IllegalArgumentException if the value is null or invalid
* @throws ArithmeticException if the new datetime exceeds the capacity
*/
public TimeOfDay withFieldAdded(DurationFieldType fieldType, int amount) {
int index = indexOfSupported(fieldType);
if (amount == 0) {
return this;
}
int[] newValues = getValues();
newValues = getField(index).addWrapPartial(this, index, newValues, amount);
return new TimeOfDay(this, newValues);
}
/**
* Returns a copy of this time with the specified period added,
* wrapping to what would be a new day if required.
*
* If the addition is zero, then this is returned.
* Fields in the period that aren't present in the partial are ignored.
*
* This method is typically used to add multiple copies of complex
* period instances. Adding one field is best achieved using methods
* like {@link #withFieldAdded(DurationFieldType, int)}
* or {@link #plusHours(int)}.
*
* @param period the period to add to this one, null means zero
* @param scalar the amount of times to add, such as -1 to subtract once
* @return a copy of this instance with the period added
* @throws ArithmeticException if the new datetime exceeds the capacity
*/
public TimeOfDay withPeriodAdded(ReadablePeriod period, int scalar) {
if (period == null || scalar == 0) {
return this;
}
int[] newValues = getValues();
for (int i = 0; i < period.size(); i++) {
DurationFieldType fieldType = period.getFieldType(i);
int index = indexOf(fieldType);
if (index >= 0) {
newValues = getField(index).addWrapPartial(this, index, newValues,
FieldUtils.safeMultiply(period.getValue(i), scalar));
}
}
return new TimeOfDay(this, newValues);
}
//-----------------------------------------------------------------------
/**
* Returns a copy of this time with the specified period added,
* wrapping to what would be a new day if required.
*
* 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 {@link #plusHours(int)}.
*
* @param period the duration to add to this one, null means zero
* @return a copy of this instance with the period added
* @throws ArithmeticException if the new datetime exceeds the capacity of a long
*/
public TimeOfDay plus(ReadablePeriod period) {
return withPeriodAdded(period, 1);
}
//-----------------------------------------------------------------------
/**
* Returns a copy of this time plus the specified number of hours.
*
* This time instance is immutable and unaffected by this method call.
*
* The following three lines are identical in effect:
*
* TimeOfDay added = dt.plusHours(6);
* TimeOfDay added = dt.plus(Period.hours(6));
* TimeOfDay added = dt.withFieldAdded(DurationFieldType.hours(), 6);
*
*
* @param hours the amount of hours to add, may be negative
* @return the new time plus the increased hours
* @since 1.1
*/
public TimeOfDay plusHours(int hours) {
return withFieldAdded(DurationFieldType.hours(), hours);
}
/**
* Returns a copy of this time plus the specified number of minutes.
*
* This time instance is immutable and unaffected by this method call.
*
* The following three lines are identical in effect:
*
* TimeOfDay added = dt.plusMinutes(6);
* TimeOfDay added = dt.plus(Period.minutes(6));
* TimeOfDay added = dt.withFieldAdded(DurationFieldType.minutes(), 6);
*
*
* @param minutes the amount of minutes to add, may be negative
* @return the new time plus the increased minutes
* @since 1.1
*/
public TimeOfDay plusMinutes(int minutes) {
return withFieldAdded(DurationFieldType.minutes(), minutes);
}
/**
* Returns a copy of this time plus the specified number of seconds.
*
* This time instance is immutable and unaffected by this method call.
*
* The following three lines are identical in effect:
*
* TimeOfDay added = dt.plusSeconds(6);
* TimeOfDay added = dt.plus(Period.seconds(6));
* TimeOfDay added = dt.withFieldAdded(DurationFieldType.seconds(), 6);
*
*
* @param seconds the amount of seconds to add, may be negative
* @return the new time plus the increased seconds
* @since 1.1
*/
public TimeOfDay plusSeconds(int seconds) {
return withFieldAdded(DurationFieldType.seconds(), seconds);
}
/**
* Returns a copy of this time plus the specified number of millis.
*
* This time instance is immutable and unaffected by this method call.
*
* The following three lines are identical in effect:
*
* TimeOfDay added = dt.plusMillis(6);
* TimeOfDay added = dt.plus(Period.millis(6));
* TimeOfDay added = dt.withFieldAdded(DurationFieldType.millis(), 6);
*
*
* @param millis the amount of millis to add, may be negative
* @return the new time plus the increased millis
* @since 1.1
*/
public TimeOfDay plusMillis(int millis) {
return withFieldAdded(DurationFieldType.millis(), millis);
}
//-----------------------------------------------------------------------
/**
* Returns a copy of this time with the specified period taken away,
* wrapping to what would be a new day if required.
*
* 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 {@link #minusHours(int)}.
*
* @param period the period to reduce this instant by
* @return a copy of this instance with the period taken away
* @throws ArithmeticException if the new time exceeds capacity
*/
public TimeOfDay minus(ReadablePeriod period) {
return withPeriodAdded(period, -1);
}
//-----------------------------------------------------------------------
/**
* Returns a copy of this time minus the specified number of hours.
*
* This time instance is immutable and unaffected by this method call.
*
* The following three lines are identical in effect:
*
* TimeOfDay subtracted = dt.minusHours(6);
* TimeOfDay subtracted = dt.minus(Period.hours(6));
* TimeOfDay subtracted = dt.withFieldAdded(DurationFieldType.hours(), -6);
*
*
* @param hours the amount of hours to subtract, may be negative
* @return the new time minus the increased hours
* @since 1.1
*/
public TimeOfDay minusHours(int hours) {
return withFieldAdded(DurationFieldType.hours(), FieldUtils.safeNegate(hours));
}
/**
* Returns a copy of this time minus the specified number of minutes.
*
* This time instance is immutable and unaffected by this method call.
*
* The following three lines are identical in effect:
*
* TimeOfDay subtracted = dt.minusMinutes(6);
* TimeOfDay subtracted = dt.minus(Period.minutes(6));
* TimeOfDay subtracted = dt.withFieldAdded(DurationFieldType.minutes(), -6);
*
*
* @param minutes the amount of minutes to subtract, may be negative
* @return the new time minus the increased minutes
* @since 1.1
*/
public TimeOfDay minusMinutes(int minutes) {
return withFieldAdded(DurationFieldType.minutes(), FieldUtils.safeNegate(minutes));
}
/**
* Returns a copy of this time minus the specified number of seconds.
*
* This time instance is immutable and unaffected by this method call.
*
* The following three lines are identical in effect:
*
* TimeOfDay subtracted = dt.minusSeconds(6);
* TimeOfDay subtracted = dt.minus(Period.seconds(6));
* TimeOfDay subtracted = dt.withFieldAdded(DurationFieldType.seconds(), -6);
*
*
* @param seconds the amount of seconds to subtract, may be negative
* @return the new time minus the increased seconds
* @since 1.1
*/
public TimeOfDay minusSeconds(int seconds) {
return withFieldAdded(DurationFieldType.seconds(), FieldUtils.safeNegate(seconds));
}
/**
* Returns a copy of this time minus the specified number of millis.
*
* This time instance is immutable and unaffected by this method call.
*
* The following three lines are identical in effect:
*
* TimeOfDay subtracted = dt.minusMillis(6);
* TimeOfDay subtracted = dt.minus(Period.millis(6));
* TimeOfDay subtracted = dt.withFieldAdded(DurationFieldType.millis(), -6);
*
*
* @param millis the amount of millis to subtract, may be negative
* @return the new time minus the increased millis
* @since 1.1
*/
public TimeOfDay minusMillis(int millis) {
return withFieldAdded(DurationFieldType.millis(), FieldUtils.safeNegate(millis));
}
//-----------------------------------------------------------------------
/**
* Gets the property object for the specified type, which contains
* many useful methods.
*
* @param type the field type to get the property for
* @return the property object
* @throws IllegalArgumentException if the field is null or unsupported
*/
public Property property(DateTimeFieldType type) {
return new Property(this, indexOfSupported(type));
}
//-----------------------------------------------------------------------
/**
* Converts this object to a LocalTime with the same time and chronology.
*
* @return a LocalTime with the same time and chronology
* @since 1.3
*/
public LocalTime toLocalTime() {
return new LocalTime(getHourOfDay(), getMinuteOfHour(),
getSecondOfMinute(), getMillisOfSecond(), getChronology());
}
//-----------------------------------------------------------------------
/**
* Converts this partial to a full datetime using the default time zone
* setting the time fields from this instance and the date fields from
* the current time.
*
* @return this date as a datetime with the time as the current time
*/
public DateTime toDateTimeToday() {
return toDateTimeToday(null);
}
/**
* Converts this partial 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.
*
* @param zone the zone to use, null means default
* @return this date as a datetime with the time as the current time
*/
public DateTime toDateTimeToday(DateTimeZone zone) {
Chronology chrono = getChronology().withZone(zone);
long instantMillis = DateTimeUtils.currentTimeMillis();
long resolved = chrono.set(this, instantMillis);
return new DateTime(resolved, chrono);
}
//-----------------------------------------------------------------------
/**
* Get the hour of day (0-23) field value.
*
* @return the hour of day
*/
public int getHourOfDay() {
return getValue(HOUR_OF_DAY);
}
/**
* Get the minute of hour field value.
*
* @return the minute of hour
*/
public int getMinuteOfHour() {
return getValue(MINUTE_OF_HOUR);
}
/**
* Get the second of minute field value.
*
* @return the second of minute
*/
public int getSecondOfMinute() {
return getValue(SECOND_OF_MINUTE);
}
/**
* Get the millis of second field value.
*
* @return the millis of second
*/
public int getMillisOfSecond() {
return getValue(MILLIS_OF_SECOND);
}
//-----------------------------------------------------------------------
/**
* Returns a copy of this time with the hour of day field updated.
*
* TimeOfDay is immutable, so there are no set methods.
* Instead, this method returns a new instance with the value of
* hour of day changed.
*
* @param hour the hour of day to set
* @return a copy of this object with the field set
* @throws IllegalArgumentException if the value is invalid
* @since 1.3
*/
public TimeOfDay withHourOfDay(int hour) {
int[] newValues = getValues();
newValues = getChronology().hourOfDay().set(this, HOUR_OF_DAY, newValues, hour);
return new TimeOfDay(this, newValues);
}
/**
* Returns a copy of this time with the minute of hour field updated.
*
* TimeOfDay is immutable, so there are no set methods.
* Instead, this method returns a new instance with the value of
* minute of hour changed.
*
* @param minute the minute of hour to set
* @return a copy of this object with the field set
* @throws IllegalArgumentException if the value is invalid
* @since 1.3
*/
public TimeOfDay withMinuteOfHour(int minute) {
int[] newValues = getValues();
newValues = getChronology().minuteOfHour().set(this, MINUTE_OF_HOUR, newValues, minute);
return new TimeOfDay(this, newValues);
}
/**
* Returns a copy of this time with the second of minute field updated.
*
* TimeOfDay is immutable, so there are no set methods.
* Instead, this method returns a new instance with the value of
* second of minute changed.
*
* @param second the second of minute to set
* @return a copy of this object with the field set
* @throws IllegalArgumentException if the value is invalid
* @since 1.3
*/
public TimeOfDay withSecondOfMinute(int second) {
int[] newValues = getValues();
newValues = getChronology().secondOfMinute().set(this, SECOND_OF_MINUTE, newValues, second);
return new TimeOfDay(this, newValues);
}
/**
* Returns a copy of this time with the millis of second field updated.
*
* TimeOfDay is immutable, so there are no set methods.
* Instead, this method returns a new instance with the value of
* millis of second changed.
*
* @param millis the millis of second to set
* @return a copy of this object with the field set
* @throws IllegalArgumentException if the value is invalid
* @since 1.3
*/
public TimeOfDay withMillisOfSecond(int millis) {
int[] newValues = getValues();
newValues = getChronology().millisOfSecond().set(this, MILLIS_OF_SECOND, newValues, millis);
return new TimeOfDay(this, newValues);
}
//-----------------------------------------------------------------------
/**
* Get the hour of day field property which provides access to advanced functionality.
*
* @return the hour of day property
*/
public Property hourOfDay() {
return new Property(this, HOUR_OF_DAY);
}
/**
* Get the minute of hour field property which provides access to advanced functionality.
*
* @return the minute of hour property
*/
public Property minuteOfHour() {
return new Property(this, MINUTE_OF_HOUR);
}
/**
* Get the second of minute field property which provides access to advanced functionality.
*
* @return the second of minute property
*/
public Property secondOfMinute() {
return new Property(this, SECOND_OF_MINUTE);
}
/**
* Get the millis of second property which provides access to advanced functionality.
*
* @return the millis of second property
*/
public Property millisOfSecond() {
return new Property(this, MILLIS_OF_SECOND);
}
//-----------------------------------------------------------------------
/**
* Output the time in the ISO8601 format THH:mm:ss.SSS.
*
* @return ISO8601 formatted string
*/
public String toString() {
return ISODateTimeFormat.tTime().print(this);
}
//-----------------------------------------------------------------------
/**
* The property class for TimeOfDay.
*
* This class binds a TimeOfDay to a DateTimeField.
*
* @author Stephen Colebourne
* @since 1.0
* @deprecated Use LocalTime which has a much better internal implementation
*/
@Deprecated
public static class Property extends AbstractPartialFieldProperty implements Serializable {
/** Serialization version */
private static final long serialVersionUID = 5598459141741063833L;
/** The partial */
private final TimeOfDay iTimeOfDay;
/** The field index */
private final int iFieldIndex;
/**
* Constructs a property.
*
* @param partial the partial instance
* @param fieldIndex the index in the partial
*/
Property(TimeOfDay partial, int fieldIndex) {
super();
iTimeOfDay = partial;
iFieldIndex = fieldIndex;
}
/**
* Gets the field that this property uses.
*
* @return the field
*/
public DateTimeField getField() {
return iTimeOfDay.getField(iFieldIndex);
}
/**
* Gets the partial that this property belongs to.
*
* @return the partial
*/
protected ReadablePartial getReadablePartial() {
return iTimeOfDay;
}
/**
* Gets the partial that this property belongs to.
*
* @return the partial
*/
public TimeOfDay getTimeOfDay() {
return iTimeOfDay;
}
/**
* Gets the value of this field.
*
* @return the field value
*/
public int get() {
return iTimeOfDay.getValue(iFieldIndex);
}
//-----------------------------------------------------------------------
/**
* Adds to the value of this field in a copy of this TimeOfDay,
* wrapping to what would be the next day if necessary.
*
* The value will be added to this field. If the value is too large to be
* added solely to this field then it will affect larger fields.
* Smaller fields are unaffected.
*
* If the result would be too large, beyond 23:59:59:999, then the
* calculation wraps to 00:00:00.000. For the alternate strict behaviour
* with no wrapping see {@link #addNoWrapToCopy(int)}.
*
* The TimeOfDay attached to this property is unchanged by this call.
* Instead, a new instance is returned.
*
* @param valueToAdd the value to add to the field in the copy
* @return a copy of the TimeOfDay with the field value changed
* @throws IllegalArgumentException if the value isn't valid
*/
public TimeOfDay addToCopy(int valueToAdd) {
int[] newValues = iTimeOfDay.getValues();
newValues = getField().addWrapPartial(iTimeOfDay, iFieldIndex, newValues, valueToAdd);
return new TimeOfDay(iTimeOfDay, newValues);
}
/**
* Adds to the value of this field in a copy of this TimeOfDay,
* throwing an Exception if the bounds are exceeded.
*
* The value will be added to this field. If the value is too large to be
* added solely to this field then it will affect larger fields.
* Smaller fields are unaffected.
*
* If the result would be too large (beyond 23:59:59:999) or too
* small (less than 00:00:00.000) then an Execption is thrown.
* For the alternate behaviour which wraps to the next 'day',
* see {@link #addToCopy(int)}.
*
* The TimeOfDay attached to this property is unchanged by this call.
* Instead, a new instance is returned.
*
* @param valueToAdd the value to add to the field in the copy
* @return a copy of the TimeOfDay with the field value changed
* @throws IllegalArgumentException if the value isn't valid
*/
public TimeOfDay addNoWrapToCopy(int valueToAdd) {
int[] newValues = iTimeOfDay.getValues();
newValues = getField().add(iTimeOfDay, iFieldIndex, newValues, valueToAdd);
return new TimeOfDay(iTimeOfDay, newValues);
}
/**
* Adds to the value of this field in a copy of this TimeOfDay wrapping
* within this field if the maximum value is reached.
*
* The value will be added to this field. If the value is too large to be
* added solely to this field then it wraps within this field.
* Other fields are unaffected.
*
* For example,
* 12:59:37 addWrapField one minute returns 12:00:37.
*
* The TimeOfDay attached to this property is unchanged by this call.
* Instead, a new instance is returned.
*
* @param valueToAdd the value to add to the field in the copy
* @return a copy of the TimeOfDay with the field value changed
* @throws IllegalArgumentException if the value isn't valid
*/
public TimeOfDay addWrapFieldToCopy(int valueToAdd) {
int[] newValues = iTimeOfDay.getValues();
newValues = getField().addWrapField(iTimeOfDay, iFieldIndex, newValues, valueToAdd);
return new TimeOfDay(iTimeOfDay, newValues);
}
//-----------------------------------------------------------------------
/**
* Sets this field in a copy of the TimeOfDay.
*
* The TimeOfDay attached to this property is unchanged by this call.
* Instead, a new instance is returned.
*
* @param value the value to set the field in the copy to
* @return a copy of the TimeOfDay with the field value changed
* @throws IllegalArgumentException if the value isn't valid
*/
public TimeOfDay setCopy(int value) {
int[] newValues = iTimeOfDay.getValues();
newValues = getField().set(iTimeOfDay, iFieldIndex, newValues, value);
return new TimeOfDay(iTimeOfDay, newValues);
}
/**
* Sets this field in a copy of the TimeOfDay to a parsed text value.
*
* The TimeOfDay attached to this property is unchanged by this call.
* Instead, a new instance is returned.
*
* @param text the text value to set
* @param locale optional locale to use for selecting a text symbol
* @return a copy of the TimeOfDay with the field value changed
* @throws IllegalArgumentException if the text value isn't valid
*/
public TimeOfDay setCopy(String text, Locale locale) {
int[] newValues = iTimeOfDay.getValues();
newValues = getField().set(iTimeOfDay, iFieldIndex, newValues, text, locale);
return new TimeOfDay(iTimeOfDay, newValues);
}
/**
* Sets this field in a copy of the TimeOfDay to a parsed text value.
*
* The TimeOfDay attached to this property is unchanged by this call.
* Instead, a new instance is returned.
*
* @param text the text value to set
* @return a copy of the TimeOfDay with the field value changed
* @throws IllegalArgumentException if the text value isn't valid
*/
public TimeOfDay setCopy(String text) {
return setCopy(text, null);
}
//-----------------------------------------------------------------------
/**
* Returns a new TimeOfDay with this field set to the maximum value
* for this field.
*
* The TimeOfDay attached to this property is unchanged by this call.
*
* @return a copy of the TimeOfDay with this field set to its maximum
* @since 1.2
*/
public TimeOfDay withMaximumValue() {
return setCopy(getMaximumValue());
}
/**
* Returns a new TimeOfDay with this field set to the minimum value
* for this field.
*
* The TimeOfDay attached to this property is unchanged by this call.
*
* @return a copy of the TimeOfDay with this field set to its minimum
* @since 1.2
*/
public TimeOfDay withMinimumValue() {
return setCopy(getMinimumValue());
}
}
}